1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995, 1996, 1997,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
56 #include <sys/ioctl.h>
58 #endif /* not MSDOS */
60 #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 /* File descriptor to use for input. */
102 #ifdef HAVE_WINDOW_SYSTEM
103 /* Make all keyboard buffers much bigger when using X windows. */
105 /* But not too big (local data > 32K error) if on Mac OS Classic. */
106 #define KBD_BUFFER_SIZE 512
108 #define KBD_BUFFER_SIZE 4096
110 #else /* No X-windows, character input */
111 #define KBD_BUFFER_SIZE 4096
112 #endif /* No X-windows */
114 #define abs(x) ((x) >= 0 ? (x) : -(x))
116 /* Following definition copied from eval.c */
120 struct backtrace
*next
;
121 Lisp_Object
*function
;
122 Lisp_Object
*args
; /* Points to vector of args. */
123 int nargs
; /* length of vector. If nargs is UNEVALLED,
124 args points to slot holding list of
127 /* Nonzero means call value of debugger when done with this operation. */
132 KBOARD
*initial_kboard
;
133 KBOARD
*current_kboard
;
137 KBOARD the_only_kboard
;
140 /* Non-nil disable property on a command means
141 do not execute it; call disabled-command-function's value instead. */
142 Lisp_Object Qdisabled
, Qdisabled_command_function
;
144 #define NUM_RECENT_KEYS (100)
145 int recent_keys_index
; /* Index for storing next element into recent_keys */
146 int total_keys
; /* Total number of elements stored into recent_keys */
147 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
149 /* Vector holding the key sequence that invoked the current command.
150 It is reused for each command, and it may be longer than the current
151 sequence; this_command_key_count indicates how many elements
152 actually mean something.
153 It's easier to staticpro a single Lisp_Object than an array. */
154 Lisp_Object this_command_keys
;
155 int this_command_key_count
;
157 /* 1 after calling Freset_this_command_lengths.
159 int this_command_key_count_reset
;
161 /* This vector is used as a buffer to record the events that were actually read
162 by read_key_sequence. */
163 Lisp_Object raw_keybuf
;
164 int raw_keybuf_count
;
166 #define GROW_RAW_KEYBUF \
167 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
169 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
171 new = Fmake_vector (make_number (newsize), Qnil); \
172 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
173 raw_keybuf_count * sizeof (Lisp_Object)); \
177 /* Number of elements of this_command_keys
178 that precede this key sequence. */
179 int this_single_command_key_start
;
181 /* Record values of this_command_key_count and echo_length ()
182 before this command was read. */
183 static int before_command_key_count
;
184 static int before_command_echo_length
;
186 extern int minbuf_level
;
188 extern int message_enable_multibyte
;
190 extern struct backtrace
*backtrace_list
;
192 /* If non-nil, the function that implements the display of help.
193 It's called with one argument, the help string to display. */
195 Lisp_Object Vshow_help_function
;
197 /* If a string, the message displayed before displaying a help-echo
200 Lisp_Object Vpre_help_message
;
202 /* Nonzero means do menu prompting. */
204 static int menu_prompting
;
206 /* Character to see next line of menu prompt. */
208 static Lisp_Object menu_prompt_more_char
;
210 /* For longjmp to where kbd input is being done. */
212 static jmp_buf getcjmp
;
214 /* True while doing kbd input. */
215 int waiting_for_input
;
217 /* True while displaying for echoing. Delays C-g throwing. */
221 /* Non-null means we can start echoing at the next input pause even
222 though there is something in the echo area. */
224 static struct kboard
*ok_to_echo_at_next_pause
;
226 /* The kboard last echoing, or null for none. Reset to 0 in
227 cancel_echoing. If non-null, and a current echo area message
228 exists, and echo_message_buffer is eq to the current message
229 buffer, we know that the message comes from echo_kboard. */
231 struct kboard
*echo_kboard
;
233 /* The buffer used for echoing. Set in echo_now, reset in
236 Lisp_Object echo_message_buffer
;
238 /* Nonzero means disregard local maps for the menu bar. */
239 static int inhibit_local_menu_bar_menus
;
241 /* Nonzero means C-g should cause immediate error-signal. */
244 /* The user's ERASE setting. */
245 Lisp_Object Vtty_erase_char
;
247 /* Character to recognize as the help char. */
248 Lisp_Object Vhelp_char
;
250 /* List of other event types to recognize as meaning "help". */
251 Lisp_Object Vhelp_event_list
;
253 /* Form to execute when help char is typed. */
254 Lisp_Object Vhelp_form
;
256 /* Command to run when the help character follows a prefix key. */
257 Lisp_Object Vprefix_help_command
;
259 /* List of items that should move to the end of the menu bar. */
260 Lisp_Object Vmenu_bar_final_items
;
262 /* Non-nil means show the equivalent key-binding for
263 any M-x command that has one.
264 The value can be a length of time to show the message for.
265 If the value is non-nil and not a number, we wait 2 seconds. */
266 Lisp_Object Vsuggest_key_bindings
;
268 /* How long to display an echo-area message when the minibuffer is active.
269 If the value is not a number, such messages don't time out. */
270 Lisp_Object Vminibuffer_message_timeout
;
272 /* Character that causes a quit. Normally C-g.
274 If we are running on an ordinary terminal, this must be an ordinary
275 ASCII char, since we want to make it our interrupt character.
277 If we are not running on an ordinary terminal, it still needs to be
278 an ordinary ASCII char. This character needs to be recognized in
279 the input interrupt handler. At this point, the keystroke is
280 represented as a struct input_event, while the desired quit
281 character is specified as a lispy event. The mapping from struct
282 input_events to lispy events cannot run in an interrupt handler,
283 and the reverse mapping is difficult for anything but ASCII
286 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
290 extern Lisp_Object current_global_map
;
291 extern int minibuf_level
;
293 /* If non-nil, this is a map that overrides all other local maps. */
294 Lisp_Object Voverriding_local_map
;
296 /* If non-nil, Voverriding_local_map applies to the menu bar. */
297 Lisp_Object Voverriding_local_map_menu_flag
;
299 /* Keymap that defines special misc events that should
300 be processed immediately at a low level. */
301 Lisp_Object Vspecial_event_map
;
303 /* Current depth in recursive edits. */
304 int command_loop_level
;
306 /* Total number of times command_loop has read a key sequence. */
307 EMACS_INT num_input_keys
;
309 /* Last input character read as a command. */
310 Lisp_Object last_command_char
;
312 /* Last input character read as a command, not counting menus
313 reached by the mouse. */
314 Lisp_Object last_nonmenu_event
;
316 /* Last input character read for any purpose. */
317 Lisp_Object last_input_char
;
319 /* If not Qnil, a list of objects to be read as subsequent command input. */
320 Lisp_Object Vunread_command_events
;
322 /* If not Qnil, a list of objects to be read as subsequent command input
323 including input method processing. */
324 Lisp_Object Vunread_input_method_events
;
326 /* If not Qnil, a list of objects to be read as subsequent command input
327 but NOT including input method processing. */
328 Lisp_Object Vunread_post_input_method_events
;
330 /* If not -1, an event to be read as subsequent command input. */
331 EMACS_INT unread_command_char
;
333 /* If not Qnil, this is a switch-frame event which we decided to put
334 off until the end of a key sequence. This should be read as the
335 next command input, after any unread_command_events.
337 read_key_sequence uses this to delay switch-frame events until the
338 end of the key sequence; Fread_char uses it to put off switch-frame
339 events until a non-ASCII event is acceptable as input. */
340 Lisp_Object unread_switch_frame
;
342 /* A mask of extra modifier bits to put into every keyboard char. */
343 EMACS_INT extra_keyboard_modifiers
;
345 /* Char to use as prefix when a meta character is typed in.
346 This is bound on entry to minibuffer in case ESC is changed there. */
348 Lisp_Object meta_prefix_char
;
350 /* Last size recorded for a current buffer which is not a minibuffer. */
351 static int last_non_minibuf_size
;
353 /* Number of idle seconds before an auto-save and garbage collection. */
354 static Lisp_Object Vauto_save_timeout
;
356 /* Total number of times read_char has returned. */
357 int num_input_events
;
359 /* Total number of times read_char has returned, outside of macros. */
360 EMACS_INT num_nonmacro_input_events
;
362 /* Auto-save automatically when this many characters have been typed
363 since the last time. */
365 static EMACS_INT auto_save_interval
;
367 /* Value of num_nonmacro_input_events as of last auto save. */
371 /* The command being executed by the command loop.
372 Commands may set this, and the value set will be copied into
373 current_kboard->Vlast_command instead of the actual command. */
374 Lisp_Object Vthis_command
;
376 /* This is like Vthis_command, except that commands never set it. */
377 Lisp_Object real_this_command
;
379 /* If the lookup of the command returns a binding, the original
380 command is stored in this-original-command. It is nil otherwise. */
381 Lisp_Object Vthis_original_command
;
383 /* The value of point when the last command was executed. */
384 int last_point_position
;
386 /* The buffer that was current when the last command was started. */
387 Lisp_Object last_point_position_buffer
;
389 /* The frame in which the last input event occurred, or Qmacro if the
390 last event came from a macro. We use this to determine when to
391 generate switch-frame events. This may be cleared by functions
392 like Fselect_frame, to make sure that a switch-frame event is
393 generated by the next character. */
394 Lisp_Object internal_last_event_frame
;
396 /* A user-visible version of the above, intended to allow users to
397 figure out where the last event came from, if the event doesn't
398 carry that information itself (i.e. if it was a character). */
399 Lisp_Object Vlast_event_frame
;
401 /* The timestamp of the last input event we received from the X server.
402 X Windows wants this for selection ownership. */
403 unsigned long last_event_timestamp
;
405 Lisp_Object Qself_insert_command
;
406 Lisp_Object Qforward_char
;
407 Lisp_Object Qbackward_char
;
408 Lisp_Object Qundefined
;
409 Lisp_Object Qtimer_event_handler
;
411 /* read_key_sequence stores here the command definition of the
412 key sequence that it reads. */
413 Lisp_Object read_key_sequence_cmd
;
415 /* Echo unfinished commands after this many seconds of pause. */
416 Lisp_Object Vecho_keystrokes
;
418 /* Form to evaluate (if non-nil) when Emacs is started. */
419 Lisp_Object Vtop_level
;
421 /* User-supplied table to translate input characters. */
422 Lisp_Object Vkeyboard_translate_table
;
424 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
425 extern Lisp_Object Vfunction_key_map
;
427 /* Another keymap that maps key sequences into key sequences.
428 This one takes precedence over ordinary definitions. */
429 extern Lisp_Object Vkey_translation_map
;
431 /* If non-nil, this implements the current input method. */
432 Lisp_Object Vinput_method_function
;
433 Lisp_Object Qinput_method_function
;
435 /* When we call Vinput_method_function,
436 this holds the echo area message that was just erased. */
437 Lisp_Object Vinput_method_previous_message
;
439 /* Non-nil means deactivate the mark at end of this command. */
440 Lisp_Object Vdeactivate_mark
;
442 /* Menu bar specified in Lucid Emacs fashion. */
444 Lisp_Object Vlucid_menu_bar_dirty_flag
;
445 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
447 Lisp_Object Qecho_area_clear_hook
;
449 /* Hooks to run before and after each command. */
450 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
451 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
452 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
453 /* Hook run after a command if there's no more input soon. */
454 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
456 /* Delay time in microseconds before running post-command-idle-hook. */
457 EMACS_INT post_command_idle_delay
;
459 /* List of deferred actions to be performed at a later time.
460 The precise format isn't relevant here; we just check whether it is nil. */
461 Lisp_Object Vdeferred_action_list
;
463 /* Function to call to handle deferred actions, when there are any. */
464 Lisp_Object Vdeferred_action_function
;
465 Lisp_Object Qdeferred_action_function
;
467 Lisp_Object Qinput_method_exit_on_first_char
;
468 Lisp_Object Qinput_method_use_echo_area
;
470 /* File in which we write all commands we read. */
473 /* Nonzero if input is available. */
476 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
477 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
481 /* Non-zero means force key bindings update in parse_menu_item. */
483 int update_menu_bindings
;
485 extern char *pending_malloc_warning
;
487 /* Circular buffer for pre-read keyboard input. */
489 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
491 /* Pointer to next available character in kbd_buffer.
492 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
493 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
494 next available char is in kbd_buffer[0]. */
495 static struct input_event
*kbd_fetch_ptr
;
497 /* Pointer to next place to store character in kbd_buffer. This
498 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
499 character should go in kbd_buffer[0]. */
500 static struct input_event
* volatile kbd_store_ptr
;
502 /* The above pair of variables forms a "queue empty" flag. When we
503 enqueue a non-hook event, we increment kbd_store_ptr. When we
504 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
505 there is input available iff the two pointers are not equal.
507 Why not just have a flag set and cleared by the enqueuing and
508 dequeuing functions? Such a flag could be screwed up by interrupts
509 at inopportune times. */
511 /* If this flag is non-nil, we check mouse_moved to see when the
512 mouse moves, and motion events will appear in the input stream.
513 Otherwise, mouse motion is ignored. */
514 Lisp_Object do_mouse_tracking
;
516 /* Symbols to head events. */
517 Lisp_Object Qmouse_movement
;
518 Lisp_Object Qscroll_bar_movement
;
519 Lisp_Object Qswitch_frame
;
520 Lisp_Object Qdelete_frame
;
521 Lisp_Object Qiconify_frame
;
522 Lisp_Object Qmake_frame_visible
;
523 Lisp_Object Qselect_window
;
524 Lisp_Object Qhelp_echo
;
526 /* Symbols to denote kinds of events. */
527 Lisp_Object Qfunction_key
;
528 Lisp_Object Qmouse_click
;
530 Lisp_Object Qlanguage_change
;
532 Lisp_Object Qdrag_n_drop
;
533 Lisp_Object Qsave_session
;
535 /* Lisp_Object Qmouse_movement; - also an event header */
537 /* Properties of event headers. */
538 Lisp_Object Qevent_kind
;
539 Lisp_Object Qevent_symbol_elements
;
541 /* menu item parts */
542 Lisp_Object Qmenu_alias
;
543 Lisp_Object Qmenu_enable
;
544 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
545 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
546 extern Lisp_Object Vdefine_key_rebound_commands
;
547 extern Lisp_Object Qmenu_item
;
549 /* An event header symbol HEAD may have a property named
550 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
551 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
552 mask of modifiers applied to it. If present, this is used to help
553 speed up parse_modifiers. */
554 Lisp_Object Qevent_symbol_element_mask
;
556 /* An unmodified event header BASE may have a property named
557 Qmodifier_cache, which is an alist mapping modifier masks onto
558 modified versions of BASE. If present, this helps speed up
560 Lisp_Object Qmodifier_cache
;
562 /* Symbols to use for parts of windows. */
563 Lisp_Object Qmode_line
;
564 Lisp_Object Qvertical_line
;
565 Lisp_Object Qvertical_scroll_bar
;
566 Lisp_Object Qmenu_bar
;
567 extern Lisp_Object Qleft_margin
, Qright_margin
;
568 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
569 extern Lisp_Object QCmap
;
571 Lisp_Object
recursive_edit_unwind (), command_loop ();
572 Lisp_Object
Fthis_command_keys ();
573 Lisp_Object Qextended_command_history
;
574 EMACS_TIME
timer_check ();
576 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
578 extern char *x_get_keysym_name ();
580 static void record_menu_key ();
581 static int echo_length ();
583 Lisp_Object Qpolling_period
;
585 /* List of absolute timers. Appears in order of next scheduled event. */
586 Lisp_Object Vtimer_list
;
588 /* List of idle time timers. Appears in order of next scheduled event. */
589 Lisp_Object Vtimer_idle_list
;
591 /* Incremented whenever a timer is run. */
594 extern Lisp_Object Vprint_level
, Vprint_length
;
596 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
598 EMACS_TIME
*input_available_clear_time
;
600 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
601 Default is 1 if INTERRUPT_INPUT is defined. */
604 /* Nonzero while interrupts are temporarily deferred during redisplay. */
605 int interrupts_deferred
;
607 /* Nonzero means use ^S/^Q for flow control. */
610 /* Allow m- file to inhibit use of FIONREAD. */
611 #ifdef BROKEN_FIONREAD
615 /* We are unable to use interrupts if FIONREAD is not available,
616 so flush SIGIO so we won't try. */
617 #if !defined (FIONREAD)
623 /* If we support a window system, turn on the code to poll periodically
624 to detect C-g. It isn't actually used when doing interrupt input. */
625 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
626 #define POLL_FOR_INPUT
629 /* After a command is executed, if point is moved into a region that
630 has specific properties (e.g. composition, display), we adjust
631 point to the boundary of the region. But, if a command sets this
632 variable to non-nil, we suppress this point adjustment. This
633 variable is set to nil before reading a command. */
635 Lisp_Object Vdisable_point_adjustment
;
637 /* If non-nil, always disable point adjustment. */
639 Lisp_Object Vglobal_disable_point_adjustment
;
641 /* The time when Emacs started being idle. */
643 static EMACS_TIME timer_idleness_start_time
;
645 /* After Emacs stops being idle, this saves the last value
646 of timer_idleness_start_time from when it was idle. */
648 static EMACS_TIME timer_last_idleness_start_time
;
651 /* Global variable declarations. */
653 /* Flags for readable_events. */
654 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
655 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
656 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
658 /* Function for init_keyboard to call with no args (if nonzero). */
659 void (*keyboard_init_hook
) ();
661 static int read_avail_input
P_ ((int));
662 static void get_input_pending
P_ ((int *, int));
663 static int readable_events
P_ ((int));
664 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
665 Lisp_Object
, int *));
666 static Lisp_Object
read_char_x_menu_prompt ();
667 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
669 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
671 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
672 enum scroll_bar_part
,
673 Lisp_Object
, Lisp_Object
,
676 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
677 Lisp_Object
, char **,
678 Lisp_Object
*, unsigned));
679 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
680 static int parse_solitary_modifier
P_ ((Lisp_Object
));
681 static int parse_solitary_modifier ();
682 static void save_getcjmp
P_ ((jmp_buf));
683 static void save_getcjmp ();
684 static void restore_getcjmp
P_ ((jmp_buf));
685 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
686 static void clear_event
P_ ((struct input_event
*));
687 static void any_kboard_state
P_ ((void));
688 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
689 static void timer_start_idle
P_ ((void));
690 static void timer_stop_idle
P_ ((void));
691 static void timer_resume_idle
P_ ((void));
693 /* Nonzero means don't try to suspend even if the operating system seems
695 static int cannot_suspend
;
697 extern Lisp_Object Qidentity
, Qonly
;
699 /* Install the string STR as the beginning of the string of echoing,
700 so that it serves as a prompt for the next character.
701 Also start echoing. */
707 current_kboard
->echo_string
= str
;
708 current_kboard
->echo_after_prompt
= SCHARS (str
);
712 /* Add C to the echo string, if echoing is going on.
713 C can be a character, which is printed prettily ("M-C-x" and all that
714 jazz), or a symbol, whose name is printed. */
720 if (current_kboard
->immediate_echo
)
722 int size
= KEY_DESCRIPTION_SIZE
+ 100;
723 char *buffer
= (char *) alloca (size
);
725 Lisp_Object echo_string
;
727 echo_string
= current_kboard
->echo_string
;
729 /* If someone has passed us a composite event, use its head symbol. */
734 ptr
= push_key_description (XINT (c
), ptr
, 1);
736 else if (SYMBOLP (c
))
738 Lisp_Object name
= SYMBOL_NAME (c
);
739 int nbytes
= SBYTES (name
);
741 if (size
- (ptr
- buffer
) < nbytes
)
743 int offset
= ptr
- buffer
;
744 size
= max (2 * size
, size
+ nbytes
);
745 buffer
= (char *) alloca (size
);
746 ptr
= buffer
+ offset
;
749 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
750 STRING_MULTIBYTE (name
), 1);
753 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
756 const char *text
= " (Type ? for further options)";
757 int len
= strlen (text
);
759 if (size
- (ptr
- buffer
) < len
)
761 int offset
= ptr
- buffer
;
763 buffer
= (char *) alloca (size
);
764 ptr
= buffer
+ offset
;
767 bcopy (text
, ptr
, len
);
771 /* Replace a dash from echo_dash with a space, otherwise
772 add a space at the end as a separator between keys. */
773 if (STRINGP (echo_string
)
774 && SCHARS (echo_string
) > 1)
776 Lisp_Object last_char
, prev_char
, idx
;
778 idx
= make_number (SCHARS (echo_string
) - 2);
779 prev_char
= Faref (echo_string
, idx
);
781 idx
= make_number (SCHARS (echo_string
) - 1);
782 last_char
= Faref (echo_string
, idx
);
784 /* We test PREV_CHAR to make sure this isn't the echoing
786 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
787 Faset (echo_string
, idx
, make_number (' '));
789 echo_string
= concat2 (echo_string
, build_string (" "));
792 current_kboard
->echo_string
793 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
799 /* Temporarily add a dash to the end of the echo string if it's not
800 empty, so that it serves as a mini-prompt for the very next character. */
805 /* Do nothing if not echoing at all. */
806 if (NILP (current_kboard
->echo_string
))
809 if (!current_kboard
->immediate_echo
810 && SCHARS (current_kboard
->echo_string
) == 0)
813 /* Do nothing if we just printed a prompt. */
814 if (current_kboard
->echo_after_prompt
815 == SCHARS (current_kboard
->echo_string
))
818 /* Do nothing if we have already put a dash at the end. */
819 if (SCHARS (current_kboard
->echo_string
) > 1)
821 Lisp_Object last_char
, prev_char
, idx
;
823 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
824 prev_char
= Faref (current_kboard
->echo_string
, idx
);
826 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
827 last_char
= Faref (current_kboard
->echo_string
, idx
);
829 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
833 /* Put a dash at the end of the buffer temporarily,
834 but make it go away when the next character is added. */
835 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
840 /* Display the current echo string, and begin echoing if not already
846 if (!current_kboard
->immediate_echo
)
849 current_kboard
->immediate_echo
= 1;
851 for (i
= 0; i
< this_command_key_count
; i
++)
855 /* Set before_command_echo_length to the value that would
856 have been saved before the start of this subcommand in
857 command_loop_1, if we had already been echoing then. */
858 if (i
== this_single_command_key_start
)
859 before_command_echo_length
= echo_length ();
861 c
= XVECTOR (this_command_keys
)->contents
[i
];
862 if (! (EVENT_HAS_PARAMETERS (c
)
863 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
867 /* Set before_command_echo_length to the value that would
868 have been saved before the start of this subcommand in
869 command_loop_1, if we had already been echoing then. */
870 if (this_command_key_count
== this_single_command_key_start
)
871 before_command_echo_length
= echo_length ();
873 /* Put a dash at the end to invite the user to type more. */
878 message3_nolog (current_kboard
->echo_string
,
879 SBYTES (current_kboard
->echo_string
),
880 STRING_MULTIBYTE (current_kboard
->echo_string
));
883 /* Record in what buffer we echoed, and from which kboard. */
884 echo_message_buffer
= echo_area_buffer
[0];
885 echo_kboard
= current_kboard
;
887 if (waiting_for_input
&& !NILP (Vquit_flag
))
888 quit_throw_to_read_char ();
891 /* Turn off echoing, for the start of a new command. */
896 current_kboard
->immediate_echo
= 0;
897 current_kboard
->echo_after_prompt
= -1;
898 current_kboard
->echo_string
= Qnil
;
899 ok_to_echo_at_next_pause
= NULL
;
901 echo_message_buffer
= Qnil
;
904 /* Return the length of the current echo string. */
909 return (STRINGP (current_kboard
->echo_string
)
910 ? SCHARS (current_kboard
->echo_string
)
914 /* Truncate the current echo message to its first LEN chars.
915 This and echo_char get used by read_key_sequence when the user
916 switches frames while entering a key sequence. */
919 echo_truncate (nchars
)
922 if (STRINGP (current_kboard
->echo_string
))
923 current_kboard
->echo_string
924 = Fsubstring (current_kboard
->echo_string
,
925 make_number (0), make_number (nchars
));
926 truncate_echo_area (nchars
);
930 /* Functions for manipulating this_command_keys. */
932 add_command_key (key
)
935 #if 0 /* Not needed after we made Freset_this_command_lengths
936 do the job immediately. */
937 /* If reset-this-command-length was called recently, obey it now.
938 See the doc string of that function for an explanation of why. */
939 if (before_command_restore_flag
)
941 this_command_key_count
= before_command_key_count_1
;
942 if (this_command_key_count
< this_single_command_key_start
)
943 this_single_command_key_start
= this_command_key_count
;
944 echo_truncate (before_command_echo_length_1
);
945 before_command_restore_flag
= 0;
949 if (this_command_key_count
>= ASIZE (this_command_keys
))
950 this_command_keys
= larger_vector (this_command_keys
,
951 2 * ASIZE (this_command_keys
),
954 AREF (this_command_keys
, this_command_key_count
) = key
;
955 ++this_command_key_count
;
962 int count
= SPECPDL_INDEX ();
965 if (command_loop_level
> 0)
967 specbind (Qstandard_output
, Qt
);
968 specbind (Qstandard_input
, Qt
);
971 #ifdef HAVE_X_WINDOWS
972 /* The command loop has started an hourglass timer, so we have to
973 cancel it here, otherwise it will fire because the recursive edit
974 can take some time. Do not check for display_hourglass_p here,
975 because it could already be nil. */
979 /* This function may have been called from a debugger called from
980 within redisplay, for instance by Edebugging a function called
981 from fontification-functions. We want to allow redisplay in
982 the debugging session.
984 The recursive edit is left with a `(throw exit ...)'. The `exit'
985 tag is not caught anywhere in redisplay, i.e. when we leave the
986 recursive edit, the original redisplay leading to the recursive
987 edit will be unwound. The outcome should therefore be safe. */
988 specbind (Qinhibit_redisplay
, Qnil
);
991 val
= command_loop ();
993 Fsignal (Qquit
, Qnil
);
994 /* Handle throw from read_minibuf when using minibuffer
995 while it's active but we're in another window. */
997 Fsignal (Qerror
, Fcons (val
, Qnil
));
999 return unbind_to (count
, Qnil
);
1002 /* When an auto-save happens, record the "time", and don't do again soon. */
1007 last_auto_save
= num_nonmacro_input_events
;
1010 /* Make an auto save happen as soon as possible at command level. */
1013 force_auto_save_soon ()
1015 last_auto_save
= - auto_save_interval
- 1;
1017 record_asynch_buffer_change ();
1020 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1021 doc
: /* Invoke the editor command loop recursively.
1022 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1023 that tells this function to return.
1024 Alternately, `(throw 'exit t)' makes this function signal an error.
1025 This function is called by the editor initialization to begin editing. */)
1028 int count
= SPECPDL_INDEX ();
1031 /* If we enter while input is blocked, don't lock up here.
1032 This may happen through the debugger during redisplay. */
1033 if (INPUT_BLOCKED_P
)
1036 command_loop_level
++;
1037 update_mode_lines
= 1;
1039 if (command_loop_level
1040 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1041 buffer
= Fcurrent_buffer ();
1045 /* If we leave recursive_edit_1 below with a `throw' for instance,
1046 like it is done in the splash screen display, we have to
1047 make sure that we restore single_kboard as command_loop_1
1048 would have done if it were left normally. */
1049 record_unwind_protect (recursive_edit_unwind
,
1050 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1052 recursive_edit_1 ();
1053 return unbind_to (count
, Qnil
);
1057 recursive_edit_unwind (info
)
1060 if (BUFFERP (XCAR (info
)))
1061 Fset_buffer (XCAR (info
));
1063 if (NILP (XCDR (info
)))
1064 any_kboard_state ();
1066 single_kboard_state ();
1068 command_loop_level
--;
1069 update_mode_lines
= 1;
1078 #if 0 /* Theory: if there's anything in Vunread_command_events,
1079 it will right away be read by read_key_sequence,
1080 and then if we do switch KBOARDS, it will go into the side
1081 queue then. So we don't need to do anything special here -- rms. */
1082 if (CONSP (Vunread_command_events
))
1084 current_kboard
->kbd_queue
1085 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1086 current_kboard
->kbd_queue_has_data
= 1;
1088 Vunread_command_events
= Qnil
;
1094 /* Switch to the single-kboard state, making current_kboard
1095 the only KBOARD from which further input is accepted. */
1098 single_kboard_state ()
1105 /* If we're in single_kboard state for kboard KBOARD,
1109 not_single_kboard_state (kboard
)
1113 if (kboard
== current_kboard
)
1118 /* Maintain a stack of kboards, so other parts of Emacs
1119 can switch temporarily to the kboard of a given frame
1120 and then revert to the previous status. */
1125 struct kboard_stack
*next
;
1128 static struct kboard_stack
*kboard_stack
;
1131 push_frame_kboard (f
)
1135 struct kboard_stack
*p
1136 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1138 p
->next
= kboard_stack
;
1139 p
->kboard
= current_kboard
;
1142 current_kboard
= FRAME_KBOARD (f
);
1150 struct kboard_stack
*p
= kboard_stack
;
1151 current_kboard
= p
->kboard
;
1152 kboard_stack
= p
->next
;
1157 /* Handle errors that are not handled at inner levels
1158 by printing an error message and returning to the editor command loop. */
1164 Lisp_Object old_level
, old_length
;
1165 char macroerror
[50];
1167 #ifdef HAVE_X_WINDOWS
1168 if (display_hourglass_p
)
1169 cancel_hourglass ();
1172 if (!NILP (executing_macro
))
1174 if (executing_macro_iterations
== 1)
1175 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1177 sprintf (macroerror
, "After %d kbd macro iterations: ",
1178 executing_macro_iterations
);
1183 Vstandard_output
= Qt
;
1184 Vstandard_input
= Qt
;
1185 Vexecuting_macro
= Qnil
;
1186 executing_macro
= Qnil
;
1187 current_kboard
->Vprefix_arg
= Qnil
;
1188 current_kboard
->Vlast_prefix_arg
= Qnil
;
1191 /* Avoid unquittable loop if data contains a circular list. */
1192 old_level
= Vprint_level
;
1193 old_length
= Vprint_length
;
1194 XSETFASTINT (Vprint_level
, 10);
1195 XSETFASTINT (Vprint_length
, 10);
1196 cmd_error_internal (data
, macroerror
);
1197 Vprint_level
= old_level
;
1198 Vprint_length
= old_length
;
1202 Vinhibit_quit
= Qnil
;
1204 if (command_loop_level
== 0 && minibuf_level
== 0)
1205 any_kboard_state ();
1208 return make_number (0);
1211 /* Take actions on handling an error. DATA is the data that describes
1214 CONTEXT is a C-string containing ASCII characters only which
1215 describes the context in which the error happened. If we need to
1216 generalize CONTEXT to allow multibyte characters, make it a Lisp
1220 cmd_error_internal (data
, context
)
1225 int kill_emacs_p
= 0;
1226 struct frame
*sf
= SELECTED_FRAME ();
1230 clear_message (1, 0);
1232 /* If the window system or terminal frame hasn't been initialized
1233 yet, or we're not interactive, it's best to dump this message out
1234 to stderr and exit. */
1235 if (!sf
->glyphs_initialized_p
1236 /* This is the case of the frame dumped with Emacs, when we're
1237 running under a window system. */
1238 || (!NILP (Vwindow_system
)
1239 && !inhibit_window_system
1240 && FRAME_TERMCAP_P (sf
))
1243 stream
= Qexternal_debugging_output
;
1249 message_log_maybe_newline ();
1254 /* The immediate context is not interesting for Quits,
1255 since they are asyncronous. */
1256 if (EQ (XCAR (data
), Qquit
))
1257 Vsignaling_function
= Qnil
;
1259 print_error_message (data
, stream
, context
, Vsignaling_function
);
1261 Vsignaling_function
= Qnil
;
1263 /* If the window system or terminal frame hasn't been initialized
1264 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1268 Fkill_emacs (make_number (-1));
1272 Lisp_Object
command_loop_1 ();
1273 Lisp_Object
command_loop_2 ();
1274 Lisp_Object
top_level_1 ();
1276 /* Entry to editor-command-loop.
1277 This level has the catches for exiting/returning to editor command loop.
1278 It returns nil to exit recursive edit, t to abort it. */
1283 if (command_loop_level
> 0 || minibuf_level
> 0)
1286 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1287 executing_macro
= Qnil
;
1293 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1294 /* Reset single_kboard in case top-level set it while
1295 evaluating an -f option, or we are stuck there for some
1297 any_kboard_state ();
1298 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1299 executing_macro
= Qnil
;
1301 /* End of file in -batch run causes exit here. */
1307 /* Here we catch errors in execution of commands within the
1308 editing loop, and reenter the editing loop.
1309 When there is an error, cmd_error runs and returns a non-nil
1310 value to us. A value of nil means that command_loop_1 itself
1311 returned due to end of file (or end of kbd macro). */
1316 register Lisp_Object val
;
1319 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1320 while (!NILP (val
));
1328 return Feval (Vtop_level
);
1334 /* On entry to the outer level, run the startup file */
1335 if (!NILP (Vtop_level
))
1336 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1337 else if (!NILP (Vpurify_flag
))
1338 message ("Bare impure Emacs (standard Lisp code not loaded)");
1340 message ("Bare Emacs (standard Lisp code not loaded)");
1344 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1345 doc
: /* Exit all recursive editing levels. */)
1348 #ifdef HAVE_X_WINDOWS
1349 if (display_hourglass_p
)
1350 cancel_hourglass ();
1353 /* Unblock input if we enter with input blocked. This may happen if
1354 redisplay traps e.g. during tool-bar update with input blocked. */
1355 while (INPUT_BLOCKED_P
)
1358 return Fthrow (Qtop_level
, Qnil
);
1361 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1362 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1365 if (command_loop_level
> 0 || minibuf_level
> 0)
1366 Fthrow (Qexit
, Qnil
);
1368 error ("No recursive edit is in progress");
1372 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1373 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1376 if (command_loop_level
> 0 || minibuf_level
> 0)
1379 error ("No recursive edit is in progress");
1383 /* This is the actual command reading loop,
1384 sans error-handling encapsulation. */
1386 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1388 void safe_run_hooks
P_ ((Lisp_Object
));
1389 static void adjust_point_for_property
P_ ((int, int));
1391 /* Cancel hourglass from protect_unwind.
1393 #ifdef HAVE_X_WINDOWS
1395 cancel_hourglass_unwind (arg
)
1398 cancel_hourglass ();
1409 Lisp_Object keybuf
[30];
1413 struct buffer
*prev_buffer
= NULL
;
1415 int was_locked
= single_kboard
;
1417 int already_adjusted
;
1419 current_kboard
->Vprefix_arg
= Qnil
;
1420 current_kboard
->Vlast_prefix_arg
= Qnil
;
1421 Vdeactivate_mark
= Qnil
;
1422 waiting_for_input
= 0;
1426 this_command_key_count
= 0;
1427 this_command_key_count_reset
= 0;
1428 this_single_command_key_start
= 0;
1430 if (NILP (Vmemory_full
))
1432 /* Make sure this hook runs after commands that get errors and
1433 throw to top level. */
1434 /* Note that the value cell will never directly contain nil
1435 if the symbol is a local variable. */
1436 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1437 safe_run_hooks (Qpost_command_hook
);
1439 /* If displaying a message, resize the echo area window to fit
1440 that message's size exactly. */
1441 if (!NILP (echo_area_buffer
[0]))
1442 resize_echo_area_exactly ();
1444 if (!NILP (Vdeferred_action_list
))
1445 safe_run_hooks (Qdeferred_action_function
);
1447 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1449 if (NILP (Vunread_command_events
)
1450 && NILP (Vunread_input_method_events
)
1451 && NILP (Vunread_post_input_method_events
)
1452 && NILP (Vexecuting_macro
)
1453 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1454 safe_run_hooks (Qpost_command_idle_hook
);
1458 Vmemory_full
= Qnil
;
1460 /* Do this after running Vpost_command_hook, for consistency. */
1461 current_kboard
->Vlast_command
= Vthis_command
;
1462 current_kboard
->Vreal_last_command
= real_this_command
;
1466 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1469 /* Make sure the current window's buffer is selected. */
1470 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1471 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1473 /* Display any malloc warning that just came out. Use while because
1474 displaying one warning can cause another. */
1476 while (pending_malloc_warning
)
1477 display_malloc_warning ();
1481 Vdeactivate_mark
= Qnil
;
1483 /* If minibuffer on and echo area in use,
1484 wait a short time and redraw minibuffer. */
1487 && !NILP (echo_area_buffer
[0])
1488 && EQ (minibuf_window
, echo_area_window
)
1489 && NUMBERP (Vminibuffer_message_timeout
))
1491 /* Bind inhibit-quit to t so that C-g gets read in
1492 rather than quitting back to the minibuffer. */
1493 int count
= SPECPDL_INDEX ();
1494 specbind (Qinhibit_quit
, Qt
);
1496 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1497 /* Clear the echo area. */
1499 safe_run_hooks (Qecho_area_clear_hook
);
1501 unbind_to (count
, Qnil
);
1503 /* If a C-g came in before, treat it as input now. */
1504 if (!NILP (Vquit_flag
))
1507 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1512 alloca (0); /* Cause a garbage collection now */
1513 /* Since we can free the most stuff here. */
1514 #endif /* C_ALLOCA */
1517 /* Select the frame that the last event came from. Usually,
1518 switch-frame events will take care of this, but if some lisp
1519 code swallows a switch-frame event, we'll fix things up here.
1520 Is this a good idea? */
1521 if (FRAMEP (internal_last_event_frame
)
1522 && !EQ (internal_last_event_frame
, selected_frame
))
1523 Fselect_frame (internal_last_event_frame
, Qnil
);
1525 /* If it has changed current-menubar from previous value,
1526 really recompute the menubar from the value. */
1527 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1528 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1529 call0 (Qrecompute_lucid_menubar
);
1531 before_command_key_count
= this_command_key_count
;
1532 before_command_echo_length
= echo_length ();
1534 Vthis_command
= Qnil
;
1535 real_this_command
= Qnil
;
1537 /* Read next key sequence; i gets its length. */
1538 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1541 /* A filter may have run while we were reading the input. */
1542 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1544 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1545 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1549 /* Now we have read a key sequence of length I,
1550 or else I is 0 and we found end of file. */
1552 if (i
== 0) /* End of file -- happens only in */
1553 return Qnil
; /* a kbd macro, at the end. */
1554 /* -1 means read_key_sequence got a menu that was rejected.
1555 Just loop around and read another command. */
1559 this_command_key_count
= 0;
1560 this_command_key_count_reset
= 0;
1561 this_single_command_key_start
= 0;
1565 last_command_char
= keybuf
[i
- 1];
1567 /* If the previous command tried to force a specific window-start,
1568 forget about that, in case this command moves point far away
1569 from that position. But also throw away beg_unchanged and
1570 end_unchanged information in that case, so that redisplay will
1571 update the whole window properly. */
1572 if (!NILP (XWINDOW (selected_window
)->force_start
))
1575 XWINDOW (selected_window
)->force_start
= Qnil
;
1576 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1577 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1580 cmd
= read_key_sequence_cmd
;
1581 if (!NILP (Vexecuting_macro
))
1583 if (!NILP (Vquit_flag
))
1585 Vexecuting_macro
= Qt
;
1586 QUIT
; /* Make some noise. */
1587 /* Will return since macro now empty. */
1591 /* Do redisplay processing after this command except in special
1592 cases identified below. */
1593 prev_buffer
= current_buffer
;
1594 prev_modiff
= MODIFF
;
1595 last_point_position
= PT
;
1596 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1598 /* By default, we adjust point to a boundary of a region that
1599 has such a property that should be treated intangible
1600 (e.g. composition, display). But, some commands will set
1601 this variable differently. */
1602 Vdisable_point_adjustment
= Qnil
;
1604 /* Process filters and timers may have messed with deactivate-mark.
1605 reset it before we execute the command. */
1606 Vdeactivate_mark
= Qnil
;
1608 /* Remap command through active keymaps */
1609 Vthis_original_command
= cmd
;
1613 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1617 /* Execute the command. */
1619 Vthis_command
= cmd
;
1620 real_this_command
= cmd
;
1621 /* Note that the value cell will never directly contain nil
1622 if the symbol is a local variable. */
1623 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1624 safe_run_hooks (Qpre_command_hook
);
1626 already_adjusted
= 0;
1628 if (NILP (Vthis_command
))
1630 /* nil means key is undefined. */
1631 Lisp_Object keys
= Fvector (i
, keybuf
);
1632 keys
= Fkey_description (keys
, Qnil
);
1634 message_with_string ("%s is undefined", keys
, 0);
1635 current_kboard
->defining_kbd_macro
= Qnil
;
1636 update_mode_lines
= 1;
1637 current_kboard
->Vprefix_arg
= Qnil
;
1641 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1643 /* In case we jump to directly_done. */
1644 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1646 /* Recognize some common commands in common situations and
1647 do them directly. */
1648 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1650 struct Lisp_Char_Table
*dp
1651 = window_display_table (XWINDOW (selected_window
));
1652 lose
= FETCH_CHAR (PT_BYTE
);
1654 if (! NILP (Vpost_command_hook
))
1655 /* Put this before calling adjust_point_for_property
1656 so it will only get called once in any case. */
1658 if (current_buffer
== prev_buffer
1659 && last_point_position
!= PT
1660 && NILP (Vdisable_point_adjustment
)
1661 && NILP (Vglobal_disable_point_adjustment
))
1662 adjust_point_for_property (last_point_position
, 0);
1663 already_adjusted
= 1;
1664 if (PT
== last_point_position
+ 1
1666 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1667 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1668 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1669 && (lose
>= 0x20 && lose
< 0x7f)))
1670 : (lose
>= 0x20 && lose
< 0x7f))
1671 /* To extract the case of continuation on
1672 wide-column characters. */
1673 && ASCII_BYTE_P (lose
)
1674 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1676 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1678 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1680 && !windows_or_buffers_changed
1681 && EQ (current_buffer
->selective_display
, Qnil
)
1682 && !detect_input_pending ()
1683 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1684 && NILP (Vexecuting_macro
))
1685 direct_output_forward_char (1);
1688 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1690 struct Lisp_Char_Table
*dp
1691 = window_display_table (XWINDOW (selected_window
));
1693 lose
= FETCH_CHAR (PT_BYTE
);
1694 if (! NILP (Vpost_command_hook
))
1696 if (current_buffer
== prev_buffer
1697 && last_point_position
!= PT
1698 && NILP (Vdisable_point_adjustment
)
1699 && NILP (Vglobal_disable_point_adjustment
))
1700 adjust_point_for_property (last_point_position
, 0);
1701 already_adjusted
= 1;
1702 if (PT
== last_point_position
- 1
1704 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1705 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1706 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1707 && (lose
>= 0x20 && lose
< 0x7f)))
1708 : (lose
>= 0x20 && lose
< 0x7f))
1709 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1711 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1713 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1715 && !windows_or_buffers_changed
1716 && EQ (current_buffer
->selective_display
, Qnil
)
1717 && !detect_input_pending ()
1718 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1719 && NILP (Vexecuting_macro
))
1720 direct_output_forward_char (-1);
1723 else if (EQ (Vthis_command
, Qself_insert_command
)
1724 /* Try this optimization only on char keystrokes. */
1725 && NATNUMP (last_command_char
)
1726 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1729 = translate_char (Vtranslation_table_for_input
,
1730 XFASTINT (last_command_char
));
1732 if (NILP (Vexecuting_macro
)
1733 && !EQ (minibuf_window
, selected_window
))
1735 if (!nonundocount
|| nonundocount
>= 20)
1743 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1745 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1747 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1749 || MODIFF
<= SAVE_MODIFF
1750 || windows_or_buffers_changed
1751 || !EQ (current_buffer
->selective_display
, Qnil
)
1752 || detect_input_pending ()
1753 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1754 || !NILP (Vexecuting_macro
));
1756 value
= internal_self_insert (c
, 0);
1761 if (! NILP (Vpost_command_hook
))
1762 /* Put this before calling adjust_point_for_property
1763 so it will only get called once in any case. */
1766 /* VALUE == 1 when AFTER-CHANGE functions are
1767 installed which is the case most of the time
1768 because FONT-LOCK installs one. */
1769 if (!lose
&& !value
)
1770 direct_output_for_insert (c
);
1775 /* Here for a command that isn't executed directly */
1778 #ifdef HAVE_X_WINDOWS
1779 int scount
= SPECPDL_INDEX ();
1781 if (display_hourglass_p
1782 && NILP (Vexecuting_macro
))
1784 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1790 if (NILP (current_kboard
->Vprefix_arg
))
1792 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1794 #ifdef HAVE_X_WINDOWS
1795 /* Do not check display_hourglass_p here, because
1796 Fcommand_execute could change it, but we should cancel
1797 hourglass cursor anyway.
1798 But don't cancel the hourglass within a macro
1799 just because a command in the macro finishes. */
1800 if (NILP (Vexecuting_macro
))
1801 unbind_to (scount
, Qnil
);
1806 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1808 /* Note that the value cell will never directly contain nil
1809 if the symbol is a local variable. */
1810 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1811 safe_run_hooks (Qpost_command_hook
);
1813 /* If displaying a message, resize the echo area window to fit
1814 that message's size exactly. */
1815 if (!NILP (echo_area_buffer
[0]))
1816 resize_echo_area_exactly ();
1818 if (!NILP (Vdeferred_action_list
))
1819 safe_run_hooks (Qdeferred_action_function
);
1821 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1823 if (NILP (Vunread_command_events
)
1824 && NILP (Vunread_input_method_events
)
1825 && NILP (Vunread_post_input_method_events
)
1826 && NILP (Vexecuting_macro
)
1827 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1828 safe_run_hooks (Qpost_command_idle_hook
);
1831 /* If there is a prefix argument,
1832 1) We don't want Vlast_command to be ``universal-argument''
1833 (that would be dumb), so don't set Vlast_command,
1834 2) we want to leave echoing on so that the prefix will be
1835 echoed as part of this key sequence, so don't call
1837 3) we want to leave this_command_key_count non-zero, so that
1838 read_char will realize that it is re-reading a character, and
1839 not echo it a second time.
1841 If the command didn't actually create a prefix arg,
1842 but is merely a frame event that is transparent to prefix args,
1843 then the above doesn't apply. */
1844 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1846 current_kboard
->Vlast_command
= Vthis_command
;
1847 current_kboard
->Vreal_last_command
= real_this_command
;
1849 this_command_key_count
= 0;
1850 this_command_key_count_reset
= 0;
1851 this_single_command_key_start
= 0;
1854 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1856 /* Setting transient-mark-mode to `only' is a way of
1857 turning it on for just one command. */
1859 if (EQ (Vtransient_mark_mode
, Qidentity
))
1860 Vtransient_mark_mode
= Qnil
;
1861 if (EQ (Vtransient_mark_mode
, Qonly
))
1862 Vtransient_mark_mode
= Qidentity
;
1864 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1866 /* We could also call `deactivate'mark'. */
1867 if (EQ (Vtransient_mark_mode
, Qlambda
))
1868 Vtransient_mark_mode
= Qnil
;
1871 current_buffer
->mark_active
= Qnil
;
1872 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1875 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1876 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1881 if (current_buffer
== prev_buffer
1882 && last_point_position
!= PT
1883 && NILP (Vdisable_point_adjustment
)
1884 && NILP (Vglobal_disable_point_adjustment
)
1885 && !already_adjusted
)
1886 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1888 /* Install chars successfully executed in kbd macro. */
1890 if (!NILP (current_kboard
->defining_kbd_macro
)
1891 && NILP (current_kboard
->Vprefix_arg
))
1892 finalize_kbd_macro_chars ();
1896 any_kboard_state ();
1901 extern Lisp_Object Qcomposition
, Qdisplay
;
1903 /* Adjust point to a boundary of a region that has such a property
1904 that should be treated intangible. For the moment, we check
1905 `composition', `display' and `invisible' properties.
1906 LAST_PT is the last position of point. */
1908 extern Lisp_Object Qafter_string
, Qbefore_string
;
1909 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1912 adjust_point_for_property (last_pt
, modified
)
1917 Lisp_Object val
, overlay
, tmp
;
1918 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1921 /* FIXME: cycling is probably not necessary because these properties
1922 can't be usefully combined anyway. */
1923 while (check_composition
|| check_display
|| check_invisible
)
1925 if (check_composition
1926 && PT
> BEGV
&& PT
< ZV
1927 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1928 && COMPOSITION_VALID_P (beg
, end
, val
)
1929 && beg
< PT
/* && end > PT <- It's always the case. */
1930 && (last_pt
<= beg
|| last_pt
>= end
))
1933 SET_PT (PT
< last_pt
? beg
: end
);
1934 check_display
= check_invisible
= 1;
1936 check_composition
= 0;
1938 && PT
> BEGV
&& PT
< ZV
1939 && !NILP (val
= get_char_property_and_overlay
1940 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1941 && display_prop_intangible_p (val
)
1942 && (!OVERLAYP (overlay
)
1943 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1944 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1945 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1946 && beg
< PT
) /* && end > PT <- It's always the case. */
1949 SET_PT (PT
< last_pt
? beg
: end
);
1950 check_composition
= check_invisible
= 1;
1953 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1955 int inv
, ellipsis
= 0;
1958 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1960 && !NILP (val
= get_char_property_and_overlay
1961 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1962 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1964 ellipsis
= ellipsis
|| inv
> 1
1965 || (OVERLAYP (overlay
)
1966 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1967 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1968 tmp
= Fnext_single_char_property_change
1969 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1970 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1973 && !NILP (val
= get_char_property_and_overlay
1974 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1975 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1977 ellipsis
= ellipsis
|| inv
> 1
1978 || (OVERLAYP (overlay
)
1979 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1980 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1981 tmp
= Fprevious_single_char_property_change
1982 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1983 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1986 /* Move away from the inside area. */
1987 if (beg
< PT
&& end
> PT
)
1989 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1990 /* We haven't moved yet (so we don't need to fear
1991 infinite-looping) and we were outside the range
1992 before (so either end of the range still corresponds
1993 to a move in the right direction): pretend we moved
1994 less than we actually did, so that we still have
1995 more freedom below in choosing which end of the range
1997 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1998 /* We either have moved already or the last point
1999 was already in the range: we don't get to choose
2000 which end of the range we have to go to. */
2001 : (PT
< last_pt
? beg
: end
));
2002 check_composition
= check_display
= 1;
2004 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2005 the point to something other than its argument, due to
2006 point-motion hooks, intangibility, etc. */
2007 xassert (PT
== beg
|| PT
== end
);
2010 /* Pretend the area doesn't exist if the buffer is not
2012 if (!modified
&& !ellipsis
&& beg
< end
)
2014 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2015 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2016 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2017 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2018 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2019 /* We've already moved as far as we can. Trying to go
2020 to the other end would mean moving backwards and thus
2021 could lead to an infinite loop. */
2023 else if (val
= get_pos_property (make_number (PT
),
2025 TEXT_PROP_MEANS_INVISIBLE (val
)
2026 && (val
= get_pos_property
2027 (make_number (PT
== beg
? end
: beg
),
2029 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2030 (check_composition
= check_display
= 1,
2031 SET_PT (PT
== beg
? end
: beg
));
2034 check_invisible
= 0;
2038 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2041 safe_run_hooks_1 (hook
)
2044 return call1 (Vrun_hooks
, Vinhibit_quit
);
2047 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2050 safe_run_hooks_error (data
)
2053 Lisp_Object args
[3];
2054 args
[0] = build_string ("Error in %s: %s");
2055 args
[1] = Vinhibit_quit
;
2058 return Fset (Vinhibit_quit
, Qnil
);
2061 /* If we get an error while running the hook, cause the hook variable
2062 to be nil. Also inhibit quits, so that C-g won't cause the hook
2063 to mysteriously evaporate. */
2066 safe_run_hooks (hook
)
2069 int count
= SPECPDL_INDEX ();
2070 specbind (Qinhibit_quit
, hook
);
2072 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2074 unbind_to (count
, Qnil
);
2078 /* Number of seconds between polling for input. This is a Lisp
2079 variable that can be bound. */
2081 EMACS_INT polling_period
;
2083 /* Nonzero means polling for input is temporarily suppressed. */
2085 int poll_suppress_count
;
2087 /* Asynchronous timer for polling. */
2089 struct atimer
*poll_timer
;
2092 #ifdef POLL_FOR_INPUT
2094 /* Poll for input, so what we catch a C-g if it comes in. This
2095 function is called from x_make_frame_visible, see comment
2101 if (interrupt_input_blocked
== 0
2102 && !waiting_for_input
)
2103 read_avail_input (0);
2106 /* Timer callback function for poll_timer. TIMER is equal to
2110 poll_for_input (timer
)
2111 struct atimer
*timer
;
2113 if (poll_suppress_count
== 0)
2114 poll_for_input_1 ();
2117 #endif /* POLL_FOR_INPUT */
2119 /* Begin signals to poll for input, if they are appropriate.
2120 This function is called unconditionally from various places. */
2125 #ifdef POLL_FOR_INPUT
2126 if (read_socket_hook
&& !interrupt_input
)
2128 /* Turn alarm handling on unconditionally. It might have
2129 been turned off in process.c. */
2130 turn_on_atimers (1);
2132 /* If poll timer doesn't exist, are we need one with
2133 a different interval, start a new one. */
2134 if (poll_timer
== NULL
2135 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2137 EMACS_TIME interval
;
2140 cancel_atimer (poll_timer
);
2142 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2143 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2144 poll_for_input
, NULL
);
2147 /* Let the timer's callback function poll for input
2148 if this becomes zero. */
2149 --poll_suppress_count
;
2154 /* Nonzero if we are using polling to handle input asynchronously. */
2157 input_polling_used ()
2159 #ifdef POLL_FOR_INPUT
2160 return read_socket_hook
&& !interrupt_input
;
2166 /* Turn off polling. */
2171 #ifdef POLL_FOR_INPUT
2172 if (read_socket_hook
&& !interrupt_input
)
2173 ++poll_suppress_count
;
2177 /* Set the value of poll_suppress_count to COUNT
2178 and start or stop polling accordingly. */
2181 set_poll_suppress_count (count
)
2184 #ifdef POLL_FOR_INPUT
2185 if (count
== 0 && poll_suppress_count
!= 0)
2187 poll_suppress_count
= 1;
2190 else if (count
!= 0 && poll_suppress_count
== 0)
2194 poll_suppress_count
= count
;
2198 /* Bind polling_period to a value at least N.
2199 But don't decrease it. */
2202 bind_polling_period (n
)
2205 #ifdef POLL_FOR_INPUT
2206 int new = polling_period
;
2211 stop_other_atimers (poll_timer
);
2213 specbind (Qpolling_period
, make_number (new));
2214 /* Start a new alarm with the new period. */
2219 /* Apply the control modifier to CHARACTER. */
2225 /* Save the upper bits here. */
2226 int upper
= c
& ~0177;
2230 /* Everything in the columns containing the upper-case letters
2231 denotes a control character. */
2232 if (c
>= 0100 && c
< 0140)
2236 /* Set the shift modifier for a control char
2237 made from a shifted letter. But only for letters! */
2238 if (oc
>= 'A' && oc
<= 'Z')
2239 c
|= shift_modifier
;
2242 /* The lower-case letters denote control characters too. */
2243 else if (c
>= 'a' && c
<= 'z')
2246 /* Include the bits for control and shift
2247 only if the basic ASCII code can't indicate them. */
2251 /* Replace the high bits. */
2252 c
|= (upper
& ~ctrl_modifier
);
2257 /* Display help echo in the echo area.
2259 HELP a string means display that string, HELP nil means clear the
2260 help echo. If HELP is a function, call it with OBJECT and POS as
2261 arguments; the function should return a help string or nil for
2262 none. For all other types of HELP evaluate it to obtain a string.
2264 WINDOW is the window in which the help was generated, if any.
2265 It is nil if not in a window.
2267 If OBJECT is a buffer, POS is the position in the buffer where the
2268 `help-echo' text property was found.
2270 If OBJECT is an overlay, that overlay has a `help-echo' property,
2271 and POS is the position in the overlay's buffer under the mouse.
2273 If OBJECT is a string (an overlay string or a string displayed with
2274 the `display' property). POS is the position in that string under
2277 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2278 echo overwrites a keystroke echo currently displayed in the echo
2281 Note: this function may only be called with HELP nil or a string
2282 from X code running asynchronously. */
2285 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2286 Lisp_Object help
, window
, object
, pos
;
2287 int ok_to_overwrite_keystroke_echo
;
2289 if (!NILP (help
) && !STRINGP (help
))
2291 if (FUNCTIONP (help
))
2293 Lisp_Object args
[4];
2298 help
= safe_call (4, args
);
2301 help
= safe_eval (help
);
2303 if (!STRINGP (help
))
2307 if (STRINGP (help
) || NILP (help
))
2309 if (!NILP (Vshow_help_function
))
2310 call1 (Vshow_help_function
, help
);
2311 else if (/* Don't overwrite minibuffer contents. */
2312 !MINI_WINDOW_P (XWINDOW (selected_window
))
2313 /* Don't overwrite a keystroke echo. */
2314 && (NILP (echo_message_buffer
)
2315 || ok_to_overwrite_keystroke_echo
)
2316 /* Don't overwrite a prompt. */
2317 && !cursor_in_echo_area
)
2321 int count
= SPECPDL_INDEX ();
2323 if (!help_echo_showing_p
)
2324 Vpre_help_message
= current_message ();
2326 specbind (Qmessage_truncate_lines
, Qt
);
2327 message3_nolog (help
, SBYTES (help
),
2328 STRING_MULTIBYTE (help
));
2329 unbind_to (count
, Qnil
);
2331 else if (STRINGP (Vpre_help_message
))
2333 message3_nolog (Vpre_help_message
,
2334 SBYTES (Vpre_help_message
),
2335 STRING_MULTIBYTE (Vpre_help_message
));
2336 Vpre_help_message
= Qnil
;
2342 help_echo_showing_p
= STRINGP (help
);
2348 /* Input of single characters from keyboard */
2350 Lisp_Object
print_help ();
2351 static Lisp_Object
kbd_buffer_get_event ();
2352 static void record_char ();
2355 static jmp_buf wrong_kboard_jmpbuf
;
2358 #define STOP_POLLING \
2359 do { if (! polling_stopped_here) stop_polling (); \
2360 polling_stopped_here = 1; } while (0)
2362 #define RESUME_POLLING \
2363 do { if (polling_stopped_here) start_polling (); \
2364 polling_stopped_here = 0; } while (0)
2366 /* read a character from the keyboard; call the redisplay if needed */
2367 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2368 -1 means do not do redisplay, but do do autosaving.
2371 /* The arguments MAPS and NMAPS are for menu prompting.
2372 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2374 PREV_EVENT is the previous input event, or nil if we are reading
2375 the first event of a key sequence (or not reading a key sequence).
2376 If PREV_EVENT is t, that is a "magic" value that says
2377 not to run input methods, but in other respects to act as if
2378 not reading a key sequence.
2380 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2381 if we used a mouse menu to read the input, or zero otherwise. If
2382 USED_MOUSE_MENU is null, we don't dereference it.
2384 Value is t if we showed a menu and the user rejected it. */
2387 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2391 Lisp_Object prev_event
;
2392 int *used_mouse_menu
;
2394 volatile Lisp_Object c
;
2396 jmp_buf local_getcjmp
;
2398 volatile int key_already_recorded
= 0;
2399 Lisp_Object tem
, save
;
2400 volatile Lisp_Object previous_echo_area_message
;
2401 volatile Lisp_Object also_record
;
2402 volatile int reread
;
2403 struct gcpro gcpro1
, gcpro2
;
2404 int polling_stopped_here
= 0;
2408 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2409 before_command_key_count
= this_command_key_count
;
2410 before_command_echo_length
= echo_length ();
2413 previous_echo_area_message
= Qnil
;
2415 GCPRO2 (c
, previous_echo_area_message
);
2420 if (CONSP (Vunread_post_input_method_events
))
2422 c
= XCAR (Vunread_post_input_method_events
);
2423 Vunread_post_input_method_events
2424 = XCDR (Vunread_post_input_method_events
);
2426 /* Undo what read_char_x_menu_prompt did when it unread
2427 additional keys returned by Fx_popup_menu. */
2429 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2437 if (unread_command_char
!= -1)
2439 XSETINT (c
, unread_command_char
);
2440 unread_command_char
= -1;
2446 if (CONSP (Vunread_command_events
))
2448 c
= XCAR (Vunread_command_events
);
2449 Vunread_command_events
= XCDR (Vunread_command_events
);
2451 /* Undo what read_char_x_menu_prompt did when it unread
2452 additional keys returned by Fx_popup_menu. */
2454 && EQ (XCDR (c
), Qdisabled
)
2455 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2458 /* If the queued event is something that used the mouse,
2459 set used_mouse_menu accordingly. */
2461 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2462 *used_mouse_menu
= 1;
2465 goto reread_for_input_method
;
2468 if (CONSP (Vunread_input_method_events
))
2470 c
= XCAR (Vunread_input_method_events
);
2471 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2473 /* Undo what read_char_x_menu_prompt did when it unread
2474 additional keys returned by Fx_popup_menu. */
2476 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2480 goto reread_for_input_method
;
2483 this_command_key_count_reset
= 0;
2485 if (!NILP (Vexecuting_macro
))
2487 /* We set this to Qmacro; since that's not a frame, nobody will
2488 try to switch frames on us, and the selected window will
2491 Since this event came from a macro, it would be misleading to
2492 leave internal_last_event_frame set to wherever the last
2493 real event came from. Normally, a switch-frame event selects
2494 internal_last_event_frame after each command is read, but
2495 events read from a macro should never cause a new frame to be
2497 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2499 /* Exit the macro if we are at the end.
2500 Also, some things replace the macro with t
2501 to force an early exit. */
2502 if (EQ (Vexecuting_macro
, Qt
)
2503 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2509 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2510 if (STRINGP (Vexecuting_macro
)
2511 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2512 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2514 executing_macro_index
++;
2519 if (!NILP (unread_switch_frame
))
2521 c
= unread_switch_frame
;
2522 unread_switch_frame
= Qnil
;
2524 /* This event should make it into this_command_keys, and get echoed
2525 again, so we do not set `reread'. */
2529 /* if redisplay was requested */
2530 if (commandflag
>= 0)
2532 /* If there is pending input, process any events which are not
2533 user-visible, such as X selection_request events. */
2535 || detect_input_pending_run_timers (0))
2536 swallow_events (0); /* may clear input_pending */
2538 /* Redisplay if no pending input. */
2539 while (!input_pending
)
2541 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2542 redisplay_preserve_echo_area (5);
2547 /* Normal case: no input arrived during redisplay. */
2550 /* Input arrived and pre-empted redisplay.
2551 Process any events which are not user-visible. */
2553 /* If that cleared input_pending, try again to redisplay. */
2557 /* Message turns off echoing unless more keystrokes turn it on again.
2559 The code in 20.x for the condition was
2561 1. echo_area_glyphs && *echo_area_glyphs
2562 2. && echo_area_glyphs != current_kboard->echobuf
2563 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2565 (1) means there's a current message displayed
2567 (2) means it's not the message from echoing from the current
2570 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2571 is set to a non-null value. This is done in read_char and it is
2572 set to echo_area_glyphs after a call to echo_char. That means
2573 ok_to_echo_at_next_pause is either null or
2574 current_kboard->echobuf with the appropriate current_kboard at
2577 So, condition (3) means in clear text ok_to_echo_at_next_pause
2578 must be either null, or the current message isn't from echoing at
2579 all, or it's from echoing from a different kboard than the
2582 if (/* There currently is something in the echo area. */
2583 !NILP (echo_area_buffer
[0])
2584 && (/* And it's either not from echoing. */
2585 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2586 /* Or it's an echo from a different kboard. */
2587 || echo_kboard
!= current_kboard
2588 /* Or we explicitly allow overwriting whatever there is. */
2589 || ok_to_echo_at_next_pause
== NULL
))
2594 /* Try reading a character via menu prompting in the minibuf.
2595 Try this before the sit-for, because the sit-for
2596 would do the wrong thing if we are supposed to do
2597 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2598 after a mouse event so don't try a minibuf menu. */
2600 if (nmaps
> 0 && INTERACTIVE
2601 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2602 /* Don't bring up a menu if we already have another event. */
2603 && NILP (Vunread_command_events
)
2604 && unread_command_char
< 0
2605 && !detect_input_pending_run_timers (0))
2607 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2610 key_already_recorded
= 1;
2615 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2616 We will do that below, temporarily for short sections of code,
2617 when appropriate. local_getcjmp must be in effect
2618 around any call to sit_for or kbd_buffer_get_event;
2619 it *must not* be in effect when we call redisplay. */
2621 if (_setjmp (local_getcjmp
))
2623 XSETINT (c
, quit_char
);
2624 internal_last_event_frame
= selected_frame
;
2625 Vlast_event_frame
= internal_last_event_frame
;
2626 /* If we report the quit char as an event,
2627 don't do so more than once. */
2628 if (!NILP (Vinhibit_quit
))
2633 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2634 if (kb
!= current_kboard
)
2636 Lisp_Object link
= kb
->kbd_queue
;
2637 /* We shouldn't get here if we were in single-kboard mode! */
2642 while (CONSP (XCDR (link
)))
2644 if (!NILP (XCDR (link
)))
2648 kb
->kbd_queue
= Fcons (c
, Qnil
);
2650 XSETCDR (link
, Fcons (c
, Qnil
));
2651 kb
->kbd_queue_has_data
= 1;
2652 current_kboard
= kb
;
2653 /* This is going to exit from read_char
2654 so we had better get rid of this frame's stuff. */
2656 longjmp (wrong_kboard_jmpbuf
, 1);
2663 timer_start_idle ();
2665 /* If in middle of key sequence and minibuffer not active,
2666 start echoing if enough time elapses. */
2668 if (minibuf_level
== 0
2669 && !current_kboard
->immediate_echo
2670 && this_command_key_count
> 0
2672 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2673 && NILP (Fzerop (Vecho_keystrokes
))
2674 && (/* No message. */
2675 NILP (echo_area_buffer
[0])
2676 /* Or empty message. */
2677 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2678 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2679 /* Or already echoing from same kboard. */
2680 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2681 /* Or not echoing before and echoing allowed. */
2682 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2686 /* After a mouse event, start echoing right away.
2687 This is because we are probably about to display a menu,
2688 and we don't want to delay before doing so. */
2689 if (EVENT_HAS_PARAMETERS (prev_event
))
2694 double duration
= extract_float (Vecho_keystrokes
);
2695 sec
= (int) duration
;
2696 usec
= (duration
- sec
) * 1000000;
2697 save_getcjmp (save_jump
);
2698 restore_getcjmp (local_getcjmp
);
2699 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2700 restore_getcjmp (save_jump
);
2702 && ! CONSP (Vunread_command_events
))
2707 /* Maybe auto save due to number of keystrokes. */
2709 if (commandflag
!= 0
2710 && auto_save_interval
> 0
2711 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2712 && !detect_input_pending_run_timers (0))
2714 Fdo_auto_save (Qnil
, Qnil
);
2715 /* Hooks can actually change some buffers in auto save. */
2719 /* Try reading using an X menu.
2720 This is never confused with reading using the minibuf
2721 because the recursive call of read_char in read_char_minibuf_menu_prompt
2722 does not pass on any keymaps. */
2724 if (nmaps
> 0 && INTERACTIVE
2725 && !NILP (prev_event
)
2726 && EVENT_HAS_PARAMETERS (prev_event
)
2727 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2728 && !EQ (XCAR (prev_event
), Qtool_bar
)
2729 /* Don't bring up a menu if we already have another event. */
2730 && NILP (Vunread_command_events
)
2731 && unread_command_char
< 0)
2733 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2735 /* Now that we have read an event, Emacs is not idle. */
2741 /* Maybe autosave and/or garbage collect due to idleness. */
2743 if (INTERACTIVE
&& NILP (c
))
2745 int delay_level
, buffer_size
;
2747 /* Slow down auto saves logarithmically in size of current buffer,
2748 and garbage collect while we're at it. */
2749 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2750 last_non_minibuf_size
= Z
- BEG
;
2751 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2753 while (buffer_size
> 64)
2754 delay_level
++, buffer_size
-= buffer_size
>> 2;
2755 if (delay_level
< 4) delay_level
= 4;
2756 /* delay_level is 4 for files under around 50k, 7 at 100k,
2757 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2759 /* Auto save if enough time goes by without input. */
2760 if (commandflag
!= 0
2761 && num_nonmacro_input_events
> last_auto_save
2762 && INTEGERP (Vauto_save_timeout
)
2763 && XINT (Vauto_save_timeout
) > 0)
2767 save_getcjmp (save_jump
);
2768 restore_getcjmp (local_getcjmp
);
2769 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2771 restore_getcjmp (save_jump
);
2774 && ! CONSP (Vunread_command_events
))
2776 Fdo_auto_save (Qnil
, Qnil
);
2778 /* If we have auto-saved and there is still no input
2779 available, garbage collect if there has been enough
2780 consing going on to make it worthwhile. */
2781 if (!detect_input_pending_run_timers (0)
2782 && consing_since_gc
> gc_cons_threshold
/ 2)
2783 Fgarbage_collect ();
2790 /* If this has become non-nil here, it has been set by a timer
2791 or sentinel or filter. */
2792 if (CONSP (Vunread_command_events
))
2794 c
= XCAR (Vunread_command_events
);
2795 Vunread_command_events
= XCDR (Vunread_command_events
);
2798 /* Read something from current KBOARD's side queue, if possible. */
2802 if (current_kboard
->kbd_queue_has_data
)
2804 if (!CONSP (current_kboard
->kbd_queue
))
2806 c
= XCAR (current_kboard
->kbd_queue
);
2807 current_kboard
->kbd_queue
2808 = XCDR (current_kboard
->kbd_queue
);
2809 if (NILP (current_kboard
->kbd_queue
))
2810 current_kboard
->kbd_queue_has_data
= 0;
2811 input_pending
= readable_events (0);
2812 if (EVENT_HAS_PARAMETERS (c
)
2813 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2814 internal_last_event_frame
= XCAR (XCDR (c
));
2815 Vlast_event_frame
= internal_last_event_frame
;
2820 /* If current_kboard's side queue is empty check the other kboards.
2821 If one of them has data that we have not yet seen here,
2822 switch to it and process the data waiting for it.
2824 Note: if the events queued up for another kboard
2825 have already been seen here, and therefore are not a complete command,
2826 the kbd_queue_has_data field is 0, so we skip that kboard here.
2827 That's to avoid an infinite loop switching between kboards here. */
2828 if (NILP (c
) && !single_kboard
)
2831 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2832 if (kb
->kbd_queue_has_data
)
2834 current_kboard
= kb
;
2835 /* This is going to exit from read_char
2836 so we had better get rid of this frame's stuff. */
2838 longjmp (wrong_kboard_jmpbuf
, 1);
2847 /* Finally, we read from the main queue,
2848 and if that gives us something we can't use yet, we put it on the
2849 appropriate side queue and try again. */
2855 /* Actually read a character, waiting if necessary. */
2856 save_getcjmp (save_jump
);
2857 restore_getcjmp (local_getcjmp
);
2858 timer_start_idle ();
2859 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2860 restore_getcjmp (save_jump
);
2863 if (! NILP (c
) && (kb
!= current_kboard
))
2865 Lisp_Object link
= kb
->kbd_queue
;
2868 while (CONSP (XCDR (link
)))
2870 if (!NILP (XCDR (link
)))
2874 kb
->kbd_queue
= Fcons (c
, Qnil
);
2876 XSETCDR (link
, Fcons (c
, Qnil
));
2877 kb
->kbd_queue_has_data
= 1;
2881 current_kboard
= kb
;
2882 /* This is going to exit from read_char
2883 so we had better get rid of this frame's stuff. */
2885 longjmp (wrong_kboard_jmpbuf
, 1);
2890 /* Terminate Emacs in batch mode if at eof. */
2891 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2892 Fkill_emacs (make_number (1));
2896 /* Add in any extra modifiers, where appropriate. */
2897 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2898 || ((extra_keyboard_modifiers
& 0177) < ' '
2899 && (extra_keyboard_modifiers
& 0177) != 0))
2900 XSETINT (c
, make_ctrl_char (XINT (c
)));
2902 /* Transfer any other modifier bits directly from
2903 extra_keyboard_modifiers to c. Ignore the actual character code
2904 in the low 16 bits of extra_keyboard_modifiers. */
2905 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2915 if (commandflag
>= 0
2916 && !input_pending
&& !detect_input_pending_run_timers (0))
2924 /* Buffer switch events are only for internal wakeups
2925 so don't show them to the user.
2926 Also, don't record a key if we already did. */
2927 if (BUFFERP (c
) || key_already_recorded
)
2930 /* Process special events within read_char
2931 and loop around to read another event. */
2934 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2939 int was_locked
= single_kboard
;
2941 last_input_char
= c
;
2942 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2944 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2945 /* We stopped being idle for this event; undo that. This
2946 prevents automatic window selection (under
2947 mouse_autoselect_window from acting as a real input event, for
2948 example banishing the mouse under mouse-avoidance-mode. */
2949 timer_resume_idle ();
2951 /* Resume allowing input from any kboard, if that was true before. */
2953 any_kboard_state ();
2958 /* Handle things that only apply to characters. */
2961 /* If kbd_buffer_get_event gave us an EOF, return that. */
2965 if ((STRINGP (Vkeyboard_translate_table
)
2966 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2967 || (VECTORP (Vkeyboard_translate_table
)
2968 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2969 || CHAR_TABLE_P (Vkeyboard_translate_table
))
2972 d
= Faref (Vkeyboard_translate_table
, c
);
2973 /* nil in keyboard-translate-table means no translation. */
2979 /* If this event is a mouse click in the menu bar,
2980 return just menu-bar for now. Modify the mouse click event
2981 so we won't do this twice, then queue it up. */
2982 if (EVENT_HAS_PARAMETERS (c
)
2984 && CONSP (EVENT_START (c
))
2985 && CONSP (XCDR (EVENT_START (c
))))
2989 posn
= POSN_POSN (EVENT_START (c
));
2990 /* Handle menu-bar events:
2991 insert the dummy prefix event `menu-bar'. */
2992 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2994 /* Change menu-bar to (menu-bar) as the event "position". */
2995 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2998 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3003 /* Store these characters into recent_keys, the dribble file if any,
3004 and the keyboard macro being defined, if any. */
3006 if (! NILP (also_record
))
3007 record_char (also_record
);
3009 /* Wipe the echo area.
3010 But first, if we are about to use an input method,
3011 save the echo area contents for it to refer to. */
3013 && ! NILP (Vinput_method_function
)
3014 && (unsigned) XINT (c
) >= ' '
3015 && (unsigned) XINT (c
) != 127
3016 && (unsigned) XINT (c
) < 256)
3018 previous_echo_area_message
= Fcurrent_message ();
3019 Vinput_method_previous_message
= previous_echo_area_message
;
3022 /* Now wipe the echo area, except for help events which do their
3023 own stuff with the echo area. */
3025 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3026 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3028 if (!NILP (echo_area_buffer
[0]))
3029 safe_run_hooks (Qecho_area_clear_hook
);
3030 clear_message (1, 0);
3033 reread_for_input_method
:
3035 /* Pass this to the input method, if appropriate. */
3037 && ! NILP (Vinput_method_function
)
3038 /* Don't run the input method within a key sequence,
3039 after the first event of the key sequence. */
3040 && NILP (prev_event
)
3041 && (unsigned) XINT (c
) >= ' '
3042 && (unsigned) XINT (c
) != 127
3043 && (unsigned) XINT (c
) < 256)
3046 int key_count
, key_count_reset
;
3047 struct gcpro gcpro1
;
3048 int count
= SPECPDL_INDEX ();
3050 /* Save the echo status. */
3051 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3052 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3053 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3054 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3057 if (before_command_restore_flag
)
3059 this_command_key_count
= before_command_key_count_1
;
3060 if (this_command_key_count
< this_single_command_key_start
)
3061 this_single_command_key_start
= this_command_key_count
;
3062 echo_truncate (before_command_echo_length_1
);
3063 before_command_restore_flag
= 0;
3067 /* Save the this_command_keys status. */
3068 key_count
= this_command_key_count
;
3069 key_count_reset
= this_command_key_count_reset
;
3072 keys
= Fcopy_sequence (this_command_keys
);
3077 /* Clear out this_command_keys. */
3078 this_command_key_count
= 0;
3079 this_command_key_count_reset
= 0;
3081 /* Now wipe the echo area. */
3082 if (!NILP (echo_area_buffer
[0]))
3083 safe_run_hooks (Qecho_area_clear_hook
);
3084 clear_message (1, 0);
3087 /* If we are not reading a key sequence,
3088 never use the echo area. */
3091 specbind (Qinput_method_use_echo_area
, Qt
);
3094 /* Call the input method. */
3095 tem
= call1 (Vinput_method_function
, c
);
3097 tem
= unbind_to (count
, tem
);
3099 /* Restore the saved echoing state
3100 and this_command_keys state. */
3101 this_command_key_count
= key_count
;
3102 this_command_key_count_reset
= key_count_reset
;
3104 this_command_keys
= keys
;
3107 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3108 current_kboard
->echo_string
= saved_echo_string
;
3109 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3110 if (saved_immediate_echo
)
3115 /* The input method can return no events. */
3118 /* Bring back the previous message, if any. */
3119 if (! NILP (previous_echo_area_message
))
3120 message_with_string ("%s", previous_echo_area_message
, 0);
3123 /* It returned one event or more. */
3125 Vunread_post_input_method_events
3126 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3131 /* Display help if not echoing. */
3132 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3134 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3135 Lisp_Object help
, object
, position
, window
, tem
;
3137 tem
= Fcdr (XCDR (c
));
3140 window
= Fcar (tem
);
3142 object
= Fcar (tem
);
3144 position
= Fcar (tem
);
3146 show_help_echo (help
, window
, object
, position
, 0);
3148 /* We stopped being idle for this event; undo that. */
3149 timer_resume_idle ();
3153 if (! reread
|| this_command_key_count
== 0
3154 || this_command_key_count_reset
)
3157 /* Don't echo mouse motion events. */
3158 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3159 && NILP (Fzerop (Vecho_keystrokes
))
3160 && ! (EVENT_HAS_PARAMETERS (c
)
3161 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3164 if (! NILP (also_record
))
3165 echo_char (also_record
);
3166 /* Once we reread a character, echoing can happen
3167 the next time we pause to read a new one. */
3168 ok_to_echo_at_next_pause
= current_kboard
;
3171 /* Record this character as part of the current key. */
3172 add_command_key (c
);
3173 if (! NILP (also_record
))
3174 add_command_key (also_record
);
3177 last_input_char
= c
;
3180 /* Process the help character specially if enabled */
3181 if (!NILP (Vhelp_form
) && help_char_p (c
))
3184 count
= SPECPDL_INDEX ();
3186 record_unwind_protect (Fset_window_configuration
,
3187 Fcurrent_window_configuration (Qnil
));
3189 tem0
= Feval (Vhelp_form
);
3191 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3195 c
= read_char (0, 0, 0, Qnil
, 0);
3196 while (BUFFERP (c
));
3197 /* Remove the help from the frame */
3198 unbind_to (count
, Qnil
);
3201 if (EQ (c
, make_number (040)))
3205 c
= read_char (0, 0, 0, Qnil
, 0);
3206 while (BUFFERP (c
));
3215 /* Record a key that came from a mouse menu.
3216 Record it for echoing, for this-command-keys, and so on. */
3222 /* Wipe the echo area. */
3223 clear_message (1, 0);
3228 before_command_key_count
= this_command_key_count
;
3229 before_command_echo_length
= echo_length ();
3232 /* Don't echo mouse motion events. */
3233 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3234 && NILP (Fzerop (Vecho_keystrokes
)))
3238 /* Once we reread a character, echoing can happen
3239 the next time we pause to read a new one. */
3240 ok_to_echo_at_next_pause
= 0;
3243 /* Record this character as part of the current key. */
3244 add_command_key (c
);
3246 /* Re-reading in the middle of a command */
3247 last_input_char
= c
;
3251 /* Return 1 if should recognize C as "the help character". */
3259 if (EQ (c
, Vhelp_char
))
3261 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3262 if (EQ (c
, XCAR (tail
)))
3267 /* Record the input event C in various ways. */
3275 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3277 /* To avoid filling recent_keys with help-echo and mouse-movement
3278 events, we filter out repeated help-echo events, only store the
3279 first and last in a series of mouse-movement events, and don't
3280 store repeated help-echo events which are only separated by
3281 mouse-movement events. */
3283 Lisp_Object ev1
, ev2
, ev3
;
3286 if ((ix1
= recent_keys_index
- 1) < 0)
3287 ix1
= NUM_RECENT_KEYS
- 1;
3288 ev1
= AREF (recent_keys
, ix1
);
3290 if ((ix2
= ix1
- 1) < 0)
3291 ix2
= NUM_RECENT_KEYS
- 1;
3292 ev2
= AREF (recent_keys
, ix2
);
3294 if ((ix3
= ix2
- 1) < 0)
3295 ix3
= NUM_RECENT_KEYS
- 1;
3296 ev3
= AREF (recent_keys
, ix3
);
3298 if (EQ (XCAR (c
), Qhelp_echo
))
3300 /* Don't record `help-echo' in recent_keys unless it shows some help
3301 message, and a different help than the previously recorded
3303 Lisp_Object help
, last_help
;
3305 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3306 if (!STRINGP (help
))
3308 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3309 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3311 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3312 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3313 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3315 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3316 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3317 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3318 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3321 else if (EQ (XCAR (c
), Qmouse_movement
))
3323 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3324 So additional mouse movement events replace the last element. */
3325 Lisp_Object last_window
, window
;
3327 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3328 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3329 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3330 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3331 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3333 ASET (recent_keys
, ix1
, c
);
3339 store_kbd_macro_char (c
);
3344 ASET (recent_keys
, recent_keys_index
, c
);
3345 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3346 recent_keys_index
= 0;
3348 else if (recorded
< 0)
3350 /* We need to remove one or two events from recent_keys.
3351 To do this, we simply put nil at those events and move the
3352 recent_keys_index backwards over those events. Usually,
3353 users will never see those nil events, as they will be
3354 overwritten by the command keys entered to see recent_keys
3357 while (recorded
++ < 0 && total_keys
> 0)
3359 if (total_keys
< NUM_RECENT_KEYS
)
3361 if (--recent_keys_index
< 0)
3362 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3363 ASET (recent_keys
, recent_keys_index
, Qnil
);
3367 num_nonmacro_input_events
++;
3369 /* Write c to the dribble file. If c is a lispy event, write
3370 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3371 If you, dear reader, have a better idea, you've got the source. :-) */
3376 if (XUINT (c
) < 0x100)
3377 putc (XINT (c
), dribble
);
3379 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3383 Lisp_Object dribblee
;
3385 /* If it's a structured event, take the event header. */
3386 dribblee
= EVENT_HEAD (c
);
3388 if (SYMBOLP (dribblee
))
3390 putc ('<', dribble
);
3391 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3392 SBYTES (SYMBOL_NAME (dribblee
)),
3394 putc ('>', dribble
);
3406 struct buffer
*old
= current_buffer
;
3407 Fprinc (object
, Qnil
);
3408 set_buffer_internal (XBUFFER (Vstandard_output
));
3409 call0 (intern ("help-mode"));
3410 set_buffer_internal (old
);
3414 /* Copy out or in the info on where C-g should throw to.
3415 This is used when running Lisp code from within get_char,
3416 in case get_char is called recursively.
3417 See read_process_output. */
3423 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3427 restore_getcjmp (temp
)
3430 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3435 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3436 of this function. */
3439 tracking_off (old_value
)
3440 Lisp_Object old_value
;
3442 do_mouse_tracking
= old_value
;
3443 if (NILP (old_value
))
3445 /* Redisplay may have been preempted because there was input
3446 available, and it assumes it will be called again after the
3447 input has been processed. If the only input available was
3448 the sort that we have just disabled, then we need to call
3450 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3452 redisplay_preserve_echo_area (6);
3453 get_input_pending (&input_pending
,
3454 READABLE_EVENTS_DO_TIMERS_NOW
);
3460 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3461 doc
: /* Evaluate BODY with mouse movement events enabled.
3462 Within a `track-mouse' form, mouse motion generates input events that
3463 you can read with `read-event'.
3464 Normally, mouse motion is ignored.
3465 usage: (track-mouse BODY ...) */)
3469 int count
= SPECPDL_INDEX ();
3472 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3474 do_mouse_tracking
= Qt
;
3476 val
= Fprogn (args
);
3477 return unbind_to (count
, val
);
3480 /* If mouse has moved on some frame, return one of those frames.
3481 Return 0 otherwise. */
3486 Lisp_Object tail
, frame
;
3488 FOR_EACH_FRAME (tail
, frame
)
3490 if (XFRAME (frame
)->mouse_moved
)
3491 return XFRAME (frame
);
3497 #endif /* HAVE_MOUSE */
3499 /* Low level keyboard/mouse input.
3500 kbd_buffer_store_event places events in kbd_buffer, and
3501 kbd_buffer_get_event retrieves them. */
3503 /* Return true iff there are any events in the queue that read-char
3504 would return. If this returns false, a read-char would block. */
3506 readable_events (flags
)
3509 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3512 /* If the buffer contains only FOCUS_IN_EVENT events, and
3513 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3514 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3516 int have_live_event
= 1;
3518 if (flags
& READABLE_EVENTS_FILTER_EVENTS
)
3520 struct input_event
*event
;
3522 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3526 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3529 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3531 if (event
== kbd_store_ptr
)
3532 have_live_event
= 0;
3535 if (have_live_event
) return 1;
3539 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3540 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3545 if (current_kboard
->kbd_queue_has_data
)
3551 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3552 if (kb
->kbd_queue_has_data
)
3558 /* Set this for debugging, to have a way to get out */
3563 event_to_kboard (event
)
3564 struct input_event
*event
;
3567 frame
= event
->frame_or_window
;
3569 frame
= XCAR (frame
);
3570 else if (WINDOWP (frame
))
3571 frame
= WINDOW_FRAME (XWINDOW (frame
));
3573 /* There are still some events that don't set this field.
3574 For now, just ignore the problem.
3575 Also ignore dead frames here. */
3576 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3579 return FRAME_KBOARD (XFRAME (frame
));
3584 Lisp_Object Vthrow_on_input
;
3586 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3589 kbd_buffer_store_event (event
)
3590 register struct input_event
*event
;
3592 kbd_buffer_store_event_hold (event
, 0);
3595 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3597 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3598 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3599 Else, if EVENT is a quit event, store the quit event
3600 in HOLD_QUIT, and return (thus ignoring further events).
3602 This is used in read_avail_input to postpone the processing
3603 of the quit event until all subsequent input events have been
3604 parsed (and discarded).
3608 kbd_buffer_store_event_hold (event
, hold_quit
)
3609 register struct input_event
*event
;
3610 struct input_event
*hold_quit
;
3612 if (event
->kind
== NO_EVENT
)
3615 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3618 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3620 register int c
= event
->code
& 0377;
3622 if (event
->modifiers
& ctrl_modifier
)
3623 c
= make_ctrl_char (c
);
3625 c
|= (event
->modifiers
3626 & (meta_modifier
| alt_modifier
3627 | hyper_modifier
| super_modifier
));
3633 struct input_event
*sp
;
3636 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3637 kb
!= current_kboard
))
3640 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3641 Fcons (make_number (c
), Qnil
));
3642 kb
->kbd_queue_has_data
= 1;
3643 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3645 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3648 if (event_to_kboard (sp
) == kb
)
3650 sp
->kind
= NO_EVENT
;
3651 sp
->frame_or_window
= Qnil
;
3661 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3665 /* If this results in a quit_char being returned to Emacs as
3666 input, set Vlast_event_frame properly. If this doesn't
3667 get returned to Emacs as an event, the next event read
3668 will set Vlast_event_frame again, so this is safe to do. */
3672 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3674 focus
= event
->frame_or_window
;
3675 internal_last_event_frame
= focus
;
3676 Vlast_event_frame
= focus
;
3679 last_event_timestamp
= event
->timestamp
;
3680 interrupt_signal (0 /* dummy */);
3684 if (c
&& c
== stop_character
)
3690 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3691 Just ignore the second one. */
3692 else if (event
->kind
== BUFFER_SWITCH_EVENT
3693 && kbd_fetch_ptr
!= kbd_store_ptr
3694 && ((kbd_store_ptr
== kbd_buffer
3695 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3696 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3699 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3700 kbd_store_ptr
= kbd_buffer
;
3702 /* Don't let the very last slot in the buffer become full,
3703 since that would make the two pointers equal,
3704 and that is indistinguishable from an empty buffer.
3705 Discard the event if it would fill the last slot. */
3706 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3708 *kbd_store_ptr
= *event
;
3712 /* If we're inside while-no-input, and this event qualifies
3713 as input, set quit-flag to cause an interrupt. */
3714 if (!NILP (Vthrow_on_input
)
3715 && event
->kind
!= FOCUS_IN_EVENT
3716 && event
->kind
!= HELP_EVENT
3717 && event
->kind
!= DEICONIFY_EVENT
)
3719 Vquit_flag
= Vthrow_on_input
;
3720 /* If we're inside a function that wants immediate quits,
3722 if (immediate_quit
&& NILP (Vinhibit_quit
))
3732 /* Put an input event back in the head of the event queue. */
3735 kbd_buffer_unget_event (event
)
3736 register struct input_event
*event
;
3738 if (kbd_fetch_ptr
== kbd_buffer
)
3739 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3741 /* Don't let the very last slot in the buffer become full, */
3742 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3745 *kbd_fetch_ptr
= *event
;
3750 /* Generate HELP_EVENT input_events in BUFP which has room for
3751 SIZE events. If there's not enough room in BUFP, ignore this
3754 HELP is the help form.
3756 FRAME is the frame on which the help is generated. OBJECT is the
3757 Lisp object where the help was found (a buffer, a string, an
3758 overlay, or nil if neither from a string nor from a buffer. POS is
3759 the position within OBJECT where the help was found.
3761 Value is the number of input_events generated. */
3764 gen_help_event (help
, frame
, window
, object
, pos
)
3765 Lisp_Object help
, frame
, object
, window
;
3768 struct input_event event
;
3772 event
.kind
= HELP_EVENT
;
3773 event
.frame_or_window
= frame
;
3775 event
.x
= WINDOWP (window
) ? window
: frame
;
3778 kbd_buffer_store_event (&event
);
3782 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3785 kbd_buffer_store_help_event (frame
, help
)
3786 Lisp_Object frame
, help
;
3788 struct input_event event
;
3790 event
.kind
= HELP_EVENT
;
3791 event
.frame_or_window
= frame
;
3796 kbd_buffer_store_event (&event
);
3800 /* Discard any mouse events in the event buffer by setting them to
3803 discard_mouse_events ()
3805 struct input_event
*sp
;
3806 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3808 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3811 if (sp
->kind
== MOUSE_CLICK_EVENT
3812 || sp
->kind
== WHEEL_EVENT
3814 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3816 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3818 sp
->kind
= NO_EVENT
;
3824 /* Return non-zero if there are any real events waiting in the event
3825 buffer, not counting `NO_EVENT's.
3827 If DISCARD is non-zero, discard NO_EVENT events at the front of
3828 the input queue, possibly leaving the input queue empty if there
3829 are no real input events. */
3832 kbd_buffer_events_waiting (discard
)
3835 struct input_event
*sp
;
3837 for (sp
= kbd_fetch_ptr
;
3838 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3841 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3848 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3852 /* Clear input event EVENT. */
3856 struct input_event
*event
;
3858 event
->kind
= NO_EVENT
;
3862 /* Read one event from the event buffer, waiting if necessary.
3863 The value is a Lisp object representing the event.
3864 The value is nil for an event that should be ignored,
3865 or that was handled here.
3866 We always read and discard one event. */
3869 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3871 int *used_mouse_menu
;
3880 *kbp
= current_kboard
;
3884 /* Wait until there is input available. */
3887 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3890 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3894 /* If the quit flag is set, then read_char will return
3895 quit_char, so that counts as "available input." */
3896 if (!NILP (Vquit_flag
))
3897 quit_throw_to_read_char ();
3899 /* One way or another, wait until input is available; then, if
3900 interrupt handlers have not read it, read it now. */
3903 wait_for_kbd_input ();
3905 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3909 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3912 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3916 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3918 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3919 /* Pass 1 for EXPECT since we just waited to have input. */
3920 read_avail_input (1);
3922 #endif /* not VMS */
3925 if (CONSP (Vunread_command_events
))
3928 first
= XCAR (Vunread_command_events
);
3929 Vunread_command_events
= XCDR (Vunread_command_events
);
3930 *kbp
= current_kboard
;
3934 /* At this point, we know that there is a readable event available
3935 somewhere. If the event queue is empty, then there must be a
3936 mouse movement enabled and available. */
3937 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3939 struct input_event
*event
;
3941 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3945 last_event_timestamp
= event
->timestamp
;
3948 *kbp
= event_to_kboard (event
);
3950 *kbp
= current_kboard
; /* Better than returning null ptr? */
3952 *kbp
= &the_only_kboard
;
3957 /* These two kinds of events get special handling
3958 and don't actually appear to the command loop.
3959 We return nil for them. */
3960 if (event
->kind
== SELECTION_REQUEST_EVENT
3961 || event
->kind
== SELECTION_CLEAR_EVENT
)
3964 struct input_event copy
;
3966 /* Remove it from the buffer before processing it,
3967 since otherwise swallow_events will see it
3968 and process it again. */
3970 kbd_fetch_ptr
= event
+ 1;
3971 input_pending
= readable_events (0);
3972 x_handle_selection_event (©
);
3974 /* We're getting selection request events, but we don't have
3980 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3981 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3983 /* Make an event (delete-frame (FRAME)). */
3984 obj
= Fcons (event
->frame_or_window
, Qnil
);
3985 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3986 kbd_fetch_ptr
= event
+ 1;
3989 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3990 else if (event
->kind
== ICONIFY_EVENT
)
3992 /* Make an event (iconify-frame (FRAME)). */
3993 obj
= Fcons (event
->frame_or_window
, Qnil
);
3994 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3995 kbd_fetch_ptr
= event
+ 1;
3997 else if (event
->kind
== DEICONIFY_EVENT
)
3999 /* Make an event (make-frame-visible (FRAME)). */
4000 obj
= Fcons (event
->frame_or_window
, Qnil
);
4001 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4002 kbd_fetch_ptr
= event
+ 1;
4005 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4007 /* The value doesn't matter here; only the type is tested. */
4008 XSETBUFFER (obj
, current_buffer
);
4009 kbd_fetch_ptr
= event
+ 1;
4011 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4012 || defined (USE_GTK)
4013 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4015 kbd_fetch_ptr
= event
+ 1;
4016 input_pending
= readable_events (0);
4017 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4018 x_activate_menubar (XFRAME (event
->frame_or_window
));
4022 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4024 /* Make an event (language-change (FRAME CHARSET LCID)). */
4025 obj
= Fcons (event
->frame_or_window
, Qnil
);
4026 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4027 kbd_fetch_ptr
= event
+ 1;
4030 else if (event
->kind
== SAVE_SESSION_EVENT
)
4032 obj
= Fcons (Qsave_session
, Qnil
);
4033 kbd_fetch_ptr
= event
+ 1;
4035 /* Just discard these, by returning nil.
4036 With MULTI_KBOARD, these events are used as placeholders
4037 when we need to randomly delete events from the queue.
4038 (They shouldn't otherwise be found in the buffer,
4039 but on some machines it appears they do show up
4040 even without MULTI_KBOARD.) */
4041 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4042 mouse events during a popup-menu call. */
4043 else if (event
->kind
== NO_EVENT
)
4044 kbd_fetch_ptr
= event
+ 1;
4045 else if (event
->kind
== HELP_EVENT
)
4047 Lisp_Object object
, position
, help
, frame
, window
;
4049 frame
= event
->frame_or_window
;
4050 object
= event
->arg
;
4051 position
= make_number (event
->code
);
4054 clear_event (event
);
4056 kbd_fetch_ptr
= event
+ 1;
4057 if (!WINDOWP (window
))
4059 obj
= Fcons (Qhelp_echo
,
4060 list5 (frame
, help
, window
, object
, position
));
4062 else if (event
->kind
== FOCUS_IN_EVENT
)
4064 /* Notification of a FocusIn event. The frame receiving the
4065 focus is in event->frame_or_window. Generate a
4066 switch-frame event if necessary. */
4067 Lisp_Object frame
, focus
;
4069 frame
= event
->frame_or_window
;
4070 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4074 if (!EQ (frame
, internal_last_event_frame
)
4075 && !EQ (frame
, selected_frame
))
4076 obj
= make_lispy_switch_frame (frame
);
4077 internal_last_event_frame
= frame
;
4078 kbd_fetch_ptr
= event
+ 1;
4082 /* If this event is on a different frame, return a switch-frame this
4083 time, and leave the event in the queue for next time. */
4087 frame
= event
->frame_or_window
;
4089 frame
= XCAR (frame
);
4090 else if (WINDOWP (frame
))
4091 frame
= WINDOW_FRAME (XWINDOW (frame
));
4093 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4097 if (! EQ (frame
, internal_last_event_frame
)
4098 && !EQ (frame
, selected_frame
))
4099 obj
= make_lispy_switch_frame (frame
);
4100 internal_last_event_frame
= frame
;
4102 /* If we didn't decide to make a switch-frame event, go ahead
4103 and build a real event from the queue entry. */
4107 obj
= make_lispy_event (event
);
4109 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4110 || defined (USE_GTK)
4111 /* If this was a menu selection, then set the flag to inhibit
4112 writing to last_nonmenu_event. Don't do this if the event
4113 we're returning is (menu-bar), though; that indicates the
4114 beginning of the menu sequence, and we might as well leave
4115 that as the `event with parameters' for this selection. */
4117 && !EQ (event
->frame_or_window
, event
->arg
)
4118 && (event
->kind
== MENU_BAR_EVENT
4119 || event
->kind
== TOOL_BAR_EVENT
))
4120 *used_mouse_menu
= 1;
4123 /* Wipe out this event, to catch bugs. */
4124 clear_event (event
);
4125 kbd_fetch_ptr
= event
+ 1;
4130 /* Try generating a mouse motion event. */
4131 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4133 FRAME_PTR f
= some_mouse_moved ();
4134 Lisp_Object bar_window
;
4135 enum scroll_bar_part part
;
4139 *kbp
= current_kboard
;
4140 /* Note that this uses F to determine which display to look at.
4141 If there is no valid info, it does not store anything
4142 so x remains nil. */
4144 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4148 /* Decide if we should generate a switch-frame event. Don't
4149 generate switch-frame events for motion outside of all Emacs
4155 frame
= FRAME_FOCUS_FRAME (f
);
4157 XSETFRAME (frame
, f
);
4159 if (! EQ (frame
, internal_last_event_frame
)
4160 && !EQ (frame
, selected_frame
))
4161 obj
= make_lispy_switch_frame (frame
);
4162 internal_last_event_frame
= frame
;
4165 /* If we didn't decide to make a switch-frame event, go ahead and
4166 return a mouse-motion event. */
4167 if (!NILP (x
) && NILP (obj
))
4168 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4170 #endif /* HAVE_MOUSE */
4172 /* We were promised by the above while loop that there was
4173 something for us to read! */
4176 input_pending
= readable_events (0);
4178 Vlast_event_frame
= internal_last_event_frame
;
4183 /* Process any events that are not user-visible,
4184 then return, without reading any user-visible events. */
4187 swallow_events (do_display
)
4192 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4194 struct input_event
*event
;
4196 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4200 last_event_timestamp
= event
->timestamp
;
4202 /* These two kinds of events get special handling
4203 and don't actually appear to the command loop. */
4204 if (event
->kind
== SELECTION_REQUEST_EVENT
4205 || event
->kind
== SELECTION_CLEAR_EVENT
)
4208 struct input_event copy
;
4210 /* Remove it from the buffer before processing it,
4211 since otherwise swallow_events called recursively could see it
4212 and process it again. */
4214 kbd_fetch_ptr
= event
+ 1;
4215 input_pending
= readable_events (0);
4216 x_handle_selection_event (©
);
4218 /* We're getting selection request events, but we don't have
4227 old_timers_run
= timers_run
;
4228 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4230 if (timers_run
!= old_timers_run
&& do_display
)
4231 redisplay_preserve_echo_area (7);
4234 /* Record the start of when Emacs is idle,
4235 for the sake of running idle-time timers. */
4242 /* If we are already in the idle state, do nothing. */
4243 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4246 EMACS_GET_TIME (timer_idleness_start_time
);
4248 timer_last_idleness_start_time
= timer_idleness_start_time
;
4250 /* Mark all idle-time timers as once again candidates for running. */
4251 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4255 timer
= XCAR (timers
);
4257 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4259 XVECTOR (timer
)->contents
[0] = Qnil
;
4263 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4268 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4271 /* Resume idle timer from last idle start time. */
4274 timer_resume_idle ()
4276 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4279 timer_idleness_start_time
= timer_last_idleness_start_time
;
4282 /* This is only for debugging. */
4283 struct input_event last_timer_event
;
4285 /* Check whether a timer has fired. To prevent larger problems we simply
4286 disregard elements that are not proper timers. Do not make a circular
4287 timer list for the time being.
4289 Returns the number of seconds to wait until the next timer fires. If a
4290 timer is triggering now, return zero seconds.
4291 If no timer is active, return -1 seconds.
4293 If a timer is ripe, we run it, with quitting turned off.
4295 DO_IT_NOW is now ignored. It used to mean that we should
4296 run the timer directly instead of queueing a timer-event.
4297 Now we always run timers directly. */
4300 timer_check (do_it_now
)
4303 EMACS_TIME nexttime
;
4304 EMACS_TIME now
, idleness_now
;
4305 Lisp_Object timers
, idle_timers
, chosen_timer
;
4306 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4308 EMACS_SET_SECS (nexttime
, -1);
4309 EMACS_SET_USECS (nexttime
, -1);
4311 /* Always consider the ordinary timers. */
4312 timers
= Vtimer_list
;
4313 /* Consider the idle timers only if Emacs is idle. */
4314 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4315 idle_timers
= Vtimer_idle_list
;
4318 chosen_timer
= Qnil
;
4319 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4321 if (CONSP (timers
) || CONSP (idle_timers
))
4323 EMACS_GET_TIME (now
);
4324 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4325 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4328 while (CONSP (timers
) || CONSP (idle_timers
))
4330 Lisp_Object
*vector
;
4331 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4332 EMACS_TIME timer_time
, idle_timer_time
;
4333 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4335 /* Skip past invalid timers and timers already handled. */
4338 timer
= XCAR (timers
);
4339 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4341 timers
= XCDR (timers
);
4344 vector
= XVECTOR (timer
)->contents
;
4346 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4347 || !INTEGERP (vector
[3])
4348 || ! NILP (vector
[0]))
4350 timers
= XCDR (timers
);
4354 if (!NILP (idle_timers
))
4356 timer
= XCAR (idle_timers
);
4357 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4359 idle_timers
= XCDR (idle_timers
);
4362 vector
= XVECTOR (timer
)->contents
;
4364 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4365 || !INTEGERP (vector
[3])
4366 || ! NILP (vector
[0]))
4368 idle_timers
= XCDR (idle_timers
);
4373 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4374 based on the next ordinary timer.
4375 TIMER_DIFFERENCE is the distance in time from NOW to when
4376 this timer becomes ripe (negative if it's already ripe). */
4379 timer
= XCAR (timers
);
4380 vector
= XVECTOR (timer
)->contents
;
4381 EMACS_SET_SECS (timer_time
,
4382 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4383 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4384 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4387 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4388 based on the next idle timer. */
4389 if (!NILP (idle_timers
))
4391 idle_timer
= XCAR (idle_timers
);
4392 vector
= XVECTOR (idle_timer
)->contents
;
4393 EMACS_SET_SECS (idle_timer_time
,
4394 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4395 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4396 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4399 /* Decide which timer is the next timer,
4400 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4401 Also step down the list where we found that timer. */
4403 if (! NILP (timers
) && ! NILP (idle_timers
))
4406 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4407 if (EMACS_TIME_NEG_P (temp
))
4409 chosen_timer
= timer
;
4410 timers
= XCDR (timers
);
4411 difference
= timer_difference
;
4415 chosen_timer
= idle_timer
;
4416 idle_timers
= XCDR (idle_timers
);
4417 difference
= idle_timer_difference
;
4420 else if (! NILP (timers
))
4422 chosen_timer
= timer
;
4423 timers
= XCDR (timers
);
4424 difference
= timer_difference
;
4428 chosen_timer
= idle_timer
;
4429 idle_timers
= XCDR (idle_timers
);
4430 difference
= idle_timer_difference
;
4432 vector
= XVECTOR (chosen_timer
)->contents
;
4434 /* If timer is ripe, run it if it hasn't been run. */
4435 if (EMACS_TIME_NEG_P (difference
)
4436 || (EMACS_SECS (difference
) == 0
4437 && EMACS_USECS (difference
) == 0))
4439 if (NILP (vector
[0]))
4441 int was_locked
= single_kboard
;
4442 int count
= SPECPDL_INDEX ();
4443 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4445 /* Mark the timer as triggered to prevent problems if the lisp
4446 code fails to reschedule it right. */
4449 specbind (Qinhibit_quit
, Qt
);
4451 call1 (Qtimer_event_handler
, chosen_timer
);
4452 Vdeactivate_mark
= old_deactivate_mark
;
4454 unbind_to (count
, Qnil
);
4456 /* Resume allowing input from any kboard, if that was true before. */
4458 any_kboard_state ();
4460 /* Since we have handled the event,
4461 we don't need to tell the caller to wake up and do it. */
4465 /* When we encounter a timer that is still waiting,
4466 return the amount of time to wait before it is ripe. */
4473 /* No timers are pending in the future. */
4474 /* Return 0 if we generated an event, and -1 if not. */
4479 /* Caches for modify_event_symbol. */
4480 static Lisp_Object accent_key_syms
;
4481 static Lisp_Object func_key_syms
;
4482 static Lisp_Object mouse_syms
;
4483 static Lisp_Object wheel_syms
;
4484 static Lisp_Object drag_n_drop_syms
;
4486 /* This is a list of keysym codes for special "accent" characters.
4487 It parallels lispy_accent_keys. */
4489 static int lispy_accent_codes
[] =
4491 #ifdef XK_dead_circumflex
4496 #ifdef XK_dead_grave
4501 #ifdef XK_dead_tilde
4506 #ifdef XK_dead_diaeresis
4511 #ifdef XK_dead_macron
4516 #ifdef XK_dead_degree
4521 #ifdef XK_dead_acute
4526 #ifdef XK_dead_cedilla
4531 #ifdef XK_dead_breve
4536 #ifdef XK_dead_ogonek
4541 #ifdef XK_dead_caron
4546 #ifdef XK_dead_doubleacute
4547 XK_dead_doubleacute
,
4551 #ifdef XK_dead_abovedot
4556 #ifdef XK_dead_abovering
4566 #ifdef XK_dead_belowdot
4571 #ifdef XK_dead_voiced_sound
4572 XK_dead_voiced_sound
,
4576 #ifdef XK_dead_semivoiced_sound
4577 XK_dead_semivoiced_sound
,
4593 /* This is a list of Lisp names for special "accent" characters.
4594 It parallels lispy_accent_codes. */
4596 static char *lispy_accent_keys
[] =
4614 "dead-voiced-sound",
4615 "dead-semivoiced-sound",
4621 #define FUNCTION_KEY_OFFSET 0x0
4623 char *lispy_function_keys
[] =
4627 0, /* VK_LBUTTON 0x01 */
4628 0, /* VK_RBUTTON 0x02 */
4629 "cancel", /* VK_CANCEL 0x03 */
4630 0, /* VK_MBUTTON 0x04 */
4632 0, 0, 0, /* 0x05 .. 0x07 */
4634 "backspace", /* VK_BACK 0x08 */
4635 "tab", /* VK_TAB 0x09 */
4637 0, 0, /* 0x0A .. 0x0B */
4639 "clear", /* VK_CLEAR 0x0C */
4640 "return", /* VK_RETURN 0x0D */
4642 0, 0, /* 0x0E .. 0x0F */
4644 0, /* VK_SHIFT 0x10 */
4645 0, /* VK_CONTROL 0x11 */
4646 0, /* VK_MENU 0x12 */
4647 "pause", /* VK_PAUSE 0x13 */
4648 "capslock", /* VK_CAPITAL 0x14 */
4650 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4652 "escape", /* VK_ESCAPE 0x1B */
4654 0, 0, 0, 0, /* 0x1C .. 0x1F */
4656 0, /* VK_SPACE 0x20 */
4657 "prior", /* VK_PRIOR 0x21 */
4658 "next", /* VK_NEXT 0x22 */
4659 "end", /* VK_END 0x23 */
4660 "home", /* VK_HOME 0x24 */
4661 "left", /* VK_LEFT 0x25 */
4662 "up", /* VK_UP 0x26 */
4663 "right", /* VK_RIGHT 0x27 */
4664 "down", /* VK_DOWN 0x28 */
4665 "select", /* VK_SELECT 0x29 */
4666 "print", /* VK_PRINT 0x2A */
4667 "execute", /* VK_EXECUTE 0x2B */
4668 "snapshot", /* VK_SNAPSHOT 0x2C */
4669 "insert", /* VK_INSERT 0x2D */
4670 "delete", /* VK_DELETE 0x2E */
4671 "help", /* VK_HELP 0x2F */
4673 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4675 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4677 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4679 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4681 0, 0, 0, 0, 0, 0, 0, 0, 0,
4682 0, 0, 0, 0, 0, 0, 0, 0, 0,
4683 0, 0, 0, 0, 0, 0, 0, 0,
4685 "lwindow", /* VK_LWIN 0x5B */
4686 "rwindow", /* VK_RWIN 0x5C */
4687 "apps", /* VK_APPS 0x5D */
4689 0, 0, /* 0x5E .. 0x5F */
4691 "kp-0", /* VK_NUMPAD0 0x60 */
4692 "kp-1", /* VK_NUMPAD1 0x61 */
4693 "kp-2", /* VK_NUMPAD2 0x62 */
4694 "kp-3", /* VK_NUMPAD3 0x63 */
4695 "kp-4", /* VK_NUMPAD4 0x64 */
4696 "kp-5", /* VK_NUMPAD5 0x65 */
4697 "kp-6", /* VK_NUMPAD6 0x66 */
4698 "kp-7", /* VK_NUMPAD7 0x67 */
4699 "kp-8", /* VK_NUMPAD8 0x68 */
4700 "kp-9", /* VK_NUMPAD9 0x69 */
4701 "kp-multiply", /* VK_MULTIPLY 0x6A */
4702 "kp-add", /* VK_ADD 0x6B */
4703 "kp-separator", /* VK_SEPARATOR 0x6C */
4704 "kp-subtract", /* VK_SUBTRACT 0x6D */
4705 "kp-decimal", /* VK_DECIMAL 0x6E */
4706 "kp-divide", /* VK_DIVIDE 0x6F */
4707 "f1", /* VK_F1 0x70 */
4708 "f2", /* VK_F2 0x71 */
4709 "f3", /* VK_F3 0x72 */
4710 "f4", /* VK_F4 0x73 */
4711 "f5", /* VK_F5 0x74 */
4712 "f6", /* VK_F6 0x75 */
4713 "f7", /* VK_F7 0x76 */
4714 "f8", /* VK_F8 0x77 */
4715 "f9", /* VK_F9 0x78 */
4716 "f10", /* VK_F10 0x79 */
4717 "f11", /* VK_F11 0x7A */
4718 "f12", /* VK_F12 0x7B */
4719 "f13", /* VK_F13 0x7C */
4720 "f14", /* VK_F14 0x7D */
4721 "f15", /* VK_F15 0x7E */
4722 "f16", /* VK_F16 0x7F */
4723 "f17", /* VK_F17 0x80 */
4724 "f18", /* VK_F18 0x81 */
4725 "f19", /* VK_F19 0x82 */
4726 "f20", /* VK_F20 0x83 */
4727 "f21", /* VK_F21 0x84 */
4728 "f22", /* VK_F22 0x85 */
4729 "f23", /* VK_F23 0x86 */
4730 "f24", /* VK_F24 0x87 */
4732 0, 0, 0, 0, /* 0x88 .. 0x8B */
4733 0, 0, 0, 0, /* 0x8C .. 0x8F */
4735 "kp-numlock", /* VK_NUMLOCK 0x90 */
4736 "scroll", /* VK_SCROLL 0x91 */
4738 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4739 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4740 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4741 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4742 "kp-end", /* VK_NUMPAD_END 0x96 */
4743 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4744 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4745 "kp-up", /* VK_NUMPAD_UP 0x99 */
4746 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4747 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4748 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4749 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4751 0, 0, /* 0x9E .. 0x9F */
4754 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4755 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4756 * No other API or message will distinguish left and right keys this way.
4760 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4761 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4762 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4763 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4764 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4770 "attn", /* VK_ATTN 0xF6 */
4771 "crsel", /* VK_CRSEL 0xF7 */
4772 "exsel", /* VK_EXSEL 0xF8 */
4773 "ereof", /* VK_EREOF 0xF9 */
4774 "play", /* VK_PLAY 0xFA */
4775 "zoom", /* VK_ZOOM 0xFB */
4776 "noname", /* VK_NONAME 0xFC */
4777 "pa1", /* VK_PA1 0xFD */
4778 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4782 #else /* not HAVE_NTGUI */
4784 /* This should be dealt with in XTread_socket now, and that doesn't
4785 depend on the client system having the Kana syms defined. See also
4786 the XK_kana_A case below. */
4789 static char *lispy_kana_keys
[] =
4791 /* X Keysym value */
4792 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4793 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4794 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4795 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4796 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4797 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4798 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4799 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4800 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4801 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4802 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4803 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4804 "kana-i", "kana-u", "kana-e", "kana-o",
4805 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4806 "prolongedsound", "kana-A", "kana-I", "kana-U",
4807 "kana-E", "kana-O", "kana-KA", "kana-KI",
4808 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4809 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4810 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4811 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4812 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4813 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4814 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4815 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4816 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4817 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4818 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4819 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4821 #endif /* XK_kana_A */
4824 #define FUNCTION_KEY_OFFSET 0xff00
4826 /* You'll notice that this table is arranged to be conveniently
4827 indexed by X Windows keysym values. */
4828 static char *lispy_function_keys
[] =
4830 /* X Keysym value */
4832 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4833 "backspace", "tab", "linefeed", "clear",
4835 0, 0, 0, "pause", /* 0xff10...1f */
4836 0, 0, 0, 0, 0, 0, 0, "escape",
4838 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4839 "romaji", "hiragana", "katakana", "hiragana-katakana",
4840 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4841 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4842 "eisu-toggle", /* 0xff30...3f */
4843 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4844 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4846 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4847 "down", "prior", "next", "end",
4848 "begin", 0, 0, 0, 0, 0, 0, 0,
4849 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4860 "break", /* 0xff6b */
4863 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4864 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4865 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4866 0, 0, 0, 0, 0, 0, 0, 0,
4867 "kp-tab", /* 0xff89 */
4869 "kp-enter", /* 0xff8d */
4871 "kp-f1", /* 0xff91 */
4875 "kp-home", /* 0xff95 */
4880 "kp-prior", /* kp-page-up */
4881 "kp-next", /* kp-page-down */
4887 0, 0, 0, 0, 0, 0, 0, 0, 0,
4888 "kp-multiply", /* 0xffaa */
4893 "kp-divide", /* 0xffaf */
4894 "kp-0", /* 0xffb0 */
4895 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4898 "kp-equal", /* 0xffbd */
4899 "f1", /* 0xffbe */ /* IsFunctionKey */
4901 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4902 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4903 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4904 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4905 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4906 0, 0, 0, 0, 0, 0, 0, 0,
4907 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4908 0, 0, 0, 0, 0, 0, 0, "delete"
4911 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4912 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4914 static char *iso_lispy_function_keys
[] =
4916 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4917 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4918 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4919 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4920 "iso-lefttab", /* 0xfe20 */
4921 "iso-move-line-up", "iso-move-line-down",
4922 "iso-partial-line-up", "iso-partial-line-down",
4923 "iso-partial-space-left", "iso-partial-space-right",
4924 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4925 "iso-release-margin-left", "iso-release-margin-right",
4926 "iso-release-both-margins",
4927 "iso-fast-cursor-left", "iso-fast-cursor-right",
4928 "iso-fast-cursor-up", "iso-fast-cursor-down",
4929 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4930 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4933 #endif /* not HAVE_NTGUI */
4935 Lisp_Object Vlispy_mouse_stem
;
4937 static char *lispy_wheel_names
[] =
4939 "wheel-up", "wheel-down"
4942 /* drag-n-drop events are generated when a set of selected files are
4943 dragged from another application and dropped onto an Emacs window. */
4944 static char *lispy_drag_n_drop_names
[] =
4949 /* Scroll bar parts. */
4950 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4951 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4952 Lisp_Object Qtop
, Qratio
;
4954 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4955 Lisp_Object
*scroll_bar_parts
[] = {
4956 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4957 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4960 /* User signal events. */
4961 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4963 Lisp_Object
*lispy_user_signals
[] =
4965 &Qusr1_signal
, &Qusr2_signal
4969 /* A vector, indexed by button number, giving the down-going location
4970 of currently depressed buttons, both scroll bar and non-scroll bar.
4972 The elements have the form
4973 (BUTTON-NUMBER MODIFIER-MASK . REST)
4974 where REST is the cdr of a position as it would be reported in the event.
4976 The make_lispy_event function stores positions here to tell the
4977 difference between click and drag events, and to store the starting
4978 location to be included in drag events. */
4980 static Lisp_Object button_down_location
;
4982 /* Information about the most recent up-going button event: Which
4983 button, what location, and what time. */
4985 static int last_mouse_button
;
4986 static int last_mouse_x
;
4987 static int last_mouse_y
;
4988 static unsigned long button_down_time
;
4990 /* The maximum time between clicks to make a double-click, or Qnil to
4991 disable double-click detection, or Qt for no time limit. */
4993 Lisp_Object Vdouble_click_time
;
4995 /* Maximum number of pixels the mouse may be moved between clicks
4996 to make a double-click. */
4998 EMACS_INT double_click_fuzz
;
5000 /* The number of clicks in this multiple-click. */
5002 int double_click_count
;
5004 /* Return position of a mouse click or wheel event */
5007 make_lispy_position (f
, x
, y
, time
)
5013 enum window_part part
;
5014 Lisp_Object posn
= Qnil
;
5015 Lisp_Object extra_info
= Qnil
;
5018 /* Set `window' to the window under frame pixel coordinates (x,y) */
5020 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5021 &part
, &wx
, &wy
, 0);
5025 if (WINDOWP (window
))
5027 /* It's a click in window window at frame coordinates (x,y) */
5028 struct window
*w
= XWINDOW (window
);
5029 Lisp_Object string_info
= Qnil
;
5030 int textpos
= -1, rx
= -1, ry
= -1;
5031 int dx
= -1, dy
= -1;
5032 int width
= -1, height
= -1;
5033 Lisp_Object object
= Qnil
;
5035 /* Set event coordinates to window-relative coordinates
5036 for constructing the Lisp event below. */
5040 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5042 /* Mode line or header line. Look for a string under
5043 the mouse that may have a `local-map' property. */
5047 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5049 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5050 &object
, &dx
, &dy
, &width
, &height
);
5051 if (STRINGP (string
))
5052 string_info
= Fcons (string
, make_number (charpos
));
5053 if (w
== XWINDOW (selected_window
))
5056 textpos
= XMARKER (w
->pointm
)->charpos
;
5058 else if (part
== ON_VERTICAL_BORDER
)
5060 posn
= Qvertical_line
;
5065 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5070 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5072 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5073 &object
, &dx
, &dy
, &width
, &height
);
5074 if (STRINGP (string
))
5075 string_info
= Fcons (string
, make_number (charpos
));
5077 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5079 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5082 if (part
== ON_RIGHT_FRINGE
)
5083 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5084 + window_box_width (w
, TEXT_AREA
)
5085 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5086 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5088 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5089 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5094 Lisp_Object string2
, object2
= Qnil
;
5095 struct display_pos p
;
5097 int width2
, height2
;
5098 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5099 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5100 &object2
, &dx2
, &dy2
,
5102 textpos
= CHARPOS (p
.pos
);
5103 if (rx
< 0) rx
= wx
;
5104 if (ry
< 0) ry
= wy
;
5105 if (dx
< 0) dx
= dx2
;
5106 if (dy
< 0) dy
= dy2
;
5107 if (width
< 0) width
= width2
;
5108 if (height
< 0) height
= height2
;
5112 posn
= make_number (textpos
);
5113 if (STRINGP (string2
))
5114 string_info
= Fcons (string2
,
5115 make_number (CHARPOS (p
.string_pos
)));
5121 #ifdef HAVE_WINDOW_SYSTEM
5122 if (IMAGEP (object
))
5124 Lisp_Object image_map
, hotspot
;
5125 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5127 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5129 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5130 posn
= XCAR (hotspot
);
5135 extra_info
= Fcons (object
,
5136 Fcons (Fcons (make_number (dx
),
5138 Fcons (Fcons (make_number (width
),
5139 make_number (height
)),
5143 extra_info
= Fcons (string_info
,
5144 Fcons (make_number (textpos
),
5145 Fcons (Fcons (make_number (rx
),
5151 XSETFRAME (window
, f
);
5156 XSETFASTINT (*x
, 0);
5157 XSETFASTINT (*y
, 0);
5160 return Fcons (window
,
5162 Fcons (Fcons (*x
, *y
),
5163 Fcons (make_number (time
),
5167 /* Given a struct input_event, build the lisp event which represents
5168 it. If EVENT is 0, build a mouse movement event from the mouse
5169 movement buffer, which should have a movement event in it.
5171 Note that events must be passed to this function in the order they
5172 are received; this function stores the location of button presses
5173 in order to build drag events when the button is released. */
5176 make_lispy_event (event
)
5177 struct input_event
*event
;
5181 switch (SWITCH_ENUM_CAST (event
->kind
))
5183 /* A simple keystroke. */
5184 case ASCII_KEYSTROKE_EVENT
:
5186 Lisp_Object lispy_c
;
5187 int c
= event
->code
& 0377;
5188 /* Turn ASCII characters into control characters
5190 if (event
->modifiers
& ctrl_modifier
)
5191 c
= make_ctrl_char (c
);
5193 /* Add in the other modifier bits. We took care of ctrl_modifier
5194 just above, and the shift key was taken care of by the X code,
5195 and applied to control characters by make_ctrl_char. */
5196 c
|= (event
->modifiers
5197 & (meta_modifier
| alt_modifier
5198 | hyper_modifier
| super_modifier
));
5199 /* Distinguish Shift-SPC from SPC. */
5200 if ((event
->code
& 0377) == 040
5201 && event
->modifiers
& shift_modifier
)
5202 c
|= shift_modifier
;
5203 button_down_time
= 0;
5204 XSETFASTINT (lispy_c
, c
);
5208 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5210 Lisp_Object lispy_c
;
5211 int c
= event
->code
;
5213 /* Add in the other modifier bits. We took care of ctrl_modifier
5214 just above, and the shift key was taken care of by the X code,
5215 and applied to control characters by make_ctrl_char. */
5216 c
|= (event
->modifiers
5217 & (meta_modifier
| alt_modifier
5218 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5219 /* What about the `shift' modifier ? */
5220 button_down_time
= 0;
5221 XSETFASTINT (lispy_c
, c
);
5225 /* A function key. The symbol may need to have modifier prefixes
5227 case NON_ASCII_KEYSTROKE_EVENT
:
5228 button_down_time
= 0;
5230 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5231 if (event
->code
== lispy_accent_codes
[i
])
5232 return modify_event_symbol (i
,
5234 Qfunction_key
, Qnil
,
5235 lispy_accent_keys
, &accent_key_syms
,
5236 (sizeof (lispy_accent_keys
)
5237 / sizeof (lispy_accent_keys
[0])));
5241 if (event
->code
>= 0x400 && event
->code
< 0x500)
5242 return modify_event_symbol (event
->code
- 0x400,
5243 event
->modifiers
& ~shift_modifier
,
5244 Qfunction_key
, Qnil
,
5245 lispy_kana_keys
, &func_key_syms
,
5246 (sizeof (lispy_kana_keys
)
5247 / sizeof (lispy_kana_keys
[0])));
5248 #endif /* XK_kana_A */
5251 #ifdef ISO_FUNCTION_KEY_OFFSET
5252 if (event
->code
< FUNCTION_KEY_OFFSET
5253 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5254 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5256 Qfunction_key
, Qnil
,
5257 iso_lispy_function_keys
, &func_key_syms
,
5258 (sizeof (iso_lispy_function_keys
)
5259 / sizeof (iso_lispy_function_keys
[0])));
5262 /* Handle system-specific or unknown keysyms. */
5263 if (event
->code
& (1 << 28)
5264 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5265 || (event
->code
- FUNCTION_KEY_OFFSET
5266 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5267 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5269 /* We need to use an alist rather than a vector as the cache
5270 since we can't make a vector long enuf. */
5271 if (NILP (current_kboard
->system_key_syms
))
5272 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5273 return modify_event_symbol (event
->code
,
5276 current_kboard
->Vsystem_key_alist
,
5277 0, ¤t_kboard
->system_key_syms
,
5281 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5283 Qfunction_key
, Qnil
,
5284 lispy_function_keys
, &func_key_syms
,
5285 (sizeof (lispy_function_keys
)
5286 / sizeof (lispy_function_keys
[0])));
5289 /* A mouse click. Figure out where it is, decide whether it's
5290 a press, click or drag, and build the appropriate structure. */
5291 case MOUSE_CLICK_EVENT
:
5292 #ifndef USE_TOOLKIT_SCROLL_BARS
5293 case SCROLL_BAR_CLICK_EVENT
:
5296 int button
= event
->code
;
5298 Lisp_Object position
;
5299 Lisp_Object
*start_pos_ptr
;
5300 Lisp_Object start_pos
;
5304 /* Build the position as appropriate for this mouse click. */
5305 if (event
->kind
== MOUSE_CLICK_EVENT
)
5307 struct frame
*f
= XFRAME (event
->frame_or_window
);
5308 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5312 /* Ignore mouse events that were made on frame that
5313 have been deleted. */
5314 if (! FRAME_LIVE_P (f
))
5317 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5318 /* EVENT->x and EVENT->y are frame-relative pixel
5319 coordinates at this place. Under old redisplay, COLUMN
5320 and ROW are set to frame relative glyph coordinates
5321 which are then used to determine whether this click is
5322 in a menu (non-toolkit version). */
5323 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5324 &column
, &row
, NULL
, 1);
5326 /* In the non-toolkit version, clicks on the menu bar
5327 are ordinary button events in the event buffer.
5328 Distinguish them, and invoke the menu.
5330 (In the toolkit version, the toolkit handles the menu bar
5331 and Emacs doesn't know about it until after the user
5332 makes a selection.) */
5333 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5334 && (event
->modifiers
& down_modifier
))
5336 Lisp_Object items
, item
;
5341 /* Activate the menu bar on the down event. If the
5342 up event comes in before the menu code can deal with it,
5344 if (! (event
->modifiers
& down_modifier
))
5348 /* Find the menu bar item under `column'. */
5350 items
= FRAME_MENU_BAR_ITEMS (f
);
5351 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5353 Lisp_Object pos
, string
;
5354 string
= AREF (items
, i
+ 1);
5355 pos
= AREF (items
, i
+ 3);
5358 if (column
>= XINT (pos
)
5359 && column
< XINT (pos
) + SCHARS (string
))
5361 item
= AREF (items
, i
);
5366 /* ELisp manual 2.4b says (x y) are window relative but
5367 code says they are frame-relative. */
5369 = Fcons (event
->frame_or_window
,
5371 Fcons (Fcons (event
->x
, event
->y
),
5372 Fcons (make_number (event
->timestamp
),
5375 return Fcons (item
, Fcons (position
, Qnil
));
5377 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5379 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5382 #ifndef USE_TOOLKIT_SCROLL_BARS
5385 /* It's a scrollbar click. */
5387 Lisp_Object portion_whole
;
5390 window
= event
->frame_or_window
;
5391 portion_whole
= Fcons (event
->x
, event
->y
);
5392 part
= *scroll_bar_parts
[(int) event
->part
];
5396 Fcons (Qvertical_scroll_bar
,
5397 Fcons (portion_whole
,
5398 Fcons (make_number (event
->timestamp
),
5399 Fcons (part
, Qnil
)))));
5401 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5403 if (button
>= ASIZE (button_down_location
))
5405 button_down_location
= larger_vector (button_down_location
,
5407 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5410 start_pos_ptr
= &AREF (button_down_location
, button
);
5411 start_pos
= *start_pos_ptr
;
5412 *start_pos_ptr
= Qnil
;
5415 /* On window-system frames, use the value of
5416 double-click-fuzz as is. On other frames, interpret it
5417 as a multiple of 1/8 characters. */
5421 if (WINDOWP (event
->frame_or_window
))
5422 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5423 else if (FRAMEP (event
->frame_or_window
))
5424 f
= XFRAME (event
->frame_or_window
);
5428 if (FRAME_WINDOW_P (f
))
5429 fuzz
= double_click_fuzz
;
5431 fuzz
= double_click_fuzz
/ 8;
5433 is_double
= (button
== last_mouse_button
5434 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5435 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5436 && button_down_time
!= 0
5437 && (EQ (Vdouble_click_time
, Qt
)
5438 || (INTEGERP (Vdouble_click_time
)
5439 && ((int)(event
->timestamp
- button_down_time
)
5440 < XINT (Vdouble_click_time
)))));
5443 last_mouse_button
= button
;
5444 last_mouse_x
= XINT (event
->x
);
5445 last_mouse_y
= XINT (event
->y
);
5447 /* If this is a button press, squirrel away the location, so
5448 we can decide later whether it was a click or a drag. */
5449 if (event
->modifiers
& down_modifier
)
5453 double_click_count
++;
5454 event
->modifiers
|= ((double_click_count
> 2)
5459 double_click_count
= 1;
5460 button_down_time
= event
->timestamp
;
5461 *start_pos_ptr
= Fcopy_alist (position
);
5464 /* Now we're releasing a button - check the co-ordinates to
5465 see if this was a click or a drag. */
5466 else if (event
->modifiers
& up_modifier
)
5468 /* If we did not see a down before this up, ignore the up.
5469 Probably this happened because the down event chose a
5470 menu item. It would be an annoyance to treat the
5471 release of the button that chose the menu item as a
5474 if (!CONSP (start_pos
))
5477 event
->modifiers
&= ~up_modifier
;
5478 #if 0 /* Formerly we treated an up with no down as a click event. */
5479 if (!CONSP (start_pos
))
5480 event
->modifiers
|= click_modifier
;
5485 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5487 /* The third element of every position
5488 should be the (x,y) pair. */
5489 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5491 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5493 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5494 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5497 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5498 && ydiff
< double_click_fuzz
5499 && ydiff
> - double_click_fuzz
)
5500 /* Mouse hasn't moved (much). */
5501 event
->modifiers
|= click_modifier
;
5504 button_down_time
= 0;
5505 event
->modifiers
|= drag_modifier
;
5508 /* Don't check is_double; treat this as multiple
5509 if the down-event was multiple. */
5510 if (double_click_count
> 1)
5511 event
->modifiers
|= ((double_click_count
> 2)
5517 /* Every mouse event should either have the down_modifier or
5518 the up_modifier set. */
5522 /* Get the symbol we should use for the mouse click. */
5525 head
= modify_event_symbol (button
,
5527 Qmouse_click
, Vlispy_mouse_stem
,
5530 XVECTOR (mouse_syms
)->size
);
5531 if (event
->modifiers
& drag_modifier
)
5536 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5539 Fcons (make_number (double_click_count
),
5550 Lisp_Object position
;
5553 /* Build the position as appropriate for this mouse click. */
5554 struct frame
*f
= XFRAME (event
->frame_or_window
);
5556 /* Ignore wheel events that were made on frame that have been
5558 if (! FRAME_LIVE_P (f
))
5561 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5564 /* Set double or triple modifiers to indicate the wheel speed. */
5566 /* On window-system frames, use the value of
5567 double-click-fuzz as is. On other frames, interpret it
5568 as a multiple of 1/8 characters. */
5573 if (WINDOWP (event
->frame_or_window
))
5574 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5575 else if (FRAMEP (event
->frame_or_window
))
5576 f
= XFRAME (event
->frame_or_window
);
5580 if (FRAME_WINDOW_P (f
))
5581 fuzz
= double_click_fuzz
;
5583 fuzz
= double_click_fuzz
/ 8;
5585 is_double
= (last_mouse_button
< 0
5586 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5587 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5588 && button_down_time
!= 0
5589 && (EQ (Vdouble_click_time
, Qt
)
5590 || (INTEGERP (Vdouble_click_time
)
5591 && ((int)(event
->timestamp
- button_down_time
)
5592 < XINT (Vdouble_click_time
)))));
5595 double_click_count
++;
5596 event
->modifiers
|= ((double_click_count
> 2)
5602 double_click_count
= 1;
5603 event
->modifiers
|= click_modifier
;
5606 button_down_time
= event
->timestamp
;
5607 /* Use a negative value to distinguish wheel from mouse button. */
5608 last_mouse_button
= -1;
5609 last_mouse_x
= XINT (event
->x
);
5610 last_mouse_y
= XINT (event
->y
);
5616 if (event
->modifiers
& up_modifier
)
5618 /* Emit a wheel-up event. */
5619 event
->modifiers
&= ~up_modifier
;
5622 else if (event
->modifiers
& down_modifier
)
5624 /* Emit a wheel-down event. */
5625 event
->modifiers
&= ~down_modifier
;
5629 /* Every wheel event should either have the down_modifier or
5630 the up_modifier set. */
5633 /* Get the symbol we should use for the wheel event. */
5634 head
= modify_event_symbol (symbol_num
,
5640 ASIZE (wheel_syms
));
5643 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5646 Fcons (make_number (double_click_count
),
5655 #ifdef USE_TOOLKIT_SCROLL_BARS
5657 /* We don't have down and up events if using toolkit scroll bars,
5658 so make this always a click event. Store in the `part' of
5659 the Lisp event a symbol which maps to the following actions:
5661 `above_handle' page up
5662 `below_handle' page down
5666 `bottom' bottom of buffer
5667 `handle' thumb has been dragged.
5668 `end-scroll' end of interaction with scroll bar
5670 The incoming input_event contains in its `part' member an
5671 index of type `enum scroll_bar_part' which we can use as an
5672 index in scroll_bar_parts to get the appropriate symbol. */
5674 case SCROLL_BAR_CLICK_EVENT
:
5676 Lisp_Object position
, head
, window
, portion_whole
, part
;
5678 window
= event
->frame_or_window
;
5679 portion_whole
= Fcons (event
->x
, event
->y
);
5680 part
= *scroll_bar_parts
[(int) event
->part
];
5684 Fcons (Qvertical_scroll_bar
,
5685 Fcons (portion_whole
,
5686 Fcons (make_number (event
->timestamp
),
5687 Fcons (part
, Qnil
)))));
5689 /* Always treat scroll bar events as clicks. */
5690 event
->modifiers
|= click_modifier
;
5691 event
->modifiers
&= ~up_modifier
;
5693 if (event
->code
>= ASIZE (mouse_syms
))
5694 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5696 /* Get the symbol we should use for the mouse click. */
5697 head
= modify_event_symbol (event
->code
,
5702 XVECTOR (mouse_syms
)->size
);
5703 return Fcons (head
, Fcons (position
, Qnil
));
5706 #endif /* USE_TOOLKIT_SCROLL_BARS */
5709 case W32_SCROLL_BAR_CLICK_EVENT
:
5711 int button
= event
->code
;
5713 Lisp_Object position
;
5714 Lisp_Object
*start_pos_ptr
;
5715 Lisp_Object start_pos
;
5719 Lisp_Object portion_whole
;
5722 window
= event
->frame_or_window
;
5723 portion_whole
= Fcons (event
->x
, event
->y
);
5724 part
= *scroll_bar_parts
[(int) event
->part
];
5728 Fcons (Qvertical_scroll_bar
,
5729 Fcons (portion_whole
,
5730 Fcons (make_number (event
->timestamp
),
5731 Fcons (part
, Qnil
)))));
5734 /* Always treat W32 scroll bar events as clicks. */
5735 event
->modifiers
|= click_modifier
;
5738 /* Get the symbol we should use for the mouse click. */
5741 head
= modify_event_symbol (button
,
5746 XVECTOR (mouse_syms
)->size
);
5752 #endif /* WINDOWSNT */
5754 case DRAG_N_DROP_EVENT
:
5757 Lisp_Object head
, position
;
5760 /* The frame_or_window field should be a cons of the frame in
5761 which the event occurred and a list of the filenames
5763 if (! CONSP (event
->frame_or_window
))
5766 f
= XFRAME (XCAR (event
->frame_or_window
));
5767 files
= XCDR (event
->frame_or_window
);
5769 /* Ignore mouse events that were made on frames that
5770 have been deleted. */
5771 if (! FRAME_LIVE_P (f
))
5774 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5777 head
= modify_event_symbol (0, event
->modifiers
,
5779 lispy_drag_n_drop_names
,
5780 &drag_n_drop_syms
, 1);
5786 #endif /* HAVE_MOUSE */
5788 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5789 || defined (USE_GTK)
5790 case MENU_BAR_EVENT
:
5791 if (EQ (event
->arg
, event
->frame_or_window
))
5792 /* This is the prefix key. We translate this to
5793 `(menu_bar)' because the code in keyboard.c for menu
5794 events, which we use, relies on this. */
5795 return Fcons (Qmenu_bar
, Qnil
);
5799 case SELECT_WINDOW_EVENT
:
5800 /* Make an event (select-window (WINDOW)). */
5801 return Fcons (Qselect_window
,
5802 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5805 case TOOL_BAR_EVENT
:
5806 if (EQ (event
->arg
, event
->frame_or_window
))
5807 /* This is the prefix key. We translate this to
5808 `(tool_bar)' because the code in keyboard.c for tool bar
5809 events, which we use, relies on this. */
5810 return Fcons (Qtool_bar
, Qnil
);
5811 else if (SYMBOLP (event
->arg
))
5812 return apply_modifiers (event
->modifiers
, event
->arg
);
5815 case USER_SIGNAL_EVENT
:
5816 /* A user signal. */
5817 return *lispy_user_signals
[event
->code
];
5819 case SAVE_SESSION_EVENT
:
5820 return Qsave_session
;
5822 /* The 'kind' field of the event is something we don't recognize. */
5831 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5833 Lisp_Object bar_window
;
5834 enum scroll_bar_part part
;
5838 /* Is it a scroll bar movement? */
5839 if (frame
&& ! NILP (bar_window
))
5841 Lisp_Object part_sym
;
5843 part_sym
= *scroll_bar_parts
[(int) part
];
5844 return Fcons (Qscroll_bar_movement
,
5845 (Fcons (Fcons (bar_window
,
5846 Fcons (Qvertical_scroll_bar
,
5847 Fcons (Fcons (x
, y
),
5848 Fcons (make_number (time
),
5854 /* Or is it an ordinary mouse movement? */
5857 Lisp_Object position
;
5859 position
= make_lispy_position (frame
, &x
, &y
, time
);
5861 return Fcons (Qmouse_movement
,
5867 #endif /* HAVE_MOUSE */
5869 /* Construct a switch frame event. */
5871 make_lispy_switch_frame (frame
)
5874 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5877 /* Manipulating modifiers. */
5879 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5881 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5882 SYMBOL's name of the end of the modifiers; the string from this
5883 position is the unmodified symbol name.
5885 This doesn't use any caches. */
5888 parse_modifiers_uncached (symbol
, modifier_end
)
5896 CHECK_SYMBOL (symbol
);
5899 name
= SYMBOL_NAME (symbol
);
5901 for (i
= 0; i
+2 <= SBYTES (name
); )
5903 int this_mod_end
= 0;
5906 /* See if the name continues with a modifier word.
5907 Check that the word appears, but don't check what follows it.
5908 Set this_mod and this_mod_end to record what we find. */
5910 switch (SREF (name
, i
))
5912 #define SINGLE_LETTER_MOD(BIT) \
5913 (this_mod_end = i + 1, this_mod = BIT)
5916 SINGLE_LETTER_MOD (alt_modifier
);
5920 SINGLE_LETTER_MOD (ctrl_modifier
);
5924 SINGLE_LETTER_MOD (hyper_modifier
);
5928 SINGLE_LETTER_MOD (meta_modifier
);
5932 SINGLE_LETTER_MOD (shift_modifier
);
5936 SINGLE_LETTER_MOD (super_modifier
);
5939 #undef SINGLE_LETTER_MOD
5941 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5942 if (i + LEN + 1 <= SBYTES (name) \
5943 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5945 this_mod_end = i + LEN; \
5950 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5951 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5952 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5956 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5958 #undef MULTI_LETTER_MOD
5962 /* If we found no modifier, stop looking for them. */
5963 if (this_mod_end
== 0)
5966 /* Check there is a dash after the modifier, so that it
5967 really is a modifier. */
5968 if (this_mod_end
>= SBYTES (name
)
5969 || SREF (name
, this_mod_end
) != '-')
5972 /* This modifier is real; look for another. */
5973 modifiers
|= this_mod
;
5974 i
= this_mod_end
+ 1;
5977 /* Should we include the `click' modifier? */
5978 if (! (modifiers
& (down_modifier
| drag_modifier
5979 | double_modifier
| triple_modifier
))
5980 && i
+ 7 == SBYTES (name
)
5981 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5982 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5983 modifiers
|= click_modifier
;
5991 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5992 prepended to the string BASE[0..BASE_LEN-1].
5993 This doesn't use any caches. */
5995 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5998 int base_len
, base_len_byte
;
6000 /* Since BASE could contain nulls, we can't use intern here; we have
6001 to use Fintern, which expects a genuine Lisp_String, and keeps a
6004 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6010 /* Only the event queue may use the `up' modifier; it should always
6011 be turned into a click or drag event before presented to lisp code. */
6012 if (modifiers
& up_modifier
)
6015 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6016 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6017 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6018 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6019 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6020 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6021 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6022 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6023 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6024 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6025 /* The click modifier is denoted by the absence of other modifiers. */
6029 mod_len
= p
- new_mods
;
6033 Lisp_Object new_name
;
6035 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6036 mod_len
+ base_len_byte
);
6037 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6038 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6040 return Fintern (new_name
, Qnil
);
6045 static char *modifier_names
[] =
6047 "up", "down", "drag", "click", "double", "triple", 0, 0,
6048 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6049 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6051 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6053 static Lisp_Object modifier_symbols
;
6055 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6057 lispy_modifier_list (modifiers
)
6060 Lisp_Object modifier_list
;
6063 modifier_list
= Qnil
;
6064 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6065 if (modifiers
& (1<<i
))
6066 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6069 return modifier_list
;
6073 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6074 where UNMODIFIED is the unmodified form of SYMBOL,
6075 MASK is the set of modifiers present in SYMBOL's name.
6076 This is similar to parse_modifiers_uncached, but uses the cache in
6077 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6078 Qevent_symbol_elements property. */
6081 parse_modifiers (symbol
)
6084 Lisp_Object elements
;
6086 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6087 if (CONSP (elements
))
6092 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6093 Lisp_Object unmodified
;
6096 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6097 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6100 if (modifiers
& ~INTMASK
)
6102 XSETFASTINT (mask
, modifiers
);
6103 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6105 /* Cache the parsing results on SYMBOL. */
6106 Fput (symbol
, Qevent_symbol_element_mask
,
6108 Fput (symbol
, Qevent_symbol_elements
,
6109 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6111 /* Since we know that SYMBOL is modifiers applied to unmodified,
6112 it would be nice to put that in unmodified's cache.
6113 But we can't, since we're not sure that parse_modifiers is
6120 /* Apply the modifiers MODIFIERS to the symbol BASE.
6121 BASE must be unmodified.
6123 This is like apply_modifiers_uncached, but uses BASE's
6124 Qmodifier_cache property, if present. It also builds
6125 Qevent_symbol_elements properties, since it has that info anyway.
6127 apply_modifiers copies the value of BASE's Qevent_kind property to
6128 the modified symbol. */
6130 apply_modifiers (modifiers
, base
)
6134 Lisp_Object cache
, index
, entry
, new_symbol
;
6136 /* Mask out upper bits. We don't know where this value's been. */
6137 modifiers
&= INTMASK
;
6139 /* The click modifier never figures into cache indices. */
6140 cache
= Fget (base
, Qmodifier_cache
);
6141 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6142 entry
= assq_no_quit (index
, cache
);
6145 new_symbol
= XCDR (entry
);
6148 /* We have to create the symbol ourselves. */
6149 new_symbol
= apply_modifiers_uncached (modifiers
,
6150 SDATA (SYMBOL_NAME (base
)),
6151 SCHARS (SYMBOL_NAME (base
)),
6152 SBYTES (SYMBOL_NAME (base
)));
6154 /* Add the new symbol to the base's cache. */
6155 entry
= Fcons (index
, new_symbol
);
6156 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6158 /* We have the parsing info now for free, so we could add it to
6160 XSETFASTINT (index, modifiers);
6161 Fput (new_symbol, Qevent_symbol_element_mask,
6162 Fcons (base, Fcons (index, Qnil)));
6163 Fput (new_symbol, Qevent_symbol_elements,
6164 Fcons (base, lispy_modifier_list (modifiers)));
6165 Sadly, this is only correct if `base' is indeed a base event,
6166 which is not necessarily the case. -stef */
6169 /* Make sure this symbol is of the same kind as BASE.
6171 You'd think we could just set this once and for all when we
6172 intern the symbol above, but reorder_modifiers may call us when
6173 BASE's property isn't set right; we can't assume that just
6174 because it has a Qmodifier_cache property it must have its
6175 Qevent_kind set right as well. */
6176 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6180 kind
= Fget (base
, Qevent_kind
);
6182 Fput (new_symbol
, Qevent_kind
, kind
);
6189 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6190 return a symbol with the modifiers placed in the canonical order.
6191 Canonical order is alphabetical, except for down and drag, which
6192 always come last. The 'click' modifier is never written out.
6194 Fdefine_key calls this to make sure that (for example) C-M-foo
6195 and M-C-foo end up being equivalent in the keymap. */
6198 reorder_modifiers (symbol
)
6201 /* It's hopefully okay to write the code this way, since everything
6202 will soon be in caches, and no consing will be done at all. */
6205 parsed
= parse_modifiers (symbol
);
6206 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6211 /* For handling events, we often want to produce a symbol whose name
6212 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6213 to some base, like the name of a function key or mouse button.
6214 modify_event_symbol produces symbols of this sort.
6216 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6217 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6220 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6221 into symbol names, or a string specifying a name stem used to
6222 construct a symbol name or the form `STEM-N', where N is the decimal
6223 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6224 non-nil; otherwise NAME_TABLE is used.
6226 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6227 persist between calls to modify_event_symbol that it can use to
6228 store a cache of the symbols it's generated for this NAME_TABLE
6229 before. The object stored there may be a vector or an alist.
6231 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6233 MODIFIERS is a set of modifier bits (as given in struct input_events)
6234 whose prefixes should be applied to the symbol name.
6236 SYMBOL_KIND is the value to be placed in the event_kind property of
6237 the returned symbol.
6239 The symbols we create are supposed to have an
6240 `event-symbol-elements' property, which lists the modifiers present
6241 in the symbol's name. */
6244 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6245 name_table
, symbol_table
, table_size
)
6248 Lisp_Object symbol_kind
;
6249 Lisp_Object name_alist_or_stem
;
6251 Lisp_Object
*symbol_table
;
6252 unsigned int table_size
;
6255 Lisp_Object symbol_int
;
6257 /* Get rid of the "vendor-specific" bit here. */
6258 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6260 /* Is this a request for a valid symbol? */
6261 if (symbol_num
< 0 || symbol_num
>= table_size
)
6264 if (CONSP (*symbol_table
))
6265 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6267 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6268 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6269 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6270 we've never used that symbol before. */
6273 if (! VECTORP (*symbol_table
)
6274 || XVECTOR (*symbol_table
)->size
!= table_size
)
6278 XSETFASTINT (size
, table_size
);
6279 *symbol_table
= Fmake_vector (size
, Qnil
);
6282 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6285 /* Have we already used this symbol before? */
6288 /* No; let's create it. */
6289 if (CONSP (name_alist_or_stem
))
6290 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6291 else if (STRINGP (name_alist_or_stem
))
6293 int len
= SBYTES (name_alist_or_stem
);
6294 char *buf
= (char *) alloca (len
+ 50);
6295 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6296 (long) XINT (symbol_int
) + 1);
6297 value
= intern (buf
);
6299 else if (name_table
!= 0 && name_table
[symbol_num
])
6300 value
= intern (name_table
[symbol_num
]);
6302 #ifdef HAVE_WINDOW_SYSTEM
6305 char *name
= x_get_keysym_name (symbol_num
);
6307 value
= intern (name
);
6314 sprintf (buf
, "key-%d", symbol_num
);
6315 value
= intern (buf
);
6318 if (CONSP (*symbol_table
))
6319 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6321 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6323 /* Fill in the cache entries for this symbol; this also
6324 builds the Qevent_symbol_elements property, which the user
6326 apply_modifiers (modifiers
& click_modifier
, value
);
6327 Fput (value
, Qevent_kind
, symbol_kind
);
6330 /* Apply modifiers to that symbol. */
6331 return apply_modifiers (modifiers
, value
);
6334 /* Convert a list that represents an event type,
6335 such as (ctrl meta backspace), into the usual representation of that
6336 event type as a number or a symbol. */
6338 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6339 doc
: /* Convert the event description list EVENT-DESC to an event type.
6340 EVENT-DESC should contain one base event type (a character or symbol)
6341 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6342 drag, down, double or triple). The base must be last.
6343 The return value is an event type (a character or symbol) which
6344 has the same base event type and all the specified modifiers. */)
6346 Lisp_Object event_desc
;
6354 while (CONSP (rest
))
6362 /* Given a symbol, see if it is a modifier name. */
6363 if (SYMBOLP (elt
) && CONSP (rest
))
6364 this = parse_solitary_modifier (elt
);
6368 else if (!NILP (base
))
6369 error ("Two bases given in one event");
6375 /* Let the symbol A refer to the character A. */
6376 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6377 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6379 if (INTEGERP (base
))
6381 /* Turn (shift a) into A. */
6382 if ((modifiers
& shift_modifier
) != 0
6383 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6385 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6386 modifiers
&= ~shift_modifier
;
6389 /* Turn (control a) into C-a. */
6390 if (modifiers
& ctrl_modifier
)
6391 return make_number ((modifiers
& ~ctrl_modifier
)
6392 | make_ctrl_char (XINT (base
)));
6394 return make_number (modifiers
| XINT (base
));
6396 else if (SYMBOLP (base
))
6397 return apply_modifiers (modifiers
, base
);
6400 error ("Invalid base event");
6405 /* Try to recognize SYMBOL as a modifier name.
6406 Return the modifier flag bit, or 0 if not recognized. */
6409 parse_solitary_modifier (symbol
)
6412 Lisp_Object name
= SYMBOL_NAME (symbol
);
6414 switch (SREF (name
, 0))
6416 #define SINGLE_LETTER_MOD(BIT) \
6417 if (SBYTES (name) == 1) \
6420 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6421 if (LEN == SBYTES (name) \
6422 && ! strncmp (SDATA (name), NAME, LEN)) \
6426 SINGLE_LETTER_MOD (alt_modifier
);
6430 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6434 SINGLE_LETTER_MOD (ctrl_modifier
);
6438 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6439 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6443 SINGLE_LETTER_MOD (hyper_modifier
);
6447 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6451 SINGLE_LETTER_MOD (meta_modifier
);
6455 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6459 SINGLE_LETTER_MOD (shift_modifier
);
6463 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6464 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6465 SINGLE_LETTER_MOD (super_modifier
);
6469 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6470 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6471 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6475 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6478 #undef SINGLE_LETTER_MOD
6479 #undef MULTI_LETTER_MOD
6485 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6486 Such a list is not valid as an event,
6487 but it can be a Lucid-style event type list. */
6490 lucid_event_type_list_p (object
)
6495 if (! CONSP (object
))
6498 if (EQ (XCAR (object
), Qhelp_echo
)
6499 || EQ (XCAR (object
), Qvertical_line
)
6500 || EQ (XCAR (object
), Qmode_line
)
6501 || EQ (XCAR (object
), Qheader_line
))
6504 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6508 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6515 /* Store into *addr a value nonzero if terminal input chars are available.
6516 Serves the purpose of ioctl (0, FIONREAD, addr)
6517 but works even if FIONREAD does not exist.
6518 (In fact, this may actually read some input.)
6520 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6521 timer events that are ripe.
6522 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6523 events (FOCUS_IN_EVENT).
6524 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6528 get_input_pending (addr
, flags
)
6532 /* First of all, have we already counted some input? */
6533 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6535 /* If input is being read as it arrives, and we have none, there is none. */
6536 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6539 /* Try to read some input and see how much we get. */
6541 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6544 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6547 gobble_input (expected
)
6552 if (interrupt_input
)
6555 mask
= sigblock (sigmask (SIGIO
));
6556 read_avail_input (expected
);
6560 #ifdef POLL_FOR_INPUT
6561 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6564 mask
= sigblock (sigmask (SIGALRM
));
6565 read_avail_input (expected
);
6571 read_avail_input (expected
);
6575 /* Put a BUFFER_SWITCH_EVENT in the buffer
6576 so that read_key_sequence will notice the new current buffer. */
6579 record_asynch_buffer_change ()
6581 struct input_event event
;
6585 event
.kind
= BUFFER_SWITCH_EVENT
;
6586 event
.frame_or_window
= Qnil
;
6590 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6591 The purpose of the event is to make read_key_sequence look up the
6592 keymaps again. If we aren't in read_key_sequence, we don't need one,
6593 and the event could cause trouble by messing up (input-pending-p). */
6594 tem
= Fwaiting_for_user_input_p ();
6598 /* We never need these events if we have no asynchronous subprocesses. */
6602 /* Make sure no interrupt happens while storing the event. */
6604 if (interrupt_input
)
6607 mask
= sigblock (sigmask (SIGIO
));
6608 kbd_buffer_store_event (&event
);
6615 kbd_buffer_store_event (&event
);
6622 /* Read any terminal input already buffered up by the system
6623 into the kbd_buffer, but do not wait.
6625 EXPECTED should be nonzero if the caller knows there is some input.
6627 Except on VMS, all input is read by this function.
6628 If interrupt_input is nonzero, this function MUST be called
6629 only when SIGIO is blocked.
6631 Returns the number of keyboard chars read, or -1 meaning
6632 this is a bad time to try to read input. */
6635 read_avail_input (expected
)
6641 if (read_socket_hook
)
6644 struct input_event hold_quit
;
6646 EVENT_INIT (hold_quit
);
6647 hold_quit
.kind
= NO_EVENT
;
6649 /* No need for FIONREAD or fcntl; just say don't wait. */
6650 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6655 if (hold_quit
.kind
!= NO_EVENT
)
6656 kbd_buffer_store_event (&hold_quit
);
6660 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6661 the kbd_buffer can really hold. That may prevent loss
6662 of characters on some systems when input is stuffed at us. */
6663 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6666 /* Determine how many characters we should *try* to read. */
6669 #else /* not WINDOWSNT */
6671 n_to_read
= dos_keysns ();
6674 #else /* not MSDOS */
6676 /* Find out how much input is available. */
6677 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6678 /* Formerly simply reported no input, but that sometimes led to
6679 a failure of Emacs to terminate.
6680 SIGHUP seems appropriate if we can't reach the terminal. */
6681 /* ??? Is it really right to send the signal just to this process
6682 rather than to the whole process group?
6683 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6685 if (! noninteractive
)
6686 kill (getpid (), SIGHUP
);
6692 if (n_to_read
> sizeof cbuf
)
6693 n_to_read
= sizeof cbuf
;
6694 #else /* no FIONREAD */
6695 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6696 /* Read some input if available, but don't wait. */
6697 n_to_read
= sizeof cbuf
;
6698 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6703 #endif /* not MSDOS */
6704 #endif /* not WINDOWSNT */
6706 /* Now read; for one reason or another, this will not block.
6707 NREAD is set to the number of chars read. */
6711 cbuf
[0] = dos_keyread ();
6714 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6716 /* POSIX infers that processes which are not in the session leader's
6717 process group won't get SIGHUP's at logout time. BSDI adheres to
6718 this part standard and returns -1 from read (0) with errno==EIO
6719 when the control tty is taken away.
6720 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6721 if (nread
== -1 && errno
== EIO
)
6723 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6724 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6725 This looks incorrect, but it isn't, because _BSD causes
6726 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6727 and that causes a value other than 0 when there is no input. */
6733 /* We used to retry the read if it was interrupted.
6734 But this does the wrong thing when O_NDELAY causes
6735 an EAGAIN error. Does anybody know of a situation
6736 where a retry is actually needed? */
6738 nread
< 0 && (errno
== EAGAIN
6752 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6753 fcntl (input_fd
, F_SETFL
, 0);
6754 #endif /* USG or DGUX or CYGWIN */
6755 #endif /* no FIONREAD */
6756 for (i
= 0; i
< nread
; i
++)
6758 struct input_event buf
;
6760 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6762 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6763 buf
.modifiers
= meta_modifier
;
6768 buf
.frame_or_window
= selected_frame
;
6771 kbd_buffer_store_event (&buf
);
6772 /* Don't look at input that follows a C-g too closely.
6773 This reduces lossage due to autorepeat on C-g. */
6774 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6775 && buf
.code
== quit_char
)
6782 #endif /* not VMS */
6785 handle_async_input ()
6788 extern int select_alarmed
;
6791 interrupt_input_pending
= 0;
6796 nread
= read_avail_input (1);
6797 /* -1 means it's not ok to read the input now.
6798 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6799 0 means there was no keyboard input available. */
6804 select_alarmed
= 1; /* Force the select emulator back to life */
6809 #ifdef SIGIO /* for entire page */
6810 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6813 input_available_signal (signo
)
6816 /* Must preserve main program's value of errno. */
6817 int old_errno
= errno
;
6818 #if defined (USG) && !defined (POSIX_SIGNALS)
6819 /* USG systems forget handlers when they are used;
6820 must reestablish each time */
6821 signal (signo
, input_available_signal
);
6829 interrupt_input_pending
= 1;
6831 SIGNAL_THREAD_CHECK (signo
);
6834 if (input_available_clear_time
)
6835 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6838 handle_async_input ();
6848 /* Send ourselves a SIGIO.
6850 This function exists so that the UNBLOCK_INPUT macro in
6851 blockinput.h can have some way to take care of input we put off
6852 dealing with, without assuming that every file which uses
6853 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6855 reinvoke_input_signal ()
6858 handle_async_input ();
6864 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6865 static Lisp_Object menu_bar_one_keymap_changed_items
;
6867 /* These variables hold the vector under construction within
6868 menu_bar_items and its subroutines, and the current index
6869 for storing into that vector. */
6870 static Lisp_Object menu_bar_items_vector
;
6871 static int menu_bar_items_index
;
6873 /* Return a vector of menu items for a menu bar, appropriate
6874 to the current buffer. Each item has three elements in the vector:
6877 OLD is an old vector we can optionally reuse, or nil. */
6880 menu_bar_items (old
)
6883 /* The number of keymaps we're scanning right now, and the number of
6884 keymaps we have allocated space for. */
6887 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6888 in the current keymaps, or nil where it is not a prefix. */
6891 Lisp_Object def
, tail
;
6900 struct gcpro gcpro1
;
6902 /* In order to build the menus, we need to call the keymap
6903 accessors. They all call QUIT. But this function is called
6904 during redisplay, during which a quit is fatal. So inhibit
6905 quitting while building the menus.
6906 We do this instead of specbind because (1) errors will clear it anyway
6907 and (2) this avoids risk of specpdl overflow. */
6908 oquit
= Vinhibit_quit
;
6912 menu_bar_items_vector
= old
;
6914 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6915 menu_bar_items_index
= 0;
6917 GCPRO1 (menu_bar_items_vector
);
6919 /* Build our list of keymaps.
6920 If we recognize a function key and replace its escape sequence in
6921 keybuf with its symbol, or if the sequence starts with a mouse
6922 click and we need to switch buffers, we jump back here to rebuild
6923 the initial keymaps from the current buffer. */
6927 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6928 if (!NILP (Voverriding_local_map_menu_flag
))
6930 /* Yes, use them (if non-nil) as well as the global map. */
6931 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6933 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6934 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6935 if (!NILP (Voverriding_local_map
))
6936 maps
[nmaps
++] = Voverriding_local_map
;
6940 /* No, so use major and minor mode keymaps and keymap property.
6941 Note that menu-bar bindings in the local-map and keymap
6942 properties may not work reliable, as they are only
6943 recognized when the menu-bar (or mode-line) is updated,
6944 which does not normally happen after every command. */
6947 nminor
= current_minor_maps (NULL
, &tmaps
);
6948 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6950 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6951 maps
[nmaps
++] = tem
;
6952 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6954 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6956 maps
[nmaps
++] = current_global_map
;
6959 /* Look up in each map the dummy prefix key `menu-bar'. */
6963 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6964 if (!NILP (maps
[mapno
]))
6966 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6970 menu_bar_one_keymap_changed_items
= Qnil
;
6971 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6975 /* Move to the end those items that should be at the end. */
6977 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6980 int end
= menu_bar_items_index
;
6982 for (i
= 0; i
< end
; i
+= 4)
6983 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6985 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6986 /* Move the item at index I to the end,
6987 shifting all the others forward. */
6988 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6989 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6990 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6991 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6993 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6994 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6995 (end
- i
- 4) * sizeof (Lisp_Object
));
6996 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6997 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6998 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6999 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7004 /* Add nil, nil, nil, nil at the end. */
7005 i
= menu_bar_items_index
;
7006 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7009 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7010 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7011 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7012 menu_bar_items_vector
= tem
;
7014 /* Add this item. */
7015 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7016 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7017 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7018 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7019 menu_bar_items_index
= i
;
7021 Vinhibit_quit
= oquit
;
7023 return menu_bar_items_vector
;
7026 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7027 If there's already an item for KEY, add this DEF to it. */
7029 Lisp_Object item_properties
;
7032 menu_bar_item (key
, item
, dummy1
, dummy2
)
7033 Lisp_Object key
, item
, dummy1
;
7036 struct gcpro gcpro1
;
7040 if (EQ (item
, Qundefined
))
7042 /* If a map has an explicit `undefined' as definition,
7043 discard any previously made menu bar item. */
7045 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7046 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7048 if (menu_bar_items_index
> i
+ 4)
7049 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7050 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7051 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7052 menu_bar_items_index
-= 4;
7056 /* If this keymap has already contributed to this KEY,
7057 don't contribute to it a second time. */
7058 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7059 if (!NILP (tem
) || NILP (item
))
7062 menu_bar_one_keymap_changed_items
7063 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7065 /* We add to menu_bar_one_keymap_changed_items before doing the
7066 parse_menu_item, so that if it turns out it wasn't a menu item,
7067 it still correctly hides any further menu item. */
7069 i
= parse_menu_item (item
, 0, 1);
7074 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7076 /* Find any existing item for this KEY. */
7077 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7078 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7081 /* If we did not find this KEY, add it at the end. */
7082 if (i
== menu_bar_items_index
)
7084 /* If vector is too small, get a bigger one. */
7085 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7088 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7089 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7090 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7091 menu_bar_items_vector
= tem
;
7094 /* Add this item. */
7095 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7096 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7097 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7098 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7099 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7100 menu_bar_items_index
= i
;
7102 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7106 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7107 /* If the new and the old items are not both keymaps,
7108 the lookup will only find `item'. */
7109 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7110 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7114 /* This is used as the handler when calling menu_item_eval_property. */
7116 menu_item_eval_property_1 (arg
)
7119 /* If we got a quit from within the menu computation,
7120 quit all the way out of it. This takes care of C-] in the debugger. */
7121 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7122 Fsignal (Qquit
, Qnil
);
7127 /* Evaluate an expression and return the result (or nil if something
7128 went wrong). Used to evaluate dynamic parts of menu items. */
7130 menu_item_eval_property (sexpr
)
7133 int count
= SPECPDL_INDEX ();
7135 specbind (Qinhibit_redisplay
, Qt
);
7136 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7137 menu_item_eval_property_1
);
7138 return unbind_to (count
, val
);
7141 /* This function parses a menu item and leaves the result in the
7142 vector item_properties.
7143 ITEM is a key binding, a possible menu item.
7144 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7145 evaluate dynamic expressions in the menu item.
7146 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7148 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7149 parse_menu_item returns true if the item is a menu item and false
7153 parse_menu_item (item
, notreal
, inmenubar
)
7155 int notreal
, inmenubar
;
7157 Lisp_Object def
, tem
, item_string
, start
;
7158 Lisp_Object cachelist
;
7160 Lisp_Object keyhint
;
7171 /* Create item_properties vector if necessary. */
7172 if (NILP (item_properties
))
7174 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7176 /* Initialize optional entries. */
7177 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7178 AREF (item_properties
, i
) = Qnil
;
7179 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7181 /* Save the item here to protect it from GC. */
7182 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7184 item_string
= XCAR (item
);
7188 if (STRINGP (item_string
))
7190 /* Old format menu item. */
7191 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7193 /* Maybe help string. */
7194 if (CONSP (item
) && STRINGP (XCAR (item
)))
7196 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7201 /* Maybe key binding cache. */
7202 if (CONSP (item
) && CONSP (XCAR (item
))
7203 && (NILP (XCAR (XCAR (item
)))
7204 || VECTORP (XCAR (XCAR (item
)))))
7206 cachelist
= XCAR (item
);
7210 /* This is the real definition--the function to run. */
7211 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7213 /* Get enable property, if any. */
7216 tem
= Fget (item
, Qmenu_enable
);
7218 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7221 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7223 /* New format menu item. */
7224 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7225 start
= XCDR (item
);
7228 /* We have a real binding. */
7229 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7231 item
= XCDR (start
);
7232 /* Is there a cache list with key equivalences. */
7233 if (CONSP (item
) && CONSP (XCAR (item
)))
7235 cachelist
= XCAR (item
);
7239 /* Parse properties. */
7240 while (CONSP (item
) && CONSP (XCDR (item
)))
7245 if (EQ (tem
, QCenable
))
7246 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7247 else if (EQ (tem
, QCvisible
) && !notreal
)
7249 /* If got a visible property and that evaluates to nil
7250 then ignore this item. */
7251 tem
= menu_item_eval_property (XCAR (item
));
7255 else if (EQ (tem
, QChelp
))
7256 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7257 else if (EQ (tem
, QCfilter
))
7259 else if (EQ (tem
, QCkey_sequence
))
7262 if (NILP (cachelist
)
7263 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7264 /* Be GC protected. Set keyhint to item instead of tem. */
7267 else if (EQ (tem
, QCkeys
))
7270 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7271 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7273 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7278 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7280 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7282 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7289 else if (inmenubar
|| !NILP (start
))
7293 return 0; /* not a menu item */
7295 /* If item string is not a string, evaluate it to get string.
7296 If we don't get a string, skip this item. */
7297 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7298 if (!(STRINGP (item_string
) || notreal
))
7300 item_string
= menu_item_eval_property (item_string
);
7301 if (!STRINGP (item_string
))
7303 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7306 /* If got a filter apply it on definition. */
7307 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7310 def
= menu_item_eval_property (list2 (XCAR (filter
),
7311 list2 (Qquote
, def
)));
7313 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7316 /* Enable or disable selection of item. */
7317 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7323 tem
= menu_item_eval_property (tem
);
7324 if (inmenubar
&& NILP (tem
))
7325 return 0; /* Ignore disabled items in menu bar. */
7326 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7329 /* If we got no definition, this item is just unselectable text which
7330 is OK in a submenu but not in the menubar. */
7332 return (inmenubar
? 0 : 1);
7334 /* See if this is a separate pane or a submenu. */
7335 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7336 tem
= get_keymap (def
, 0, 1);
7337 /* For a subkeymap, just record its details and exit. */
7340 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7341 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7345 /* At the top level in the menu bar, do likewise for commands also.
7346 The menu bar does not display equivalent key bindings anyway.
7347 ITEM_PROPERTY_DEF is already set up properly. */
7351 /* This is a command. See if there is an equivalent key binding. */
7352 if (NILP (cachelist
))
7354 /* We have to create a cachelist. */
7355 CHECK_IMPURE (start
);
7356 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7357 cachelist
= XCAR (XCDR (start
));
7359 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7360 if (!NILP (keyhint
))
7362 XSETCAR (cachelist
, XCAR (keyhint
));
7365 else if (STRINGP (tem
))
7367 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7368 XSETCAR (cachelist
, Qt
);
7372 tem
= XCAR (cachelist
);
7379 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7381 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7384 def
= XCAR (prefix
);
7385 prefix
= XCDR (prefix
);
7388 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7390 if (!update_menu_bindings
)
7392 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7394 if (newcache
/* Always check first time. */
7395 /* Should we check everything when precomputing key
7397 /* If something had no key binding before, don't recheck it
7398 because that is too slow--except if we have a list of
7399 rebound commands in Vdefine_key_rebound_commands, do
7400 recheck any command that appears in that list. */
7401 || (CONSP (Vdefine_key_rebound_commands
)
7402 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7405 /* We had a saved key. Is it still bound to the command? */
7408 /* If the command is an alias for another
7409 (such as lmenu.el set it up), check if the
7410 original command matches the cached command. */
7411 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7412 chkcache
= 1; /* Need to recompute key binding. */
7416 /* Recompute equivalent key binding. If the command is an alias
7417 for another (such as lmenu.el set it up), see if the original
7418 command name has equivalent keys. Otherwise look up the
7419 specified command itself. We don't try both, because that
7420 makes lmenu menus slow. */
7422 && SYMBOLP (XSYMBOL (def
)->function
)
7423 && ! NILP (Fget (def
, Qmenu_alias
)))
7424 def
= XSYMBOL (def
)->function
;
7425 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7426 XSETCAR (cachelist
, tem
);
7429 XSETCDR (cachelist
, Qnil
);
7433 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7435 tem
= XCAR (cachelist
);
7439 newcache
= chkcache
;
7442 tem
= Fkey_description (tem
, Qnil
);
7445 if (STRINGP (XCAR (prefix
)))
7446 tem
= concat2 (XCAR (prefix
), tem
);
7447 if (STRINGP (XCDR (prefix
)))
7448 tem
= concat2 (tem
, XCDR (prefix
));
7450 XSETCDR (cachelist
, tem
);
7454 tem
= XCDR (cachelist
);
7455 if (newcache
&& !NILP (tem
))
7457 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7458 XSETCDR (cachelist
, tem
);
7461 /* If we only want to precompute equivalent key bindings, stop here. */
7465 /* If we have an equivalent key binding, use that. */
7466 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7468 /* Include this when menu help is implemented.
7469 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7470 if (!(NILP (tem) || STRINGP (tem)))
7472 tem = menu_item_eval_property (tem);
7475 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7479 /* Handle radio buttons or toggle boxes. */
7480 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7482 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7483 = menu_item_eval_property (tem
);
7490 /***********************************************************************
7492 ***********************************************************************/
7494 /* A vector holding tool bar items while they are parsed in function
7495 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7498 static Lisp_Object tool_bar_items_vector
;
7500 /* A vector holding the result of parse_tool_bar_item. Layout is like
7501 the one for a single item in tool_bar_items_vector. */
7503 static Lisp_Object tool_bar_item_properties
;
7505 /* Next free index in tool_bar_items_vector. */
7507 static int ntool_bar_items
;
7509 /* The symbols `tool-bar', and `:image'. */
7511 extern Lisp_Object Qtool_bar
;
7512 Lisp_Object QCimage
;
7514 /* Function prototypes. */
7516 static void init_tool_bar_items
P_ ((Lisp_Object
));
7517 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7518 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7519 static void append_tool_bar_item
P_ ((void));
7522 /* Return a vector of tool bar items for keymaps currently in effect.
7523 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7524 tool bar items found. */
7527 tool_bar_items (reuse
, nitems
)
7538 /* In order to build the menus, we need to call the keymap
7539 accessors. They all call QUIT. But this function is called
7540 during redisplay, during which a quit is fatal. So inhibit
7541 quitting while building the menus. We do this instead of
7542 specbind because (1) errors will clear it anyway and (2) this
7543 avoids risk of specpdl overflow. */
7544 oquit
= Vinhibit_quit
;
7547 /* Initialize tool_bar_items_vector and protect it from GC. */
7548 init_tool_bar_items (reuse
);
7550 /* Build list of keymaps in maps. Set nmaps to the number of maps
7553 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7554 if (!NILP (Voverriding_local_map_menu_flag
))
7556 /* Yes, use them (if non-nil) as well as the global map. */
7557 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7559 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7560 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7561 if (!NILP (Voverriding_local_map
))
7562 maps
[nmaps
++] = Voverriding_local_map
;
7566 /* No, so use major and minor mode keymaps and keymap property.
7567 Note that tool-bar bindings in the local-map and keymap
7568 properties may not work reliable, as they are only
7569 recognized when the tool-bar (or mode-line) is updated,
7570 which does not normally happen after every command. */
7573 nminor
= current_minor_maps (NULL
, &tmaps
);
7574 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7576 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7577 maps
[nmaps
++] = tem
;
7578 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7580 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7583 /* Add global keymap at the end. */
7584 maps
[nmaps
++] = current_global_map
;
7586 /* Process maps in reverse order and look up in each map the prefix
7588 for (i
= nmaps
- 1; i
>= 0; --i
)
7589 if (!NILP (maps
[i
]))
7593 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7598 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7599 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7601 Lisp_Object keydef
= XCAR (tail
);
7603 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7608 Vinhibit_quit
= oquit
;
7609 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7610 return tool_bar_items_vector
;
7614 /* Process the definition of KEY which is DEF. */
7617 process_tool_bar_item (key
, def
)
7618 Lisp_Object key
, def
;
7621 extern Lisp_Object Qundefined
;
7622 struct gcpro gcpro1
, gcpro2
;
7624 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7628 if (EQ (def
, Qundefined
))
7630 /* If a map has an explicit `undefined' as definition,
7631 discard any previously made item. */
7632 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7634 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7636 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7638 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7639 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7640 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7641 * sizeof (Lisp_Object
)));
7642 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7647 else if (parse_tool_bar_item (key
, def
))
7648 /* Append a new tool bar item to tool_bar_items_vector. Accept
7649 more than one definition for the same key. */
7650 append_tool_bar_item ();
7656 /* Parse a tool bar item specification ITEM for key KEY and return the
7657 result in tool_bar_item_properties. Value is zero if ITEM is
7660 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7662 CAPTION is the caption of the item, If it's not a string, it is
7663 evaluated to get a string.
7665 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7666 as binding are currently ignored.
7668 The following properties are recognized:
7672 FORM is evaluated and specifies whether the tool bar item is
7673 enabled or disabled.
7677 FORM is evaluated and specifies whether the tool bar item is visible.
7679 - `:filter FUNCTION'
7681 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7682 result is stored as the new binding.
7684 - `:button (TYPE SELECTED)'
7686 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7687 and specifies whether the button is selected (pressed) or not.
7691 IMAGES is either a single image specification or a vector of four
7692 image specifications. See enum tool_bar_item_images.
7694 - `:help HELP-STRING'.
7696 Gives a help string to display for the tool bar item. */
7699 parse_tool_bar_item (key
, item
)
7700 Lisp_Object key
, item
;
7702 /* Access slot with index IDX of vector tool_bar_item_properties. */
7703 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7705 Lisp_Object filter
= Qnil
;
7706 Lisp_Object caption
;
7709 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7710 Rule out items that aren't lists, don't start with
7711 `menu-item' or whose rest following `tool-bar-item' is not a
7714 || !EQ (XCAR (item
), Qmenu_item
)
7715 || (item
= XCDR (item
),
7719 /* Create tool_bar_item_properties vector if necessary. Reset it to
7721 if (VECTORP (tool_bar_item_properties
))
7723 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7727 tool_bar_item_properties
7728 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7731 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7732 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7734 /* Get the caption of the item. If the caption is not a string,
7735 evaluate it to get a string. If we don't get a string, skip this
7737 caption
= XCAR (item
);
7738 if (!STRINGP (caption
))
7740 caption
= menu_item_eval_property (caption
);
7741 if (!STRINGP (caption
))
7744 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7746 /* Give up if rest following the caption is not a list. */
7751 /* Store the binding. */
7752 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7755 /* Ignore cached key binding, if any. */
7756 if (CONSP (item
) && CONSP (XCAR (item
)))
7759 /* Process the rest of the properties. */
7760 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7762 Lisp_Object key
, value
;
7765 value
= XCAR (XCDR (item
));
7767 if (EQ (key
, QCenable
))
7768 /* `:enable FORM'. */
7769 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7770 else if (EQ (key
, QCvisible
))
7772 /* `:visible FORM'. If got a visible property and that
7773 evaluates to nil then ignore this item. */
7774 if (NILP (menu_item_eval_property (value
)))
7777 else if (EQ (key
, QChelp
))
7778 /* `:help HELP-STRING'. */
7779 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7780 else if (EQ (key
, QCfilter
))
7781 /* ':filter FORM'. */
7783 else if (EQ (key
, QCbutton
) && CONSP (value
))
7785 /* `:button (TYPE . SELECTED)'. */
7786 Lisp_Object type
, selected
;
7788 type
= XCAR (value
);
7789 selected
= XCDR (value
);
7790 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7792 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7793 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7796 else if (EQ (key
, QCimage
)
7798 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7799 /* Value is either a single image specification or a vector
7800 of 4 such specifications for the different button states. */
7801 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7804 /* If got a filter apply it on binding. */
7806 PROP (TOOL_BAR_ITEM_BINDING
)
7807 = menu_item_eval_property (list2 (filter
,
7809 PROP (TOOL_BAR_ITEM_BINDING
))));
7811 /* See if the binding is a keymap. Give up if it is. */
7812 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7815 /* Enable or disable selection of item. */
7816 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7817 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7818 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7820 /* Handle radio buttons or toggle boxes. */
7821 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7822 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7823 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7831 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7832 that can be reused. */
7835 init_tool_bar_items (reuse
)
7838 if (VECTORP (reuse
))
7839 tool_bar_items_vector
= reuse
;
7841 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7842 ntool_bar_items
= 0;
7846 /* Append parsed tool bar item properties from
7847 tool_bar_item_properties */
7850 append_tool_bar_item ()
7852 Lisp_Object
*to
, *from
;
7854 /* Enlarge tool_bar_items_vector if necessary. */
7855 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7856 >= XVECTOR (tool_bar_items_vector
)->size
)
7858 Lisp_Object new_vector
;
7859 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7861 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7862 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7863 XVECTOR (new_vector
)->contents
,
7864 old_size
* sizeof (Lisp_Object
));
7865 tool_bar_items_vector
= new_vector
;
7868 /* Append entries from tool_bar_item_properties to the end of
7869 tool_bar_items_vector. */
7870 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7871 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7872 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7873 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7880 /* Read a character using menus based on maps in the array MAPS.
7881 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7882 Return t if we displayed a menu but the user rejected it.
7884 PREV_EVENT is the previous input event, or nil if we are reading
7885 the first event of a key sequence.
7887 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7888 if we used a mouse menu to read the input, or zero otherwise. If
7889 USED_MOUSE_MENU is null, we don't dereference it.
7891 The prompting is done based on the prompt-string of the map
7892 and the strings associated with various map elements.
7894 This can be done with X menus or with menus put in the minibuf.
7895 These are done in different ways, depending on how the input will be read.
7896 Menus using X are done after auto-saving in read-char, getting the input
7897 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7898 and do auto-saving in the inner call of read_char. */
7901 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7904 Lisp_Object prev_event
;
7905 int *used_mouse_menu
;
7908 register Lisp_Object name
= Qnil
;
7910 if (used_mouse_menu
)
7911 *used_mouse_menu
= 0;
7913 /* Use local over global Menu maps */
7915 if (! menu_prompting
)
7918 /* Optionally disregard all but the global map. */
7919 if (inhibit_local_menu_bar_menus
)
7921 maps
+= (nmaps
- 1);
7925 /* Get the menu name from the first map that has one (a prompt string). */
7926 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7928 name
= Fkeymap_prompt (maps
[mapno
]);
7933 /* If we don't have any menus, just read a character normally. */
7934 if (!STRINGP (name
))
7938 /* If we got to this point via a mouse click,
7939 use a real menu for mouse selection. */
7940 if (EVENT_HAS_PARAMETERS (prev_event
)
7941 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7942 && !EQ (XCAR (prev_event
), Qtool_bar
))
7944 /* Display the menu and get the selection. */
7945 Lisp_Object
*realmaps
7946 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7950 /* Use the maps that are not nil. */
7951 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7952 if (!NILP (maps
[mapno
]))
7953 realmaps
[nmaps1
++] = maps
[mapno
];
7955 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7960 record_menu_key (XCAR (value
));
7962 /* If we got multiple events, unread all but
7964 There is no way to prevent those unread events
7965 from showing up later in last_nonmenu_event.
7966 So turn symbol and integer events into lists,
7967 to indicate that they came from a mouse menu,
7968 so that when present in last_nonmenu_event
7969 they won't confuse things. */
7970 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7972 record_menu_key (XCAR (tem
));
7973 if (SYMBOLP (XCAR (tem
))
7974 || INTEGERP (XCAR (tem
)))
7975 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7978 /* If we got more than one event, put all but the first
7979 onto this list to be read later.
7980 Return just the first event now. */
7981 Vunread_command_events
7982 = nconc2 (XCDR (value
), Vunread_command_events
);
7983 value
= XCAR (value
);
7985 else if (NILP (value
))
7987 if (used_mouse_menu
)
7988 *used_mouse_menu
= 1;
7991 #endif /* HAVE_MENUS */
7995 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7996 We make this bigger when necessary, and never free it. */
7997 static char *read_char_minibuf_menu_text
;
7998 /* Size of that buffer. */
7999 static int read_char_minibuf_menu_width
;
8002 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8008 register Lisp_Object name
;
8010 /* FIXME: Use the minibuffer's frame width. */
8011 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8014 Lisp_Object rest
, vector
;
8020 if (! menu_prompting
)
8023 /* Make sure we have a big enough buffer for the menu text. */
8024 if (read_char_minibuf_menu_text
== 0)
8026 read_char_minibuf_menu_width
= width
+ 4;
8027 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8029 else if (width
+ 4 > read_char_minibuf_menu_width
)
8031 read_char_minibuf_menu_width
= width
+ 4;
8032 read_char_minibuf_menu_text
8033 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8035 menu
= read_char_minibuf_menu_text
;
8037 /* Get the menu name from the first map that has one (a prompt string). */
8038 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8040 name
= Fkeymap_prompt (maps
[mapno
]);
8045 /* If we don't have any menus, just read a character normally. */
8046 if (!STRINGP (name
))
8049 /* Prompt string always starts with map's prompt, and a space. */
8050 strcpy (menu
, SDATA (name
));
8051 nlength
= SBYTES (name
);
8052 menu
[nlength
++] = ':';
8053 menu
[nlength
++] = ' ';
8056 /* Start prompting at start of first map. */
8060 /* Present the documented bindings, a line at a time. */
8067 Lisp_Object orig_defn_macro
;
8069 /* Loop over elements of map. */
8074 /* If reached end of map, start at beginning of next map. */
8078 /* At end of last map, wrap around to first map if just starting,
8079 or end this line if already have something on it. */
8083 if (notfirst
|| nobindings
) break;
8088 /* Look at the next element of the map. */
8090 elt
= XVECTOR (vector
)->contents
[idx
];
8092 elt
= Fcar_safe (rest
);
8094 if (idx
< 0 && VECTORP (elt
))
8096 /* If we found a dense table in the keymap,
8097 advanced past it, but start scanning its contents. */
8098 rest
= Fcdr_safe (rest
);
8104 /* An ordinary element. */
8105 Lisp_Object event
, tem
;
8109 event
= Fcar_safe (elt
); /* alist */
8110 elt
= Fcdr_safe (elt
);
8114 XSETINT (event
, idx
); /* vector */
8117 /* Ignore the element if it has no prompt string. */
8118 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8120 /* 1 if the char to type matches the string. */
8122 Lisp_Object upcased_event
, downcased_event
;
8123 Lisp_Object desc
= Qnil
;
8125 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8127 upcased_event
= Fupcase (event
);
8128 downcased_event
= Fdowncase (event
);
8129 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8130 || XINT (downcased_event
) == SREF (s
, 0));
8132 desc
= Fsingle_key_description (event
, Qnil
);
8134 #if 0 /* It is redundant to list the equivalent key bindings because
8135 the prefix is what the user has already typed. */
8137 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8139 /* Insert equivalent keybinding. */
8140 s
= concat2 (s
, tem
);
8143 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8144 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8146 /* Insert button prefix. */
8147 Lisp_Object selected
8148 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8149 if (EQ (tem
, QCradio
))
8150 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8152 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8153 s
= concat2 (tem
, s
);
8157 /* If we have room for the prompt string, add it to this line.
8158 If this is the first on the line, always add it. */
8159 if ((SCHARS (s
) + i
+ 2
8160 + (char_matches
? 0 : SCHARS (desc
) + 3))
8166 /* Punctuate between strings. */
8169 strcpy (menu
+ i
, ", ");
8175 /* If the char to type doesn't match the string's
8176 first char, explicitly show what char to type. */
8179 /* Add as much of string as fits. */
8180 thiswidth
= SCHARS (desc
);
8181 if (thiswidth
+ i
> width
)
8182 thiswidth
= width
- i
;
8183 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8185 strcpy (menu
+ i
, " = ");
8189 /* Add as much of string as fits. */
8190 thiswidth
= SCHARS (s
);
8191 if (thiswidth
+ i
> width
)
8192 thiswidth
= width
- i
;
8193 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8199 /* If this element does not fit, end the line now,
8200 and save the element for the next line. */
8201 strcpy (menu
+ i
, "...");
8206 /* Move past this element. */
8207 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8208 /* Handle reaching end of dense table. */
8213 rest
= Fcdr_safe (rest
);
8217 /* Prompt with that and read response. */
8218 message2_nolog (menu
, strlen (menu
),
8219 ! NILP (current_buffer
->enable_multibyte_characters
));
8221 /* Make believe its not a keyboard macro in case the help char
8222 is pressed. Help characters are not recorded because menu prompting
8223 is not used on replay.
8225 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8226 current_kboard
->defining_kbd_macro
= Qnil
;
8228 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8229 while (BUFFERP (obj
));
8230 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8232 if (!INTEGERP (obj
))
8237 if (! EQ (obj
, menu_prompt_more_char
)
8238 && (!INTEGERP (menu_prompt_more_char
)
8239 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8241 if (!NILP (current_kboard
->defining_kbd_macro
))
8242 store_kbd_macro_char (obj
);
8245 /* Help char - go round again */
8249 /* Reading key sequences. */
8251 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8252 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8253 keymap, or nil otherwise. Return the index of the first keymap in
8254 which KEY has any binding, or NMAPS if no map has a binding.
8256 If KEY is a meta ASCII character, treat it like meta-prefix-char
8257 followed by the corresponding non-meta character. Keymaps in
8258 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8261 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8264 NEXT may be the same array as CURRENT. */
8267 follow_key (key
, nmaps
, current
, defs
, next
)
8269 Lisp_Object
*current
, *defs
, *next
;
8272 int i
, first_binding
;
8274 first_binding
= nmaps
;
8275 for (i
= nmaps
- 1; i
>= 0; i
--)
8277 if (! NILP (current
[i
]))
8279 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8280 if (! NILP (defs
[i
]))
8287 /* Given the set of bindings we've found, produce the next set of maps. */
8288 if (first_binding
< nmaps
)
8289 for (i
= 0; i
< nmaps
; i
++)
8290 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8292 return first_binding
;
8295 /* Structure used to keep track of partial application of key remapping
8296 such as Vfunction_key_map and Vkey_translation_map. */
8297 typedef struct keyremap
8299 Lisp_Object map
, parent
;
8303 /* Lookup KEY in MAP.
8304 MAP is a keymap mapping keys to key vectors or functions.
8305 If the mapping is a function and DO_FUNCTION is non-zero, then
8306 the function is called with PROMPT as parameter and its return
8307 value is used as the return value of this function (after checking
8308 that it is indeed a vector). */
8311 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8312 Lisp_Object map
, key
, prompt
;
8317 next
= access_keymap (map
, key
, 1, 0, 1);
8319 /* Handle symbol with autoload definition. */
8320 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8321 && CONSP (XSYMBOL (next
)->function
)
8322 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8323 do_autoload (XSYMBOL (next
)->function
, next
);
8325 /* Handle a symbol whose function definition is a keymap
8327 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8328 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8329 || KEYMAPP (XSYMBOL (next
)->function
)))
8330 next
= XSYMBOL (next
)->function
;
8332 /* If the keymap gives a function, not an
8333 array, then call the function with one arg and use
8334 its value instead. */
8335 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8340 next
= call1 (next
, prompt
);
8341 /* If the function returned something invalid,
8342 barf--don't ignore it.
8343 (To ignore it safely, we would need to gcpro a bunch of
8344 other variables.) */
8345 if (! (VECTORP (next
) || STRINGP (next
)))
8346 error ("Function %s returns invalid key sequence", tem
);
8351 /* Do one step of the key remapping used for function-key-map and
8352 key-translation-map:
8353 KEYBUF is the buffer holding the input events.
8354 BUFSIZE is its maximum size.
8355 FKEY is a pointer to the keyremap structure to use.
8356 INPUT is the index of the last element in KEYBUF.
8357 DOIT if non-zero says that the remapping can actually take place.
8358 DIFF is used to return the number of keys added/removed by the remapping.
8359 PARENT is the root of the keymap.
8360 PROMPT is the prompt to use if the remapping happens through a function.
8361 The return value is non-zero if the remapping actually took place. */
8364 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8365 Lisp_Object
*keybuf
, prompt
;
8367 int input
, doit
, *diff
, bufsize
;
8369 Lisp_Object next
, key
;
8371 key
= keybuf
[fkey
->end
++];
8372 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8374 /* If keybuf[fkey->start..fkey->end] is bound in the
8375 map and we're in a position to do the key remapping, replace it with
8376 the binding and restart with fkey->start at the end. */
8377 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8379 int len
= XFASTINT (Flength (next
));
8382 *diff
= len
- (fkey
->end
- fkey
->start
);
8384 if (input
+ *diff
>= bufsize
)
8385 error ("Key sequence too long");
8387 /* Shift the keys that follow fkey->end. */
8389 for (i
= fkey
->end
; i
< input
; i
++)
8390 keybuf
[i
+ *diff
] = keybuf
[i
];
8392 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8393 keybuf
[i
+ *diff
] = keybuf
[i
];
8394 /* Overwrite the old keys with the new ones. */
8395 for (i
= 0; i
< len
; i
++)
8396 keybuf
[fkey
->start
+ i
]
8397 = Faref (next
, make_number (i
));
8399 fkey
->start
= fkey
->end
+= *diff
;
8400 fkey
->map
= fkey
->parent
;
8405 fkey
->map
= get_keymap (next
, 0, 1);
8407 /* If we no longer have a bound suffix, try a new position for
8409 if (!CONSP (fkey
->map
))
8411 fkey
->end
= ++fkey
->start
;
8412 fkey
->map
= fkey
->parent
;
8417 /* Read a sequence of keys that ends with a non prefix character,
8418 storing it in KEYBUF, a buffer of size BUFSIZE.
8420 Return the length of the key sequence stored.
8421 Return -1 if the user rejected a command menu.
8423 Echo starting immediately unless `prompt' is 0.
8425 Where a key sequence ends depends on the currently active keymaps.
8426 These include any minor mode keymaps active in the current buffer,
8427 the current buffer's local map, and the global map.
8429 If a key sequence has no other bindings, we check Vfunction_key_map
8430 to see if some trailing subsequence might be the beginning of a
8431 function key's sequence. If so, we try to read the whole function
8432 key, and substitute its symbolic name into the key sequence.
8434 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8435 `double-' events into similar click events, if that would make them
8436 bound. We try to turn `triple-' events first into `double-' events,
8439 If we get a mouse click in a mode line, vertical divider, or other
8440 non-text area, we treat the click as if it were prefixed by the
8441 symbol denoting that area - `mode-line', `vertical-line', or
8444 If the sequence starts with a mouse click, we read the key sequence
8445 with respect to the buffer clicked on, not the current buffer.
8447 If the user switches frames in the midst of a key sequence, we put
8448 off the switch-frame event until later; the next call to
8449 read_char will return it.
8451 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8452 from the selected window's buffer. */
8455 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8456 can_return_switch_frame
, fix_current_buffer
)
8457 Lisp_Object
*keybuf
;
8460 int dont_downcase_last
;
8461 int can_return_switch_frame
;
8462 int fix_current_buffer
;
8464 volatile Lisp_Object from_string
;
8465 volatile int count
= SPECPDL_INDEX ();
8467 /* How many keys there are in the current key sequence. */
8470 /* The length of the echo buffer when we started reading, and
8471 the length of this_command_keys when we started reading. */
8472 volatile int echo_start
;
8473 volatile int keys_start
;
8475 /* The number of keymaps we're scanning right now, and the number of
8476 keymaps we have allocated space for. */
8478 volatile int nmaps_allocated
= 0;
8480 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8481 the current keymaps. */
8482 Lisp_Object
*volatile defs
= NULL
;
8484 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8485 in the current keymaps, or nil where it is not a prefix. */
8486 Lisp_Object
*volatile submaps
= NULL
;
8488 /* The local map to start out with at start of key sequence. */
8489 volatile Lisp_Object orig_local_map
;
8491 /* The map from the `keymap' property to start out with at start of
8493 volatile Lisp_Object orig_keymap
;
8495 /* 1 if we have already considered switching to the local-map property
8496 of the place where a mouse click occurred. */
8497 volatile int localized_local_map
= 0;
8499 /* The index in defs[] of the first keymap that has a binding for
8500 this key sequence. In other words, the lowest i such that
8501 defs[i] is non-nil. */
8502 volatile int first_binding
;
8503 /* Index of the first key that has no binding.
8504 It is useless to try fkey.start larger than that. */
8505 volatile int first_unbound
;
8507 /* If t < mock_input, then KEYBUF[t] should be read as the next
8510 We use this to recover after recognizing a function key. Once we
8511 realize that a suffix of the current key sequence is actually a
8512 function key's escape sequence, we replace the suffix with the
8513 function key's binding from Vfunction_key_map. Now keybuf
8514 contains a new and different key sequence, so the echo area,
8515 this_command_keys, and the submaps and defs arrays are wrong. In
8516 this situation, we set mock_input to t, set t to 0, and jump to
8517 restart_sequence; the loop will read keys from keybuf up until
8518 mock_input, thus rebuilding the state; and then it will resume
8519 reading characters from the keyboard. */
8520 volatile int mock_input
= 0;
8522 /* If the sequence is unbound in submaps[], then
8523 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8524 and fkey.map is its binding.
8526 These might be > t, indicating that all function key scanning
8527 should hold off until t reaches them. We do this when we've just
8528 recognized a function key, to avoid searching for the function
8529 key's again in Vfunction_key_map. */
8530 volatile keyremap fkey
;
8532 /* Likewise, for key_translation_map. */
8533 volatile keyremap keytran
;
8535 /* If we receive a `switch-frame' or `select-window' event in the middle of
8536 a key sequence, we put it off for later.
8537 While we're reading, we keep the event here. */
8538 volatile Lisp_Object delayed_switch_frame
;
8540 /* See the comment below... */
8541 #if defined (GOBBLE_FIRST_EVENT)
8542 Lisp_Object first_event
;
8545 volatile Lisp_Object original_uppercase
;
8546 volatile int original_uppercase_position
= -1;
8548 /* Gets around Microsoft compiler limitations. */
8551 struct buffer
*starting_buffer
;
8553 /* List of events for which a fake prefix key has been generated. */
8554 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8556 #if defined (GOBBLE_FIRST_EVENT)
8560 struct gcpro gcpro1
;
8562 GCPRO1 (fake_prefixed_keys
);
8563 raw_keybuf_count
= 0;
8565 last_nonmenu_event
= Qnil
;
8567 delayed_switch_frame
= Qnil
;
8568 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8569 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8570 /* If there is no translation-map, turn off scanning. */
8571 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8572 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8577 echo_prompt (prompt
);
8578 else if (cursor_in_echo_area
8579 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8580 && NILP (Fzerop (Vecho_keystrokes
)))
8581 /* This doesn't put in a dash if the echo buffer is empty, so
8582 you don't always see a dash hanging out in the minibuffer. */
8586 /* Record the initial state of the echo area and this_command_keys;
8587 we will need to restore them if we replay a key sequence. */
8589 echo_start
= echo_length ();
8590 keys_start
= this_command_key_count
;
8591 this_single_command_key_start
= keys_start
;
8593 #if defined (GOBBLE_FIRST_EVENT)
8594 /* This doesn't quite work, because some of the things that read_char
8595 does cannot safely be bypassed. It seems too risky to try to make
8598 /* Read the first char of the sequence specially, before setting
8599 up any keymaps, in case a filter runs and switches buffers on us. */
8600 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8602 #endif /* GOBBLE_FIRST_EVENT */
8604 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8605 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8608 /* We jump here when the key sequence has been thoroughly changed, and
8609 we need to rescan it starting from the beginning. When we jump here,
8610 keybuf[0..mock_input] holds the sequence we should reread. */
8613 starting_buffer
= current_buffer
;
8614 first_unbound
= bufsize
+ 1;
8616 /* Build our list of keymaps.
8617 If we recognize a function key and replace its escape sequence in
8618 keybuf with its symbol, or if the sequence starts with a mouse
8619 click and we need to switch buffers, we jump back here to rebuild
8620 the initial keymaps from the current buffer. */
8623 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8624 || !NILP (Voverriding_local_map
))
8626 if (3 > nmaps_allocated
)
8628 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8629 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8630 nmaps_allocated
= 3;
8632 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8633 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8634 if (!NILP (Voverriding_local_map
))
8635 submaps
[nmaps
++] = Voverriding_local_map
;
8643 nminor
= current_minor_maps (0, &maps
);
8644 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8646 if (total
> nmaps_allocated
)
8648 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8649 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8650 nmaps_allocated
= total
;
8653 if (!NILP (orig_keymap
))
8654 submaps
[nmaps
++] = orig_keymap
;
8656 bcopy (maps
, (void *) (submaps
+ nmaps
),
8657 nminor
* sizeof (submaps
[0]));
8661 submaps
[nmaps
++] = orig_local_map
;
8663 submaps
[nmaps
++] = current_global_map
;
8665 /* Find an accurate initial value for first_binding. */
8666 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8667 if (! NILP (submaps
[first_binding
]))
8670 /* Start from the beginning in keybuf. */
8673 /* These are no-ops the first time through, but if we restart, they
8674 revert the echo area and this_command_keys to their original state. */
8675 this_command_key_count
= keys_start
;
8676 if (INTERACTIVE
&& t
< mock_input
)
8677 echo_truncate (echo_start
);
8679 /* If the best binding for the current key sequence is a keymap, or
8680 we may be looking at a function key's escape sequence, keep on
8682 while (first_binding
< nmaps
8683 /* Keep reading as long as there's a prefix binding. */
8684 ? !NILP (submaps
[first_binding
])
8685 /* Don't return in the middle of a possible function key sequence,
8686 if the only bindings we found were via case conversion.
8687 Thus, if ESC O a has a function-key-map translation
8688 and ESC o has a binding, don't return after ESC O,
8689 so that we can translate ESC O plus the next character. */
8690 : (fkey
.start
< t
|| keytran
.start
< t
))
8693 int used_mouse_menu
= 0;
8695 /* Where the last real key started. If we need to throw away a
8696 key that has expanded into more than one element of keybuf
8697 (say, a mouse click on the mode line which is being treated
8698 as [mode-line (mouse-...)], then we backtrack to this point
8700 volatile int last_real_key_start
;
8702 /* These variables are analogous to echo_start and keys_start;
8703 while those allow us to restart the entire key sequence,
8704 echo_local_start and keys_local_start allow us to throw away
8706 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8708 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8709 eassert (fkey
.start
<= fkey
.end
);
8710 eassert (keytran
.start
<= keytran
.end
);
8711 /* key-translation-map is applied *after* function-key-map. */
8712 eassert (keytran
.end
<= fkey
.start
);
8714 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8715 { /* The prefix upto first_unbound has no binding and has
8716 no translation left to do either, so we know it's unbound.
8717 If we don't stop now, we risk staying here indefinitely
8718 (if the user keeps entering fkey or keytran prefixes
8719 like C-c ESC ESC ESC ESC ...) */
8721 for (i
= first_unbound
+ 1; i
< t
; i
++)
8722 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8723 mock_input
= t
- first_unbound
- 1;
8724 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8725 fkey
.map
= fkey
.parent
;
8726 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8727 keytran
.map
= keytran
.parent
;
8728 goto replay_sequence
;
8732 error ("Key sequence too long");
8735 echo_local_start
= echo_length ();
8736 keys_local_start
= this_command_key_count
;
8737 local_first_binding
= first_binding
;
8740 /* These are no-ops, unless we throw away a keystroke below and
8741 jumped back up to replay_key; in that case, these restore the
8742 variables to their original state, allowing us to replay the
8744 if (INTERACTIVE
&& t
< mock_input
)
8745 echo_truncate (echo_local_start
);
8746 this_command_key_count
= keys_local_start
;
8747 first_binding
= local_first_binding
;
8749 /* By default, assume each event is "real". */
8750 last_real_key_start
= t
;
8752 /* Does mock_input indicate that we are re-reading a key sequence? */
8756 add_command_key (key
);
8757 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8758 && NILP (Fzerop (Vecho_keystrokes
)))
8762 /* If not, we should actually read a character. */
8767 KBOARD
*interrupted_kboard
= current_kboard
;
8768 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8769 if (setjmp (wrong_kboard_jmpbuf
))
8771 if (!NILP (delayed_switch_frame
))
8773 interrupted_kboard
->kbd_queue
8774 = Fcons (delayed_switch_frame
,
8775 interrupted_kboard
->kbd_queue
);
8776 delayed_switch_frame
= Qnil
;
8779 interrupted_kboard
->kbd_queue
8780 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8782 /* If the side queue is non-empty, ensure it begins with a
8783 switch-frame, so we'll replay it in the right context. */
8784 if (CONSP (interrupted_kboard
->kbd_queue
)
8785 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8786 !(EVENT_HAS_PARAMETERS (key
)
8787 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8791 XSETFRAME (frame
, interrupted_frame
);
8792 interrupted_kboard
->kbd_queue
8793 = Fcons (make_lispy_switch_frame (frame
),
8794 interrupted_kboard
->kbd_queue
);
8797 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8798 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8799 goto replay_sequence
;
8802 key
= read_char (NILP (prompt
), nmaps
,
8803 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8807 /* read_char returns t when it shows a menu and the user rejects it.
8811 unbind_to (count
, Qnil
);
8816 /* read_char returns -1 at the end of a macro.
8817 Emacs 18 handles this by returning immediately with a
8818 zero, so that's what we'll do. */
8819 if (INTEGERP (key
) && XINT (key
) == -1)
8822 /* The Microsoft C compiler can't handle the goto that
8828 /* If the current buffer has been changed from under us, the
8829 keymap may have changed, so replay the sequence. */
8832 timer_resume_idle ();
8835 /* Reset the current buffer from the selected window
8836 in case something changed the former and not the latter.
8837 This is to be more consistent with the behavior
8838 of the command_loop_1. */
8839 if (fix_current_buffer
)
8841 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8843 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8844 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8847 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8848 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8849 goto replay_sequence
;
8852 /* If we have a quit that was typed in another frame, and
8853 quit_throw_to_read_char switched buffers,
8854 replay to get the right keymap. */
8856 && XINT (key
) == quit_char
8857 && current_buffer
!= starting_buffer
)
8860 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8864 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8865 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8866 goto replay_sequence
;
8871 if (EVENT_HAS_PARAMETERS (key
)
8872 /* Either a `switch-frame' or a `select-window' event. */
8873 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8875 /* If we're at the beginning of a key sequence, and the caller
8876 says it's okay, go ahead and return this event. If we're
8877 in the midst of a key sequence, delay it until the end. */
8878 if (t
> 0 || !can_return_switch_frame
)
8880 delayed_switch_frame
= key
;
8886 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8889 /* Clicks in non-text areas get prefixed by the symbol
8890 in their CHAR-ADDRESS field. For example, a click on
8891 the mode line is prefixed by the symbol `mode-line'.
8893 Furthermore, key sequences beginning with mouse clicks
8894 are read using the keymaps of the buffer clicked on, not
8895 the current buffer. So we may have to switch the buffer
8898 When we turn one event into two events, we must make sure
8899 that neither of the two looks like the original--so that,
8900 if we replay the events, they won't be expanded again.
8901 If not for this, such reexpansion could happen either here
8902 or when user programs play with this-command-keys. */
8903 if (EVENT_HAS_PARAMETERS (key
))
8908 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8909 if (EQ (kind
, Qmouse_click
))
8911 Lisp_Object window
, posn
;
8913 window
= POSN_WINDOW (EVENT_START (key
));
8914 posn
= POSN_POSN (EVENT_START (key
));
8917 || (!NILP (fake_prefixed_keys
)
8918 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8920 /* We're looking a second time at an event for which
8921 we generated a fake prefix key. Set
8922 last_real_key_start appropriately. */
8924 last_real_key_start
= t
- 1;
8927 /* Key sequences beginning with mouse clicks are
8928 read using the keymaps in the buffer clicked on,
8929 not the current buffer. If we're at the
8930 beginning of a key sequence, switch buffers. */
8931 if (last_real_key_start
== 0
8933 && BUFFERP (XWINDOW (window
)->buffer
)
8934 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8936 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8940 /* Arrange to go back to the original buffer once we're
8941 done reading the key sequence. Note that we can't
8942 use save_excursion_{save,restore} here, because they
8943 save point as well as the current buffer; we don't
8944 want to save point, because redisplay may change it,
8945 to accommodate a Fset_window_start or something. We
8946 don't want to do this at the top of the function,
8947 because we may get input from a subprocess which
8948 wants to change the selected window and stuff (say,
8950 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8952 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8954 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8955 orig_local_map
= get_local_map (PT
, current_buffer
,
8957 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8958 goto replay_sequence
;
8961 /* For a mouse click, get the local text-property keymap
8962 of the place clicked on, rather than point. */
8963 if (last_real_key_start
== 0
8964 && CONSP (XCDR (key
))
8965 && ! localized_local_map
)
8967 Lisp_Object map_here
, start
, pos
;
8969 localized_local_map
= 1;
8970 start
= EVENT_START (key
);
8972 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8974 pos
= POSN_BUFFER_POSN (start
);
8976 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8978 map_here
= get_local_map (XINT (pos
),
8979 current_buffer
, Qlocal_map
);
8980 if (!EQ (map_here
, orig_local_map
))
8982 orig_local_map
= map_here
;
8986 goto replay_sequence
;
8988 map_here
= get_local_map (XINT (pos
),
8989 current_buffer
, Qkeymap
);
8990 if (!EQ (map_here
, orig_keymap
))
8992 orig_keymap
= map_here
;
8996 goto replay_sequence
;
9002 /* Expand mode-line and scroll-bar events into two events:
9003 use posn as a fake prefix key. */
9005 && (NILP (fake_prefixed_keys
)
9006 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9008 if (t
+ 1 >= bufsize
)
9009 error ("Key sequence too long");
9012 keybuf
[t
+ 1] = key
;
9015 /* Record that a fake prefix key has been generated
9016 for KEY. Don't modify the event; this would
9017 prevent proper action when the event is pushed
9018 back into unread-command-events. */
9019 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9021 /* If on a mode line string with a local keymap,
9022 reconsider the key sequence with that keymap. */
9023 if (string
= POSN_STRING (EVENT_START (key
)),
9024 (CONSP (string
) && STRINGP (XCAR (string
))))
9026 Lisp_Object pos
, map
, map2
;
9028 pos
= XCDR (string
);
9029 string
= XCAR (string
);
9031 && XINT (pos
) < SCHARS (string
))
9033 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9035 orig_local_map
= map
;
9036 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9039 if (!NILP (map
) || !NILP (map2
))
9040 goto replay_sequence
;
9046 else if (NILP (from_string
)
9047 && (string
= POSN_STRING (EVENT_START (key
)),
9048 (CONSP (string
) && STRINGP (XCAR (string
)))))
9050 /* For a click on a string, i.e. overlay string or a
9051 string displayed via the `display' property,
9052 consider `local-map' and `keymap' properties of
9054 Lisp_Object pos
, map
, map2
;
9056 pos
= XCDR (string
);
9057 string
= XCAR (string
);
9059 && XINT (pos
) < SCHARS (string
))
9061 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9063 orig_local_map
= map
;
9064 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9068 if (!NILP (map
) || !NILP (map2
))
9070 from_string
= string
;
9071 goto replay_sequence
;
9076 else if (CONSP (XCDR (key
))
9077 && CONSP (EVENT_START (key
))
9078 && CONSP (XCDR (EVENT_START (key
))))
9082 posn
= POSN_POSN (EVENT_START (key
));
9083 /* Handle menu-bar events:
9084 insert the dummy prefix event `menu-bar'. */
9085 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9087 if (t
+ 1 >= bufsize
)
9088 error ("Key sequence too long");
9092 /* Zap the position in key, so we know that we've
9093 expanded it, and don't try to do so again. */
9094 POSN_SET_POSN (EVENT_START (key
),
9095 Fcons (posn
, Qnil
));
9098 goto replay_sequence
;
9100 else if (CONSP (posn
))
9102 /* We're looking at the second event of a
9103 sequence which we expanded before. Set
9104 last_real_key_start appropriately. */
9105 if (last_real_key_start
== t
&& t
> 0)
9106 last_real_key_start
= t
- 1;
9111 /* We have finally decided that KEY is something we might want
9113 first_binding
= (follow_key (key
,
9114 nmaps
- first_binding
,
9115 submaps
+ first_binding
,
9116 defs
+ first_binding
,
9117 submaps
+ first_binding
)
9120 /* If KEY wasn't bound, we'll try some fallbacks. */
9121 if (first_binding
< nmaps
)
9122 /* This is needed for the following scenario:
9123 event 0: a down-event that gets dropped by calling replay_key.
9124 event 1: some normal prefix like C-h.
9125 After event 0, first_unbound is 0, after event 1 fkey.start
9126 and keytran.start are both 1, so when we see that C-h is bound,
9127 we need to update first_unbound. */
9128 first_unbound
= max (t
+ 1, first_unbound
);
9133 /* Remember the position to put an upper bound on fkey.start. */
9134 first_unbound
= min (t
, first_unbound
);
9136 head
= EVENT_HEAD (key
);
9137 if (help_char_p (head
) && t
> 0)
9139 read_key_sequence_cmd
= Vprefix_help_command
;
9141 last_nonmenu_event
= key
;
9142 /* The Microsoft C compiler can't handle the goto that
9150 Lisp_Object breakdown
;
9153 breakdown
= parse_modifiers (head
);
9154 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9155 /* Attempt to reduce an unbound mouse event to a simpler
9156 event that is bound:
9157 Drags reduce to clicks.
9158 Double-clicks reduce to clicks.
9159 Triple-clicks reduce to double-clicks, then to clicks.
9160 Down-clicks are eliminated.
9161 Double-downs reduce to downs, then are eliminated.
9162 Triple-downs reduce to double-downs, then to downs,
9163 then are eliminated. */
9164 if (modifiers
& (down_modifier
| drag_modifier
9165 | double_modifier
| triple_modifier
))
9167 while (modifiers
& (down_modifier
| drag_modifier
9168 | double_modifier
| triple_modifier
))
9170 Lisp_Object new_head
, new_click
;
9171 if (modifiers
& triple_modifier
)
9172 modifiers
^= (double_modifier
| triple_modifier
);
9173 else if (modifiers
& double_modifier
)
9174 modifiers
&= ~double_modifier
;
9175 else if (modifiers
& drag_modifier
)
9176 modifiers
&= ~drag_modifier
;
9179 /* Dispose of this `down' event by simply jumping
9180 back to replay_key, to get another event.
9182 Note that if this event came from mock input,
9183 then just jumping back to replay_key will just
9184 hand it to us again. So we have to wipe out any
9187 We could delete keybuf[t] and shift everything
9188 after that to the left by one spot, but we'd also
9189 have to fix up any variable that points into
9190 keybuf, and shifting isn't really necessary
9193 Adding prefixes for non-textual mouse clicks
9194 creates two characters of mock input, and both
9195 must be thrown away. If we're only looking at
9196 the prefix now, we can just jump back to
9197 replay_key. On the other hand, if we've already
9198 processed the prefix, and now the actual click
9199 itself is giving us trouble, then we've lost the
9200 state of the keymaps we want to backtrack to, and
9201 we need to replay the whole sequence to rebuild
9204 Beyond that, only function key expansion could
9205 create more than two keys, but that should never
9206 generate mouse events, so it's okay to zero
9207 mock_input in that case too.
9209 FIXME: The above paragraph seems just plain
9210 wrong, if you consider things like
9211 xterm-mouse-mode. -stef
9213 Isn't this just the most wonderful code ever? */
9215 /* If mock_input > t + 1, the above simplification
9216 will actually end up dropping keys on the floor.
9217 This is probably OK for now, but even
9218 if mock_input <= t + 1, we need to adjust fkey
9220 Typical case [header-line down-mouse-N]:
9221 mock_input = 2, t = 1, fkey.end = 1,
9222 last_real_key_start = 0. */
9223 if (fkey
.end
> last_real_key_start
)
9225 fkey
.end
= fkey
.start
9226 = min (last_real_key_start
, fkey
.start
);
9227 fkey
.map
= fkey
.parent
;
9228 if (keytran
.end
> last_real_key_start
)
9230 keytran
.end
= keytran
.start
9231 = min (last_real_key_start
, keytran
.start
);
9232 keytran
.map
= keytran
.parent
;
9235 if (t
== last_real_key_start
)
9242 mock_input
= last_real_key_start
;
9243 goto replay_sequence
;
9248 = apply_modifiers (modifiers
, XCAR (breakdown
));
9250 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9252 /* Look for a binding for this new key. follow_key
9253 promises that it didn't munge submaps the
9254 last time we called it, since key was unbound. */
9256 = (follow_key (new_click
,
9257 nmaps
- local_first_binding
,
9258 submaps
+ local_first_binding
,
9259 defs
+ local_first_binding
,
9260 submaps
+ local_first_binding
)
9261 + local_first_binding
);
9263 /* If that click is bound, go for it. */
9264 if (first_binding
< nmaps
)
9269 /* Otherwise, we'll leave key set to the drag event. */
9276 /* Normally, last_nonmenu_event gets the previous key we read.
9277 But when a mouse popup menu is being used,
9278 we don't update last_nonmenu_event; it continues to hold the mouse
9279 event that preceded the first level of menu. */
9280 if (!used_mouse_menu
)
9281 last_nonmenu_event
= key
;
9283 /* Record what part of this_command_keys is the current key sequence. */
9284 this_single_command_key_start
= this_command_key_count
- t
;
9286 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9287 /* There is a binding and it's not a prefix.
9288 There is thus no function-key in this sequence.
9289 Moving fkey.start is important in this case to allow keytran.start
9290 to go over the sequence before we return (since we keep the
9291 invariant that keytran.end <= fkey.start). */
9294 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9297 /* If the sequence is unbound, see if we can hang a function key
9298 off the end of it. */
9299 /* Continue scan from fkey.end until we find a bound suffix. */
9300 while (fkey
.end
< t
)
9302 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9305 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9306 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9307 max (t
, mock_input
),
9308 /* If there's a binding (i.e.
9309 first_binding >= nmaps) we don't want
9310 to apply this function-key-mapping. */
9311 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9316 mock_input
= diff
+ max (t
, mock_input
);
9317 goto replay_sequence
;
9321 /* Look for this sequence in key-translation-map.
9322 Scan from keytran.end until we find a bound suffix. */
9323 while (keytran
.end
< fkey
.start
)
9325 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9328 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9329 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9334 mock_input
= diff
+ max (t
, mock_input
);
9335 /* Adjust the function-key-map counters. */
9339 goto replay_sequence
;
9343 /* If KEY is not defined in any of the keymaps,
9344 and cannot be part of a function key or translation,
9345 and is an upper case letter
9346 use the corresponding lower-case letter instead. */
9347 if (first_binding
>= nmaps
9348 && fkey
.start
>= t
&& keytran
.start
>= t
9350 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9351 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9352 || (XINT (key
) & shift_modifier
)))
9354 Lisp_Object new_key
;
9356 original_uppercase
= key
;
9357 original_uppercase_position
= t
- 1;
9359 if (XINT (key
) & shift_modifier
)
9360 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9362 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9363 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
9365 /* We have to do this unconditionally, regardless of whether
9366 the lower-case char is defined in the keymaps, because they
9367 might get translated through function-key-map. */
9368 keybuf
[t
- 1] = new_key
;
9369 mock_input
= max (t
, mock_input
);
9371 goto replay_sequence
;
9373 /* If KEY is not defined in any of the keymaps,
9374 and cannot be part of a function key or translation,
9375 and is a shifted function key,
9376 use the corresponding unshifted function key instead. */
9377 if (first_binding
>= nmaps
9378 && fkey
.start
>= t
&& keytran
.start
>= t
9381 Lisp_Object breakdown
;
9384 breakdown
= parse_modifiers (key
);
9385 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9386 if (modifiers
& shift_modifier
)
9388 Lisp_Object new_key
;
9390 original_uppercase
= key
;
9391 original_uppercase_position
= t
- 1;
9393 modifiers
&= ~shift_modifier
;
9394 new_key
= apply_modifiers (modifiers
,
9397 keybuf
[t
- 1] = new_key
;
9398 mock_input
= max (t
, mock_input
);
9399 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9400 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9402 goto replay_sequence
;
9408 read_key_sequence_cmd
= (first_binding
< nmaps
9409 ? defs
[first_binding
]
9412 unread_switch_frame
= delayed_switch_frame
;
9413 unbind_to (count
, Qnil
);
9415 /* Don't downcase the last character if the caller says don't.
9416 Don't downcase it if the result is undefined, either. */
9417 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9418 && t
- 1 == original_uppercase_position
)
9419 keybuf
[t
- 1] = original_uppercase
;
9421 /* Occasionally we fabricate events, perhaps by expanding something
9422 according to function-key-map, or by adding a prefix symbol to a
9423 mouse click in the scroll bar or modeline. In this cases, return
9424 the entire generated key sequence, even if we hit an unbound
9425 prefix or a definition before the end. This means that you will
9426 be able to push back the event properly, and also means that
9427 read-key-sequence will always return a logical unit.
9430 for (; t
< mock_input
; t
++)
9432 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9433 && NILP (Fzerop (Vecho_keystrokes
)))
9434 echo_char (keybuf
[t
]);
9435 add_command_key (keybuf
[t
]);
9444 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9445 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9446 The sequence is sufficient to specify a non-prefix command in the
9447 current local and global maps.
9449 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9450 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9451 as a continuation of the previous key.
9453 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9454 convert the last event to lower case. (Normally any upper case event
9455 is converted to lower case if the original event is undefined and the lower
9456 case equivalent is defined.) A non-nil value is appropriate for reading
9457 a key sequence to be defined.
9459 A C-g typed while in this function is treated like any other character,
9460 and `quit-flag' is not set.
9462 If the key sequence starts with a mouse click, then the sequence is read
9463 using the keymaps of the buffer of the window clicked in, not the buffer
9464 of the selected window as normal.
9466 `read-key-sequence' drops unbound button-down events, since you normally
9467 only care about the click or drag events which follow them. If a drag
9468 or multi-click event is unbound, but the corresponding click event would
9469 be bound, `read-key-sequence' turns the event into a click event at the
9470 drag's starting position. This means that you don't have to distinguish
9471 between click and drag, double, or triple events unless you want to.
9473 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9474 lines separating windows, and scroll bars with imaginary keys
9475 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9477 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9478 function will process a switch-frame event if the user switches frames
9479 before typing anything. If the user switches frames in the middle of a
9480 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9481 is nil, then the event will be put off until after the current key sequence.
9483 `read-key-sequence' checks `function-key-map' for function key
9484 sequences, where they wouldn't conflict with ordinary bindings. See
9485 `function-key-map' for more details.
9487 The optional fifth argument COMMAND-LOOP, if non-nil, means
9488 that this key sequence is being read by something that will
9489 read commands one after another. It should be nil if the caller
9490 will read just one key sequence. */)
9491 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9493 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9494 Lisp_Object can_return_switch_frame
, command_loop
;
9496 Lisp_Object keybuf
[30];
9498 struct gcpro gcpro1
;
9499 int count
= SPECPDL_INDEX ();
9502 CHECK_STRING (prompt
);
9505 specbind (Qinput_method_exit_on_first_char
,
9506 (NILP (command_loop
) ? Qt
: Qnil
));
9507 specbind (Qinput_method_use_echo_area
,
9508 (NILP (command_loop
) ? Qt
: Qnil
));
9510 bzero (keybuf
, sizeof keybuf
);
9512 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9514 if (NILP (continue_echo
))
9516 this_command_key_count
= 0;
9517 this_command_key_count_reset
= 0;
9518 this_single_command_key_start
= 0;
9521 #ifdef HAVE_X_WINDOWS
9522 if (display_hourglass_p
)
9523 cancel_hourglass ();
9526 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9527 prompt
, ! NILP (dont_downcase_last
),
9528 ! NILP (can_return_switch_frame
), 0);
9530 #if 0 /* The following is fine for code reading a key sequence and
9531 then proceeding with a lenghty computation, but it's not good
9532 for code reading keys in a loop, like an input method. */
9533 #ifdef HAVE_X_WINDOWS
9534 if (display_hourglass_p
)
9545 return unbind_to (count
, make_event_array (i
, keybuf
));
9548 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9549 Sread_key_sequence_vector
, 1, 5, 0,
9550 doc
: /* Like `read-key-sequence' but always return a vector. */)
9551 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9553 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9554 Lisp_Object can_return_switch_frame
, command_loop
;
9556 Lisp_Object keybuf
[30];
9558 struct gcpro gcpro1
;
9559 int count
= SPECPDL_INDEX ();
9562 CHECK_STRING (prompt
);
9565 specbind (Qinput_method_exit_on_first_char
,
9566 (NILP (command_loop
) ? Qt
: Qnil
));
9567 specbind (Qinput_method_use_echo_area
,
9568 (NILP (command_loop
) ? Qt
: Qnil
));
9570 bzero (keybuf
, sizeof keybuf
);
9572 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9574 if (NILP (continue_echo
))
9576 this_command_key_count
= 0;
9577 this_command_key_count_reset
= 0;
9578 this_single_command_key_start
= 0;
9581 #ifdef HAVE_X_WINDOWS
9582 if (display_hourglass_p
)
9583 cancel_hourglass ();
9586 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9587 prompt
, ! NILP (dont_downcase_last
),
9588 ! NILP (can_return_switch_frame
), 0);
9590 #ifdef HAVE_X_WINDOWS
9591 if (display_hourglass_p
)
9601 return unbind_to (count
, Fvector (i
, keybuf
));
9604 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9605 doc
: /* Execute CMD as an editor command.
9606 CMD must be a symbol that satisfies the `commandp' predicate.
9607 Optional second arg RECORD-FLAG non-nil
9608 means unconditionally put this command in `command-history'.
9609 Otherwise, that is done only if an arg is read using the minibuffer.
9610 The argument KEYS specifies the value to use instead of (this-command-keys)
9611 when reading the arguments; if it is nil, (this-command-keys) is used.
9612 The argument SPECIAL, if non-nil, means that this command is executing
9613 a special event, so ignore the prefix argument and don't clear it. */)
9614 (cmd
, record_flag
, keys
, special
)
9615 Lisp_Object cmd
, record_flag
, keys
, special
;
9617 register Lisp_Object final
;
9618 register Lisp_Object tem
;
9619 Lisp_Object prefixarg
;
9620 struct backtrace backtrace
;
9621 extern int debug_on_next_call
;
9623 debug_on_next_call
= 0;
9627 prefixarg
= current_kboard
->Vprefix_arg
;
9628 Vcurrent_prefix_arg
= prefixarg
;
9629 current_kboard
->Vprefix_arg
= Qnil
;
9636 tem
= Fget (cmd
, Qdisabled
);
9637 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9639 tem
= Fsymbol_value (Qdisabled_command_function
);
9641 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9647 final
= Findirect_function (cmd
);
9649 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9651 struct gcpro gcpro1
, gcpro2
;
9653 GCPRO2 (cmd
, prefixarg
);
9654 do_autoload (final
, cmd
);
9661 if (STRINGP (final
) || VECTORP (final
))
9663 /* If requested, place the macro in the command history. For
9664 other sorts of commands, call-interactively takes care of
9666 if (!NILP (record_flag
))
9669 = Fcons (Fcons (Qexecute_kbd_macro
,
9670 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9673 /* Don't keep command history around forever. */
9674 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9676 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9678 XSETCDR (tem
, Qnil
);
9682 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9685 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9687 backtrace
.next
= backtrace_list
;
9688 backtrace_list
= &backtrace
;
9689 backtrace
.function
= &Qcall_interactively
;
9690 backtrace
.args
= &cmd
;
9691 backtrace
.nargs
= 1;
9692 backtrace
.evalargs
= 0;
9693 backtrace
.debug_on_exit
= 0;
9695 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9697 backtrace_list
= backtrace
.next
;
9705 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9707 doc
: /* Read function name, then read its arguments and call it. */)
9709 Lisp_Object prefixarg
;
9711 Lisp_Object function
;
9713 int saved_last_point_position
;
9714 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9715 Lisp_Object bindings
, value
;
9716 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9717 #ifdef HAVE_X_WINDOWS
9718 /* The call to Fcompleting_read wil start and cancel the hourglass,
9719 but if the hourglass was already scheduled, this means that no
9720 hourglass will be shown for the actual M-x command itself.
9721 So we restart it if it is already scheduled. Note that checking
9722 hourglass_shown_p is not enough, normally the hourglass is not shown,
9723 just scheduled to be shown. */
9724 int hstarted
= hourglass_started ();
9727 saved_keys
= Fvector (this_command_key_count
,
9728 XVECTOR (this_command_keys
)->contents
);
9729 saved_last_point_position_buffer
= last_point_position_buffer
;
9730 saved_last_point_position
= last_point_position
;
9732 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9734 if (EQ (prefixarg
, Qminus
))
9736 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9737 strcpy (buf
, "C-u ");
9738 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9739 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9740 else if (INTEGERP (prefixarg
))
9741 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9743 /* This isn't strictly correct if execute-extended-command
9744 is bound to anything else. Perhaps it should use
9745 this_command_keys? */
9746 strcat (buf
, "M-x ");
9748 /* Prompt with buf, and then read a string, completing from and
9749 restricting to the set of all defined commands. Don't provide
9750 any initial input. Save the command read on the extended-command
9752 function
= Fcompleting_read (build_string (buf
),
9753 Vobarray
, Qcommandp
,
9754 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9757 #ifdef HAVE_X_WINDOWS
9758 if (hstarted
) start_hourglass ();
9761 if (STRINGP (function
) && SCHARS (function
) == 0)
9762 error ("No command name given");
9764 /* Set this_command_keys to the concatenation of saved_keys and
9765 function, followed by a RET. */
9770 this_command_key_count
= 0;
9771 this_command_key_count_reset
= 0;
9772 this_single_command_key_start
= 0;
9774 keys
= XVECTOR (saved_keys
)->contents
;
9775 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9776 add_command_key (keys
[i
]);
9778 for (i
= 0; i
< SCHARS (function
); i
++)
9779 add_command_key (Faref (function
, make_number (i
)));
9781 add_command_key (make_number ('\015'));
9784 last_point_position
= saved_last_point_position
;
9785 last_point_position_buffer
= saved_last_point_position_buffer
;
9789 function
= Fintern (function
, Qnil
);
9790 current_kboard
->Vprefix_arg
= prefixarg
;
9791 Vthis_command
= function
;
9792 real_this_command
= function
;
9794 /* If enabled, show which key runs this command. */
9795 if (!NILP (Vsuggest_key_bindings
)
9796 && NILP (Vexecuting_macro
)
9797 && SYMBOLP (function
))
9798 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9804 GCPRO2 (bindings
, value
);
9805 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9807 /* If the command has a key binding, print it now. */
9808 if (!NILP (bindings
)
9809 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9812 /* But first wait, and skip the message if there is input. */
9814 if (!NILP (echo_area_buffer
[0]))
9815 /* This command displayed something in the echo area;
9816 so wait a few seconds, then display our suggestion message. */
9817 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9818 ? XINT (Vsuggest_key_bindings
) : 2);
9820 /* This command left the echo area empty,
9821 so display our message immediately. */
9824 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9825 && ! CONSP (Vunread_command_events
))
9827 Lisp_Object binding
;
9829 int message_p
= push_message ();
9830 int count
= SPECPDL_INDEX ();
9832 record_unwind_protect (pop_message_unwind
, Qnil
);
9833 binding
= Fkey_description (bindings
, Qnil
);
9836 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9839 sprintf (newmessage
, "You can run the command `%s' with %s",
9840 SDATA (SYMBOL_NAME (function
)),
9842 message2_nolog (newmessage
,
9843 strlen (newmessage
),
9844 STRING_MULTIBYTE (binding
));
9845 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9846 ? Vsuggest_key_bindings
: make_number (2)),
9851 unbind_to (count
, Qnil
);
9855 RETURN_UNGCPRO (value
);
9859 /* Return nonzero if input events are pending. */
9862 detect_input_pending ()
9865 get_input_pending (&input_pending
, 0);
9867 return input_pending
;
9870 /* Return nonzero if input events other than mouse movements are
9874 detect_input_pending_ignore_squeezables ()
9877 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9879 return input_pending
;
9882 /* Return nonzero if input events are pending, and run any pending timers. */
9885 detect_input_pending_run_timers (do_display
)
9888 int old_timers_run
= timers_run
;
9891 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9893 if (old_timers_run
!= timers_run
&& do_display
)
9895 redisplay_preserve_echo_area (8);
9896 /* The following fixes a bug when using lazy-lock with
9897 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9898 from an idle timer function. The symptom of the bug is that
9899 the cursor sometimes doesn't become visible until the next X
9900 event is processed. --gerd. */
9902 rif
->flush_display (NULL
);
9905 return input_pending
;
9908 /* This is called in some cases before a possible quit.
9909 It cases the next call to detect_input_pending to recompute input_pending.
9910 So calling this function unnecessarily can't do any harm. */
9913 clear_input_pending ()
9918 /* Return nonzero if there are pending requeued events.
9919 This isn't used yet. The hope is to make wait_reading_process_output
9920 call it, and return if it runs Lisp code that unreads something.
9921 The problem is, kbd_buffer_get_event needs to be fixed to know what
9922 to do in that case. It isn't trivial. */
9925 requeued_events_pending_p ()
9927 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9931 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9932 doc
: /* Return t if command input is currently available with no wait.
9933 Actually, the value is nil only if we can be sure that no input is available;
9934 if there is a doubt, the value is t. */)
9937 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9940 get_input_pending (&input_pending
,
9941 READABLE_EVENTS_DO_TIMERS_NOW
9942 | READABLE_EVENTS_FILTER_EVENTS
);
9943 return input_pending
> 0 ? Qt
: Qnil
;
9946 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9947 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9950 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9953 if (total_keys
< NUM_RECENT_KEYS
)
9954 return Fvector (total_keys
, keys
);
9957 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9958 bcopy (keys
+ recent_keys_index
,
9959 XVECTOR (val
)->contents
,
9960 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9962 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9963 recent_keys_index
* sizeof (Lisp_Object
));
9968 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9969 doc
: /* Return the key sequence that invoked this command.
9970 However, if the command has called `read-key-sequence', it returns
9971 the last key sequence that has been read.
9972 The value is a string or a vector. */)
9975 return make_event_array (this_command_key_count
,
9976 XVECTOR (this_command_keys
)->contents
);
9979 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9980 doc
: /* Return the key sequence that invoked this command, as a vector.
9981 However, if the command has called `read-key-sequence', it returns
9982 the last key sequence that has been read. */)
9985 return Fvector (this_command_key_count
,
9986 XVECTOR (this_command_keys
)->contents
);
9989 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9990 Sthis_single_command_keys
, 0, 0, 0,
9991 doc
: /* Return the key sequence that invoked this command.
9992 More generally, it returns the last key sequence read, either by
9993 the command loop or by `read-key-sequence'.
9994 Unlike `this-command-keys', this function's value
9995 does not include prefix arguments.
9996 The value is always a vector. */)
9999 return Fvector (this_command_key_count
10000 - this_single_command_key_start
,
10001 (XVECTOR (this_command_keys
)->contents
10002 + this_single_command_key_start
));
10005 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10006 Sthis_single_command_raw_keys
, 0, 0, 0,
10007 doc
: /* Return the raw events that were read for this command.
10008 More generally, it returns the last key sequence read, either by
10009 the command loop or by `read-key-sequence'.
10010 Unlike `this-single-command-keys', this function's value
10011 shows the events before all translations (except for input methods).
10012 The value is always a vector. */)
10015 return Fvector (raw_keybuf_count
,
10016 (XVECTOR (raw_keybuf
)->contents
));
10019 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10020 Sreset_this_command_lengths
, 0, 0, 0,
10021 doc
: /* Make the unread events replace the last command and echo.
10022 Used in `universal-argument-other-key'.
10024 `universal-argument-other-key' rereads the event just typed.
10025 It then gets translated through `function-key-map'.
10026 The translated event has to replace the real events,
10027 both in the value of (this-command-keys) and in echoing.
10028 To achieve this, `universal-argument-other-key' calls
10029 `reset-this-command-lengths', which discards the record of reading
10030 these events the first time. */)
10033 this_command_key_count
= before_command_key_count
;
10034 if (this_command_key_count
< this_single_command_key_start
)
10035 this_single_command_key_start
= this_command_key_count
;
10037 echo_truncate (before_command_echo_length
);
10039 /* Cause whatever we put into unread-command-events
10040 to echo as if it were being freshly read from the keyboard. */
10041 this_command_key_count_reset
= 1;
10046 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10047 Sclear_this_command_keys
, 0, 1, 0,
10048 doc
: /* Clear out the vector that `this-command-keys' returns.
10049 Also clear the record of the last 100 events, unless optional arg
10050 KEEP-RECORD is non-nil. */)
10052 Lisp_Object keep_record
;
10056 this_command_key_count
= 0;
10057 this_command_key_count_reset
= 0;
10059 if (NILP (keep_record
))
10061 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10062 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10064 recent_keys_index
= 0;
10069 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10070 doc
: /* Return the current depth in recursive edits. */)
10074 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10078 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10079 "FOpen dribble file: ",
10080 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10081 If FILE is nil, close any open dribble file. */)
10092 file
= Fexpand_file_name (file
, Qnil
);
10093 dribble
= fopen (SDATA (file
), "w");
10095 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10100 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10101 doc
: /* Discard the contents of the terminal input buffer.
10102 Also end any kbd macro being defined. */)
10105 if (!NILP (current_kboard
->defining_kbd_macro
))
10107 /* Discard the last command from the macro. */
10108 Fcancel_kbd_macro_events ();
10112 update_mode_lines
++;
10114 Vunread_command_events
= Qnil
;
10115 unread_command_char
= -1;
10117 discard_tty_input ();
10119 kbd_fetch_ptr
= kbd_store_ptr
;
10125 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10126 doc
: /* Stop Emacs and return to superior process. You can resume later.
10127 If `cannot-suspend' is non-nil, or if the system doesn't support job
10128 control, run a subshell instead.
10130 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10131 to be read as terminal input by Emacs's parent, after suspension.
10133 Before suspending, run the normal hook `suspend-hook'.
10134 After resumption run the normal hook `suspend-resume-hook'.
10136 Some operating systems cannot stop the Emacs process and resume it later.
10137 On such systems, Emacs starts a subshell instead of suspending. */)
10139 Lisp_Object stuffstring
;
10141 int count
= SPECPDL_INDEX ();
10142 int old_height
, old_width
;
10144 struct gcpro gcpro1
;
10146 if (!NILP (stuffstring
))
10147 CHECK_STRING (stuffstring
);
10149 /* Run the functions in suspend-hook. */
10150 if (!NILP (Vrun_hooks
))
10151 call1 (Vrun_hooks
, intern ("suspend-hook"));
10153 GCPRO1 (stuffstring
);
10154 get_frame_size (&old_width
, &old_height
);
10155 reset_sys_modes ();
10156 /* sys_suspend can get an error if it tries to fork a subshell
10157 and the system resources aren't available for that. */
10158 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10160 stuff_buffered_input (stuffstring
);
10161 if (cannot_suspend
)
10165 unbind_to (count
, Qnil
);
10167 /* Check if terminal/window size has changed.
10168 Note that this is not useful when we are running directly
10169 with a window system; but suspend should be disabled in that case. */
10170 get_frame_size (&width
, &height
);
10171 if (width
!= old_width
|| height
!= old_height
)
10172 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10174 /* Run suspend-resume-hook. */
10175 if (!NILP (Vrun_hooks
))
10176 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10182 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10183 Then in any case stuff anything Emacs has read ahead and not used. */
10186 stuff_buffered_input (stuffstring
)
10187 Lisp_Object stuffstring
;
10189 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10190 register unsigned char *p
;
10192 if (STRINGP (stuffstring
))
10194 register int count
;
10196 p
= SDATA (stuffstring
);
10197 count
= SBYTES (stuffstring
);
10198 while (count
-- > 0)
10203 /* Anything we have read ahead, put back for the shell to read. */
10204 /* ?? What should this do when we have multiple keyboards??
10205 Should we ignore anything that was typed in at the "wrong" kboard?
10207 rms: we should stuff everything back into the kboard
10209 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10212 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10213 kbd_fetch_ptr
= kbd_buffer
;
10214 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10215 stuff_char (kbd_fetch_ptr
->code
);
10217 clear_event (kbd_fetch_ptr
);
10221 #endif /* SIGTSTP */
10225 set_waiting_for_input (time_to_clear
)
10226 EMACS_TIME
*time_to_clear
;
10228 input_available_clear_time
= time_to_clear
;
10230 /* Tell interrupt_signal to throw back to read_char, */
10231 waiting_for_input
= 1;
10233 /* If interrupt_signal was called before and buffered a C-g,
10234 make it run again now, to avoid timing error. */
10235 if (!NILP (Vquit_flag
))
10236 quit_throw_to_read_char ();
10240 clear_waiting_for_input ()
10242 /* Tell interrupt_signal not to throw back to read_char, */
10243 waiting_for_input
= 0;
10244 input_available_clear_time
= 0;
10247 /* This routine is called at interrupt level in response to C-g.
10249 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10250 is called from kbd_buffer_store_event, in handling SIGIO or
10253 If `waiting_for_input' is non zero, then unless `echoing' is
10254 nonzero, immediately throw back to read_char.
10256 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10257 eval to throw, when it gets a chance. If quit-flag is already
10258 non-nil, it stops the job right away. */
10261 interrupt_signal (signalnum
) /* If we don't have an argument, */
10262 int signalnum
; /* some compilers complain in signal calls. */
10265 /* Must preserve main program's value of errno. */
10266 int old_errno
= errno
;
10267 struct frame
*sf
= SELECTED_FRAME ();
10269 #if defined (USG) && !defined (POSIX_SIGNALS)
10270 if (!read_socket_hook
&& NILP (Vwindow_system
))
10272 /* USG systems forget handlers when they are used;
10273 must reestablish each time */
10274 signal (SIGINT
, interrupt_signal
);
10275 signal (SIGQUIT
, interrupt_signal
);
10279 SIGNAL_THREAD_CHECK (signalnum
);
10282 if (!NILP (Vquit_flag
)
10283 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10285 /* If SIGINT isn't blocked, don't let us be interrupted by
10286 another SIGINT, it might be harmful due to non-reentrancy
10287 in I/O functions. */
10288 sigblock (sigmask (SIGINT
));
10291 reset_sys_modes ();
10293 #ifdef SIGTSTP /* Support possible in later USG versions */
10295 * On systems which can suspend the current process and return to the original
10296 * shell, this command causes the user to end up back at the shell.
10297 * The "Auto-save" and "Abort" questions are not asked until
10298 * the user elects to return to emacs, at which point he can save the current
10299 * job and either dump core or continue.
10304 if (sys_suspend () == -1)
10306 printf ("Not running as a subprocess;\n");
10307 printf ("you can continue or abort.\n");
10309 #else /* not VMS */
10310 /* Perhaps should really fork an inferior shell?
10311 But that would not provide any way to get back
10312 to the original shell, ever. */
10313 printf ("No support for stopping a process on this operating system;\n");
10314 printf ("you can continue or abort.\n");
10315 #endif /* not VMS */
10316 #endif /* not SIGTSTP */
10318 /* We must remain inside the screen area when the internal terminal
10319 is used. Note that [Enter] is not echoed by dos. */
10322 /* It doesn't work to autosave while GC is in progress;
10323 the code used for auto-saving doesn't cope with the mark bit. */
10324 if (!gc_in_progress
)
10326 printf ("Auto-save? (y or n) ");
10328 if (((c
= getchar ()) & ~040) == 'Y')
10330 Fdo_auto_save (Qt
, Qnil
);
10332 printf ("\r\nAuto-save done");
10333 #else /* not MSDOS */
10334 printf ("Auto-save done\n");
10335 #endif /* not MSDOS */
10337 while (c
!= '\n') c
= getchar ();
10341 /* During GC, it must be safe to reenable quitting again. */
10342 Vinhibit_quit
= Qnil
;
10345 #endif /* not MSDOS */
10346 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10347 printf ("but will instead do a real quit after garbage collection ends\r\n");
10352 printf ("\r\nAbort? (y or n) ");
10353 #else /* not MSDOS */
10355 printf ("Abort (and enter debugger)? (y or n) ");
10356 #else /* not VMS */
10357 printf ("Abort (and dump core)? (y or n) ");
10358 #endif /* not VMS */
10359 #endif /* not MSDOS */
10361 if (((c
= getchar ()) & ~040) == 'Y')
10363 while (c
!= '\n') c
= getchar ();
10365 printf ("\r\nContinuing...\r\n");
10366 #else /* not MSDOS */
10367 printf ("Continuing...\n");
10368 #endif /* not MSDOS */
10375 /* If executing a function that wants to be interrupted out of
10376 and the user has not deferred quitting by binding `inhibit-quit'
10377 then quit right away. */
10378 if (immediate_quit
&& NILP (Vinhibit_quit
))
10380 struct gl_state_s saved
;
10381 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10383 immediate_quit
= 0;
10386 GCPRO4 (saved
.object
, saved
.global_code
,
10387 saved
.current_syntax_table
, saved
.old_prop
);
10388 Fsignal (Qquit
, Qnil
);
10393 /* Else request quit when it's safe */
10397 if (waiting_for_input
&& !echoing
)
10398 quit_throw_to_read_char ();
10403 /* Handle a C-g by making read_char return C-g. */
10406 quit_throw_to_read_char ()
10409 /* Prevent another signal from doing this before we finish. */
10410 clear_waiting_for_input ();
10413 Vunread_command_events
= Qnil
;
10414 unread_command_char
= -1;
10416 #if 0 /* Currently, sit_for is called from read_char without turning
10417 off polling. And that can call set_waiting_for_input.
10418 It seems to be harmless. */
10419 #ifdef POLL_FOR_INPUT
10420 /* May be > 1 if in recursive minibuffer. */
10421 if (poll_suppress_count
== 0)
10425 if (FRAMEP (internal_last_event_frame
)
10426 && !EQ (internal_last_event_frame
, selected_frame
))
10427 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10430 _longjmp (getcjmp
, 1);
10433 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10434 doc
: /* Set mode of reading keyboard input.
10435 First arg INTERRUPT non-nil means use input interrupts;
10436 nil means use CBREAK mode.
10437 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10438 (no effect except in CBREAK mode).
10439 Third arg META t means accept 8-bit input (for a Meta key).
10440 META nil means ignore the top bit, on the assumption it is parity.
10441 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10442 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10443 See also `current-input-mode'. */)
10444 (interrupt
, flow
, meta
, quit
)
10445 Lisp_Object interrupt
, flow
, meta
, quit
;
10448 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10449 error ("set-input-mode: QUIT must be an ASCII character");
10451 #ifdef POLL_FOR_INPUT
10456 /* this causes startup screen to be restored and messes with the mouse */
10457 reset_sys_modes ();
10461 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10462 if (read_socket_hook
)
10464 /* When using X, don't give the user a real choice,
10465 because we haven't implemented the mechanisms to support it. */
10466 #ifdef NO_SOCK_SIGIO
10467 interrupt_input
= 0;
10468 #else /* not NO_SOCK_SIGIO */
10469 interrupt_input
= 1;
10470 #endif /* NO_SOCK_SIGIO */
10473 interrupt_input
= !NILP (interrupt
);
10474 #else /* not SIGIO */
10475 interrupt_input
= 0;
10476 #endif /* not SIGIO */
10478 /* Our VMS input only works by interrupts, as of now. */
10480 interrupt_input
= 1;
10483 flow_control
= !NILP (flow
);
10486 else if (EQ (meta
, Qt
))
10491 /* Don't let this value be out of range. */
10492 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10498 #ifdef POLL_FOR_INPUT
10499 poll_suppress_count
= 1;
10505 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10506 doc
: /* Return information about the way Emacs currently reads keyboard input.
10507 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10508 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10509 nil, Emacs is using CBREAK mode.
10510 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10511 terminal; this does not apply if Emacs uses interrupt-driven input.
10512 META is t if accepting 8-bit input with 8th bit as Meta flag.
10513 META nil means ignoring the top bit, on the assumption it is parity.
10514 META is neither t nor nil if accepting 8-bit input and using
10515 all 8 bits as the character code.
10516 QUIT is the character Emacs currently uses to quit.
10517 The elements of this list correspond to the arguments of
10518 `set-input-mode'. */)
10521 Lisp_Object val
[4];
10523 val
[0] = interrupt_input
? Qt
: Qnil
;
10524 val
[1] = flow_control
? Qt
: Qnil
;
10525 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10526 XSETFASTINT (val
[3], quit_char
);
10528 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10531 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10532 doc
: /* Return position information for pixel coordinates X and Y.
10533 By default, X and Y are relative to text area of the selected window.
10534 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10535 If optional fourth arg WHOLE is non-nil, X is relative to the left
10536 edge of the window.
10538 The return value is similar to a mouse click position:
10539 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10540 IMAGE (DX . DY) (WIDTH . HEIGHT))
10541 The `posn-' functions access elements of such lists. */)
10542 (x
, y
, frame_or_window
, whole
)
10543 Lisp_Object x
, y
, frame_or_window
, whole
;
10548 if (NILP (frame_or_window
))
10549 frame_or_window
= selected_window
;
10551 if (WINDOWP (frame_or_window
))
10555 CHECK_LIVE_WINDOW (frame_or_window
);
10557 w
= XWINDOW (frame_or_window
);
10558 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10560 ? window_box_left_offset (w
, TEXT_AREA
)
10561 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10562 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10563 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10564 frame_or_window
= w
->frame
;
10567 CHECK_LIVE_FRAME (frame_or_window
);
10569 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10572 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10573 doc
: /* Return position information for buffer POS in WINDOW.
10574 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10576 Return nil if position is not visible in window. Otherwise,
10577 the return value is similar to that returned by `event-start' for
10578 a mouse click at the upper left corner of the glyph corresponding
10579 to the given buffer position:
10580 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10581 IMAGE (DX . DY) (WIDTH . HEIGHT))
10582 The `posn-' functions access elements of such lists. */)
10584 Lisp_Object pos
, window
;
10588 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10590 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10596 * Set up a new kboard object with reasonable initial values.
10602 kb
->Voverriding_terminal_local_map
= Qnil
;
10603 kb
->Vlast_command
= Qnil
;
10604 kb
->Vreal_last_command
= Qnil
;
10605 kb
->Vprefix_arg
= Qnil
;
10606 kb
->Vlast_prefix_arg
= Qnil
;
10607 kb
->kbd_queue
= Qnil
;
10608 kb
->kbd_queue_has_data
= 0;
10609 kb
->immediate_echo
= 0;
10610 kb
->echo_string
= Qnil
;
10611 kb
->echo_after_prompt
= -1;
10612 kb
->kbd_macro_buffer
= 0;
10613 kb
->kbd_macro_bufsize
= 0;
10614 kb
->defining_kbd_macro
= Qnil
;
10615 kb
->Vlast_kbd_macro
= Qnil
;
10616 kb
->reference_count
= 0;
10617 kb
->Vsystem_key_alist
= Qnil
;
10618 kb
->system_key_syms
= Qnil
;
10619 kb
->Vdefault_minibuffer_frame
= Qnil
;
10623 * Destroy the contents of a kboard object, but not the object itself.
10624 * We use this just before deleting it, or if we're going to initialize
10625 * it a second time.
10631 if (kb
->kbd_macro_buffer
)
10632 xfree (kb
->kbd_macro_buffer
);
10635 #ifdef MULTI_KBOARD
10637 /* Free KB and memory referenced from it. */
10645 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10648 *kbp
= kb
->next_kboard
;
10650 /* Prevent a dangling reference to KB. */
10651 if (kb
== current_kboard
10652 && FRAMEP (selected_frame
)
10653 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10655 current_kboard
= XFRAME (selected_frame
)->kboard
;
10656 if (current_kboard
== kb
)
10664 #endif /* MULTI_KBOARD */
10669 /* This is correct before outermost invocation of the editor loop */
10670 command_loop_level
= -1;
10671 immediate_quit
= 0;
10672 quit_char
= Ctl ('g');
10673 Vunread_command_events
= Qnil
;
10674 unread_command_char
= -1;
10675 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10677 recent_keys_index
= 0;
10678 kbd_fetch_ptr
= kbd_buffer
;
10679 kbd_store_ptr
= kbd_buffer
;
10681 do_mouse_tracking
= Qnil
;
10685 /* This means that command_loop_1 won't try to select anything the first
10687 internal_last_event_frame
= Qnil
;
10688 Vlast_event_frame
= internal_last_event_frame
;
10690 #ifdef MULTI_KBOARD
10691 current_kboard
= initial_kboard
;
10693 wipe_kboard (current_kboard
);
10694 init_kboard (current_kboard
);
10696 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10698 signal (SIGINT
, interrupt_signal
);
10699 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10700 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10701 SIGQUIT and we can't tell which one it will give us. */
10702 signal (SIGQUIT
, interrupt_signal
);
10703 #endif /* HAVE_TERMIO */
10705 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10707 if (!noninteractive
)
10708 signal (SIGIO
, input_available_signal
);
10711 /* Use interrupt input by default, if it works and noninterrupt input
10712 has deficiencies. */
10714 #ifdef INTERRUPT_INPUT
10715 interrupt_input
= 1;
10717 interrupt_input
= 0;
10720 /* Our VMS input only works by interrupts, as of now. */
10722 interrupt_input
= 1;
10728 if (keyboard_init_hook
)
10729 (*keyboard_init_hook
) ();
10731 #ifdef POLL_FOR_INPUT
10732 poll_suppress_count
= 1;
10737 /* At least provide an escape route since C-g doesn't work. */
10738 signal (SIGINT
, interrupt_signal
);
10742 /* This type's only use is in syms_of_keyboard, to initialize the
10743 event header symbols and put properties on them. */
10744 struct event_head
{
10750 struct event_head head_table
[] = {
10751 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10752 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10753 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10754 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10755 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10756 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10757 /* `select-window' should be handled just like `switch-frame'
10758 in read_key_sequence. */
10759 {&Qselect_window
, "select-window", &Qswitch_frame
}
10763 syms_of_keyboard ()
10765 Vpre_help_message
= Qnil
;
10766 staticpro (&Vpre_help_message
);
10768 Vlispy_mouse_stem
= build_string ("mouse");
10769 staticpro (&Vlispy_mouse_stem
);
10772 QCimage
= intern (":image");
10773 staticpro (&QCimage
);
10775 staticpro (&Qhelp_echo
);
10776 Qhelp_echo
= intern ("help-echo");
10778 staticpro (&item_properties
);
10779 item_properties
= Qnil
;
10781 staticpro (&tool_bar_item_properties
);
10782 tool_bar_item_properties
= Qnil
;
10783 staticpro (&tool_bar_items_vector
);
10784 tool_bar_items_vector
= Qnil
;
10786 staticpro (&real_this_command
);
10787 real_this_command
= Qnil
;
10789 Qtimer_event_handler
= intern ("timer-event-handler");
10790 staticpro (&Qtimer_event_handler
);
10792 Qdisabled_command_function
= intern ("disabled-command-function");
10793 staticpro (&Qdisabled_command_function
);
10795 Qself_insert_command
= intern ("self-insert-command");
10796 staticpro (&Qself_insert_command
);
10798 Qforward_char
= intern ("forward-char");
10799 staticpro (&Qforward_char
);
10801 Qbackward_char
= intern ("backward-char");
10802 staticpro (&Qbackward_char
);
10804 Qdisabled
= intern ("disabled");
10805 staticpro (&Qdisabled
);
10807 Qundefined
= intern ("undefined");
10808 staticpro (&Qundefined
);
10810 Qpre_command_hook
= intern ("pre-command-hook");
10811 staticpro (&Qpre_command_hook
);
10813 Qpost_command_hook
= intern ("post-command-hook");
10814 staticpro (&Qpost_command_hook
);
10816 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10817 staticpro (&Qpost_command_idle_hook
);
10819 Qdeferred_action_function
= intern ("deferred-action-function");
10820 staticpro (&Qdeferred_action_function
);
10822 Qcommand_hook_internal
= intern ("command-hook-internal");
10823 staticpro (&Qcommand_hook_internal
);
10825 Qfunction_key
= intern ("function-key");
10826 staticpro (&Qfunction_key
);
10827 Qmouse_click
= intern ("mouse-click");
10828 staticpro (&Qmouse_click
);
10830 Qlanguage_change
= intern ("language-change");
10831 staticpro (&Qlanguage_change
);
10833 Qdrag_n_drop
= intern ("drag-n-drop");
10834 staticpro (&Qdrag_n_drop
);
10836 Qsave_session
= intern ("save-session");
10837 staticpro(&Qsave_session
);
10839 Qusr1_signal
= intern ("usr1-signal");
10840 staticpro (&Qusr1_signal
);
10841 Qusr2_signal
= intern ("usr2-signal");
10842 staticpro (&Qusr2_signal
);
10844 Qmenu_enable
= intern ("menu-enable");
10845 staticpro (&Qmenu_enable
);
10846 Qmenu_alias
= intern ("menu-alias");
10847 staticpro (&Qmenu_alias
);
10848 QCenable
= intern (":enable");
10849 staticpro (&QCenable
);
10850 QCvisible
= intern (":visible");
10851 staticpro (&QCvisible
);
10852 QChelp
= intern (":help");
10853 staticpro (&QChelp
);
10854 QCfilter
= intern (":filter");
10855 staticpro (&QCfilter
);
10856 QCbutton
= intern (":button");
10857 staticpro (&QCbutton
);
10858 QCkeys
= intern (":keys");
10859 staticpro (&QCkeys
);
10860 QCkey_sequence
= intern (":key-sequence");
10861 staticpro (&QCkey_sequence
);
10862 QCtoggle
= intern (":toggle");
10863 staticpro (&QCtoggle
);
10864 QCradio
= intern (":radio");
10865 staticpro (&QCradio
);
10867 Qmode_line
= intern ("mode-line");
10868 staticpro (&Qmode_line
);
10869 Qvertical_line
= intern ("vertical-line");
10870 staticpro (&Qvertical_line
);
10871 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10872 staticpro (&Qvertical_scroll_bar
);
10873 Qmenu_bar
= intern ("menu-bar");
10874 staticpro (&Qmenu_bar
);
10876 Qabove_handle
= intern ("above-handle");
10877 staticpro (&Qabove_handle
);
10878 Qhandle
= intern ("handle");
10879 staticpro (&Qhandle
);
10880 Qbelow_handle
= intern ("below-handle");
10881 staticpro (&Qbelow_handle
);
10882 Qup
= intern ("up");
10884 Qdown
= intern ("down");
10885 staticpro (&Qdown
);
10886 Qtop
= intern ("top");
10888 Qbottom
= intern ("bottom");
10889 staticpro (&Qbottom
);
10890 Qend_scroll
= intern ("end-scroll");
10891 staticpro (&Qend_scroll
);
10892 Qratio
= intern ("ratio");
10893 staticpro (&Qratio
);
10895 Qevent_kind
= intern ("event-kind");
10896 staticpro (&Qevent_kind
);
10897 Qevent_symbol_elements
= intern ("event-symbol-elements");
10898 staticpro (&Qevent_symbol_elements
);
10899 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10900 staticpro (&Qevent_symbol_element_mask
);
10901 Qmodifier_cache
= intern ("modifier-cache");
10902 staticpro (&Qmodifier_cache
);
10904 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10905 staticpro (&Qrecompute_lucid_menubar
);
10906 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10907 staticpro (&Qactivate_menubar_hook
);
10909 Qpolling_period
= intern ("polling-period");
10910 staticpro (&Qpolling_period
);
10912 Qinput_method_function
= intern ("input-method-function");
10913 staticpro (&Qinput_method_function
);
10915 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10916 staticpro (&Qinput_method_exit_on_first_char
);
10917 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10918 staticpro (&Qinput_method_use_echo_area
);
10920 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10921 Fset (Qinput_method_use_echo_area
, Qnil
);
10923 last_point_position_buffer
= Qnil
;
10926 struct event_head
*p
;
10928 for (p
= head_table
;
10929 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10932 *p
->var
= intern (p
->name
);
10933 staticpro (p
->var
);
10934 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10935 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10939 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10940 staticpro (&button_down_location
);
10941 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10942 staticpro (&mouse_syms
);
10943 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10944 staticpro (&wheel_syms
);
10948 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10950 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10951 for (i
= 0; i
< len
; i
++)
10952 if (modifier_names
[i
])
10953 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10954 staticpro (&modifier_symbols
);
10957 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10958 staticpro (&recent_keys
);
10960 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10961 staticpro (&this_command_keys
);
10963 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10964 staticpro (&raw_keybuf
);
10966 Qextended_command_history
= intern ("extended-command-history");
10967 Fset (Qextended_command_history
, Qnil
);
10968 staticpro (&Qextended_command_history
);
10970 accent_key_syms
= Qnil
;
10971 staticpro (&accent_key_syms
);
10973 func_key_syms
= Qnil
;
10974 staticpro (&func_key_syms
);
10976 drag_n_drop_syms
= Qnil
;
10977 staticpro (&drag_n_drop_syms
);
10979 unread_switch_frame
= Qnil
;
10980 staticpro (&unread_switch_frame
);
10982 internal_last_event_frame
= Qnil
;
10983 staticpro (&internal_last_event_frame
);
10985 read_key_sequence_cmd
= Qnil
;
10986 staticpro (&read_key_sequence_cmd
);
10988 menu_bar_one_keymap_changed_items
= Qnil
;
10989 staticpro (&menu_bar_one_keymap_changed_items
);
10991 defsubr (&Sevent_convert_list
);
10992 defsubr (&Sread_key_sequence
);
10993 defsubr (&Sread_key_sequence_vector
);
10994 defsubr (&Srecursive_edit
);
10996 defsubr (&Strack_mouse
);
10998 defsubr (&Sinput_pending_p
);
10999 defsubr (&Scommand_execute
);
11000 defsubr (&Srecent_keys
);
11001 defsubr (&Sthis_command_keys
);
11002 defsubr (&Sthis_command_keys_vector
);
11003 defsubr (&Sthis_single_command_keys
);
11004 defsubr (&Sthis_single_command_raw_keys
);
11005 defsubr (&Sreset_this_command_lengths
);
11006 defsubr (&Sclear_this_command_keys
);
11007 defsubr (&Ssuspend_emacs
);
11008 defsubr (&Sabort_recursive_edit
);
11009 defsubr (&Sexit_recursive_edit
);
11010 defsubr (&Srecursion_depth
);
11011 defsubr (&Stop_level
);
11012 defsubr (&Sdiscard_input
);
11013 defsubr (&Sopen_dribble_file
);
11014 defsubr (&Sset_input_mode
);
11015 defsubr (&Scurrent_input_mode
);
11016 defsubr (&Sexecute_extended_command
);
11017 defsubr (&Sposn_at_point
);
11018 defsubr (&Sposn_at_x_y
);
11020 DEFVAR_LISP ("last-command-char", &last_command_char
,
11021 doc
: /* Last input event that was part of a command. */);
11023 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11024 doc
: /* Last input event that was part of a command. */);
11026 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11027 doc
: /* Last input event in a command, except for mouse menu events.
11028 Mouse menus give back keys that don't look like mouse events;
11029 this variable holds the actual mouse event that led to the menu,
11030 so that you can determine whether the command was run by mouse or not. */);
11032 DEFVAR_LISP ("last-input-char", &last_input_char
,
11033 doc
: /* Last input event. */);
11035 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11036 doc
: /* Last input event. */);
11038 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11039 doc
: /* List of events to be read as the command input.
11040 These events are processed first, before actual keyboard input. */);
11041 Vunread_command_events
= Qnil
;
11043 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11044 doc
: /* If not -1, an object to be read as next command input event. */);
11046 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11047 doc
: /* List of events to be processed as input by input methods.
11048 These events are processed after `unread-command-events', but
11049 before actual keyboard input. */);
11050 Vunread_post_input_method_events
= Qnil
;
11052 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11053 doc
: /* List of events to be processed as input by input methods.
11054 These events are processed after `unread-command-events', but
11055 before actual keyboard input. */);
11056 Vunread_input_method_events
= Qnil
;
11058 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11059 doc
: /* Meta-prefix character code.
11060 Meta-foo as command input turns into this character followed by foo. */);
11061 XSETINT (meta_prefix_char
, 033);
11063 DEFVAR_KBOARD ("last-command", Vlast_command
,
11064 doc
: /* The last command executed.
11065 Normally a symbol with a function definition, but can be whatever was found
11066 in the keymap, or whatever the variable `this-command' was set to by that
11069 The value `mode-exit' is special; it means that the previous command
11070 read an event that told it to exit, and it did so and unread that event.
11071 In other words, the present command is the event that made the previous
11074 The value `kill-region' is special; it means that the previous command
11075 was a kill command. */);
11077 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11078 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11080 DEFVAR_LISP ("this-command", &Vthis_command
,
11081 doc
: /* The command now being executed.
11082 The command can set this variable; whatever is put here
11083 will be in `last-command' during the following command. */);
11084 Vthis_command
= Qnil
;
11086 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11087 doc
: /* The command bound to the current key sequence before remapping.
11088 It equals `this-command' if the original command was not remapped through
11089 any of the active keymaps. Otherwise, the value of `this-command' is the
11090 result of looking up the original command in the active keymaps. */);
11091 Vthis_original_command
= Qnil
;
11093 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11094 doc
: /* *Number of input events between auto-saves.
11095 Zero means disable autosaving due to number of characters typed. */);
11096 auto_save_interval
= 300;
11098 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11099 doc
: /* *Number of seconds idle time before auto-save.
11100 Zero or nil means disable auto-saving due to idleness.
11101 After auto-saving due to this many seconds of idle time,
11102 Emacs also does a garbage collection if that seems to be warranted. */);
11103 XSETFASTINT (Vauto_save_timeout
, 30);
11105 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11106 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11107 The value may be integer or floating point. */);
11108 Vecho_keystrokes
= make_number (1);
11110 DEFVAR_INT ("polling-period", &polling_period
,
11111 doc
: /* *Interval between polling for input during Lisp execution.
11112 The reason for polling is to make C-g work to stop a running program.
11113 Polling is needed only when using X windows and SIGIO does not work.
11114 Polling is automatically disabled in all other cases. */);
11115 polling_period
= 2;
11117 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11118 doc
: /* *Maximum time between mouse clicks to make a double-click.
11119 Measured in milliseconds. nil means disable double-click recognition;
11120 t means double-clicks have no time limit and are detected
11121 by position only. */);
11122 Vdouble_click_time
= make_number (500);
11124 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11125 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11126 On window-system frames, value is the number of pixels the mouse may have
11127 moved horizontally or vertically between two clicks to make a double-click.
11128 On non window-system frames, value is interpreted in units of 1/8 characters
11131 This variable is also the threshold for motion of the mouse
11132 to count as a drag. */);
11133 double_click_fuzz
= 3;
11135 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11136 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11137 inhibit_local_menu_bar_menus
= 0;
11139 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11140 doc
: /* Number of complete key sequences read as input so far.
11141 This includes key sequences read from keyboard macros.
11142 The number is effectively the number of interactive command invocations. */);
11143 num_input_keys
= 0;
11145 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11146 doc
: /* Number of input events read from the keyboard so far.
11147 This does not include events generated by keyboard macros. */);
11148 num_nonmacro_input_events
= 0;
11150 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11151 doc
: /* The frame in which the most recently read event occurred.
11152 If the last event came from a keyboard macro, this is set to `macro'. */);
11153 Vlast_event_frame
= Qnil
;
11155 /* This variable is set up in sysdep.c. */
11156 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11157 doc
: /* The ERASE character as set by the user with stty. */);
11159 DEFVAR_LISP ("help-char", &Vhelp_char
,
11160 doc
: /* Character to recognize as meaning Help.
11161 When it is read, do `(eval help-form)', and display result if it's a string.
11162 If the value of `help-form' is nil, this char can be read normally. */);
11163 XSETINT (Vhelp_char
, Ctl ('H'));
11165 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11166 doc
: /* List of input events to recognize as meaning Help.
11167 These work just like the value of `help-char' (see that). */);
11168 Vhelp_event_list
= Qnil
;
11170 DEFVAR_LISP ("help-form", &Vhelp_form
,
11171 doc
: /* Form to execute when character `help-char' is read.
11172 If the form returns a string, that string is displayed.
11173 If `help-form' is nil, the help char is not recognized. */);
11176 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11177 doc
: /* Command to run when `help-char' character follows a prefix key.
11178 This command is used only when there is no actual binding
11179 for that character after that prefix key. */);
11180 Vprefix_help_command
= Qnil
;
11182 DEFVAR_LISP ("top-level", &Vtop_level
,
11183 doc
: /* Form to evaluate when Emacs starts up.
11184 Useful to set before you dump a modified Emacs. */);
11187 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11188 doc
: /* Translate table for keyboard input, or nil.
11189 If non-nil, the value should be a char-table. Each character read
11190 from the keyboard is looked up in this char-table. If the value found
11191 there is non-nil, then it is used instead of the actual input character.
11193 The value can also be a string or vector, but this is considered obsolete.
11194 If it is a string or vector of length N, character codes N and up are left
11195 untranslated. In a vector, an element which is nil means "no translation".
11197 This is applied to the characters supplied to input methods, not their
11198 output. See also `translation-table-for-input'. */);
11199 Vkeyboard_translate_table
= Qnil
;
11201 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11202 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11203 \(Even if the operating system has support for stopping a process.\) */);
11204 cannot_suspend
= 0;
11206 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11207 doc
: /* Non-nil means prompt with menus when appropriate.
11208 This is done when reading from a keymap that has a prompt string,
11209 for elements that have prompt strings.
11210 The menu is displayed on the screen
11211 if X menus were enabled at configuration
11212 time and the previous event was a mouse click prefix key.
11213 Otherwise, menu prompting uses the echo area. */);
11214 menu_prompting
= 1;
11216 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11217 doc
: /* Character to see next line of menu prompt.
11218 Type this character while in a menu prompt to rotate around the lines of it. */);
11219 XSETINT (menu_prompt_more_char
, ' ');
11221 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11222 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11223 Emacs applies the modifiers of the character stored here to each keyboard
11224 character it reads. For example, after evaluating the expression
11225 (setq extra-keyboard-modifiers ?\\C-x)
11226 all input characters will have the control modifier applied to them.
11228 Note that the character ?\\C-@, equivalent to the integer zero, does
11229 not count as a control character; rather, it counts as a character
11230 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11231 cancels any modification. */);
11232 extra_keyboard_modifiers
= 0;
11234 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11235 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11236 The command loop sets this to nil before each command,
11237 and tests the value when the command returns.
11238 Buffer modification stores t in this variable. */);
11239 Vdeactivate_mark
= Qnil
;
11241 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11242 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11243 Vcommand_hook_internal
= Qnil
;
11245 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11246 doc
: /* Normal hook run before each command is executed.
11247 If an unhandled error happens in running this hook,
11248 the hook value is set to nil, since otherwise the error
11249 might happen repeatedly and make Emacs nonfunctional. */);
11250 Vpre_command_hook
= Qnil
;
11252 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11253 doc
: /* Normal hook run after each command is executed.
11254 If an unhandled error happens in running this hook,
11255 the hook value is set to nil, since otherwise the error
11256 might happen repeatedly and make Emacs nonfunctional. */);
11257 Vpost_command_hook
= Qnil
;
11259 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11260 doc
: /* Normal hook run after each command is executed, if idle.
11261 Errors running the hook are caught and ignored. */);
11262 Vpost_command_idle_hook
= Qnil
;
11264 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11265 doc
: /* Delay time before running `post-command-idle-hook'.
11266 This is measured in microseconds. */);
11267 post_command_idle_delay
= 100000;
11270 DEFVAR_LISP ("echo-area-clear-hook", ...,
11271 doc
: /* Normal hook run when clearing the echo area. */);
11273 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11274 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11276 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11277 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11278 Vlucid_menu_bar_dirty_flag
= Qnil
;
11280 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11281 doc
: /* List of menu bar items to move to the end of the menu bar.
11282 The elements of the list are event types that may have menu bar bindings. */);
11283 Vmenu_bar_final_items
= Qnil
;
11285 DEFVAR_KBOARD ("overriding-terminal-local-map",
11286 Voverriding_terminal_local_map
,
11287 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11288 If this variable is non-nil, it is used as a keymap instead of the
11289 buffer's local map, and the minor mode keymaps and text property keymaps.
11290 It also replaces `overriding-local-map'.
11292 This variable is intended to let commands such as `universal-argument'
11293 set up a different keymap for reading the next command. */);
11295 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11296 doc
: /* Keymap that overrides all other local keymaps.
11297 If this variable is non-nil, it is used as a keymap--replacing the
11298 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11299 Voverriding_local_map
= Qnil
;
11301 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11302 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11303 Otherwise, the menu bar continues to reflect the buffer's local map
11304 and the minor mode maps regardless of `overriding-local-map'. */);
11305 Voverriding_local_map_menu_flag
= Qnil
;
11307 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11308 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11309 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11311 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11312 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11314 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11315 doc
: /* Alist of system-specific X windows key symbols.
11316 Each element should have the form (N . SYMBOL) where N is the
11317 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11318 and SYMBOL is its name. */);
11320 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11321 doc
: /* List of deferred actions to be performed at a later time.
11322 The precise format isn't relevant here; we just check whether it is nil. */);
11323 Vdeferred_action_list
= Qnil
;
11325 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11326 doc
: /* Function to call to handle deferred actions, after each command.
11327 This function is called with no arguments after each command
11328 whenever `deferred-action-list' is non-nil. */);
11329 Vdeferred_action_function
= Qnil
;
11331 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11332 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11333 The value can be a length of time to show the message for.
11334 If the value is non-nil and not a number, we wait 2 seconds. */);
11335 Vsuggest_key_bindings
= Qt
;
11337 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11338 doc
: /* List of active absolute time timers in order of increasing time. */);
11339 Vtimer_list
= Qnil
;
11341 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11342 doc
: /* List of active idle-time timers in order of increasing time. */);
11343 Vtimer_idle_list
= Qnil
;
11345 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11346 doc
: /* If non-nil, the function that implements the current input method.
11347 It's called with one argument, a printing character that was just read.
11348 \(That means a character with code 040...0176.)
11349 Typically this function uses `read-event' to read additional events.
11350 When it does so, it should first bind `input-method-function' to nil
11351 so it will not be called recursively.
11353 The function should return a list of zero or more events
11354 to be used as input. If it wants to put back some events
11355 to be reconsidered, separately, by the input method,
11356 it can add them to the beginning of `unread-command-events'.
11358 The input method function can find in `input-method-previous-method'
11359 the previous echo area message.
11361 The input method function should refer to the variables
11362 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11363 for guidance on what to do. */);
11364 Vinput_method_function
= Qnil
;
11366 DEFVAR_LISP ("input-method-previous-message",
11367 &Vinput_method_previous_message
,
11368 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11369 This variable exists because `read-event' clears the echo area
11370 before running the input method. It is nil if there was no message. */);
11371 Vinput_method_previous_message
= Qnil
;
11373 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11374 doc
: /* If non-nil, the function that implements the display of help.
11375 It's called with one argument, the help string to display. */);
11376 Vshow_help_function
= Qnil
;
11378 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11379 doc
: /* If non-nil, suppress point adjustment after executing a command.
11381 After a command is executed, if point is moved into a region that has
11382 special properties (e.g. composition, display), we adjust point to
11383 the boundary of the region. But, when a command sets this variable to
11384 non-nil, we suppress the point adjustment.
11386 This variable is set to nil before reading a command, and is checked
11387 just after executing the command. */);
11388 Vdisable_point_adjustment
= Qnil
;
11390 DEFVAR_LISP ("global-disable-point-adjustment",
11391 &Vglobal_disable_point_adjustment
,
11392 doc
: /* *If non-nil, always suppress point adjustment.
11394 The default value is nil, in which case, point adjustment are
11395 suppressed only after special commands that set
11396 `disable-point-adjustment' (which see) to non-nil. */);
11397 Vglobal_disable_point_adjustment
= Qnil
;
11399 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11400 doc
: /* Non-nil means updating menu bindings is allowed.
11401 A value of nil means menu bindings should not be updated.
11402 Used during Emacs' startup. */);
11403 update_menu_bindings
= 1;
11405 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11406 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11407 If the value is not a number, such messages don't time out. */);
11408 Vminibuffer_message_timeout
= make_number (2);
11410 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11411 doc
: /* If non-nil, any keyboard input throws to this symbol.
11412 The value of that variable is passed to `quit-flag' and later causes a
11413 peculiar kind of quitting. */);
11414 Vthrow_on_input
= Qnil
;
11418 keys_of_keyboard ()
11420 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11421 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11422 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11423 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11424 initial_define_key (meta_map
, 'x', "execute-extended-command");
11426 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11427 "handle-delete-frame");
11428 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11430 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11432 /* Handling it at such a low-level causes read_key_sequence to get
11433 * confused because it doesn't realize that the current_buffer was
11434 * changed by read_char.
11436 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11437 * "handle-select-window"); */
11438 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11439 "handle-save-session");
11442 /* Mark the pointers in the kboard objects.
11443 Called by the Fgarbage_collector. */
11449 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11451 if (kb
->kbd_macro_buffer
)
11452 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11454 mark_object (kb
->Voverriding_terminal_local_map
);
11455 mark_object (kb
->Vlast_command
);
11456 mark_object (kb
->Vreal_last_command
);
11457 mark_object (kb
->Vprefix_arg
);
11458 mark_object (kb
->Vlast_prefix_arg
);
11459 mark_object (kb
->kbd_queue
);
11460 mark_object (kb
->defining_kbd_macro
);
11461 mark_object (kb
->Vlast_kbd_macro
);
11462 mark_object (kb
->Vsystem_key_alist
);
11463 mark_object (kb
->system_key_syms
);
11464 mark_object (kb
->Vdefault_minibuffer_frame
);
11465 mark_object (kb
->echo_string
);
11468 struct input_event
*event
;
11469 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11471 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11472 event
= kbd_buffer
;
11473 if (event
->kind
!= SELECTION_REQUEST_EVENT
11474 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11476 mark_object (event
->x
);
11477 mark_object (event
->y
);
11479 mark_object (event
->frame_or_window
);
11480 mark_object (event
->arg
);
11485 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11486 (do not change this comment) */