1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99,2000,01,02,03,04
3 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"
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 call0 (Vdeferred_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 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
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
), 0, 0, 0);
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))
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
)
2970 && CHAR_VALID_P (XINT (c
), 0)))
2973 d
= Faref (Vkeyboard_translate_table
, c
);
2974 /* nil in keyboard-translate-table means no translation. */
2980 /* If this event is a mouse click in the menu bar,
2981 return just menu-bar for now. Modify the mouse click event
2982 so we won't do this twice, then queue it up. */
2983 if (EVENT_HAS_PARAMETERS (c
)
2985 && CONSP (EVENT_START (c
))
2986 && CONSP (XCDR (EVENT_START (c
))))
2990 posn
= POSN_POSN (EVENT_START (c
));
2991 /* Handle menu-bar events:
2992 insert the dummy prefix event `menu-bar'. */
2993 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2995 /* Change menu-bar to (menu-bar) as the event "position". */
2996 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2999 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3004 /* Store these characters into recent_keys, the dribble file if any,
3005 and the keyboard macro being defined, if any. */
3007 if (! NILP (also_record
))
3008 record_char (also_record
);
3010 /* Wipe the echo area.
3011 But first, if we are about to use an input method,
3012 save the echo area contents for it to refer to. */
3014 && ! NILP (Vinput_method_function
)
3015 && (unsigned) XINT (c
) >= ' '
3016 && (unsigned) XINT (c
) != 127
3017 && (unsigned) XINT (c
) < 256)
3019 previous_echo_area_message
= Fcurrent_message ();
3020 Vinput_method_previous_message
= previous_echo_area_message
;
3023 /* Now wipe the echo area, except for help events which do their
3024 own stuff with the echo area. */
3026 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3027 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3029 if (!NILP (echo_area_buffer
[0]))
3030 safe_run_hooks (Qecho_area_clear_hook
);
3031 clear_message (1, 0);
3034 reread_for_input_method
:
3036 /* Pass this to the input method, if appropriate. */
3038 && ! NILP (Vinput_method_function
)
3039 /* Don't run the input method within a key sequence,
3040 after the first event of the key sequence. */
3041 && NILP (prev_event
)
3042 && (unsigned) XINT (c
) >= ' '
3043 && (unsigned) XINT (c
) != 127
3044 && (unsigned) XINT (c
) < 256)
3047 int key_count
, key_count_reset
;
3048 struct gcpro gcpro1
;
3049 int count
= SPECPDL_INDEX ();
3051 /* Save the echo status. */
3052 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3053 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3054 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3055 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3058 if (before_command_restore_flag
)
3060 this_command_key_count
= before_command_key_count_1
;
3061 if (this_command_key_count
< this_single_command_key_start
)
3062 this_single_command_key_start
= this_command_key_count
;
3063 echo_truncate (before_command_echo_length_1
);
3064 before_command_restore_flag
= 0;
3068 /* Save the this_command_keys status. */
3069 key_count
= this_command_key_count
;
3070 key_count_reset
= this_command_key_count_reset
;
3073 keys
= Fcopy_sequence (this_command_keys
);
3078 /* Clear out this_command_keys. */
3079 this_command_key_count
= 0;
3080 this_command_key_count_reset
= 0;
3082 /* Now wipe the echo area. */
3083 if (!NILP (echo_area_buffer
[0]))
3084 safe_run_hooks (Qecho_area_clear_hook
);
3085 clear_message (1, 0);
3088 /* If we are not reading a key sequence,
3089 never use the echo area. */
3092 specbind (Qinput_method_use_echo_area
, Qt
);
3095 /* Call the input method. */
3096 tem
= call1 (Vinput_method_function
, c
);
3098 tem
= unbind_to (count
, tem
);
3100 /* Restore the saved echoing state
3101 and this_command_keys state. */
3102 this_command_key_count
= key_count
;
3103 this_command_key_count_reset
= key_count_reset
;
3105 this_command_keys
= keys
;
3108 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3109 current_kboard
->echo_string
= saved_echo_string
;
3110 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3111 if (saved_immediate_echo
)
3116 /* The input method can return no events. */
3119 /* Bring back the previous message, if any. */
3120 if (! NILP (previous_echo_area_message
))
3121 message_with_string ("%s", previous_echo_area_message
, 0);
3124 /* It returned one event or more. */
3126 Vunread_post_input_method_events
3127 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3132 /* Display help if not echoing. */
3133 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3135 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3136 Lisp_Object help
, object
, position
, window
, tem
;
3138 tem
= Fcdr (XCDR (c
));
3141 window
= Fcar (tem
);
3143 object
= Fcar (tem
);
3145 position
= Fcar (tem
);
3147 show_help_echo (help
, window
, object
, position
, 0);
3149 /* We stopped being idle for this event; undo that. */
3150 timer_resume_idle ();
3154 if (! reread
|| this_command_key_count
== 0
3155 || this_command_key_count_reset
)
3158 /* Don't echo mouse motion events. */
3159 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3160 && NILP (Fzerop (Vecho_keystrokes
))
3161 && ! (EVENT_HAS_PARAMETERS (c
)
3162 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3165 if (! NILP (also_record
))
3166 echo_char (also_record
);
3167 /* Once we reread a character, echoing can happen
3168 the next time we pause to read a new one. */
3169 ok_to_echo_at_next_pause
= current_kboard
;
3172 /* Record this character as part of the current key. */
3173 add_command_key (c
);
3174 if (! NILP (also_record
))
3175 add_command_key (also_record
);
3178 last_input_char
= c
;
3181 /* Process the help character specially if enabled */
3182 if (!NILP (Vhelp_form
) && help_char_p (c
))
3185 count
= SPECPDL_INDEX ();
3187 record_unwind_protect (Fset_window_configuration
,
3188 Fcurrent_window_configuration (Qnil
));
3190 tem0
= Feval (Vhelp_form
);
3192 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3196 c
= read_char (0, 0, 0, Qnil
, 0);
3197 while (BUFFERP (c
));
3198 /* Remove the help from the frame */
3199 unbind_to (count
, Qnil
);
3202 if (EQ (c
, make_number (040)))
3206 c
= read_char (0, 0, 0, Qnil
, 0);
3207 while (BUFFERP (c
));
3216 /* Record a key that came from a mouse menu.
3217 Record it for echoing, for this-command-keys, and so on. */
3223 /* Wipe the echo area. */
3224 clear_message (1, 0);
3229 before_command_key_count
= this_command_key_count
;
3230 before_command_echo_length
= echo_length ();
3233 /* Don't echo mouse motion events. */
3234 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3235 && NILP (Fzerop (Vecho_keystrokes
)))
3239 /* Once we reread a character, echoing can happen
3240 the next time we pause to read a new one. */
3241 ok_to_echo_at_next_pause
= 0;
3244 /* Record this character as part of the current key. */
3245 add_command_key (c
);
3247 /* Re-reading in the middle of a command */
3248 last_input_char
= c
;
3252 /* Return 1 if should recognize C as "the help character". */
3260 if (EQ (c
, Vhelp_char
))
3262 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3263 if (EQ (c
, XCAR (tail
)))
3268 /* Record the input event C in various ways. */
3276 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3278 /* To avoid filling recent_keys with help-echo and mouse-movement
3279 events, we filter out repeated help-echo events, only store the
3280 first and last in a series of mouse-movement events, and don't
3281 store repeated help-echo events which are only separated by
3282 mouse-movement events. */
3284 Lisp_Object ev1
, ev2
, ev3
;
3287 if ((ix1
= recent_keys_index
- 1) < 0)
3288 ix1
= NUM_RECENT_KEYS
- 1;
3289 ev1
= AREF (recent_keys
, ix1
);
3291 if ((ix2
= ix1
- 1) < 0)
3292 ix2
= NUM_RECENT_KEYS
- 1;
3293 ev2
= AREF (recent_keys
, ix2
);
3295 if ((ix3
= ix2
- 1) < 0)
3296 ix3
= NUM_RECENT_KEYS
- 1;
3297 ev3
= AREF (recent_keys
, ix3
);
3299 if (EQ (XCAR (c
), Qhelp_echo
))
3301 /* Don't record `help-echo' in recent_keys unless it shows some help
3302 message, and a different help than the previously recorded
3304 Lisp_Object help
, last_help
;
3306 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3307 if (!STRINGP (help
))
3309 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3310 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3312 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3313 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3314 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3316 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3317 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3318 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3319 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3322 else if (EQ (XCAR (c
), Qmouse_movement
))
3324 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3325 So additional mouse movement events replace the last element. */
3326 Lisp_Object last_window
, window
;
3328 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3329 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3330 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3331 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3332 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3334 ASET (recent_keys
, ix1
, c
);
3340 store_kbd_macro_char (c
);
3345 ASET (recent_keys
, recent_keys_index
, c
);
3346 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3347 recent_keys_index
= 0;
3349 else if (recorded
< 0)
3351 /* We need to remove one or two events from recent_keys.
3352 To do this, we simply put nil at those events and move the
3353 recent_keys_index backwards over those events. Usually,
3354 users will never see those nil events, as they will be
3355 overwritten by the command keys entered to see recent_keys
3358 while (recorded
++ < 0 && total_keys
> 0)
3360 if (total_keys
< NUM_RECENT_KEYS
)
3362 if (--recent_keys_index
< 0)
3363 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3364 ASET (recent_keys
, recent_keys_index
, Qnil
);
3368 num_nonmacro_input_events
++;
3370 /* Write c to the dribble file. If c is a lispy event, write
3371 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3372 If you, dear reader, have a better idea, you've got the source. :-) */
3377 if (XUINT (c
) < 0x100)
3378 putc (XINT (c
), dribble
);
3380 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3384 Lisp_Object dribblee
;
3386 /* If it's a structured event, take the event header. */
3387 dribblee
= EVENT_HEAD (c
);
3389 if (SYMBOLP (dribblee
))
3391 putc ('<', dribble
);
3392 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3393 SBYTES (SYMBOL_NAME (dribblee
)),
3395 putc ('>', dribble
);
3407 struct buffer
*old
= current_buffer
;
3408 Fprinc (object
, Qnil
);
3409 set_buffer_internal (XBUFFER (Vstandard_output
));
3410 call0 (intern ("help-mode"));
3411 set_buffer_internal (old
);
3415 /* Copy out or in the info on where C-g should throw to.
3416 This is used when running Lisp code from within get_char,
3417 in case get_char is called recursively.
3418 See read_process_output. */
3424 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3428 restore_getcjmp (temp
)
3431 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3436 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3437 of this function. */
3440 tracking_off (old_value
)
3441 Lisp_Object old_value
;
3443 do_mouse_tracking
= old_value
;
3444 if (NILP (old_value
))
3446 /* Redisplay may have been preempted because there was input
3447 available, and it assumes it will be called again after the
3448 input has been processed. If the only input available was
3449 the sort that we have just disabled, then we need to call
3451 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3453 redisplay_preserve_echo_area (6);
3454 get_input_pending (&input_pending
,
3455 READABLE_EVENTS_DO_TIMERS_NOW
);
3461 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3462 doc
: /* Evaluate BODY with mouse movement events enabled.
3463 Within a `track-mouse' form, mouse motion generates input events that
3464 you can read with `read-event'.
3465 Normally, mouse motion is ignored.
3466 usage: (track-mouse BODY ...) */)
3470 int count
= SPECPDL_INDEX ();
3473 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3475 do_mouse_tracking
= Qt
;
3477 val
= Fprogn (args
);
3478 return unbind_to (count
, val
);
3481 /* If mouse has moved on some frame, return one of those frames.
3482 Return 0 otherwise. */
3487 Lisp_Object tail
, frame
;
3489 FOR_EACH_FRAME (tail
, frame
)
3491 if (XFRAME (frame
)->mouse_moved
)
3492 return XFRAME (frame
);
3498 #endif /* HAVE_MOUSE */
3500 /* Low level keyboard/mouse input.
3501 kbd_buffer_store_event places events in kbd_buffer, and
3502 kbd_buffer_get_event retrieves them. */
3504 /* Return true iff there are any events in the queue that read-char
3505 would return. If this returns false, a read-char would block. */
3507 readable_events (flags
)
3510 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3513 /* If the buffer contains only FOCUS_IN_EVENT events, and
3514 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3515 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3517 int have_live_event
= 1;
3519 if (flags
& READABLE_EVENTS_FILTER_EVENTS
)
3521 struct input_event
*event
;
3523 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3527 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3530 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3532 if (event
== kbd_store_ptr
)
3533 have_live_event
= 0;
3536 if (have_live_event
) return 1;
3540 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3541 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3546 if (current_kboard
->kbd_queue_has_data
)
3552 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3553 if (kb
->kbd_queue_has_data
)
3559 /* Set this for debugging, to have a way to get out */
3564 event_to_kboard (event
)
3565 struct input_event
*event
;
3568 frame
= event
->frame_or_window
;
3570 frame
= XCAR (frame
);
3571 else if (WINDOWP (frame
))
3572 frame
= WINDOW_FRAME (XWINDOW (frame
));
3574 /* There are still some events that don't set this field.
3575 For now, just ignore the problem.
3576 Also ignore dead frames here. */
3577 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3580 return FRAME_KBOARD (XFRAME (frame
));
3585 Lisp_Object Vthrow_on_input
;
3587 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3590 kbd_buffer_store_event (event
)
3591 register struct input_event
*event
;
3593 kbd_buffer_store_event_hold (event
, 0);
3596 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3598 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3599 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3600 Else, if EVENT is a quit event, store the quit event
3601 in HOLD_QUIT, and return (thus ignoring further events).
3603 This is used in read_avail_input to postpone the processing
3604 of the quit event until all subsequent input events have been
3605 parsed (and discarded).
3609 kbd_buffer_store_event_hold (event
, hold_quit
)
3610 register struct input_event
*event
;
3611 struct input_event
*hold_quit
;
3613 if (event
->kind
== NO_EVENT
)
3616 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3619 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3621 register int c
= event
->code
& 0377;
3623 if (event
->modifiers
& ctrl_modifier
)
3624 c
= make_ctrl_char (c
);
3626 c
|= (event
->modifiers
3627 & (meta_modifier
| alt_modifier
3628 | hyper_modifier
| super_modifier
));
3634 struct input_event
*sp
;
3637 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3638 kb
!= current_kboard
))
3641 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3642 Fcons (make_number (c
), Qnil
));
3643 kb
->kbd_queue_has_data
= 1;
3644 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3646 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3649 if (event_to_kboard (sp
) == kb
)
3651 sp
->kind
= NO_EVENT
;
3652 sp
->frame_or_window
= Qnil
;
3662 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3666 /* If this results in a quit_char being returned to Emacs as
3667 input, set Vlast_event_frame properly. If this doesn't
3668 get returned to Emacs as an event, the next event read
3669 will set Vlast_event_frame again, so this is safe to do. */
3673 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3675 focus
= event
->frame_or_window
;
3676 internal_last_event_frame
= focus
;
3677 Vlast_event_frame
= focus
;
3680 last_event_timestamp
= event
->timestamp
;
3681 interrupt_signal (0 /* dummy */);
3685 if (c
&& c
== stop_character
)
3691 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3692 Just ignore the second one. */
3693 else if (event
->kind
== BUFFER_SWITCH_EVENT
3694 && kbd_fetch_ptr
!= kbd_store_ptr
3695 && ((kbd_store_ptr
== kbd_buffer
3696 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3697 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3700 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3701 kbd_store_ptr
= kbd_buffer
;
3703 /* Don't let the very last slot in the buffer become full,
3704 since that would make the two pointers equal,
3705 and that is indistinguishable from an empty buffer.
3706 Discard the event if it would fill the last slot. */
3707 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3709 *kbd_store_ptr
= *event
;
3713 /* If we're inside while-no-input, and this event qualifies
3714 as input, set quit-flag to cause an interrupt. */
3715 if (!NILP (Vthrow_on_input
)
3716 && event
->kind
!= FOCUS_IN_EVENT
3717 && event
->kind
!= HELP_EVENT
3718 && event
->kind
!= DEICONIFY_EVENT
)
3720 Vquit_flag
= Vthrow_on_input
;
3721 /* If we're inside a function that wants immediate quits,
3723 if (immediate_quit
&& NILP (Vinhibit_quit
))
3733 /* Put an input event back in the head of the event queue. */
3736 kbd_buffer_unget_event (event
)
3737 register struct input_event
*event
;
3739 if (kbd_fetch_ptr
== kbd_buffer
)
3740 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3742 /* Don't let the very last slot in the buffer become full, */
3743 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3746 *kbd_fetch_ptr
= *event
;
3751 /* Generate HELP_EVENT input_events in BUFP which has room for
3752 SIZE events. If there's not enough room in BUFP, ignore this
3755 HELP is the help form.
3757 FRAME is the frame on which the help is generated. OBJECT is the
3758 Lisp object where the help was found (a buffer, a string, an
3759 overlay, or nil if neither from a string nor from a buffer. POS is
3760 the position within OBJECT where the help was found.
3762 Value is the number of input_events generated. */
3765 gen_help_event (help
, frame
, window
, object
, pos
)
3766 Lisp_Object help
, frame
, object
, window
;
3769 struct input_event event
;
3773 event
.kind
= HELP_EVENT
;
3774 event
.frame_or_window
= frame
;
3776 event
.x
= WINDOWP (window
) ? window
: frame
;
3779 kbd_buffer_store_event (&event
);
3783 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3786 kbd_buffer_store_help_event (frame
, help
)
3787 Lisp_Object frame
, help
;
3789 struct input_event event
;
3791 event
.kind
= HELP_EVENT
;
3792 event
.frame_or_window
= frame
;
3797 kbd_buffer_store_event (&event
);
3801 /* Discard any mouse events in the event buffer by setting them to
3804 discard_mouse_events ()
3806 struct input_event
*sp
;
3807 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3809 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3812 if (sp
->kind
== MOUSE_CLICK_EVENT
3813 || sp
->kind
== WHEEL_EVENT
3815 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3817 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3819 sp
->kind
= NO_EVENT
;
3825 /* Return non-zero if there are any real events waiting in the event
3826 buffer, not counting `NO_EVENT's.
3828 If DISCARD is non-zero, discard NO_EVENT events at the front of
3829 the input queue, possibly leaving the input queue empty if there
3830 are no real input events. */
3833 kbd_buffer_events_waiting (discard
)
3836 struct input_event
*sp
;
3838 for (sp
= kbd_fetch_ptr
;
3839 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3842 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3849 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3853 /* Clear input event EVENT. */
3857 struct input_event
*event
;
3859 event
->kind
= NO_EVENT
;
3863 /* Read one event from the event buffer, waiting if necessary.
3864 The value is a Lisp object representing the event.
3865 The value is nil for an event that should be ignored,
3866 or that was handled here.
3867 We always read and discard one event. */
3870 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3872 int *used_mouse_menu
;
3881 *kbp
= current_kboard
;
3885 /* Wait until there is input available. */
3888 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3891 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3895 /* If the quit flag is set, then read_char will return
3896 quit_char, so that counts as "available input." */
3897 if (!NILP (Vquit_flag
))
3898 quit_throw_to_read_char ();
3900 /* One way or another, wait until input is available; then, if
3901 interrupt handlers have not read it, read it now. */
3904 wait_for_kbd_input ();
3906 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3910 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3913 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3917 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3919 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3920 /* Pass 1 for EXPECT since we just waited to have input. */
3921 read_avail_input (1);
3923 #endif /* not VMS */
3926 if (CONSP (Vunread_command_events
))
3929 first
= XCAR (Vunread_command_events
);
3930 Vunread_command_events
= XCDR (Vunread_command_events
);
3931 *kbp
= current_kboard
;
3935 /* At this point, we know that there is a readable event available
3936 somewhere. If the event queue is empty, then there must be a
3937 mouse movement enabled and available. */
3938 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3940 struct input_event
*event
;
3942 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3946 last_event_timestamp
= event
->timestamp
;
3949 *kbp
= event_to_kboard (event
);
3951 *kbp
= current_kboard
; /* Better than returning null ptr? */
3953 *kbp
= &the_only_kboard
;
3958 /* These two kinds of events get special handling
3959 and don't actually appear to the command loop.
3960 We return nil for them. */
3961 if (event
->kind
== SELECTION_REQUEST_EVENT
3962 || event
->kind
== SELECTION_CLEAR_EVENT
)
3965 struct input_event copy
;
3967 /* Remove it from the buffer before processing it,
3968 since otherwise swallow_events will see it
3969 and process it again. */
3971 kbd_fetch_ptr
= event
+ 1;
3972 input_pending
= readable_events (0);
3973 x_handle_selection_event (©
);
3975 /* We're getting selection request events, but we don't have
3981 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3982 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3984 /* Make an event (delete-frame (FRAME)). */
3985 obj
= Fcons (event
->frame_or_window
, Qnil
);
3986 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3987 kbd_fetch_ptr
= event
+ 1;
3990 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3991 else if (event
->kind
== ICONIFY_EVENT
)
3993 /* Make an event (iconify-frame (FRAME)). */
3994 obj
= Fcons (event
->frame_or_window
, Qnil
);
3995 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3996 kbd_fetch_ptr
= event
+ 1;
3998 else if (event
->kind
== DEICONIFY_EVENT
)
4000 /* Make an event (make-frame-visible (FRAME)). */
4001 obj
= Fcons (event
->frame_or_window
, Qnil
);
4002 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4003 kbd_fetch_ptr
= event
+ 1;
4006 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4008 /* The value doesn't matter here; only the type is tested. */
4009 XSETBUFFER (obj
, current_buffer
);
4010 kbd_fetch_ptr
= event
+ 1;
4012 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4013 || defined (USE_GTK)
4014 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4016 kbd_fetch_ptr
= event
+ 1;
4017 input_pending
= readable_events (0);
4018 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4019 x_activate_menubar (XFRAME (event
->frame_or_window
));
4023 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4025 /* Make an event (language-change (FRAME CHARSET LCID)). */
4026 obj
= Fcons (event
->frame_or_window
, Qnil
);
4027 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4028 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== SAVE_SESSION_EVENT
)
4033 obj
= Fcons (Qsave_session
, Qnil
);
4034 kbd_fetch_ptr
= event
+ 1;
4036 /* Just discard these, by returning nil.
4037 With MULTI_KBOARD, these events are used as placeholders
4038 when we need to randomly delete events from the queue.
4039 (They shouldn't otherwise be found in the buffer,
4040 but on some machines it appears they do show up
4041 even without MULTI_KBOARD.) */
4042 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4043 mouse events during a popup-menu call. */
4044 else if (event
->kind
== NO_EVENT
)
4045 kbd_fetch_ptr
= event
+ 1;
4046 else if (event
->kind
== HELP_EVENT
)
4048 Lisp_Object object
, position
, help
, frame
, window
;
4050 frame
= event
->frame_or_window
;
4051 object
= event
->arg
;
4052 position
= make_number (event
->code
);
4055 clear_event (event
);
4057 kbd_fetch_ptr
= event
+ 1;
4058 if (!WINDOWP (window
))
4060 obj
= Fcons (Qhelp_echo
,
4061 list5 (frame
, help
, window
, object
, position
));
4063 else if (event
->kind
== FOCUS_IN_EVENT
)
4065 /* Notification of a FocusIn event. The frame receiving the
4066 focus is in event->frame_or_window. Generate a
4067 switch-frame event if necessary. */
4068 Lisp_Object frame
, focus
;
4070 frame
= event
->frame_or_window
;
4071 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4075 if (!EQ (frame
, internal_last_event_frame
)
4076 && !EQ (frame
, selected_frame
))
4077 obj
= make_lispy_switch_frame (frame
);
4078 internal_last_event_frame
= frame
;
4079 kbd_fetch_ptr
= event
+ 1;
4083 /* If this event is on a different frame, return a switch-frame this
4084 time, and leave the event in the queue for next time. */
4088 frame
= event
->frame_or_window
;
4090 frame
= XCAR (frame
);
4091 else if (WINDOWP (frame
))
4092 frame
= WINDOW_FRAME (XWINDOW (frame
));
4094 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4098 if (! EQ (frame
, internal_last_event_frame
)
4099 && !EQ (frame
, selected_frame
))
4100 obj
= make_lispy_switch_frame (frame
);
4101 internal_last_event_frame
= frame
;
4103 /* If we didn't decide to make a switch-frame event, go ahead
4104 and build a real event from the queue entry. */
4108 obj
= make_lispy_event (event
);
4110 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4111 || defined (USE_GTK)
4112 /* If this was a menu selection, then set the flag to inhibit
4113 writing to last_nonmenu_event. Don't do this if the event
4114 we're returning is (menu-bar), though; that indicates the
4115 beginning of the menu sequence, and we might as well leave
4116 that as the `event with parameters' for this selection. */
4118 && !EQ (event
->frame_or_window
, event
->arg
)
4119 && (event
->kind
== MENU_BAR_EVENT
4120 || event
->kind
== TOOL_BAR_EVENT
))
4121 *used_mouse_menu
= 1;
4124 /* Wipe out this event, to catch bugs. */
4125 clear_event (event
);
4126 kbd_fetch_ptr
= event
+ 1;
4131 /* Try generating a mouse motion event. */
4132 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4134 FRAME_PTR f
= some_mouse_moved ();
4135 Lisp_Object bar_window
;
4136 enum scroll_bar_part part
;
4140 *kbp
= current_kboard
;
4141 /* Note that this uses F to determine which display to look at.
4142 If there is no valid info, it does not store anything
4143 so x remains nil. */
4145 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4149 /* Decide if we should generate a switch-frame event. Don't
4150 generate switch-frame events for motion outside of all Emacs
4156 frame
= FRAME_FOCUS_FRAME (f
);
4158 XSETFRAME (frame
, f
);
4160 if (! EQ (frame
, internal_last_event_frame
)
4161 && !EQ (frame
, selected_frame
))
4162 obj
= make_lispy_switch_frame (frame
);
4163 internal_last_event_frame
= frame
;
4166 /* If we didn't decide to make a switch-frame event, go ahead and
4167 return a mouse-motion event. */
4168 if (!NILP (x
) && NILP (obj
))
4169 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4171 #endif /* HAVE_MOUSE */
4173 /* We were promised by the above while loop that there was
4174 something for us to read! */
4177 input_pending
= readable_events (0);
4179 Vlast_event_frame
= internal_last_event_frame
;
4184 /* Process any events that are not user-visible,
4185 then return, without reading any user-visible events. */
4188 swallow_events (do_display
)
4193 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4195 struct input_event
*event
;
4197 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4201 last_event_timestamp
= event
->timestamp
;
4203 /* These two kinds of events get special handling
4204 and don't actually appear to the command loop. */
4205 if (event
->kind
== SELECTION_REQUEST_EVENT
4206 || event
->kind
== SELECTION_CLEAR_EVENT
)
4209 struct input_event copy
;
4211 /* Remove it from the buffer before processing it,
4212 since otherwise swallow_events called recursively could see it
4213 and process it again. */
4215 kbd_fetch_ptr
= event
+ 1;
4216 input_pending
= readable_events (0);
4217 x_handle_selection_event (©
);
4219 /* We're getting selection request events, but we don't have
4228 old_timers_run
= timers_run
;
4229 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4231 if (timers_run
!= old_timers_run
&& do_display
)
4232 redisplay_preserve_echo_area (7);
4235 /* Record the start of when Emacs is idle,
4236 for the sake of running idle-time timers. */
4243 /* If we are already in the idle state, do nothing. */
4244 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4247 EMACS_GET_TIME (timer_idleness_start_time
);
4249 timer_last_idleness_start_time
= timer_idleness_start_time
;
4251 /* Mark all idle-time timers as once again candidates for running. */
4252 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4256 timer
= XCAR (timers
);
4258 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4260 XVECTOR (timer
)->contents
[0] = Qnil
;
4264 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4269 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4272 /* Resume idle timer from last idle start time. */
4275 timer_resume_idle ()
4277 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4280 timer_idleness_start_time
= timer_last_idleness_start_time
;
4283 /* This is only for debugging. */
4284 struct input_event last_timer_event
;
4286 /* Check whether a timer has fired. To prevent larger problems we simply
4287 disregard elements that are not proper timers. Do not make a circular
4288 timer list for the time being.
4290 Returns the number of seconds to wait until the next timer fires. If a
4291 timer is triggering now, return zero seconds.
4292 If no timer is active, return -1 seconds.
4294 If a timer is ripe, we run it, with quitting turned off.
4296 DO_IT_NOW is now ignored. It used to mean that we should
4297 run the timer directly instead of queueing a timer-event.
4298 Now we always run timers directly. */
4301 timer_check (do_it_now
)
4304 EMACS_TIME nexttime
;
4305 EMACS_TIME now
, idleness_now
;
4306 Lisp_Object timers
, idle_timers
, chosen_timer
;
4307 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4309 EMACS_SET_SECS (nexttime
, -1);
4310 EMACS_SET_USECS (nexttime
, -1);
4312 /* Always consider the ordinary timers. */
4313 timers
= Vtimer_list
;
4314 /* Consider the idle timers only if Emacs is idle. */
4315 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4316 idle_timers
= Vtimer_idle_list
;
4319 chosen_timer
= Qnil
;
4320 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4322 if (CONSP (timers
) || CONSP (idle_timers
))
4324 EMACS_GET_TIME (now
);
4325 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4326 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4329 while (CONSP (timers
) || CONSP (idle_timers
))
4331 Lisp_Object
*vector
;
4332 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4333 EMACS_TIME timer_time
, idle_timer_time
;
4334 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4336 /* Skip past invalid timers and timers already handled. */
4339 timer
= XCAR (timers
);
4340 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4342 timers
= XCDR (timers
);
4345 vector
= XVECTOR (timer
)->contents
;
4347 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4348 || !INTEGERP (vector
[3])
4349 || ! NILP (vector
[0]))
4351 timers
= XCDR (timers
);
4355 if (!NILP (idle_timers
))
4357 timer
= XCAR (idle_timers
);
4358 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4360 idle_timers
= XCDR (idle_timers
);
4363 vector
= XVECTOR (timer
)->contents
;
4365 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4366 || !INTEGERP (vector
[3])
4367 || ! NILP (vector
[0]))
4369 idle_timers
= XCDR (idle_timers
);
4374 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4375 based on the next ordinary timer.
4376 TIMER_DIFFERENCE is the distance in time from NOW to when
4377 this timer becomes ripe (negative if it's already ripe). */
4380 timer
= XCAR (timers
);
4381 vector
= XVECTOR (timer
)->contents
;
4382 EMACS_SET_SECS (timer_time
,
4383 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4384 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4385 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4388 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4389 based on the next idle timer. */
4390 if (!NILP (idle_timers
))
4392 idle_timer
= XCAR (idle_timers
);
4393 vector
= XVECTOR (idle_timer
)->contents
;
4394 EMACS_SET_SECS (idle_timer_time
,
4395 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4396 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4397 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4400 /* Decide which timer is the next timer,
4401 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4402 Also step down the list where we found that timer. */
4404 if (! NILP (timers
) && ! NILP (idle_timers
))
4407 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4408 if (EMACS_TIME_NEG_P (temp
))
4410 chosen_timer
= timer
;
4411 timers
= XCDR (timers
);
4412 difference
= timer_difference
;
4416 chosen_timer
= idle_timer
;
4417 idle_timers
= XCDR (idle_timers
);
4418 difference
= idle_timer_difference
;
4421 else if (! NILP (timers
))
4423 chosen_timer
= timer
;
4424 timers
= XCDR (timers
);
4425 difference
= timer_difference
;
4429 chosen_timer
= idle_timer
;
4430 idle_timers
= XCDR (idle_timers
);
4431 difference
= idle_timer_difference
;
4433 vector
= XVECTOR (chosen_timer
)->contents
;
4435 /* If timer is ripe, run it if it hasn't been run. */
4436 if (EMACS_TIME_NEG_P (difference
)
4437 || (EMACS_SECS (difference
) == 0
4438 && EMACS_USECS (difference
) == 0))
4440 if (NILP (vector
[0]))
4442 int was_locked
= single_kboard
;
4443 int count
= SPECPDL_INDEX ();
4444 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4446 /* Mark the timer as triggered to prevent problems if the lisp
4447 code fails to reschedule it right. */
4450 specbind (Qinhibit_quit
, Qt
);
4452 call1 (Qtimer_event_handler
, chosen_timer
);
4453 Vdeactivate_mark
= old_deactivate_mark
;
4455 unbind_to (count
, Qnil
);
4457 /* Resume allowing input from any kboard, if that was true before. */
4459 any_kboard_state ();
4461 /* Since we have handled the event,
4462 we don't need to tell the caller to wake up and do it. */
4466 /* When we encounter a timer that is still waiting,
4467 return the amount of time to wait before it is ripe. */
4474 /* No timers are pending in the future. */
4475 /* Return 0 if we generated an event, and -1 if not. */
4480 /* Caches for modify_event_symbol. */
4481 static Lisp_Object accent_key_syms
;
4482 static Lisp_Object func_key_syms
;
4483 static Lisp_Object mouse_syms
;
4484 static Lisp_Object wheel_syms
;
4485 static Lisp_Object drag_n_drop_syms
;
4487 /* This is a list of keysym codes for special "accent" characters.
4488 It parallels lispy_accent_keys. */
4490 static int lispy_accent_codes
[] =
4492 #ifdef XK_dead_circumflex
4497 #ifdef XK_dead_grave
4502 #ifdef XK_dead_tilde
4507 #ifdef XK_dead_diaeresis
4512 #ifdef XK_dead_macron
4517 #ifdef XK_dead_degree
4522 #ifdef XK_dead_acute
4527 #ifdef XK_dead_cedilla
4532 #ifdef XK_dead_breve
4537 #ifdef XK_dead_ogonek
4542 #ifdef XK_dead_caron
4547 #ifdef XK_dead_doubleacute
4548 XK_dead_doubleacute
,
4552 #ifdef XK_dead_abovedot
4557 #ifdef XK_dead_abovering
4567 #ifdef XK_dead_belowdot
4572 #ifdef XK_dead_voiced_sound
4573 XK_dead_voiced_sound
,
4577 #ifdef XK_dead_semivoiced_sound
4578 XK_dead_semivoiced_sound
,
4594 /* This is a list of Lisp names for special "accent" characters.
4595 It parallels lispy_accent_codes. */
4597 static char *lispy_accent_keys
[] =
4615 "dead-voiced-sound",
4616 "dead-semivoiced-sound",
4622 #define FUNCTION_KEY_OFFSET 0x0
4624 char *lispy_function_keys
[] =
4628 0, /* VK_LBUTTON 0x01 */
4629 0, /* VK_RBUTTON 0x02 */
4630 "cancel", /* VK_CANCEL 0x03 */
4631 0, /* VK_MBUTTON 0x04 */
4633 0, 0, 0, /* 0x05 .. 0x07 */
4635 "backspace", /* VK_BACK 0x08 */
4636 "tab", /* VK_TAB 0x09 */
4638 0, 0, /* 0x0A .. 0x0B */
4640 "clear", /* VK_CLEAR 0x0C */
4641 "return", /* VK_RETURN 0x0D */
4643 0, 0, /* 0x0E .. 0x0F */
4645 0, /* VK_SHIFT 0x10 */
4646 0, /* VK_CONTROL 0x11 */
4647 0, /* VK_MENU 0x12 */
4648 "pause", /* VK_PAUSE 0x13 */
4649 "capslock", /* VK_CAPITAL 0x14 */
4651 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4653 "escape", /* VK_ESCAPE 0x1B */
4655 0, 0, 0, 0, /* 0x1C .. 0x1F */
4657 0, /* VK_SPACE 0x20 */
4658 "prior", /* VK_PRIOR 0x21 */
4659 "next", /* VK_NEXT 0x22 */
4660 "end", /* VK_END 0x23 */
4661 "home", /* VK_HOME 0x24 */
4662 "left", /* VK_LEFT 0x25 */
4663 "up", /* VK_UP 0x26 */
4664 "right", /* VK_RIGHT 0x27 */
4665 "down", /* VK_DOWN 0x28 */
4666 "select", /* VK_SELECT 0x29 */
4667 "print", /* VK_PRINT 0x2A */
4668 "execute", /* VK_EXECUTE 0x2B */
4669 "snapshot", /* VK_SNAPSHOT 0x2C */
4670 "insert", /* VK_INSERT 0x2D */
4671 "delete", /* VK_DELETE 0x2E */
4672 "help", /* VK_HELP 0x2F */
4674 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4676 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4678 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4680 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4682 0, 0, 0, 0, 0, 0, 0, 0, 0,
4683 0, 0, 0, 0, 0, 0, 0, 0, 0,
4684 0, 0, 0, 0, 0, 0, 0, 0,
4686 "lwindow", /* VK_LWIN 0x5B */
4687 "rwindow", /* VK_RWIN 0x5C */
4688 "apps", /* VK_APPS 0x5D */
4690 0, 0, /* 0x5E .. 0x5F */
4692 "kp-0", /* VK_NUMPAD0 0x60 */
4693 "kp-1", /* VK_NUMPAD1 0x61 */
4694 "kp-2", /* VK_NUMPAD2 0x62 */
4695 "kp-3", /* VK_NUMPAD3 0x63 */
4696 "kp-4", /* VK_NUMPAD4 0x64 */
4697 "kp-5", /* VK_NUMPAD5 0x65 */
4698 "kp-6", /* VK_NUMPAD6 0x66 */
4699 "kp-7", /* VK_NUMPAD7 0x67 */
4700 "kp-8", /* VK_NUMPAD8 0x68 */
4701 "kp-9", /* VK_NUMPAD9 0x69 */
4702 "kp-multiply", /* VK_MULTIPLY 0x6A */
4703 "kp-add", /* VK_ADD 0x6B */
4704 "kp-separator", /* VK_SEPARATOR 0x6C */
4705 "kp-subtract", /* VK_SUBTRACT 0x6D */
4706 "kp-decimal", /* VK_DECIMAL 0x6E */
4707 "kp-divide", /* VK_DIVIDE 0x6F */
4708 "f1", /* VK_F1 0x70 */
4709 "f2", /* VK_F2 0x71 */
4710 "f3", /* VK_F3 0x72 */
4711 "f4", /* VK_F4 0x73 */
4712 "f5", /* VK_F5 0x74 */
4713 "f6", /* VK_F6 0x75 */
4714 "f7", /* VK_F7 0x76 */
4715 "f8", /* VK_F8 0x77 */
4716 "f9", /* VK_F9 0x78 */
4717 "f10", /* VK_F10 0x79 */
4718 "f11", /* VK_F11 0x7A */
4719 "f12", /* VK_F12 0x7B */
4720 "f13", /* VK_F13 0x7C */
4721 "f14", /* VK_F14 0x7D */
4722 "f15", /* VK_F15 0x7E */
4723 "f16", /* VK_F16 0x7F */
4724 "f17", /* VK_F17 0x80 */
4725 "f18", /* VK_F18 0x81 */
4726 "f19", /* VK_F19 0x82 */
4727 "f20", /* VK_F20 0x83 */
4728 "f21", /* VK_F21 0x84 */
4729 "f22", /* VK_F22 0x85 */
4730 "f23", /* VK_F23 0x86 */
4731 "f24", /* VK_F24 0x87 */
4733 0, 0, 0, 0, /* 0x88 .. 0x8B */
4734 0, 0, 0, 0, /* 0x8C .. 0x8F */
4736 "kp-numlock", /* VK_NUMLOCK 0x90 */
4737 "scroll", /* VK_SCROLL 0x91 */
4739 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4740 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4741 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4742 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4743 "kp-end", /* VK_NUMPAD_END 0x96 */
4744 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4745 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4746 "kp-up", /* VK_NUMPAD_UP 0x99 */
4747 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4748 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4749 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4750 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4752 0, 0, /* 0x9E .. 0x9F */
4755 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4756 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4757 * No other API or message will distinguish left and right keys this way.
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,
4765 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4771 "attn", /* VK_ATTN 0xF6 */
4772 "crsel", /* VK_CRSEL 0xF7 */
4773 "exsel", /* VK_EXSEL 0xF8 */
4774 "ereof", /* VK_EREOF 0xF9 */
4775 "play", /* VK_PLAY 0xFA */
4776 "zoom", /* VK_ZOOM 0xFB */
4777 "noname", /* VK_NONAME 0xFC */
4778 "pa1", /* VK_PA1 0xFD */
4779 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4783 #else /* not HAVE_NTGUI */
4785 /* This should be dealt with in XTread_socket now, and that doesn't
4786 depend on the client system having the Kana syms defined. See also
4787 the XK_kana_A case below. */
4790 static char *lispy_kana_keys
[] =
4792 /* X Keysym value */
4793 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4794 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4795 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4796 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4797 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4798 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4799 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4800 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4801 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4802 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4803 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4804 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4805 "kana-i", "kana-u", "kana-e", "kana-o",
4806 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4807 "prolongedsound", "kana-A", "kana-I", "kana-U",
4808 "kana-E", "kana-O", "kana-KA", "kana-KI",
4809 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4810 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4811 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4812 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4813 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4814 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4815 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4816 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4817 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4818 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4819 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4820 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4822 #endif /* XK_kana_A */
4825 #define FUNCTION_KEY_OFFSET 0xff00
4827 /* You'll notice that this table is arranged to be conveniently
4828 indexed by X Windows keysym values. */
4829 static char *lispy_function_keys
[] =
4831 /* X Keysym value */
4833 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4834 "backspace", "tab", "linefeed", "clear",
4836 0, 0, 0, "pause", /* 0xff10...1f */
4837 0, 0, 0, 0, 0, 0, 0, "escape",
4839 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4840 "romaji", "hiragana", "katakana", "hiragana-katakana",
4841 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4842 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4843 "eisu-toggle", /* 0xff30...3f */
4844 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4845 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4847 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4848 "down", "prior", "next", "end",
4849 "begin", 0, 0, 0, 0, 0, 0, 0,
4850 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4861 "break", /* 0xff6b */
4864 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4865 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4866 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4867 0, 0, 0, 0, 0, 0, 0, 0,
4868 "kp-tab", /* 0xff89 */
4870 "kp-enter", /* 0xff8d */
4872 "kp-f1", /* 0xff91 */
4876 "kp-home", /* 0xff95 */
4881 "kp-prior", /* kp-page-up */
4882 "kp-next", /* kp-page-down */
4888 0, 0, 0, 0, 0, 0, 0, 0, 0,
4889 "kp-multiply", /* 0xffaa */
4894 "kp-divide", /* 0xffaf */
4895 "kp-0", /* 0xffb0 */
4896 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4899 "kp-equal", /* 0xffbd */
4900 "f1", /* 0xffbe */ /* IsFunctionKey */
4902 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4903 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4904 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4905 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4906 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4907 0, 0, 0, 0, 0, 0, 0, 0,
4908 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4909 0, 0, 0, 0, 0, 0, 0, "delete"
4912 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4913 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4915 static char *iso_lispy_function_keys
[] =
4917 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4918 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4919 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4920 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4921 "iso-lefttab", /* 0xfe20 */
4922 "iso-move-line-up", "iso-move-line-down",
4923 "iso-partial-line-up", "iso-partial-line-down",
4924 "iso-partial-space-left", "iso-partial-space-right",
4925 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4926 "iso-release-margin-left", "iso-release-margin-right",
4927 "iso-release-both-margins",
4928 "iso-fast-cursor-left", "iso-fast-cursor-right",
4929 "iso-fast-cursor-up", "iso-fast-cursor-down",
4930 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4931 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4934 #endif /* not HAVE_NTGUI */
4936 Lisp_Object Vlispy_mouse_stem
;
4938 static char *lispy_wheel_names
[] =
4940 "wheel-up", "wheel-down"
4943 /* drag-n-drop events are generated when a set of selected files are
4944 dragged from another application and dropped onto an Emacs window. */
4945 static char *lispy_drag_n_drop_names
[] =
4950 /* Scroll bar parts. */
4951 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4952 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4953 Lisp_Object Qtop
, Qratio
;
4955 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4956 Lisp_Object
*scroll_bar_parts
[] = {
4957 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4958 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4961 /* User signal events. */
4962 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4964 Lisp_Object
*lispy_user_signals
[] =
4966 &Qusr1_signal
, &Qusr2_signal
4970 /* A vector, indexed by button number, giving the down-going location
4971 of currently depressed buttons, both scroll bar and non-scroll bar.
4973 The elements have the form
4974 (BUTTON-NUMBER MODIFIER-MASK . REST)
4975 where REST is the cdr of a position as it would be reported in the event.
4977 The make_lispy_event function stores positions here to tell the
4978 difference between click and drag events, and to store the starting
4979 location to be included in drag events. */
4981 static Lisp_Object button_down_location
;
4983 /* Information about the most recent up-going button event: Which
4984 button, what location, and what time. */
4986 static int last_mouse_button
;
4987 static int last_mouse_x
;
4988 static int last_mouse_y
;
4989 static unsigned long button_down_time
;
4991 /* The maximum time between clicks to make a double-click, or Qnil to
4992 disable double-click detection, or Qt for no time limit. */
4994 Lisp_Object Vdouble_click_time
;
4996 /* Maximum number of pixels the mouse may be moved between clicks
4997 to make a double-click. */
4999 EMACS_INT double_click_fuzz
;
5001 /* The number of clicks in this multiple-click. */
5003 int double_click_count
;
5005 /* Return position of a mouse click or wheel event */
5008 make_lispy_position (f
, x
, y
, time
)
5014 enum window_part part
;
5015 Lisp_Object posn
= Qnil
;
5016 Lisp_Object extra_info
= Qnil
;
5019 /* Set `window' to the window under frame pixel coordinates (x,y) */
5021 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5022 &part
, &wx
, &wy
, 0);
5026 if (WINDOWP (window
))
5028 /* It's a click in window window at frame coordinates (x,y) */
5029 struct window
*w
= XWINDOW (window
);
5030 Lisp_Object string_info
= Qnil
;
5031 int textpos
= -1, rx
= -1, ry
= -1;
5032 int dx
= -1, dy
= -1;
5033 int width
= -1, height
= -1;
5034 Lisp_Object object
= Qnil
;
5036 /* Set event coordinates to window-relative coordinates
5037 for constructing the Lisp event below. */
5041 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5043 /* Mode line or header line. Look for a string under
5044 the mouse that may have a `local-map' property. */
5048 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5050 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5051 &object
, &dx
, &dy
, &width
, &height
);
5052 if (STRINGP (string
))
5053 string_info
= Fcons (string
, make_number (charpos
));
5054 if (w
== XWINDOW (selected_window
))
5057 textpos
= XMARKER (w
->pointm
)->charpos
;
5059 else if (part
== ON_VERTICAL_BORDER
)
5061 posn
= Qvertical_line
;
5066 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5071 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5073 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5074 &object
, &dx
, &dy
, &width
, &height
);
5075 if (STRINGP (string
))
5076 string_info
= Fcons (string
, make_number (charpos
));
5078 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5080 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5083 if (part
== ON_RIGHT_FRINGE
)
5084 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5085 + window_box_width (w
, TEXT_AREA
)
5086 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5087 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5089 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5090 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5095 Lisp_Object string2
, object2
= Qnil
;
5096 struct display_pos p
;
5098 int width2
, height2
;
5099 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5100 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5101 &object2
, &dx2
, &dy2
,
5103 textpos
= CHARPOS (p
.pos
);
5104 if (rx
< 0) rx
= wx
;
5105 if (ry
< 0) ry
= wy
;
5106 if (dx
< 0) dx
= dx2
;
5107 if (dy
< 0) dy
= dy2
;
5108 if (width
< 0) width
= width2
;
5109 if (height
< 0) height
= height2
;
5113 posn
= make_number (textpos
);
5114 if (STRINGP (string2
))
5115 string_info
= Fcons (string2
,
5116 make_number (CHARPOS (p
.string_pos
)));
5122 #ifdef HAVE_WINDOW_SYSTEM
5123 if (IMAGEP (object
))
5125 Lisp_Object image_map
, hotspot
;
5126 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5128 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5130 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5131 posn
= XCAR (hotspot
);
5136 extra_info
= Fcons (object
,
5137 Fcons (Fcons (make_number (dx
),
5139 Fcons (Fcons (make_number (width
),
5140 make_number (height
)),
5144 extra_info
= Fcons (string_info
,
5145 Fcons (make_number (textpos
),
5146 Fcons (Fcons (make_number (rx
),
5152 XSETFRAME (window
, f
);
5157 XSETFASTINT (*x
, 0);
5158 XSETFASTINT (*y
, 0);
5161 return Fcons (window
,
5163 Fcons (Fcons (*x
, *y
),
5164 Fcons (make_number (time
),
5168 /* Given a struct input_event, build the lisp event which represents
5169 it. If EVENT is 0, build a mouse movement event from the mouse
5170 movement buffer, which should have a movement event in it.
5172 Note that events must be passed to this function in the order they
5173 are received; this function stores the location of button presses
5174 in order to build drag events when the button is released. */
5177 make_lispy_event (event
)
5178 struct input_event
*event
;
5182 switch (SWITCH_ENUM_CAST (event
->kind
))
5184 /* A simple keystroke. */
5185 case ASCII_KEYSTROKE_EVENT
:
5187 Lisp_Object lispy_c
;
5188 int c
= event
->code
& 0377;
5189 /* Turn ASCII characters into control characters
5191 if (event
->modifiers
& ctrl_modifier
)
5192 c
= make_ctrl_char (c
);
5194 /* Add in the other modifier bits. We took care of ctrl_modifier
5195 just above, and the shift key was taken care of by the X code,
5196 and applied to control characters by make_ctrl_char. */
5197 c
|= (event
->modifiers
5198 & (meta_modifier
| alt_modifier
5199 | hyper_modifier
| super_modifier
));
5200 /* Distinguish Shift-SPC from SPC. */
5201 if ((event
->code
& 0377) == 040
5202 && event
->modifiers
& shift_modifier
)
5203 c
|= shift_modifier
;
5204 button_down_time
= 0;
5205 XSETFASTINT (lispy_c
, c
);
5209 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5211 Lisp_Object lispy_c
;
5212 int c
= event
->code
;
5214 /* Add in the other modifier bits. We took care of ctrl_modifier
5215 just above, and the shift key was taken care of by the X code,
5216 and applied to control characters by make_ctrl_char. */
5217 c
|= (event
->modifiers
5218 & (meta_modifier
| alt_modifier
5219 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5220 /* What about the `shift' modifier ? */
5221 button_down_time
= 0;
5222 XSETFASTINT (lispy_c
, c
);
5226 /* A function key. The symbol may need to have modifier prefixes
5228 case NON_ASCII_KEYSTROKE_EVENT
:
5229 button_down_time
= 0;
5231 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5232 if (event
->code
== lispy_accent_codes
[i
])
5233 return modify_event_symbol (i
,
5235 Qfunction_key
, Qnil
,
5236 lispy_accent_keys
, &accent_key_syms
,
5237 (sizeof (lispy_accent_keys
)
5238 / sizeof (lispy_accent_keys
[0])));
5242 if (event
->code
>= 0x400 && event
->code
< 0x500)
5243 return modify_event_symbol (event
->code
- 0x400,
5244 event
->modifiers
& ~shift_modifier
,
5245 Qfunction_key
, Qnil
,
5246 lispy_kana_keys
, &func_key_syms
,
5247 (sizeof (lispy_kana_keys
)
5248 / sizeof (lispy_kana_keys
[0])));
5249 #endif /* XK_kana_A */
5252 #ifdef ISO_FUNCTION_KEY_OFFSET
5253 if (event
->code
< FUNCTION_KEY_OFFSET
5254 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5255 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5257 Qfunction_key
, Qnil
,
5258 iso_lispy_function_keys
, &func_key_syms
,
5259 (sizeof (iso_lispy_function_keys
)
5260 / sizeof (iso_lispy_function_keys
[0])));
5263 /* Handle system-specific or unknown keysyms. */
5264 if (event
->code
& (1 << 28)
5265 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5266 || (event
->code
- FUNCTION_KEY_OFFSET
5267 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5268 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5270 /* We need to use an alist rather than a vector as the cache
5271 since we can't make a vector long enuf. */
5272 if (NILP (current_kboard
->system_key_syms
))
5273 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5274 return modify_event_symbol (event
->code
,
5277 current_kboard
->Vsystem_key_alist
,
5278 0, ¤t_kboard
->system_key_syms
,
5282 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5284 Qfunction_key
, Qnil
,
5285 lispy_function_keys
, &func_key_syms
,
5286 (sizeof (lispy_function_keys
)
5287 / sizeof (lispy_function_keys
[0])));
5290 /* A mouse click. Figure out where it is, decide whether it's
5291 a press, click or drag, and build the appropriate structure. */
5292 case MOUSE_CLICK_EVENT
:
5293 #ifndef USE_TOOLKIT_SCROLL_BARS
5294 case SCROLL_BAR_CLICK_EVENT
:
5297 int button
= event
->code
;
5299 Lisp_Object position
;
5300 Lisp_Object
*start_pos_ptr
;
5301 Lisp_Object start_pos
;
5305 /* Build the position as appropriate for this mouse click. */
5306 if (event
->kind
== MOUSE_CLICK_EVENT
)
5308 struct frame
*f
= XFRAME (event
->frame_or_window
);
5309 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5313 /* Ignore mouse events that were made on frame that
5314 have been deleted. */
5315 if (! FRAME_LIVE_P (f
))
5318 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5319 /* EVENT->x and EVENT->y are frame-relative pixel
5320 coordinates at this place. Under old redisplay, COLUMN
5321 and ROW are set to frame relative glyph coordinates
5322 which are then used to determine whether this click is
5323 in a menu (non-toolkit version). */
5324 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5325 &column
, &row
, NULL
, 1);
5327 /* In the non-toolkit version, clicks on the menu bar
5328 are ordinary button events in the event buffer.
5329 Distinguish them, and invoke the menu.
5331 (In the toolkit version, the toolkit handles the menu bar
5332 and Emacs doesn't know about it until after the user
5333 makes a selection.) */
5334 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5335 && (event
->modifiers
& down_modifier
))
5337 Lisp_Object items
, item
;
5342 /* Activate the menu bar on the down event. If the
5343 up event comes in before the menu code can deal with it,
5345 if (! (event
->modifiers
& down_modifier
))
5349 /* Find the menu bar item under `column'. */
5351 items
= FRAME_MENU_BAR_ITEMS (f
);
5352 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5354 Lisp_Object pos
, string
;
5355 string
= AREF (items
, i
+ 1);
5356 pos
= AREF (items
, i
+ 3);
5359 if (column
>= XINT (pos
)
5360 && column
< XINT (pos
) + SCHARS (string
))
5362 item
= AREF (items
, i
);
5367 /* ELisp manual 2.4b says (x y) are window relative but
5368 code says they are frame-relative. */
5370 = Fcons (event
->frame_or_window
,
5372 Fcons (Fcons (event
->x
, event
->y
),
5373 Fcons (make_number (event
->timestamp
),
5376 return Fcons (item
, Fcons (position
, Qnil
));
5378 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5380 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5383 #ifndef USE_TOOLKIT_SCROLL_BARS
5386 /* It's a scrollbar click. */
5388 Lisp_Object portion_whole
;
5391 window
= event
->frame_or_window
;
5392 portion_whole
= Fcons (event
->x
, event
->y
);
5393 part
= *scroll_bar_parts
[(int) event
->part
];
5397 Fcons (Qvertical_scroll_bar
,
5398 Fcons (portion_whole
,
5399 Fcons (make_number (event
->timestamp
),
5400 Fcons (part
, Qnil
)))));
5402 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5404 if (button
>= ASIZE (button_down_location
))
5406 button_down_location
= larger_vector (button_down_location
,
5408 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5411 start_pos_ptr
= &AREF (button_down_location
, button
);
5412 start_pos
= *start_pos_ptr
;
5413 *start_pos_ptr
= Qnil
;
5416 /* On window-system frames, use the value of
5417 double-click-fuzz as is. On other frames, interpret it
5418 as a multiple of 1/8 characters. */
5422 if (WINDOWP (event
->frame_or_window
))
5423 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5424 else if (FRAMEP (event
->frame_or_window
))
5425 f
= XFRAME (event
->frame_or_window
);
5429 if (FRAME_WINDOW_P (f
))
5430 fuzz
= double_click_fuzz
;
5432 fuzz
= double_click_fuzz
/ 8;
5434 is_double
= (button
== last_mouse_button
5435 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5436 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5437 && button_down_time
!= 0
5438 && (EQ (Vdouble_click_time
, Qt
)
5439 || (INTEGERP (Vdouble_click_time
)
5440 && ((int)(event
->timestamp
- button_down_time
)
5441 < XINT (Vdouble_click_time
)))));
5444 last_mouse_button
= button
;
5445 last_mouse_x
= XINT (event
->x
);
5446 last_mouse_y
= XINT (event
->y
);
5448 /* If this is a button press, squirrel away the location, so
5449 we can decide later whether it was a click or a drag. */
5450 if (event
->modifiers
& down_modifier
)
5454 double_click_count
++;
5455 event
->modifiers
|= ((double_click_count
> 2)
5460 double_click_count
= 1;
5461 button_down_time
= event
->timestamp
;
5462 *start_pos_ptr
= Fcopy_alist (position
);
5465 /* Now we're releasing a button - check the co-ordinates to
5466 see if this was a click or a drag. */
5467 else if (event
->modifiers
& up_modifier
)
5469 /* If we did not see a down before this up, ignore the up.
5470 Probably this happened because the down event chose a
5471 menu item. It would be an annoyance to treat the
5472 release of the button that chose the menu item as a
5475 if (!CONSP (start_pos
))
5478 event
->modifiers
&= ~up_modifier
;
5479 #if 0 /* Formerly we treated an up with no down as a click event. */
5480 if (!CONSP (start_pos
))
5481 event
->modifiers
|= click_modifier
;
5486 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5488 /* The third element of every position
5489 should be the (x,y) pair. */
5490 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5492 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5494 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5495 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5498 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5499 && ydiff
< double_click_fuzz
5500 && ydiff
> - double_click_fuzz
)
5501 /* Mouse hasn't moved (much). */
5502 event
->modifiers
|= click_modifier
;
5505 button_down_time
= 0;
5506 event
->modifiers
|= drag_modifier
;
5509 /* Don't check is_double; treat this as multiple
5510 if the down-event was multiple. */
5511 if (double_click_count
> 1)
5512 event
->modifiers
|= ((double_click_count
> 2)
5518 /* Every mouse event should either have the down_modifier or
5519 the up_modifier set. */
5523 /* Get the symbol we should use for the mouse click. */
5526 head
= modify_event_symbol (button
,
5528 Qmouse_click
, Vlispy_mouse_stem
,
5531 XVECTOR (mouse_syms
)->size
);
5532 if (event
->modifiers
& drag_modifier
)
5537 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5540 Fcons (make_number (double_click_count
),
5551 Lisp_Object position
;
5554 /* Build the position as appropriate for this mouse click. */
5555 struct frame
*f
= XFRAME (event
->frame_or_window
);
5557 /* Ignore wheel events that were made on frame that have been
5559 if (! FRAME_LIVE_P (f
))
5562 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5565 /* Set double or triple modifiers to indicate the wheel speed. */
5567 /* On window-system frames, use the value of
5568 double-click-fuzz as is. On other frames, interpret it
5569 as a multiple of 1/8 characters. */
5574 if (WINDOWP (event
->frame_or_window
))
5575 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5576 else if (FRAMEP (event
->frame_or_window
))
5577 f
= XFRAME (event
->frame_or_window
);
5581 if (FRAME_WINDOW_P (f
))
5582 fuzz
= double_click_fuzz
;
5584 fuzz
= double_click_fuzz
/ 8;
5586 is_double
= (last_mouse_button
< 0
5587 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5588 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5589 && button_down_time
!= 0
5590 && (EQ (Vdouble_click_time
, Qt
)
5591 || (INTEGERP (Vdouble_click_time
)
5592 && ((int)(event
->timestamp
- button_down_time
)
5593 < XINT (Vdouble_click_time
)))));
5596 double_click_count
++;
5597 event
->modifiers
|= ((double_click_count
> 2)
5603 double_click_count
= 1;
5604 event
->modifiers
|= click_modifier
;
5607 button_down_time
= event
->timestamp
;
5608 /* Use a negative value to distinguish wheel from mouse button. */
5609 last_mouse_button
= -1;
5610 last_mouse_x
= XINT (event
->x
);
5611 last_mouse_y
= XINT (event
->y
);
5617 if (event
->modifiers
& up_modifier
)
5619 /* Emit a wheel-up event. */
5620 event
->modifiers
&= ~up_modifier
;
5623 else if (event
->modifiers
& down_modifier
)
5625 /* Emit a wheel-down event. */
5626 event
->modifiers
&= ~down_modifier
;
5630 /* Every wheel event should either have the down_modifier or
5631 the up_modifier set. */
5634 /* Get the symbol we should use for the wheel event. */
5635 head
= modify_event_symbol (symbol_num
,
5641 ASIZE (wheel_syms
));
5644 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5647 Fcons (make_number (double_click_count
),
5656 #ifdef USE_TOOLKIT_SCROLL_BARS
5658 /* We don't have down and up events if using toolkit scroll bars,
5659 so make this always a click event. Store in the `part' of
5660 the Lisp event a symbol which maps to the following actions:
5662 `above_handle' page up
5663 `below_handle' page down
5667 `bottom' bottom of buffer
5668 `handle' thumb has been dragged.
5669 `end-scroll' end of interaction with scroll bar
5671 The incoming input_event contains in its `part' member an
5672 index of type `enum scroll_bar_part' which we can use as an
5673 index in scroll_bar_parts to get the appropriate symbol. */
5675 case SCROLL_BAR_CLICK_EVENT
:
5677 Lisp_Object position
, head
, window
, portion_whole
, part
;
5679 window
= event
->frame_or_window
;
5680 portion_whole
= Fcons (event
->x
, event
->y
);
5681 part
= *scroll_bar_parts
[(int) event
->part
];
5685 Fcons (Qvertical_scroll_bar
,
5686 Fcons (portion_whole
,
5687 Fcons (make_number (event
->timestamp
),
5688 Fcons (part
, Qnil
)))));
5690 /* Always treat scroll bar events as clicks. */
5691 event
->modifiers
|= click_modifier
;
5692 event
->modifiers
&= ~up_modifier
;
5694 if (event
->code
>= ASIZE (mouse_syms
))
5695 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5697 /* Get the symbol we should use for the mouse click. */
5698 head
= modify_event_symbol (event
->code
,
5703 XVECTOR (mouse_syms
)->size
);
5704 return Fcons (head
, Fcons (position
, Qnil
));
5707 #endif /* USE_TOOLKIT_SCROLL_BARS */
5710 case W32_SCROLL_BAR_CLICK_EVENT
:
5712 int button
= event
->code
;
5714 Lisp_Object position
;
5715 Lisp_Object
*start_pos_ptr
;
5716 Lisp_Object start_pos
;
5720 Lisp_Object portion_whole
;
5723 window
= event
->frame_or_window
;
5724 portion_whole
= Fcons (event
->x
, event
->y
);
5725 part
= *scroll_bar_parts
[(int) event
->part
];
5729 Fcons (Qvertical_scroll_bar
,
5730 Fcons (portion_whole
,
5731 Fcons (make_number (event
->timestamp
),
5732 Fcons (part
, Qnil
)))));
5735 /* Always treat W32 scroll bar events as clicks. */
5736 event
->modifiers
|= click_modifier
;
5739 /* Get the symbol we should use for the mouse click. */
5742 head
= modify_event_symbol (button
,
5747 XVECTOR (mouse_syms
)->size
);
5753 #endif /* WINDOWSNT */
5755 case DRAG_N_DROP_EVENT
:
5758 Lisp_Object head
, position
;
5761 /* The frame_or_window field should be a cons of the frame in
5762 which the event occurred and a list of the filenames
5764 if (! CONSP (event
->frame_or_window
))
5767 f
= XFRAME (XCAR (event
->frame_or_window
));
5768 files
= XCDR (event
->frame_or_window
);
5770 /* Ignore mouse events that were made on frames that
5771 have been deleted. */
5772 if (! FRAME_LIVE_P (f
))
5775 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5778 head
= modify_event_symbol (0, event
->modifiers
,
5780 lispy_drag_n_drop_names
,
5781 &drag_n_drop_syms
, 1);
5787 #endif /* HAVE_MOUSE */
5789 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5790 || defined (USE_GTK)
5791 case MENU_BAR_EVENT
:
5792 if (EQ (event
->arg
, event
->frame_or_window
))
5793 /* This is the prefix key. We translate this to
5794 `(menu_bar)' because the code in keyboard.c for menu
5795 events, which we use, relies on this. */
5796 return Fcons (Qmenu_bar
, Qnil
);
5800 case SELECT_WINDOW_EVENT
:
5801 /* Make an event (select-window (WINDOW)). */
5802 return Fcons (Qselect_window
,
5803 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5806 case TOOL_BAR_EVENT
:
5807 if (EQ (event
->arg
, event
->frame_or_window
))
5808 /* This is the prefix key. We translate this to
5809 `(tool_bar)' because the code in keyboard.c for tool bar
5810 events, which we use, relies on this. */
5811 return Fcons (Qtool_bar
, Qnil
);
5812 else if (SYMBOLP (event
->arg
))
5813 return apply_modifiers (event
->modifiers
, event
->arg
);
5816 case USER_SIGNAL_EVENT
:
5817 /* A user signal. */
5818 return *lispy_user_signals
[event
->code
];
5820 case SAVE_SESSION_EVENT
:
5821 return Qsave_session
;
5823 /* The 'kind' field of the event is something we don't recognize. */
5832 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5834 Lisp_Object bar_window
;
5835 enum scroll_bar_part part
;
5839 /* Is it a scroll bar movement? */
5840 if (frame
&& ! NILP (bar_window
))
5842 Lisp_Object part_sym
;
5844 part_sym
= *scroll_bar_parts
[(int) part
];
5845 return Fcons (Qscroll_bar_movement
,
5846 (Fcons (Fcons (bar_window
,
5847 Fcons (Qvertical_scroll_bar
,
5848 Fcons (Fcons (x
, y
),
5849 Fcons (make_number (time
),
5855 /* Or is it an ordinary mouse movement? */
5858 Lisp_Object position
;
5860 position
= make_lispy_position (frame
, &x
, &y
, time
);
5862 return Fcons (Qmouse_movement
,
5868 #endif /* HAVE_MOUSE */
5870 /* Construct a switch frame event. */
5872 make_lispy_switch_frame (frame
)
5875 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5878 /* Manipulating modifiers. */
5880 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5882 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5883 SYMBOL's name of the end of the modifiers; the string from this
5884 position is the unmodified symbol name.
5886 This doesn't use any caches. */
5889 parse_modifiers_uncached (symbol
, modifier_end
)
5897 CHECK_SYMBOL (symbol
);
5900 name
= SYMBOL_NAME (symbol
);
5902 for (i
= 0; i
+2 <= SBYTES (name
); )
5904 int this_mod_end
= 0;
5907 /* See if the name continues with a modifier word.
5908 Check that the word appears, but don't check what follows it.
5909 Set this_mod and this_mod_end to record what we find. */
5911 switch (SREF (name
, i
))
5913 #define SINGLE_LETTER_MOD(BIT) \
5914 (this_mod_end = i + 1, this_mod = BIT)
5917 SINGLE_LETTER_MOD (alt_modifier
);
5921 SINGLE_LETTER_MOD (ctrl_modifier
);
5925 SINGLE_LETTER_MOD (hyper_modifier
);
5929 SINGLE_LETTER_MOD (meta_modifier
);
5933 SINGLE_LETTER_MOD (shift_modifier
);
5937 SINGLE_LETTER_MOD (super_modifier
);
5940 #undef SINGLE_LETTER_MOD
5942 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5943 if (i + LEN + 1 <= SBYTES (name) \
5944 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5946 this_mod_end = i + LEN; \
5951 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5952 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5953 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5957 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5959 #undef MULTI_LETTER_MOD
5963 /* If we found no modifier, stop looking for them. */
5964 if (this_mod_end
== 0)
5967 /* Check there is a dash after the modifier, so that it
5968 really is a modifier. */
5969 if (this_mod_end
>= SBYTES (name
)
5970 || SREF (name
, this_mod_end
) != '-')
5973 /* This modifier is real; look for another. */
5974 modifiers
|= this_mod
;
5975 i
= this_mod_end
+ 1;
5978 /* Should we include the `click' modifier? */
5979 if (! (modifiers
& (down_modifier
| drag_modifier
5980 | double_modifier
| triple_modifier
))
5981 && i
+ 7 == SBYTES (name
)
5982 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5983 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5984 modifiers
|= click_modifier
;
5992 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5993 prepended to the string BASE[0..BASE_LEN-1].
5994 This doesn't use any caches. */
5996 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5999 int base_len
, base_len_byte
;
6001 /* Since BASE could contain nulls, we can't use intern here; we have
6002 to use Fintern, which expects a genuine Lisp_String, and keeps a
6005 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6011 /* Only the event queue may use the `up' modifier; it should always
6012 be turned into a click or drag event before presented to lisp code. */
6013 if (modifiers
& up_modifier
)
6016 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6017 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6018 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6019 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6020 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6021 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6022 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6023 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6024 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6025 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6026 /* The click modifier is denoted by the absence of other modifiers. */
6030 mod_len
= p
- new_mods
;
6034 Lisp_Object new_name
;
6036 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6037 mod_len
+ base_len_byte
);
6038 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6039 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6041 return Fintern (new_name
, Qnil
);
6046 static char *modifier_names
[] =
6048 "up", "down", "drag", "click", "double", "triple", 0, 0,
6049 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6050 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6052 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6054 static Lisp_Object modifier_symbols
;
6056 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6058 lispy_modifier_list (modifiers
)
6061 Lisp_Object modifier_list
;
6064 modifier_list
= Qnil
;
6065 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6066 if (modifiers
& (1<<i
))
6067 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6070 return modifier_list
;
6074 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6075 where UNMODIFIED is the unmodified form of SYMBOL,
6076 MASK is the set of modifiers present in SYMBOL's name.
6077 This is similar to parse_modifiers_uncached, but uses the cache in
6078 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6079 Qevent_symbol_elements property. */
6082 parse_modifiers (symbol
)
6085 Lisp_Object elements
;
6087 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6088 if (CONSP (elements
))
6093 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6094 Lisp_Object unmodified
;
6097 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6098 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6101 if (modifiers
& ~INTMASK
)
6103 XSETFASTINT (mask
, modifiers
);
6104 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6106 /* Cache the parsing results on SYMBOL. */
6107 Fput (symbol
, Qevent_symbol_element_mask
,
6109 Fput (symbol
, Qevent_symbol_elements
,
6110 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6112 /* Since we know that SYMBOL is modifiers applied to unmodified,
6113 it would be nice to put that in unmodified's cache.
6114 But we can't, since we're not sure that parse_modifiers is
6121 /* Apply the modifiers MODIFIERS to the symbol BASE.
6122 BASE must be unmodified.
6124 This is like apply_modifiers_uncached, but uses BASE's
6125 Qmodifier_cache property, if present. It also builds
6126 Qevent_symbol_elements properties, since it has that info anyway.
6128 apply_modifiers copies the value of BASE's Qevent_kind property to
6129 the modified symbol. */
6131 apply_modifiers (modifiers
, base
)
6135 Lisp_Object cache
, index
, entry
, new_symbol
;
6137 /* Mask out upper bits. We don't know where this value's been. */
6138 modifiers
&= INTMASK
;
6140 /* The click modifier never figures into cache indices. */
6141 cache
= Fget (base
, Qmodifier_cache
);
6142 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6143 entry
= assq_no_quit (index
, cache
);
6146 new_symbol
= XCDR (entry
);
6149 /* We have to create the symbol ourselves. */
6150 new_symbol
= apply_modifiers_uncached (modifiers
,
6151 SDATA (SYMBOL_NAME (base
)),
6152 SCHARS (SYMBOL_NAME (base
)),
6153 SBYTES (SYMBOL_NAME (base
)));
6155 /* Add the new symbol to the base's cache. */
6156 entry
= Fcons (index
, new_symbol
);
6157 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6159 /* We have the parsing info now for free, so we could add it to
6161 XSETFASTINT (index, modifiers);
6162 Fput (new_symbol, Qevent_symbol_element_mask,
6163 Fcons (base, Fcons (index, Qnil)));
6164 Fput (new_symbol, Qevent_symbol_elements,
6165 Fcons (base, lispy_modifier_list (modifiers)));
6166 Sadly, this is only correct if `base' is indeed a base event,
6167 which is not necessarily the case. -stef */
6170 /* Make sure this symbol is of the same kind as BASE.
6172 You'd think we could just set this once and for all when we
6173 intern the symbol above, but reorder_modifiers may call us when
6174 BASE's property isn't set right; we can't assume that just
6175 because it has a Qmodifier_cache property it must have its
6176 Qevent_kind set right as well. */
6177 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6181 kind
= Fget (base
, Qevent_kind
);
6183 Fput (new_symbol
, Qevent_kind
, kind
);
6190 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6191 return a symbol with the modifiers placed in the canonical order.
6192 Canonical order is alphabetical, except for down and drag, which
6193 always come last. The 'click' modifier is never written out.
6195 Fdefine_key calls this to make sure that (for example) C-M-foo
6196 and M-C-foo end up being equivalent in the keymap. */
6199 reorder_modifiers (symbol
)
6202 /* It's hopefully okay to write the code this way, since everything
6203 will soon be in caches, and no consing will be done at all. */
6206 parsed
= parse_modifiers (symbol
);
6207 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6212 /* For handling events, we often want to produce a symbol whose name
6213 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6214 to some base, like the name of a function key or mouse button.
6215 modify_event_symbol produces symbols of this sort.
6217 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6218 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6221 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6222 into symbol names, or a string specifying a name stem used to
6223 construct a symbol name or the form `STEM-N', where N is the decimal
6224 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6225 non-nil; otherwise NAME_TABLE is used.
6227 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6228 persist between calls to modify_event_symbol that it can use to
6229 store a cache of the symbols it's generated for this NAME_TABLE
6230 before. The object stored there may be a vector or an alist.
6232 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6234 MODIFIERS is a set of modifier bits (as given in struct input_events)
6235 whose prefixes should be applied to the symbol name.
6237 SYMBOL_KIND is the value to be placed in the event_kind property of
6238 the returned symbol.
6240 The symbols we create are supposed to have an
6241 `event-symbol-elements' property, which lists the modifiers present
6242 in the symbol's name. */
6245 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6246 name_table
, symbol_table
, table_size
)
6249 Lisp_Object symbol_kind
;
6250 Lisp_Object name_alist_or_stem
;
6252 Lisp_Object
*symbol_table
;
6253 unsigned int table_size
;
6256 Lisp_Object symbol_int
;
6258 /* Get rid of the "vendor-specific" bit here. */
6259 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6261 /* Is this a request for a valid symbol? */
6262 if (symbol_num
< 0 || symbol_num
>= table_size
)
6265 if (CONSP (*symbol_table
))
6266 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6268 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6269 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6270 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6271 we've never used that symbol before. */
6274 if (! VECTORP (*symbol_table
)
6275 || XVECTOR (*symbol_table
)->size
!= table_size
)
6279 XSETFASTINT (size
, table_size
);
6280 *symbol_table
= Fmake_vector (size
, Qnil
);
6283 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6286 /* Have we already used this symbol before? */
6289 /* No; let's create it. */
6290 if (CONSP (name_alist_or_stem
))
6291 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6292 else if (STRINGP (name_alist_or_stem
))
6294 int len
= SBYTES (name_alist_or_stem
);
6295 char *buf
= (char *) alloca (len
+ 50);
6296 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6297 (long) XINT (symbol_int
) + 1);
6298 value
= intern (buf
);
6300 else if (name_table
!= 0 && name_table
[symbol_num
])
6301 value
= intern (name_table
[symbol_num
]);
6303 #ifdef HAVE_WINDOW_SYSTEM
6306 char *name
= x_get_keysym_name (symbol_num
);
6308 value
= intern (name
);
6315 sprintf (buf
, "key-%d", symbol_num
);
6316 value
= intern (buf
);
6319 if (CONSP (*symbol_table
))
6320 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6322 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6324 /* Fill in the cache entries for this symbol; this also
6325 builds the Qevent_symbol_elements property, which the user
6327 apply_modifiers (modifiers
& click_modifier
, value
);
6328 Fput (value
, Qevent_kind
, symbol_kind
);
6331 /* Apply modifiers to that symbol. */
6332 return apply_modifiers (modifiers
, value
);
6335 /* Convert a list that represents an event type,
6336 such as (ctrl meta backspace), into the usual representation of that
6337 event type as a number or a symbol. */
6339 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6340 doc
: /* Convert the event description list EVENT-DESC to an event type.
6341 EVENT-DESC should contain one base event type (a character or symbol)
6342 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6343 drag, down, double or triple). The base must be last.
6344 The return value is an event type (a character or symbol) which
6345 has the same base event type and all the specified modifiers. */)
6347 Lisp_Object event_desc
;
6355 while (CONSP (rest
))
6363 /* Given a symbol, see if it is a modifier name. */
6364 if (SYMBOLP (elt
) && CONSP (rest
))
6365 this = parse_solitary_modifier (elt
);
6369 else if (!NILP (base
))
6370 error ("Two bases given in one event");
6376 /* Let the symbol A refer to the character A. */
6377 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6378 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6380 if (INTEGERP (base
))
6382 /* Turn (shift a) into A. */
6383 if ((modifiers
& shift_modifier
) != 0
6384 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6386 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6387 modifiers
&= ~shift_modifier
;
6390 /* Turn (control a) into C-a. */
6391 if (modifiers
& ctrl_modifier
)
6392 return make_number ((modifiers
& ~ctrl_modifier
)
6393 | make_ctrl_char (XINT (base
)));
6395 return make_number (modifiers
| XINT (base
));
6397 else if (SYMBOLP (base
))
6398 return apply_modifiers (modifiers
, base
);
6401 error ("Invalid base event");
6406 /* Try to recognize SYMBOL as a modifier name.
6407 Return the modifier flag bit, or 0 if not recognized. */
6410 parse_solitary_modifier (symbol
)
6413 Lisp_Object name
= SYMBOL_NAME (symbol
);
6415 switch (SREF (name
, 0))
6417 #define SINGLE_LETTER_MOD(BIT) \
6418 if (SBYTES (name) == 1) \
6421 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6422 if (LEN == SBYTES (name) \
6423 && ! strncmp (SDATA (name), NAME, LEN)) \
6427 SINGLE_LETTER_MOD (alt_modifier
);
6431 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6435 SINGLE_LETTER_MOD (ctrl_modifier
);
6439 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6440 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6444 SINGLE_LETTER_MOD (hyper_modifier
);
6448 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6452 SINGLE_LETTER_MOD (meta_modifier
);
6456 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6460 SINGLE_LETTER_MOD (shift_modifier
);
6464 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6465 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6466 SINGLE_LETTER_MOD (super_modifier
);
6470 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6471 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6472 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6476 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6479 #undef SINGLE_LETTER_MOD
6480 #undef MULTI_LETTER_MOD
6486 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6487 Such a list is not valid as an event,
6488 but it can be a Lucid-style event type list. */
6491 lucid_event_type_list_p (object
)
6496 if (! CONSP (object
))
6499 if (EQ (XCAR (object
), Qhelp_echo
)
6500 || EQ (XCAR (object
), Qvertical_line
)
6501 || EQ (XCAR (object
), Qmode_line
)
6502 || EQ (XCAR (object
), Qheader_line
))
6505 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6509 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6516 /* Store into *addr a value nonzero if terminal input chars are available.
6517 Serves the purpose of ioctl (0, FIONREAD, addr)
6518 but works even if FIONREAD does not exist.
6519 (In fact, this may actually read some input.)
6521 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6522 timer events that are ripe.
6523 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6524 events (FOCUS_IN_EVENT).
6525 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6529 get_input_pending (addr
, flags
)
6533 /* First of all, have we already counted some input? */
6534 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6536 /* If input is being read as it arrives, and we have none, there is none. */
6537 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6540 /* Try to read some input and see how much we get. */
6542 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6545 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6548 gobble_input (expected
)
6553 if (interrupt_input
)
6556 mask
= sigblock (sigmask (SIGIO
));
6557 read_avail_input (expected
);
6561 #ifdef POLL_FOR_INPUT
6562 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6565 mask
= sigblock (sigmask (SIGALRM
));
6566 read_avail_input (expected
);
6572 read_avail_input (expected
);
6576 /* Put a BUFFER_SWITCH_EVENT in the buffer
6577 so that read_key_sequence will notice the new current buffer. */
6580 record_asynch_buffer_change ()
6582 struct input_event event
;
6586 event
.kind
= BUFFER_SWITCH_EVENT
;
6587 event
.frame_or_window
= Qnil
;
6591 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6592 The purpose of the event is to make read_key_sequence look up the
6593 keymaps again. If we aren't in read_key_sequence, we don't need one,
6594 and the event could cause trouble by messing up (input-pending-p). */
6595 tem
= Fwaiting_for_user_input_p ();
6599 /* We never need these events if we have no asynchronous subprocesses. */
6603 /* Make sure no interrupt happens while storing the event. */
6605 if (interrupt_input
)
6608 mask
= sigblock (sigmask (SIGIO
));
6609 kbd_buffer_store_event (&event
);
6616 kbd_buffer_store_event (&event
);
6623 /* Read any terminal input already buffered up by the system
6624 into the kbd_buffer, but do not wait.
6626 EXPECTED should be nonzero if the caller knows there is some input.
6628 Except on VMS, all input is read by this function.
6629 If interrupt_input is nonzero, this function MUST be called
6630 only when SIGIO is blocked.
6632 Returns the number of keyboard chars read, or -1 meaning
6633 this is a bad time to try to read input. */
6636 read_avail_input (expected
)
6642 if (read_socket_hook
)
6645 struct input_event hold_quit
;
6647 EVENT_INIT (hold_quit
);
6648 hold_quit
.kind
= NO_EVENT
;
6650 /* No need for FIONREAD or fcntl; just say don't wait. */
6651 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6656 if (hold_quit
.kind
!= NO_EVENT
)
6657 kbd_buffer_store_event (&hold_quit
);
6661 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6662 the kbd_buffer can really hold. That may prevent loss
6663 of characters on some systems when input is stuffed at us. */
6664 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6667 /* Determine how many characters we should *try* to read. */
6670 #else /* not WINDOWSNT */
6672 n_to_read
= dos_keysns ();
6675 #else /* not MSDOS */
6677 /* Find out how much input is available. */
6678 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6679 /* Formerly simply reported no input, but that sometimes led to
6680 a failure of Emacs to terminate.
6681 SIGHUP seems appropriate if we can't reach the terminal. */
6682 /* ??? Is it really right to send the signal just to this process
6683 rather than to the whole process group?
6684 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6686 if (! noninteractive
)
6687 kill (getpid (), SIGHUP
);
6693 if (n_to_read
> sizeof cbuf
)
6694 n_to_read
= sizeof cbuf
;
6695 #else /* no FIONREAD */
6696 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6697 /* Read some input if available, but don't wait. */
6698 n_to_read
= sizeof cbuf
;
6699 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6704 #endif /* not MSDOS */
6705 #endif /* not WINDOWSNT */
6707 /* Now read; for one reason or another, this will not block.
6708 NREAD is set to the number of chars read. */
6712 cbuf
[0] = dos_keyread ();
6715 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6717 /* POSIX infers that processes which are not in the session leader's
6718 process group won't get SIGHUP's at logout time. BSDI adheres to
6719 this part standard and returns -1 from read (0) with errno==EIO
6720 when the control tty is taken away.
6721 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6722 if (nread
== -1 && errno
== EIO
)
6724 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6725 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6726 This looks incorrect, but it isn't, because _BSD causes
6727 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6728 and that causes a value other than 0 when there is no input. */
6734 /* We used to retry the read if it was interrupted.
6735 But this does the wrong thing when O_NDELAY causes
6736 an EAGAIN error. Does anybody know of a situation
6737 where a retry is actually needed? */
6739 nread
< 0 && (errno
== EAGAIN
6753 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6754 fcntl (input_fd
, F_SETFL
, 0);
6755 #endif /* USG or DGUX or CYGWIN */
6756 #endif /* no FIONREAD */
6757 for (i
= 0; i
< nread
; i
++)
6759 struct input_event buf
;
6761 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6763 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6764 buf
.modifiers
= meta_modifier
;
6769 buf
.frame_or_window
= selected_frame
;
6772 kbd_buffer_store_event (&buf
);
6773 /* Don't look at input that follows a C-g too closely.
6774 This reduces lossage due to autorepeat on C-g. */
6775 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6776 && buf
.code
== quit_char
)
6783 #endif /* not VMS */
6786 handle_async_input ()
6789 extern int select_alarmed
;
6792 interrupt_input_pending
= 0;
6797 nread
= read_avail_input (1);
6798 /* -1 means it's not ok to read the input now.
6799 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6800 0 means there was no keyboard input available. */
6805 select_alarmed
= 1; /* Force the select emulator back to life */
6810 #ifdef SIGIO /* for entire page */
6811 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6814 input_available_signal (signo
)
6817 /* Must preserve main program's value of errno. */
6818 int old_errno
= errno
;
6819 #if defined (USG) && !defined (POSIX_SIGNALS)
6820 /* USG systems forget handlers when they are used;
6821 must reestablish each time */
6822 signal (signo
, input_available_signal
);
6830 interrupt_input_pending
= 1;
6832 SIGNAL_THREAD_CHECK (signo
);
6835 if (input_available_clear_time
)
6836 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6839 handle_async_input ();
6849 /* Send ourselves a SIGIO.
6851 This function exists so that the UNBLOCK_INPUT macro in
6852 blockinput.h can have some way to take care of input we put off
6853 dealing with, without assuming that every file which uses
6854 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6856 reinvoke_input_signal ()
6859 handle_async_input ();
6865 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6866 static Lisp_Object menu_bar_one_keymap_changed_items
;
6868 /* These variables hold the vector under construction within
6869 menu_bar_items and its subroutines, and the current index
6870 for storing into that vector. */
6871 static Lisp_Object menu_bar_items_vector
;
6872 static int menu_bar_items_index
;
6874 /* Return a vector of menu items for a menu bar, appropriate
6875 to the current buffer. Each item has three elements in the vector:
6878 OLD is an old vector we can optionally reuse, or nil. */
6881 menu_bar_items (old
)
6884 /* The number of keymaps we're scanning right now, and the number of
6885 keymaps we have allocated space for. */
6888 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6889 in the current keymaps, or nil where it is not a prefix. */
6892 Lisp_Object def
, tail
;
6901 struct gcpro gcpro1
;
6903 /* In order to build the menus, we need to call the keymap
6904 accessors. They all call QUIT. But this function is called
6905 during redisplay, during which a quit is fatal. So inhibit
6906 quitting while building the menus.
6907 We do this instead of specbind because (1) errors will clear it anyway
6908 and (2) this avoids risk of specpdl overflow. */
6909 oquit
= Vinhibit_quit
;
6913 menu_bar_items_vector
= old
;
6915 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6916 menu_bar_items_index
= 0;
6918 GCPRO1 (menu_bar_items_vector
);
6920 /* Build our list of keymaps.
6921 If we recognize a function key and replace its escape sequence in
6922 keybuf with its symbol, or if the sequence starts with a mouse
6923 click and we need to switch buffers, we jump back here to rebuild
6924 the initial keymaps from the current buffer. */
6928 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6929 if (!NILP (Voverriding_local_map_menu_flag
))
6931 /* Yes, use them (if non-nil) as well as the global map. */
6932 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6934 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6935 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6936 if (!NILP (Voverriding_local_map
))
6937 maps
[nmaps
++] = Voverriding_local_map
;
6941 /* No, so use major and minor mode keymaps and keymap property.
6942 Note that menu-bar bindings in the local-map and keymap
6943 properties may not work reliable, as they are only
6944 recognized when the menu-bar (or mode-line) is updated,
6945 which does not normally happen after every command. */
6948 nminor
= current_minor_maps (NULL
, &tmaps
);
6949 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6951 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6952 maps
[nmaps
++] = tem
;
6953 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6955 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6957 maps
[nmaps
++] = current_global_map
;
6960 /* Look up in each map the dummy prefix key `menu-bar'. */
6964 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6965 if (!NILP (maps
[mapno
]))
6967 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6971 menu_bar_one_keymap_changed_items
= Qnil
;
6972 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6976 /* Move to the end those items that should be at the end. */
6978 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6981 int end
= menu_bar_items_index
;
6983 for (i
= 0; i
< end
; i
+= 4)
6984 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6986 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6987 /* Move the item at index I to the end,
6988 shifting all the others forward. */
6989 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6990 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6991 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6992 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6994 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6995 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6996 (end
- i
- 4) * sizeof (Lisp_Object
));
6997 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6998 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6999 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7000 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7005 /* Add nil, nil, nil, nil at the end. */
7006 i
= menu_bar_items_index
;
7007 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7010 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7011 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7012 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7013 menu_bar_items_vector
= tem
;
7015 /* Add this item. */
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 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7020 menu_bar_items_index
= i
;
7022 Vinhibit_quit
= oquit
;
7024 return menu_bar_items_vector
;
7027 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7028 If there's already an item for KEY, add this DEF to it. */
7030 Lisp_Object item_properties
;
7033 menu_bar_item (key
, item
, dummy1
, dummy2
)
7034 Lisp_Object key
, item
, dummy1
;
7037 struct gcpro gcpro1
;
7041 if (EQ (item
, Qundefined
))
7043 /* If a map has an explicit `undefined' as definition,
7044 discard any previously made menu bar item. */
7046 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7047 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7049 if (menu_bar_items_index
> i
+ 4)
7050 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7051 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7052 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7053 menu_bar_items_index
-= 4;
7057 /* If this keymap has already contributed to this KEY,
7058 don't contribute to it a second time. */
7059 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7060 if (!NILP (tem
) || NILP (item
))
7063 menu_bar_one_keymap_changed_items
7064 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7066 /* We add to menu_bar_one_keymap_changed_items before doing the
7067 parse_menu_item, so that if it turns out it wasn't a menu item,
7068 it still correctly hides any further menu item. */
7070 i
= parse_menu_item (item
, 0, 1);
7075 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7077 /* Find any existing item for this KEY. */
7078 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7079 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7082 /* If we did not find this KEY, add it at the end. */
7083 if (i
== menu_bar_items_index
)
7085 /* If vector is too small, get a bigger one. */
7086 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7089 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7090 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7091 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7092 menu_bar_items_vector
= tem
;
7095 /* Add this item. */
7096 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7097 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7098 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7099 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7100 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7101 menu_bar_items_index
= i
;
7103 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7107 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7108 /* If the new and the old items are not both keymaps,
7109 the lookup will only find `item'. */
7110 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7111 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7115 /* This is used as the handler when calling menu_item_eval_property. */
7117 menu_item_eval_property_1 (arg
)
7120 /* If we got a quit from within the menu computation,
7121 quit all the way out of it. This takes care of C-] in the debugger. */
7122 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7123 Fsignal (Qquit
, Qnil
);
7128 /* Evaluate an expression and return the result (or nil if something
7129 went wrong). Used to evaluate dynamic parts of menu items. */
7131 menu_item_eval_property (sexpr
)
7134 int count
= SPECPDL_INDEX ();
7136 specbind (Qinhibit_redisplay
, Qt
);
7137 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7138 menu_item_eval_property_1
);
7139 return unbind_to (count
, val
);
7142 /* This function parses a menu item and leaves the result in the
7143 vector item_properties.
7144 ITEM is a key binding, a possible menu item.
7145 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7146 evaluate dynamic expressions in the menu item.
7147 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7149 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7150 parse_menu_item returns true if the item is a menu item and false
7154 parse_menu_item (item
, notreal
, inmenubar
)
7156 int notreal
, inmenubar
;
7158 Lisp_Object def
, tem
, item_string
, start
;
7159 Lisp_Object cachelist
;
7161 Lisp_Object keyhint
;
7172 /* Create item_properties vector if necessary. */
7173 if (NILP (item_properties
))
7175 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7177 /* Initialize optional entries. */
7178 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7179 AREF (item_properties
, i
) = Qnil
;
7180 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7182 /* Save the item here to protect it from GC. */
7183 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7185 item_string
= XCAR (item
);
7189 if (STRINGP (item_string
))
7191 /* Old format menu item. */
7192 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7194 /* Maybe help string. */
7195 if (CONSP (item
) && STRINGP (XCAR (item
)))
7197 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7202 /* Maybe key binding cache. */
7203 if (CONSP (item
) && CONSP (XCAR (item
))
7204 && (NILP (XCAR (XCAR (item
)))
7205 || VECTORP (XCAR (XCAR (item
)))))
7207 cachelist
= XCAR (item
);
7211 /* This is the real definition--the function to run. */
7212 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7214 /* Get enable property, if any. */
7217 tem
= Fget (item
, Qmenu_enable
);
7219 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7222 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7224 /* New format menu item. */
7225 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7226 start
= XCDR (item
);
7229 /* We have a real binding. */
7230 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7232 item
= XCDR (start
);
7233 /* Is there a cache list with key equivalences. */
7234 if (CONSP (item
) && CONSP (XCAR (item
)))
7236 cachelist
= XCAR (item
);
7240 /* Parse properties. */
7241 while (CONSP (item
) && CONSP (XCDR (item
)))
7246 if (EQ (tem
, QCenable
))
7247 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7248 else if (EQ (tem
, QCvisible
) && !notreal
)
7250 /* If got a visible property and that evaluates to nil
7251 then ignore this item. */
7252 tem
= menu_item_eval_property (XCAR (item
));
7256 else if (EQ (tem
, QChelp
))
7257 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7258 else if (EQ (tem
, QCfilter
))
7260 else if (EQ (tem
, QCkey_sequence
))
7263 if (NILP (cachelist
)
7264 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7265 /* Be GC protected. Set keyhint to item instead of tem. */
7268 else if (EQ (tem
, QCkeys
))
7271 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7272 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7274 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7279 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7281 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7283 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7290 else if (inmenubar
|| !NILP (start
))
7294 return 0; /* not a menu item */
7296 /* If item string is not a string, evaluate it to get string.
7297 If we don't get a string, skip this item. */
7298 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7299 if (!(STRINGP (item_string
) || notreal
))
7301 item_string
= menu_item_eval_property (item_string
);
7302 if (!STRINGP (item_string
))
7304 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7307 /* If got a filter apply it on definition. */
7308 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7311 def
= menu_item_eval_property (list2 (XCAR (filter
),
7312 list2 (Qquote
, def
)));
7314 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7317 /* Enable or disable selection of item. */
7318 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7324 tem
= menu_item_eval_property (tem
);
7325 if (inmenubar
&& NILP (tem
))
7326 return 0; /* Ignore disabled items in menu bar. */
7327 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7330 /* If we got no definition, this item is just unselectable text which
7331 is OK in a submenu but not in the menubar. */
7333 return (inmenubar
? 0 : 1);
7335 /* See if this is a separate pane or a submenu. */
7336 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7337 tem
= get_keymap (def
, 0, 1);
7338 /* For a subkeymap, just record its details and exit. */
7341 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7342 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7346 /* At the top level in the menu bar, do likewise for commands also.
7347 The menu bar does not display equivalent key bindings anyway.
7348 ITEM_PROPERTY_DEF is already set up properly. */
7352 /* This is a command. See if there is an equivalent key binding. */
7353 if (NILP (cachelist
))
7355 /* We have to create a cachelist. */
7356 CHECK_IMPURE (start
);
7357 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7358 cachelist
= XCAR (XCDR (start
));
7360 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7361 if (!NILP (keyhint
))
7363 XSETCAR (cachelist
, XCAR (keyhint
));
7366 else if (STRINGP (tem
))
7368 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7369 XSETCAR (cachelist
, Qt
);
7373 tem
= XCAR (cachelist
);
7380 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7382 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7385 def
= XCAR (prefix
);
7386 prefix
= XCDR (prefix
);
7389 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7391 if (!update_menu_bindings
)
7393 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7395 if (newcache
/* Always check first time. */
7396 /* Should we check everything when precomputing key
7398 /* If something had no key binding before, don't recheck it
7399 because that is too slow--except if we have a list of
7400 rebound commands in Vdefine_key_rebound_commands, do
7401 recheck any command that appears in that list. */
7402 || (CONSP (Vdefine_key_rebound_commands
)
7403 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7406 /* We had a saved key. Is it still bound to the command? */
7409 /* If the command is an alias for another
7410 (such as lmenu.el set it up), check if the
7411 original command matches the cached command. */
7412 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7413 chkcache
= 1; /* Need to recompute key binding. */
7417 /* Recompute equivalent key binding. If the command is an alias
7418 for another (such as lmenu.el set it up), see if the original
7419 command name has equivalent keys. Otherwise look up the
7420 specified command itself. We don't try both, because that
7421 makes lmenu menus slow. */
7423 && SYMBOLP (XSYMBOL (def
)->function
)
7424 && ! NILP (Fget (def
, Qmenu_alias
)))
7425 def
= XSYMBOL (def
)->function
;
7426 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7427 XSETCAR (cachelist
, tem
);
7430 XSETCDR (cachelist
, Qnil
);
7434 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7436 tem
= XCAR (cachelist
);
7440 newcache
= chkcache
;
7443 tem
= Fkey_description (tem
, Qnil
);
7446 if (STRINGP (XCAR (prefix
)))
7447 tem
= concat2 (XCAR (prefix
), tem
);
7448 if (STRINGP (XCDR (prefix
)))
7449 tem
= concat2 (tem
, XCDR (prefix
));
7451 XSETCDR (cachelist
, tem
);
7455 tem
= XCDR (cachelist
);
7456 if (newcache
&& !NILP (tem
))
7458 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7459 XSETCDR (cachelist
, tem
);
7462 /* If we only want to precompute equivalent key bindings, stop here. */
7466 /* If we have an equivalent key binding, use that. */
7467 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7469 /* Include this when menu help is implemented.
7470 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7471 if (!(NILP (tem) || STRINGP (tem)))
7473 tem = menu_item_eval_property (tem);
7476 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7480 /* Handle radio buttons or toggle boxes. */
7481 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7483 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7484 = menu_item_eval_property (tem
);
7491 /***********************************************************************
7493 ***********************************************************************/
7495 /* A vector holding tool bar items while they are parsed in function
7496 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7499 static Lisp_Object tool_bar_items_vector
;
7501 /* A vector holding the result of parse_tool_bar_item. Layout is like
7502 the one for a single item in tool_bar_items_vector. */
7504 static Lisp_Object tool_bar_item_properties
;
7506 /* Next free index in tool_bar_items_vector. */
7508 static int ntool_bar_items
;
7510 /* The symbols `tool-bar', and `:image'. */
7512 extern Lisp_Object Qtool_bar
;
7513 Lisp_Object QCimage
;
7515 /* Function prototypes. */
7517 static void init_tool_bar_items
P_ ((Lisp_Object
));
7518 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7519 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7520 static void append_tool_bar_item
P_ ((void));
7523 /* Return a vector of tool bar items for keymaps currently in effect.
7524 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7525 tool bar items found. */
7528 tool_bar_items (reuse
, nitems
)
7539 /* In order to build the menus, we need to call the keymap
7540 accessors. They all call QUIT. But this function is called
7541 during redisplay, during which a quit is fatal. So inhibit
7542 quitting while building the menus. We do this instead of
7543 specbind because (1) errors will clear it anyway and (2) this
7544 avoids risk of specpdl overflow. */
7545 oquit
= Vinhibit_quit
;
7548 /* Initialize tool_bar_items_vector and protect it from GC. */
7549 init_tool_bar_items (reuse
);
7551 /* Build list of keymaps in maps. Set nmaps to the number of maps
7554 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7555 if (!NILP (Voverriding_local_map_menu_flag
))
7557 /* Yes, use them (if non-nil) as well as the global map. */
7558 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7560 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7561 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7562 if (!NILP (Voverriding_local_map
))
7563 maps
[nmaps
++] = Voverriding_local_map
;
7567 /* No, so use major and minor mode keymaps and keymap property.
7568 Note that tool-bar bindings in the local-map and keymap
7569 properties may not work reliable, as they are only
7570 recognized when the tool-bar (or mode-line) is updated,
7571 which does not normally happen after every command. */
7574 nminor
= current_minor_maps (NULL
, &tmaps
);
7575 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7577 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7578 maps
[nmaps
++] = tem
;
7579 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7581 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7584 /* Add global keymap at the end. */
7585 maps
[nmaps
++] = current_global_map
;
7587 /* Process maps in reverse order and look up in each map the prefix
7589 for (i
= nmaps
- 1; i
>= 0; --i
)
7590 if (!NILP (maps
[i
]))
7594 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7599 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7600 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7602 Lisp_Object keydef
= XCAR (tail
);
7604 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7609 Vinhibit_quit
= oquit
;
7610 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7611 return tool_bar_items_vector
;
7615 /* Process the definition of KEY which is DEF. */
7618 process_tool_bar_item (key
, def
)
7619 Lisp_Object key
, def
;
7622 extern Lisp_Object Qundefined
;
7623 struct gcpro gcpro1
, gcpro2
;
7625 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7629 if (EQ (def
, Qundefined
))
7631 /* If a map has an explicit `undefined' as definition,
7632 discard any previously made item. */
7633 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7635 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7637 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7639 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7640 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7641 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7642 * sizeof (Lisp_Object
)));
7643 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7648 else if (parse_tool_bar_item (key
, def
))
7649 /* Append a new tool bar item to tool_bar_items_vector. Accept
7650 more than one definition for the same key. */
7651 append_tool_bar_item ();
7657 /* Parse a tool bar item specification ITEM for key KEY and return the
7658 result in tool_bar_item_properties. Value is zero if ITEM is
7661 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7663 CAPTION is the caption of the item, If it's not a string, it is
7664 evaluated to get a string.
7666 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7667 as binding are currently ignored.
7669 The following properties are recognized:
7673 FORM is evaluated and specifies whether the tool bar item is
7674 enabled or disabled.
7678 FORM is evaluated and specifies whether the tool bar item is visible.
7680 - `:filter FUNCTION'
7682 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7683 result is stored as the new binding.
7685 - `:button (TYPE SELECTED)'
7687 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7688 and specifies whether the button is selected (pressed) or not.
7692 IMAGES is either a single image specification or a vector of four
7693 image specifications. See enum tool_bar_item_images.
7695 - `:help HELP-STRING'.
7697 Gives a help string to display for the tool bar item. */
7700 parse_tool_bar_item (key
, item
)
7701 Lisp_Object key
, item
;
7703 /* Access slot with index IDX of vector tool_bar_item_properties. */
7704 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7706 Lisp_Object filter
= Qnil
;
7707 Lisp_Object caption
;
7710 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7711 Rule out items that aren't lists, don't start with
7712 `menu-item' or whose rest following `tool-bar-item' is not a
7715 || !EQ (XCAR (item
), Qmenu_item
)
7716 || (item
= XCDR (item
),
7720 /* Create tool_bar_item_properties vector if necessary. Reset it to
7722 if (VECTORP (tool_bar_item_properties
))
7724 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7728 tool_bar_item_properties
7729 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7732 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7733 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7735 /* Get the caption of the item. If the caption is not a string,
7736 evaluate it to get a string. If we don't get a string, skip this
7738 caption
= XCAR (item
);
7739 if (!STRINGP (caption
))
7741 caption
= menu_item_eval_property (caption
);
7742 if (!STRINGP (caption
))
7745 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7747 /* Give up if rest following the caption is not a list. */
7752 /* Store the binding. */
7753 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7756 /* Ignore cached key binding, if any. */
7757 if (CONSP (item
) && CONSP (XCAR (item
)))
7760 /* Process the rest of the properties. */
7761 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7763 Lisp_Object key
, value
;
7766 value
= XCAR (XCDR (item
));
7768 if (EQ (key
, QCenable
))
7769 /* `:enable FORM'. */
7770 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7771 else if (EQ (key
, QCvisible
))
7773 /* `:visible FORM'. If got a visible property and that
7774 evaluates to nil then ignore this item. */
7775 if (NILP (menu_item_eval_property (value
)))
7778 else if (EQ (key
, QChelp
))
7779 /* `:help HELP-STRING'. */
7780 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7781 else if (EQ (key
, QCfilter
))
7782 /* ':filter FORM'. */
7784 else if (EQ (key
, QCbutton
) && CONSP (value
))
7786 /* `:button (TYPE . SELECTED)'. */
7787 Lisp_Object type
, selected
;
7789 type
= XCAR (value
);
7790 selected
= XCDR (value
);
7791 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7793 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7794 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7797 else if (EQ (key
, QCimage
)
7799 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7800 /* Value is either a single image specification or a vector
7801 of 4 such specifications for the different button states. */
7802 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7805 /* If got a filter apply it on binding. */
7807 PROP (TOOL_BAR_ITEM_BINDING
)
7808 = menu_item_eval_property (list2 (filter
,
7810 PROP (TOOL_BAR_ITEM_BINDING
))));
7812 /* See if the binding is a keymap. Give up if it is. */
7813 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7816 /* Enable or disable selection of item. */
7817 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7818 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7819 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7821 /* Handle radio buttons or toggle boxes. */
7822 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7823 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7824 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7832 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7833 that can be reused. */
7836 init_tool_bar_items (reuse
)
7839 if (VECTORP (reuse
))
7840 tool_bar_items_vector
= reuse
;
7842 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7843 ntool_bar_items
= 0;
7847 /* Append parsed tool bar item properties from
7848 tool_bar_item_properties */
7851 append_tool_bar_item ()
7853 Lisp_Object
*to
, *from
;
7855 /* Enlarge tool_bar_items_vector if necessary. */
7856 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7857 >= XVECTOR (tool_bar_items_vector
)->size
)
7859 Lisp_Object new_vector
;
7860 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7862 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7863 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7864 XVECTOR (new_vector
)->contents
,
7865 old_size
* sizeof (Lisp_Object
));
7866 tool_bar_items_vector
= new_vector
;
7869 /* Append entries from tool_bar_item_properties to the end of
7870 tool_bar_items_vector. */
7871 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7872 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7873 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7874 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7881 /* Read a character using menus based on maps in the array MAPS.
7882 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7883 Return t if we displayed a menu but the user rejected it.
7885 PREV_EVENT is the previous input event, or nil if we are reading
7886 the first event of a key sequence.
7888 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7889 if we used a mouse menu to read the input, or zero otherwise. If
7890 USED_MOUSE_MENU is null, we don't dereference it.
7892 The prompting is done based on the prompt-string of the map
7893 and the strings associated with various map elements.
7895 This can be done with X menus or with menus put in the minibuf.
7896 These are done in different ways, depending on how the input will be read.
7897 Menus using X are done after auto-saving in read-char, getting the input
7898 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7899 and do auto-saving in the inner call of read_char. */
7902 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7905 Lisp_Object prev_event
;
7906 int *used_mouse_menu
;
7909 register Lisp_Object name
= Qnil
;
7911 if (used_mouse_menu
)
7912 *used_mouse_menu
= 0;
7914 /* Use local over global Menu maps */
7916 if (! menu_prompting
)
7919 /* Optionally disregard all but the global map. */
7920 if (inhibit_local_menu_bar_menus
)
7922 maps
+= (nmaps
- 1);
7926 /* Get the menu name from the first map that has one (a prompt string). */
7927 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7929 name
= Fkeymap_prompt (maps
[mapno
]);
7934 /* If we don't have any menus, just read a character normally. */
7935 if (!STRINGP (name
))
7939 /* If we got to this point via a mouse click,
7940 use a real menu for mouse selection. */
7941 if (EVENT_HAS_PARAMETERS (prev_event
)
7942 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7943 && !EQ (XCAR (prev_event
), Qtool_bar
))
7945 /* Display the menu and get the selection. */
7946 Lisp_Object
*realmaps
7947 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7951 /* Use the maps that are not nil. */
7952 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7953 if (!NILP (maps
[mapno
]))
7954 realmaps
[nmaps1
++] = maps
[mapno
];
7956 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7961 record_menu_key (XCAR (value
));
7963 /* If we got multiple events, unread all but
7965 There is no way to prevent those unread events
7966 from showing up later in last_nonmenu_event.
7967 So turn symbol and integer events into lists,
7968 to indicate that they came from a mouse menu,
7969 so that when present in last_nonmenu_event
7970 they won't confuse things. */
7971 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7973 record_menu_key (XCAR (tem
));
7974 if (SYMBOLP (XCAR (tem
))
7975 || INTEGERP (XCAR (tem
)))
7976 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7979 /* If we got more than one event, put all but the first
7980 onto this list to be read later.
7981 Return just the first event now. */
7982 Vunread_command_events
7983 = nconc2 (XCDR (value
), Vunread_command_events
);
7984 value
= XCAR (value
);
7986 else if (NILP (value
))
7988 if (used_mouse_menu
)
7989 *used_mouse_menu
= 1;
7992 #endif /* HAVE_MENUS */
7996 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7997 We make this bigger when necessary, and never free it. */
7998 static char *read_char_minibuf_menu_text
;
7999 /* Size of that buffer. */
8000 static int read_char_minibuf_menu_width
;
8003 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8009 register Lisp_Object name
;
8011 /* FIXME: Use the minibuffer's frame width. */
8012 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8015 Lisp_Object rest
, vector
;
8021 if (! menu_prompting
)
8024 /* Make sure we have a big enough buffer for the menu text. */
8025 if (read_char_minibuf_menu_text
== 0)
8027 read_char_minibuf_menu_width
= width
+ 4;
8028 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8030 else if (width
+ 4 > read_char_minibuf_menu_width
)
8032 read_char_minibuf_menu_width
= width
+ 4;
8033 read_char_minibuf_menu_text
8034 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8036 menu
= read_char_minibuf_menu_text
;
8038 /* Get the menu name from the first map that has one (a prompt string). */
8039 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8041 name
= Fkeymap_prompt (maps
[mapno
]);
8046 /* If we don't have any menus, just read a character normally. */
8047 if (!STRINGP (name
))
8050 /* Prompt string always starts with map's prompt, and a space. */
8051 strcpy (menu
, SDATA (name
));
8052 nlength
= SBYTES (name
);
8053 menu
[nlength
++] = ':';
8054 menu
[nlength
++] = ' ';
8057 /* Start prompting at start of first map. */
8061 /* Present the documented bindings, a line at a time. */
8068 Lisp_Object orig_defn_macro
;
8070 /* Loop over elements of map. */
8075 /* If reached end of map, start at beginning of next map. */
8079 /* At end of last map, wrap around to first map if just starting,
8080 or end this line if already have something on it. */
8084 if (notfirst
|| nobindings
) break;
8089 /* Look at the next element of the map. */
8091 elt
= XVECTOR (vector
)->contents
[idx
];
8093 elt
= Fcar_safe (rest
);
8095 if (idx
< 0 && VECTORP (elt
))
8097 /* If we found a dense table in the keymap,
8098 advanced past it, but start scanning its contents. */
8099 rest
= Fcdr_safe (rest
);
8105 /* An ordinary element. */
8106 Lisp_Object event
, tem
;
8110 event
= Fcar_safe (elt
); /* alist */
8111 elt
= Fcdr_safe (elt
);
8115 XSETINT (event
, idx
); /* vector */
8118 /* Ignore the element if it has no prompt string. */
8119 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8121 /* 1 if the char to type matches the string. */
8123 Lisp_Object upcased_event
, downcased_event
;
8124 Lisp_Object desc
= Qnil
;
8126 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8128 upcased_event
= Fupcase (event
);
8129 downcased_event
= Fdowncase (event
);
8130 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8131 || XINT (downcased_event
) == SREF (s
, 0));
8133 desc
= Fsingle_key_description (event
, Qnil
);
8135 #if 0 /* It is redundant to list the equivalent key bindings because
8136 the prefix is what the user has already typed. */
8138 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8140 /* Insert equivalent keybinding. */
8141 s
= concat2 (s
, tem
);
8144 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8145 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8147 /* Insert button prefix. */
8148 Lisp_Object selected
8149 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8150 if (EQ (tem
, QCradio
))
8151 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8153 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8154 s
= concat2 (tem
, s
);
8158 /* If we have room for the prompt string, add it to this line.
8159 If this is the first on the line, always add it. */
8160 if ((SCHARS (s
) + i
+ 2
8161 + (char_matches
? 0 : SCHARS (desc
) + 3))
8167 /* Punctuate between strings. */
8170 strcpy (menu
+ i
, ", ");
8176 /* If the char to type doesn't match the string's
8177 first char, explicitly show what char to type. */
8180 /* Add as much of string as fits. */
8181 thiswidth
= SCHARS (desc
);
8182 if (thiswidth
+ i
> width
)
8183 thiswidth
= width
- i
;
8184 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8186 strcpy (menu
+ i
, " = ");
8190 /* Add as much of string as fits. */
8191 thiswidth
= SCHARS (s
);
8192 if (thiswidth
+ i
> width
)
8193 thiswidth
= width
- i
;
8194 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8200 /* If this element does not fit, end the line now,
8201 and save the element for the next line. */
8202 strcpy (menu
+ i
, "...");
8207 /* Move past this element. */
8208 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8209 /* Handle reaching end of dense table. */
8214 rest
= Fcdr_safe (rest
);
8218 /* Prompt with that and read response. */
8219 message2_nolog (menu
, strlen (menu
),
8220 ! NILP (current_buffer
->enable_multibyte_characters
));
8222 /* Make believe its not a keyboard macro in case the help char
8223 is pressed. Help characters are not recorded because menu prompting
8224 is not used on replay.
8226 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8227 current_kboard
->defining_kbd_macro
= Qnil
;
8229 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8230 while (BUFFERP (obj
));
8231 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8233 if (!INTEGERP (obj
))
8238 if (! EQ (obj
, menu_prompt_more_char
)
8239 && (!INTEGERP (menu_prompt_more_char
)
8240 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8242 if (!NILP (current_kboard
->defining_kbd_macro
))
8243 store_kbd_macro_char (obj
);
8246 /* Help char - go round again */
8250 /* Reading key sequences. */
8252 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8253 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8254 keymap, or nil otherwise. Return the index of the first keymap in
8255 which KEY has any binding, or NMAPS if no map has a binding.
8257 If KEY is a meta ASCII character, treat it like meta-prefix-char
8258 followed by the corresponding non-meta character. Keymaps in
8259 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8262 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8265 NEXT may be the same array as CURRENT. */
8268 follow_key (key
, nmaps
, current
, defs
, next
)
8270 Lisp_Object
*current
, *defs
, *next
;
8273 int i
, first_binding
;
8275 first_binding
= nmaps
;
8276 for (i
= nmaps
- 1; i
>= 0; i
--)
8278 if (! NILP (current
[i
]))
8280 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8281 if (! NILP (defs
[i
]))
8288 /* Given the set of bindings we've found, produce the next set of maps. */
8289 if (first_binding
< nmaps
)
8290 for (i
= 0; i
< nmaps
; i
++)
8291 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8293 return first_binding
;
8296 /* Structure used to keep track of partial application of key remapping
8297 such as Vfunction_key_map and Vkey_translation_map. */
8298 typedef struct keyremap
8300 Lisp_Object map
, parent
;
8304 /* Lookup KEY in MAP.
8305 MAP is a keymap mapping keys to key vectors or functions.
8306 If the mapping is a function and DO_FUNCTION is non-zero, then
8307 the function is called with PROMPT as parameter and its return
8308 value is used as the return value of this function (after checking
8309 that it is indeed a vector). */
8312 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8313 Lisp_Object map
, key
, prompt
;
8318 next
= access_keymap (map
, key
, 1, 0, 1);
8320 /* Handle symbol with autoload definition. */
8321 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8322 && CONSP (XSYMBOL (next
)->function
)
8323 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8324 do_autoload (XSYMBOL (next
)->function
, next
);
8326 /* Handle a symbol whose function definition is a keymap
8328 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8329 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8330 || KEYMAPP (XSYMBOL (next
)->function
)))
8331 next
= XSYMBOL (next
)->function
;
8333 /* If the keymap gives a function, not an
8334 array, then call the function with one arg and use
8335 its value instead. */
8336 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8341 next
= call1 (next
, prompt
);
8342 /* If the function returned something invalid,
8343 barf--don't ignore it.
8344 (To ignore it safely, we would need to gcpro a bunch of
8345 other variables.) */
8346 if (! (VECTORP (next
) || STRINGP (next
)))
8347 error ("Function %s returns invalid key sequence", tem
);
8352 /* Do one step of the key remapping used for function-key-map and
8353 key-translation-map:
8354 KEYBUF is the buffer holding the input events.
8355 BUFSIZE is its maximum size.
8356 FKEY is a pointer to the keyremap structure to use.
8357 INPUT is the index of the last element in KEYBUF.
8358 DOIT if non-zero says that the remapping can actually take place.
8359 DIFF is used to return the number of keys added/removed by the remapping.
8360 PARENT is the root of the keymap.
8361 PROMPT is the prompt to use if the remapping happens through a function.
8362 The return value is non-zero if the remapping actually took place. */
8365 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8366 Lisp_Object
*keybuf
, prompt
;
8368 int input
, doit
, *diff
, bufsize
;
8370 Lisp_Object next
, key
;
8372 key
= keybuf
[fkey
->end
++];
8373 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8375 /* If keybuf[fkey->start..fkey->end] is bound in the
8376 map and we're in a position to do the key remapping, replace it with
8377 the binding and restart with fkey->start at the end. */
8378 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8380 int len
= XFASTINT (Flength (next
));
8383 *diff
= len
- (fkey
->end
- fkey
->start
);
8385 if (input
+ *diff
>= bufsize
)
8386 error ("Key sequence too long");
8388 /* Shift the keys that follow fkey->end. */
8390 for (i
= fkey
->end
; i
< input
; i
++)
8391 keybuf
[i
+ *diff
] = keybuf
[i
];
8393 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8394 keybuf
[i
+ *diff
] = keybuf
[i
];
8395 /* Overwrite the old keys with the new ones. */
8396 for (i
= 0; i
< len
; i
++)
8397 keybuf
[fkey
->start
+ i
]
8398 = Faref (next
, make_number (i
));
8400 fkey
->start
= fkey
->end
+= *diff
;
8401 fkey
->map
= fkey
->parent
;
8406 fkey
->map
= get_keymap (next
, 0, 1);
8408 /* If we no longer have a bound suffix, try a new position for
8410 if (!CONSP (fkey
->map
))
8412 fkey
->end
= ++fkey
->start
;
8413 fkey
->map
= fkey
->parent
;
8418 /* Read a sequence of keys that ends with a non prefix character,
8419 storing it in KEYBUF, a buffer of size BUFSIZE.
8421 Return the length of the key sequence stored.
8422 Return -1 if the user rejected a command menu.
8424 Echo starting immediately unless `prompt' is 0.
8426 Where a key sequence ends depends on the currently active keymaps.
8427 These include any minor mode keymaps active in the current buffer,
8428 the current buffer's local map, and the global map.
8430 If a key sequence has no other bindings, we check Vfunction_key_map
8431 to see if some trailing subsequence might be the beginning of a
8432 function key's sequence. If so, we try to read the whole function
8433 key, and substitute its symbolic name into the key sequence.
8435 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8436 `double-' events into similar click events, if that would make them
8437 bound. We try to turn `triple-' events first into `double-' events,
8440 If we get a mouse click in a mode line, vertical divider, or other
8441 non-text area, we treat the click as if it were prefixed by the
8442 symbol denoting that area - `mode-line', `vertical-line', or
8445 If the sequence starts with a mouse click, we read the key sequence
8446 with respect to the buffer clicked on, not the current buffer.
8448 If the user switches frames in the midst of a key sequence, we put
8449 off the switch-frame event until later; the next call to
8450 read_char will return it.
8452 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8453 from the selected window's buffer. */
8456 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8457 can_return_switch_frame
, fix_current_buffer
)
8458 Lisp_Object
*keybuf
;
8461 int dont_downcase_last
;
8462 int can_return_switch_frame
;
8463 int fix_current_buffer
;
8465 volatile Lisp_Object from_string
;
8466 volatile int count
= SPECPDL_INDEX ();
8468 /* How many keys there are in the current key sequence. */
8471 /* The length of the echo buffer when we started reading, and
8472 the length of this_command_keys when we started reading. */
8473 volatile int echo_start
;
8474 volatile int keys_start
;
8476 /* The number of keymaps we're scanning right now, and the number of
8477 keymaps we have allocated space for. */
8479 volatile int nmaps_allocated
= 0;
8481 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8482 the current keymaps. */
8483 Lisp_Object
*volatile defs
= NULL
;
8485 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8486 in the current keymaps, or nil where it is not a prefix. */
8487 Lisp_Object
*volatile submaps
= NULL
;
8489 /* The local map to start out with at start of key sequence. */
8490 volatile Lisp_Object orig_local_map
;
8492 /* The map from the `keymap' property to start out with at start of
8494 volatile Lisp_Object orig_keymap
;
8496 /* 1 if we have already considered switching to the local-map property
8497 of the place where a mouse click occurred. */
8498 volatile int localized_local_map
= 0;
8500 /* The index in defs[] of the first keymap that has a binding for
8501 this key sequence. In other words, the lowest i such that
8502 defs[i] is non-nil. */
8503 volatile int first_binding
;
8504 /* Index of the first key that has no binding.
8505 It is useless to try fkey.start larger than that. */
8506 volatile int first_unbound
;
8508 /* If t < mock_input, then KEYBUF[t] should be read as the next
8511 We use this to recover after recognizing a function key. Once we
8512 realize that a suffix of the current key sequence is actually a
8513 function key's escape sequence, we replace the suffix with the
8514 function key's binding from Vfunction_key_map. Now keybuf
8515 contains a new and different key sequence, so the echo area,
8516 this_command_keys, and the submaps and defs arrays are wrong. In
8517 this situation, we set mock_input to t, set t to 0, and jump to
8518 restart_sequence; the loop will read keys from keybuf up until
8519 mock_input, thus rebuilding the state; and then it will resume
8520 reading characters from the keyboard. */
8521 volatile int mock_input
= 0;
8523 /* If the sequence is unbound in submaps[], then
8524 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8525 and fkey.map is its binding.
8527 These might be > t, indicating that all function key scanning
8528 should hold off until t reaches them. We do this when we've just
8529 recognized a function key, to avoid searching for the function
8530 key's again in Vfunction_key_map. */
8531 volatile keyremap fkey
;
8533 /* Likewise, for key_translation_map. */
8534 volatile keyremap keytran
;
8536 /* If we receive a `switch-frame' or `select-window' event in the middle of
8537 a key sequence, we put it off for later.
8538 While we're reading, we keep the event here. */
8539 volatile Lisp_Object delayed_switch_frame
;
8541 /* See the comment below... */
8542 #if defined (GOBBLE_FIRST_EVENT)
8543 Lisp_Object first_event
;
8546 volatile Lisp_Object original_uppercase
;
8547 volatile int original_uppercase_position
= -1;
8549 /* Gets around Microsoft compiler limitations. */
8552 struct buffer
*starting_buffer
;
8554 /* List of events for which a fake prefix key has been generated. */
8555 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8557 #if defined (GOBBLE_FIRST_EVENT)
8561 struct gcpro gcpro1
;
8563 GCPRO1 (fake_prefixed_keys
);
8564 raw_keybuf_count
= 0;
8566 last_nonmenu_event
= Qnil
;
8568 delayed_switch_frame
= Qnil
;
8569 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8570 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8571 /* If there is no translation-map, turn off scanning. */
8572 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8573 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8578 echo_prompt (prompt
);
8579 else if (cursor_in_echo_area
8580 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8581 && NILP (Fzerop (Vecho_keystrokes
)))
8582 /* This doesn't put in a dash if the echo buffer is empty, so
8583 you don't always see a dash hanging out in the minibuffer. */
8587 /* Record the initial state of the echo area and this_command_keys;
8588 we will need to restore them if we replay a key sequence. */
8590 echo_start
= echo_length ();
8591 keys_start
= this_command_key_count
;
8592 this_single_command_key_start
= keys_start
;
8594 #if defined (GOBBLE_FIRST_EVENT)
8595 /* This doesn't quite work, because some of the things that read_char
8596 does cannot safely be bypassed. It seems too risky to try to make
8599 /* Read the first char of the sequence specially, before setting
8600 up any keymaps, in case a filter runs and switches buffers on us. */
8601 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8603 #endif /* GOBBLE_FIRST_EVENT */
8605 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8606 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8609 /* We jump here when the key sequence has been thoroughly changed, and
8610 we need to rescan it starting from the beginning. When we jump here,
8611 keybuf[0..mock_input] holds the sequence we should reread. */
8614 starting_buffer
= current_buffer
;
8615 first_unbound
= bufsize
+ 1;
8617 /* Build our list of keymaps.
8618 If we recognize a function key and replace its escape sequence in
8619 keybuf with its symbol, or if the sequence starts with a mouse
8620 click and we need to switch buffers, we jump back here to rebuild
8621 the initial keymaps from the current buffer. */
8624 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8625 || !NILP (Voverriding_local_map
))
8627 if (3 > nmaps_allocated
)
8629 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8630 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8631 nmaps_allocated
= 3;
8633 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8634 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8635 if (!NILP (Voverriding_local_map
))
8636 submaps
[nmaps
++] = Voverriding_local_map
;
8644 nminor
= current_minor_maps (0, &maps
);
8645 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8647 if (total
> nmaps_allocated
)
8649 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8650 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8651 nmaps_allocated
= total
;
8654 if (!NILP (orig_keymap
))
8655 submaps
[nmaps
++] = orig_keymap
;
8657 bcopy (maps
, (void *) (submaps
+ nmaps
),
8658 nminor
* sizeof (submaps
[0]));
8662 submaps
[nmaps
++] = orig_local_map
;
8664 submaps
[nmaps
++] = current_global_map
;
8666 /* Find an accurate initial value for first_binding. */
8667 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8668 if (! NILP (submaps
[first_binding
]))
8671 /* Start from the beginning in keybuf. */
8674 /* These are no-ops the first time through, but if we restart, they
8675 revert the echo area and this_command_keys to their original state. */
8676 this_command_key_count
= keys_start
;
8677 if (INTERACTIVE
&& t
< mock_input
)
8678 echo_truncate (echo_start
);
8680 /* If the best binding for the current key sequence is a keymap, or
8681 we may be looking at a function key's escape sequence, keep on
8683 while (first_binding
< nmaps
8684 /* Keep reading as long as there's a prefix binding. */
8685 ? !NILP (submaps
[first_binding
])
8686 /* Don't return in the middle of a possible function key sequence,
8687 if the only bindings we found were via case conversion.
8688 Thus, if ESC O a has a function-key-map translation
8689 and ESC o has a binding, don't return after ESC O,
8690 so that we can translate ESC O plus the next character. */
8691 : (fkey
.start
< t
|| keytran
.start
< t
))
8694 int used_mouse_menu
= 0;
8696 /* Where the last real key started. If we need to throw away a
8697 key that has expanded into more than one element of keybuf
8698 (say, a mouse click on the mode line which is being treated
8699 as [mode-line (mouse-...)], then we backtrack to this point
8701 volatile int last_real_key_start
;
8703 /* These variables are analogous to echo_start and keys_start;
8704 while those allow us to restart the entire key sequence,
8705 echo_local_start and keys_local_start allow us to throw away
8707 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8709 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8710 eassert (fkey
.start
<= fkey
.end
);
8711 eassert (keytran
.start
<= keytran
.end
);
8712 /* key-translation-map is applied *after* function-key-map. */
8713 eassert (keytran
.end
<= fkey
.start
);
8715 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8716 { /* The prefix upto first_unbound has no binding and has
8717 no translation left to do either, so we know it's unbound.
8718 If we don't stop now, we risk staying here indefinitely
8719 (if the user keeps entering fkey or keytran prefixes
8720 like C-c ESC ESC ESC ESC ...) */
8722 for (i
= first_unbound
+ 1; i
< t
; i
++)
8723 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8724 mock_input
= t
- first_unbound
- 1;
8725 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8726 fkey
.map
= fkey
.parent
;
8727 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8728 keytran
.map
= keytran
.parent
;
8729 goto replay_sequence
;
8733 error ("Key sequence too long");
8736 echo_local_start
= echo_length ();
8737 keys_local_start
= this_command_key_count
;
8738 local_first_binding
= first_binding
;
8741 /* These are no-ops, unless we throw away a keystroke below and
8742 jumped back up to replay_key; in that case, these restore the
8743 variables to their original state, allowing us to replay the
8745 if (INTERACTIVE
&& t
< mock_input
)
8746 echo_truncate (echo_local_start
);
8747 this_command_key_count
= keys_local_start
;
8748 first_binding
= local_first_binding
;
8750 /* By default, assume each event is "real". */
8751 last_real_key_start
= t
;
8753 /* Does mock_input indicate that we are re-reading a key sequence? */
8757 add_command_key (key
);
8758 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8759 && NILP (Fzerop (Vecho_keystrokes
)))
8763 /* If not, we should actually read a character. */
8768 KBOARD
*interrupted_kboard
= current_kboard
;
8769 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8770 if (setjmp (wrong_kboard_jmpbuf
))
8772 if (!NILP (delayed_switch_frame
))
8774 interrupted_kboard
->kbd_queue
8775 = Fcons (delayed_switch_frame
,
8776 interrupted_kboard
->kbd_queue
);
8777 delayed_switch_frame
= Qnil
;
8780 interrupted_kboard
->kbd_queue
8781 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8783 /* If the side queue is non-empty, ensure it begins with a
8784 switch-frame, so we'll replay it in the right context. */
8785 if (CONSP (interrupted_kboard
->kbd_queue
)
8786 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8787 !(EVENT_HAS_PARAMETERS (key
)
8788 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8792 XSETFRAME (frame
, interrupted_frame
);
8793 interrupted_kboard
->kbd_queue
8794 = Fcons (make_lispy_switch_frame (frame
),
8795 interrupted_kboard
->kbd_queue
);
8798 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8799 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8800 goto replay_sequence
;
8803 key
= read_char (NILP (prompt
), nmaps
,
8804 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8808 /* read_char returns t when it shows a menu and the user rejects it.
8812 unbind_to (count
, Qnil
);
8817 /* read_char returns -1 at the end of a macro.
8818 Emacs 18 handles this by returning immediately with a
8819 zero, so that's what we'll do. */
8820 if (INTEGERP (key
) && XINT (key
) == -1)
8823 /* The Microsoft C compiler can't handle the goto that
8829 /* If the current buffer has been changed from under us, the
8830 keymap may have changed, so replay the sequence. */
8833 timer_resume_idle ();
8836 /* Reset the current buffer from the selected window
8837 in case something changed the former and not the latter.
8838 This is to be more consistent with the behavior
8839 of the command_loop_1. */
8840 if (fix_current_buffer
)
8842 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8844 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8845 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8848 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8849 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8850 goto replay_sequence
;
8853 /* If we have a quit that was typed in another frame, and
8854 quit_throw_to_read_char switched buffers,
8855 replay to get the right keymap. */
8857 && XINT (key
) == quit_char
8858 && current_buffer
!= starting_buffer
)
8861 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8865 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8866 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8867 goto replay_sequence
;
8872 if (EVENT_HAS_PARAMETERS (key
)
8873 /* Either a `switch-frame' or a `select-window' event. */
8874 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8876 /* If we're at the beginning of a key sequence, and the caller
8877 says it's okay, go ahead and return this event. If we're
8878 in the midst of a key sequence, delay it until the end. */
8879 if (t
> 0 || !can_return_switch_frame
)
8881 delayed_switch_frame
= key
;
8887 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8890 /* Clicks in non-text areas get prefixed by the symbol
8891 in their CHAR-ADDRESS field. For example, a click on
8892 the mode line is prefixed by the symbol `mode-line'.
8894 Furthermore, key sequences beginning with mouse clicks
8895 are read using the keymaps of the buffer clicked on, not
8896 the current buffer. So we may have to switch the buffer
8899 When we turn one event into two events, we must make sure
8900 that neither of the two looks like the original--so that,
8901 if we replay the events, they won't be expanded again.
8902 If not for this, such reexpansion could happen either here
8903 or when user programs play with this-command-keys. */
8904 if (EVENT_HAS_PARAMETERS (key
))
8909 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8910 if (EQ (kind
, Qmouse_click
))
8912 Lisp_Object window
, posn
;
8914 window
= POSN_WINDOW (EVENT_START (key
));
8915 posn
= POSN_POSN (EVENT_START (key
));
8918 || (!NILP (fake_prefixed_keys
)
8919 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8921 /* We're looking a second time at an event for which
8922 we generated a fake prefix key. Set
8923 last_real_key_start appropriately. */
8925 last_real_key_start
= t
- 1;
8928 /* Key sequences beginning with mouse clicks are
8929 read using the keymaps in the buffer clicked on,
8930 not the current buffer. If we're at the
8931 beginning of a key sequence, switch buffers. */
8932 if (last_real_key_start
== 0
8934 && BUFFERP (XWINDOW (window
)->buffer
)
8935 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8937 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8941 /* Arrange to go back to the original buffer once we're
8942 done reading the key sequence. Note that we can't
8943 use save_excursion_{save,restore} here, because they
8944 save point as well as the current buffer; we don't
8945 want to save point, because redisplay may change it,
8946 to accommodate a Fset_window_start or something. We
8947 don't want to do this at the top of the function,
8948 because we may get input from a subprocess which
8949 wants to change the selected window and stuff (say,
8951 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8953 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8955 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8956 orig_local_map
= get_local_map (PT
, current_buffer
,
8958 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8959 goto replay_sequence
;
8962 /* For a mouse click, get the local text-property keymap
8963 of the place clicked on, rather than point. */
8964 if (last_real_key_start
== 0
8965 && CONSP (XCDR (key
))
8966 && ! localized_local_map
)
8968 Lisp_Object map_here
, start
, pos
;
8970 localized_local_map
= 1;
8971 start
= EVENT_START (key
);
8973 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8975 pos
= POSN_BUFFER_POSN (start
);
8977 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8979 map_here
= get_local_map (XINT (pos
),
8980 current_buffer
, Qlocal_map
);
8981 if (!EQ (map_here
, orig_local_map
))
8983 orig_local_map
= map_here
;
8987 goto replay_sequence
;
8989 map_here
= get_local_map (XINT (pos
),
8990 current_buffer
, Qkeymap
);
8991 if (!EQ (map_here
, orig_keymap
))
8993 orig_keymap
= map_here
;
8997 goto replay_sequence
;
9003 /* Expand mode-line and scroll-bar events into two events:
9004 use posn as a fake prefix key. */
9006 && (NILP (fake_prefixed_keys
)
9007 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9009 if (t
+ 1 >= bufsize
)
9010 error ("Key sequence too long");
9013 keybuf
[t
+ 1] = key
;
9016 /* Record that a fake prefix key has been generated
9017 for KEY. Don't modify the event; this would
9018 prevent proper action when the event is pushed
9019 back into unread-command-events. */
9020 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9022 /* If on a mode line string with a local keymap,
9023 reconsider the key sequence with that keymap. */
9024 if (string
= POSN_STRING (EVENT_START (key
)),
9025 (CONSP (string
) && STRINGP (XCAR (string
))))
9027 Lisp_Object pos
, map
, map2
;
9029 pos
= XCDR (string
);
9030 string
= XCAR (string
);
9032 && XINT (pos
) < SCHARS (string
))
9034 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9036 orig_local_map
= map
;
9037 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9040 if (!NILP (map
) || !NILP (map2
))
9041 goto replay_sequence
;
9047 else if (NILP (from_string
)
9048 && (string
= POSN_STRING (EVENT_START (key
)),
9049 (CONSP (string
) && STRINGP (XCAR (string
)))))
9051 /* For a click on a string, i.e. overlay string or a
9052 string displayed via the `display' property,
9053 consider `local-map' and `keymap' properties of
9055 Lisp_Object pos
, map
, map2
;
9057 pos
= XCDR (string
);
9058 string
= XCAR (string
);
9060 && XINT (pos
) < SCHARS (string
))
9062 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9064 orig_local_map
= map
;
9065 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9069 if (!NILP (map
) || !NILP (map2
))
9071 from_string
= string
;
9072 goto replay_sequence
;
9077 else if (CONSP (XCDR (key
))
9078 && CONSP (EVENT_START (key
))
9079 && CONSP (XCDR (EVENT_START (key
))))
9083 posn
= POSN_POSN (EVENT_START (key
));
9084 /* Handle menu-bar events:
9085 insert the dummy prefix event `menu-bar'. */
9086 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9088 if (t
+ 1 >= bufsize
)
9089 error ("Key sequence too long");
9093 /* Zap the position in key, so we know that we've
9094 expanded it, and don't try to do so again. */
9095 POSN_SET_POSN (EVENT_START (key
),
9096 Fcons (posn
, Qnil
));
9099 goto replay_sequence
;
9101 else if (CONSP (posn
))
9103 /* We're looking at the second event of a
9104 sequence which we expanded before. Set
9105 last_real_key_start appropriately. */
9106 if (last_real_key_start
== t
&& t
> 0)
9107 last_real_key_start
= t
- 1;
9112 /* We have finally decided that KEY is something we might want
9114 first_binding
= (follow_key (key
,
9115 nmaps
- first_binding
,
9116 submaps
+ first_binding
,
9117 defs
+ first_binding
,
9118 submaps
+ first_binding
)
9121 /* If KEY wasn't bound, we'll try some fallbacks. */
9122 if (first_binding
< nmaps
)
9123 /* This is needed for the following scenario:
9124 event 0: a down-event that gets dropped by calling replay_key.
9125 event 1: some normal prefix like C-h.
9126 After event 0, first_unbound is 0, after event 1 fkey.start
9127 and keytran.start are both 1, so when we see that C-h is bound,
9128 we need to update first_unbound. */
9129 first_unbound
= max (t
+ 1, first_unbound
);
9134 /* Remember the position to put an upper bound on fkey.start. */
9135 first_unbound
= min (t
, first_unbound
);
9137 head
= EVENT_HEAD (key
);
9138 if (help_char_p (head
) && t
> 0)
9140 read_key_sequence_cmd
= Vprefix_help_command
;
9142 last_nonmenu_event
= key
;
9143 /* The Microsoft C compiler can't handle the goto that
9151 Lisp_Object breakdown
;
9154 breakdown
= parse_modifiers (head
);
9155 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9156 /* Attempt to reduce an unbound mouse event to a simpler
9157 event that is bound:
9158 Drags reduce to clicks.
9159 Double-clicks reduce to clicks.
9160 Triple-clicks reduce to double-clicks, then to clicks.
9161 Down-clicks are eliminated.
9162 Double-downs reduce to downs, then are eliminated.
9163 Triple-downs reduce to double-downs, then to downs,
9164 then are eliminated. */
9165 if (modifiers
& (down_modifier
| drag_modifier
9166 | double_modifier
| triple_modifier
))
9168 while (modifiers
& (down_modifier
| drag_modifier
9169 | double_modifier
| triple_modifier
))
9171 Lisp_Object new_head
, new_click
;
9172 if (modifiers
& triple_modifier
)
9173 modifiers
^= (double_modifier
| triple_modifier
);
9174 else if (modifiers
& double_modifier
)
9175 modifiers
&= ~double_modifier
;
9176 else if (modifiers
& drag_modifier
)
9177 modifiers
&= ~drag_modifier
;
9180 /* Dispose of this `down' event by simply jumping
9181 back to replay_key, to get another event.
9183 Note that if this event came from mock input,
9184 then just jumping back to replay_key will just
9185 hand it to us again. So we have to wipe out any
9188 We could delete keybuf[t] and shift everything
9189 after that to the left by one spot, but we'd also
9190 have to fix up any variable that points into
9191 keybuf, and shifting isn't really necessary
9194 Adding prefixes for non-textual mouse clicks
9195 creates two characters of mock input, and both
9196 must be thrown away. If we're only looking at
9197 the prefix now, we can just jump back to
9198 replay_key. On the other hand, if we've already
9199 processed the prefix, and now the actual click
9200 itself is giving us trouble, then we've lost the
9201 state of the keymaps we want to backtrack to, and
9202 we need to replay the whole sequence to rebuild
9205 Beyond that, only function key expansion could
9206 create more than two keys, but that should never
9207 generate mouse events, so it's okay to zero
9208 mock_input in that case too.
9210 FIXME: The above paragraph seems just plain
9211 wrong, if you consider things like
9212 xterm-mouse-mode. -stef
9214 Isn't this just the most wonderful code ever? */
9216 /* If mock_input > t + 1, the above simplification
9217 will actually end up dropping keys on the floor.
9218 This is probably OK for now, but even
9219 if mock_input <= t + 1, we need to adjust fkey
9221 Typical case [header-line down-mouse-N]:
9222 mock_input = 2, t = 1, fkey.end = 1,
9223 last_real_key_start = 0. */
9224 if (fkey
.end
> last_real_key_start
)
9226 fkey
.end
= fkey
.start
9227 = min (last_real_key_start
, fkey
.start
);
9228 fkey
.map
= fkey
.parent
;
9229 if (keytran
.end
> last_real_key_start
)
9231 keytran
.end
= keytran
.start
9232 = min (last_real_key_start
, keytran
.start
);
9233 keytran
.map
= keytran
.parent
;
9236 if (t
== last_real_key_start
)
9243 mock_input
= last_real_key_start
;
9244 goto replay_sequence
;
9249 = apply_modifiers (modifiers
, XCAR (breakdown
));
9251 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9253 /* Look for a binding for this new key. follow_key
9254 promises that it didn't munge submaps the
9255 last time we called it, since key was unbound. */
9257 = (follow_key (new_click
,
9258 nmaps
- local_first_binding
,
9259 submaps
+ local_first_binding
,
9260 defs
+ local_first_binding
,
9261 submaps
+ local_first_binding
)
9262 + local_first_binding
);
9264 /* If that click is bound, go for it. */
9265 if (first_binding
< nmaps
)
9270 /* Otherwise, we'll leave key set to the drag event. */
9277 /* Normally, last_nonmenu_event gets the previous key we read.
9278 But when a mouse popup menu is being used,
9279 we don't update last_nonmenu_event; it continues to hold the mouse
9280 event that preceded the first level of menu. */
9281 if (!used_mouse_menu
)
9282 last_nonmenu_event
= key
;
9284 /* Record what part of this_command_keys is the current key sequence. */
9285 this_single_command_key_start
= this_command_key_count
- t
;
9287 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9288 /* There is a binding and it's not a prefix.
9289 There is thus no function-key in this sequence.
9290 Moving fkey.start is important in this case to allow keytran.start
9291 to go over the sequence before we return (since we keep the
9292 invariant that keytran.end <= fkey.start). */
9295 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9298 /* If the sequence is unbound, see if we can hang a function key
9299 off the end of it. */
9300 /* Continue scan from fkey.end until we find a bound suffix. */
9301 while (fkey
.end
< t
)
9303 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9306 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9307 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9308 max (t
, mock_input
),
9309 /* If there's a binding (i.e.
9310 first_binding >= nmaps) we don't want
9311 to apply this function-key-mapping. */
9312 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9317 mock_input
= diff
+ max (t
, mock_input
);
9318 goto replay_sequence
;
9322 /* Look for this sequence in key-translation-map.
9323 Scan from keytran.end until we find a bound suffix. */
9324 while (keytran
.end
< fkey
.start
)
9326 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9329 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9330 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9335 mock_input
= diff
+ max (t
, mock_input
);
9336 /* Adjust the function-key-map counters. */
9340 goto replay_sequence
;
9344 /* If KEY is not defined in any of the keymaps,
9345 and cannot be part of a function key or translation,
9346 and is an upper case letter
9347 use the corresponding lower-case letter instead. */
9348 if (first_binding
>= nmaps
9349 && fkey
.start
>= t
&& keytran
.start
>= t
9351 && ((((XINT (key
) & 0x3ffff)
9352 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9353 && UPPERCASEP (XINT (key
) & 0x3ffff))
9354 || (XINT (key
) & shift_modifier
)))
9356 Lisp_Object new_key
;
9358 original_uppercase
= key
;
9359 original_uppercase_position
= t
- 1;
9361 if (XINT (key
) & shift_modifier
)
9362 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9364 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9365 | (XINT (key
) & ~0x3ffff)));
9367 /* We have to do this unconditionally, regardless of whether
9368 the lower-case char is defined in the keymaps, because they
9369 might get translated through function-key-map. */
9370 keybuf
[t
- 1] = new_key
;
9371 mock_input
= max (t
, mock_input
);
9373 goto replay_sequence
;
9375 /* If KEY is not defined in any of the keymaps,
9376 and cannot be part of a function key or translation,
9377 and is a shifted function key,
9378 use the corresponding unshifted function key instead. */
9379 if (first_binding
>= nmaps
9380 && fkey
.start
>= t
&& keytran
.start
>= t
9383 Lisp_Object breakdown
;
9386 breakdown
= parse_modifiers (key
);
9387 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9388 if (modifiers
& shift_modifier
)
9390 Lisp_Object new_key
;
9392 original_uppercase
= key
;
9393 original_uppercase_position
= t
- 1;
9395 modifiers
&= ~shift_modifier
;
9396 new_key
= apply_modifiers (modifiers
,
9399 keybuf
[t
- 1] = new_key
;
9400 mock_input
= max (t
, mock_input
);
9401 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9402 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9404 goto replay_sequence
;
9410 read_key_sequence_cmd
= (first_binding
< nmaps
9411 ? defs
[first_binding
]
9414 unread_switch_frame
= delayed_switch_frame
;
9415 unbind_to (count
, Qnil
);
9417 /* Don't downcase the last character if the caller says don't.
9418 Don't downcase it if the result is undefined, either. */
9419 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9420 && t
- 1 == original_uppercase_position
)
9421 keybuf
[t
- 1] = original_uppercase
;
9423 /* Occasionally we fabricate events, perhaps by expanding something
9424 according to function-key-map, or by adding a prefix symbol to a
9425 mouse click in the scroll bar or modeline. In this cases, return
9426 the entire generated key sequence, even if we hit an unbound
9427 prefix or a definition before the end. This means that you will
9428 be able to push back the event properly, and also means that
9429 read-key-sequence will always return a logical unit.
9432 for (; t
< mock_input
; t
++)
9434 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9435 && NILP (Fzerop (Vecho_keystrokes
)))
9436 echo_char (keybuf
[t
]);
9437 add_command_key (keybuf
[t
]);
9446 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9447 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9448 The sequence is sufficient to specify a non-prefix command in the
9449 current local and global maps.
9451 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9452 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9453 as a continuation of the previous key.
9455 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9456 convert the last event to lower case. (Normally any upper case event
9457 is converted to lower case if the original event is undefined and the lower
9458 case equivalent is defined.) A non-nil value is appropriate for reading
9459 a key sequence to be defined.
9461 A C-g typed while in this function is treated like any other character,
9462 and `quit-flag' is not set.
9464 If the key sequence starts with a mouse click, then the sequence is read
9465 using the keymaps of the buffer of the window clicked in, not the buffer
9466 of the selected window as normal.
9468 `read-key-sequence' drops unbound button-down events, since you normally
9469 only care about the click or drag events which follow them. If a drag
9470 or multi-click event is unbound, but the corresponding click event would
9471 be bound, `read-key-sequence' turns the event into a click event at the
9472 drag's starting position. This means that you don't have to distinguish
9473 between click and drag, double, or triple events unless you want to.
9475 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9476 lines separating windows, and scroll bars with imaginary keys
9477 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9479 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9480 function will process a switch-frame event if the user switches frames
9481 before typing anything. If the user switches frames in the middle of a
9482 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9483 is nil, then the event will be put off until after the current key sequence.
9485 `read-key-sequence' checks `function-key-map' for function key
9486 sequences, where they wouldn't conflict with ordinary bindings. See
9487 `function-key-map' for more details.
9489 The optional fifth argument COMMAND-LOOP, if non-nil, means
9490 that this key sequence is being read by something that will
9491 read commands one after another. It should be nil if the caller
9492 will read just one key sequence. */)
9493 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9495 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9496 Lisp_Object can_return_switch_frame
, command_loop
;
9498 Lisp_Object keybuf
[30];
9500 struct gcpro gcpro1
;
9501 int count
= SPECPDL_INDEX ();
9504 CHECK_STRING (prompt
);
9507 specbind (Qinput_method_exit_on_first_char
,
9508 (NILP (command_loop
) ? Qt
: Qnil
));
9509 specbind (Qinput_method_use_echo_area
,
9510 (NILP (command_loop
) ? Qt
: Qnil
));
9512 bzero (keybuf
, sizeof keybuf
);
9514 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9516 if (NILP (continue_echo
))
9518 this_command_key_count
= 0;
9519 this_command_key_count_reset
= 0;
9520 this_single_command_key_start
= 0;
9523 #ifdef HAVE_X_WINDOWS
9524 if (display_hourglass_p
)
9525 cancel_hourglass ();
9528 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9529 prompt
, ! NILP (dont_downcase_last
),
9530 ! NILP (can_return_switch_frame
), 0);
9532 #if 0 /* The following is fine for code reading a key sequence and
9533 then proceeding with a lenghty computation, but it's not good
9534 for code reading keys in a loop, like an input method. */
9535 #ifdef HAVE_X_WINDOWS
9536 if (display_hourglass_p
)
9547 return unbind_to (count
, make_event_array (i
, keybuf
));
9550 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9551 Sread_key_sequence_vector
, 1, 5, 0,
9552 doc
: /* Like `read-key-sequence' but always return a vector. */)
9553 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9555 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9556 Lisp_Object can_return_switch_frame
, command_loop
;
9558 Lisp_Object keybuf
[30];
9560 struct gcpro gcpro1
;
9561 int count
= SPECPDL_INDEX ();
9564 CHECK_STRING (prompt
);
9567 specbind (Qinput_method_exit_on_first_char
,
9568 (NILP (command_loop
) ? Qt
: Qnil
));
9569 specbind (Qinput_method_use_echo_area
,
9570 (NILP (command_loop
) ? Qt
: Qnil
));
9572 bzero (keybuf
, sizeof keybuf
);
9574 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9576 if (NILP (continue_echo
))
9578 this_command_key_count
= 0;
9579 this_command_key_count_reset
= 0;
9580 this_single_command_key_start
= 0;
9583 #ifdef HAVE_X_WINDOWS
9584 if (display_hourglass_p
)
9585 cancel_hourglass ();
9588 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9589 prompt
, ! NILP (dont_downcase_last
),
9590 ! NILP (can_return_switch_frame
), 0);
9592 #ifdef HAVE_X_WINDOWS
9593 if (display_hourglass_p
)
9603 return unbind_to (count
, Fvector (i
, keybuf
));
9606 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9607 doc
: /* Execute CMD as an editor command.
9608 CMD must be a symbol that satisfies the `commandp' predicate.
9609 Optional second arg RECORD-FLAG non-nil
9610 means unconditionally put this command in `command-history'.
9611 Otherwise, that is done only if an arg is read using the minibuffer.
9612 The argument KEYS specifies the value to use instead of (this-command-keys)
9613 when reading the arguments; if it is nil, (this-command-keys) is used.
9614 The argument SPECIAL, if non-nil, means that this command is executing
9615 a special event, so ignore the prefix argument and don't clear it. */)
9616 (cmd
, record_flag
, keys
, special
)
9617 Lisp_Object cmd
, record_flag
, keys
, special
;
9619 register Lisp_Object final
;
9620 register Lisp_Object tem
;
9621 Lisp_Object prefixarg
;
9622 struct backtrace backtrace
;
9623 extern int debug_on_next_call
;
9625 debug_on_next_call
= 0;
9629 prefixarg
= current_kboard
->Vprefix_arg
;
9630 Vcurrent_prefix_arg
= prefixarg
;
9631 current_kboard
->Vprefix_arg
= Qnil
;
9638 tem
= Fget (cmd
, Qdisabled
);
9639 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9641 tem
= Fsymbol_value (Qdisabled_command_function
);
9643 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9649 final
= Findirect_function (cmd
);
9651 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9653 struct gcpro gcpro1
, gcpro2
;
9655 GCPRO2 (cmd
, prefixarg
);
9656 do_autoload (final
, cmd
);
9663 if (STRINGP (final
) || VECTORP (final
))
9665 /* If requested, place the macro in the command history. For
9666 other sorts of commands, call-interactively takes care of
9668 if (!NILP (record_flag
))
9671 = Fcons (Fcons (Qexecute_kbd_macro
,
9672 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9675 /* Don't keep command history around forever. */
9676 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9678 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9680 XSETCDR (tem
, Qnil
);
9684 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9687 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9689 backtrace
.next
= backtrace_list
;
9690 backtrace_list
= &backtrace
;
9691 backtrace
.function
= &Qcall_interactively
;
9692 backtrace
.args
= &cmd
;
9693 backtrace
.nargs
= 1;
9694 backtrace
.evalargs
= 0;
9695 backtrace
.debug_on_exit
= 0;
9697 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9699 backtrace_list
= backtrace
.next
;
9707 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9709 doc
: /* Read function name, then read its arguments and call it. */)
9711 Lisp_Object prefixarg
;
9713 Lisp_Object function
;
9715 int saved_last_point_position
;
9716 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9717 Lisp_Object bindings
, value
;
9718 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9720 saved_keys
= Fvector (this_command_key_count
,
9721 XVECTOR (this_command_keys
)->contents
);
9722 saved_last_point_position_buffer
= last_point_position_buffer
;
9723 saved_last_point_position
= last_point_position
;
9725 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9727 if (EQ (prefixarg
, Qminus
))
9729 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9730 strcpy (buf
, "C-u ");
9731 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9732 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9733 else if (INTEGERP (prefixarg
))
9734 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9736 /* This isn't strictly correct if execute-extended-command
9737 is bound to anything else. Perhaps it should use
9738 this_command_keys? */
9739 strcat (buf
, "M-x ");
9741 /* Prompt with buf, and then read a string, completing from and
9742 restricting to the set of all defined commands. Don't provide
9743 any initial input. Save the command read on the extended-command
9745 function
= Fcompleting_read (build_string (buf
),
9746 Vobarray
, Qcommandp
,
9747 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9750 if (STRINGP (function
) && SCHARS (function
) == 0)
9751 error ("No command name given");
9753 /* Set this_command_keys to the concatenation of saved_keys and
9754 function, followed by a RET. */
9759 this_command_key_count
= 0;
9760 this_command_key_count_reset
= 0;
9761 this_single_command_key_start
= 0;
9763 keys
= XVECTOR (saved_keys
)->contents
;
9764 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9765 add_command_key (keys
[i
]);
9767 for (i
= 0; i
< SCHARS (function
); i
++)
9768 add_command_key (Faref (function
, make_number (i
)));
9770 add_command_key (make_number ('\015'));
9773 last_point_position
= saved_last_point_position
;
9774 last_point_position_buffer
= saved_last_point_position_buffer
;
9778 function
= Fintern (function
, Qnil
);
9779 current_kboard
->Vprefix_arg
= prefixarg
;
9780 Vthis_command
= function
;
9781 real_this_command
= function
;
9783 /* If enabled, show which key runs this command. */
9784 if (!NILP (Vsuggest_key_bindings
)
9785 && NILP (Vexecuting_macro
)
9786 && SYMBOLP (function
))
9787 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9793 GCPRO2 (bindings
, value
);
9794 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9796 /* If the command has a key binding, print it now. */
9797 if (!NILP (bindings
)
9798 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9801 /* But first wait, and skip the message if there is input. */
9803 if (!NILP (echo_area_buffer
[0]))
9804 /* This command displayed something in the echo area;
9805 so wait a few seconds, then display our suggestion message. */
9806 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9807 ? XINT (Vsuggest_key_bindings
) : 2);
9809 /* This command left the echo area empty,
9810 so display our message immediately. */
9813 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9814 && ! CONSP (Vunread_command_events
))
9816 Lisp_Object binding
;
9818 int message_p
= push_message ();
9819 int count
= SPECPDL_INDEX ();
9821 record_unwind_protect (pop_message_unwind
, Qnil
);
9822 binding
= Fkey_description (bindings
, Qnil
);
9825 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9828 sprintf (newmessage
, "You can run the command `%s' with %s",
9829 SDATA (SYMBOL_NAME (function
)),
9831 message2_nolog (newmessage
,
9832 strlen (newmessage
),
9833 STRING_MULTIBYTE (binding
));
9834 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9835 ? Vsuggest_key_bindings
: make_number (2)),
9840 unbind_to (count
, Qnil
);
9844 RETURN_UNGCPRO (value
);
9848 /* Return nonzero if input events are pending. */
9851 detect_input_pending ()
9854 get_input_pending (&input_pending
, 0);
9856 return input_pending
;
9859 /* Return nonzero if input events other than mouse movements are
9863 detect_input_pending_ignore_squeezables ()
9866 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9868 return input_pending
;
9871 /* Return nonzero if input events are pending, and run any pending timers. */
9874 detect_input_pending_run_timers (do_display
)
9877 int old_timers_run
= timers_run
;
9880 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9882 if (old_timers_run
!= timers_run
&& do_display
)
9884 redisplay_preserve_echo_area (8);
9885 /* The following fixes a bug when using lazy-lock with
9886 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9887 from an idle timer function. The symptom of the bug is that
9888 the cursor sometimes doesn't become visible until the next X
9889 event is processed. --gerd. */
9891 rif
->flush_display (NULL
);
9894 return input_pending
;
9897 /* This is called in some cases before a possible quit.
9898 It cases the next call to detect_input_pending to recompute input_pending.
9899 So calling this function unnecessarily can't do any harm. */
9902 clear_input_pending ()
9907 /* Return nonzero if there are pending requeued events.
9908 This isn't used yet. The hope is to make wait_reading_process_output
9909 call it, and return if it runs Lisp code that unreads something.
9910 The problem is, kbd_buffer_get_event needs to be fixed to know what
9911 to do in that case. It isn't trivial. */
9914 requeued_events_pending_p ()
9916 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9920 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9921 doc
: /* Return t if command input is currently available with no wait.
9922 Actually, the value is nil only if we can be sure that no input is available;
9923 if there is a doubt, the value is t. */)
9926 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9929 get_input_pending (&input_pending
,
9930 READABLE_EVENTS_DO_TIMERS_NOW
9931 | READABLE_EVENTS_FILTER_EVENTS
);
9932 return input_pending
> 0 ? Qt
: Qnil
;
9935 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9936 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9939 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9942 if (total_keys
< NUM_RECENT_KEYS
)
9943 return Fvector (total_keys
, keys
);
9946 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9947 bcopy (keys
+ recent_keys_index
,
9948 XVECTOR (val
)->contents
,
9949 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9951 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9952 recent_keys_index
* sizeof (Lisp_Object
));
9957 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9958 doc
: /* Return the key sequence that invoked this command.
9959 However, if the command has called `read-key-sequence', it returns
9960 the last key sequence that has been read.
9961 The value is a string or a vector. */)
9964 return make_event_array (this_command_key_count
,
9965 XVECTOR (this_command_keys
)->contents
);
9968 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9969 doc
: /* Return the key sequence that invoked this command, as a vector.
9970 However, if the command has called `read-key-sequence', it returns
9971 the last key sequence that has been read. */)
9974 return Fvector (this_command_key_count
,
9975 XVECTOR (this_command_keys
)->contents
);
9978 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9979 Sthis_single_command_keys
, 0, 0, 0,
9980 doc
: /* Return the key sequence that invoked this command.
9981 More generally, it returns the last key sequence read, either by
9982 the command loop or by `read-key-sequence'.
9983 Unlike `this-command-keys', this function's value
9984 does not include prefix arguments.
9985 The value is always a vector. */)
9988 return Fvector (this_command_key_count
9989 - this_single_command_key_start
,
9990 (XVECTOR (this_command_keys
)->contents
9991 + this_single_command_key_start
));
9994 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9995 Sthis_single_command_raw_keys
, 0, 0, 0,
9996 doc
: /* Return the raw events that were read for this command.
9997 More generally, it returns the last key sequence read, either by
9998 the command loop or by `read-key-sequence'.
9999 Unlike `this-single-command-keys', this function's value
10000 shows the events before all translations (except for input methods).
10001 The value is always a vector. */)
10004 return Fvector (raw_keybuf_count
,
10005 (XVECTOR (raw_keybuf
)->contents
));
10008 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10009 Sreset_this_command_lengths
, 0, 0, 0,
10010 doc
: /* Make the unread events replace the last command and echo.
10011 Used in `universal-argument-other-key'.
10013 `universal-argument-other-key' rereads the event just typed.
10014 It then gets translated through `function-key-map'.
10015 The translated event has to replace the real events,
10016 both in the value of (this-command-keys) and in echoing.
10017 To achieve this, `universal-argument-other-key' calls
10018 `reset-this-command-lengths', which discards the record of reading
10019 these events the first time. */)
10022 this_command_key_count
= before_command_key_count
;
10023 if (this_command_key_count
< this_single_command_key_start
)
10024 this_single_command_key_start
= this_command_key_count
;
10026 echo_truncate (before_command_echo_length
);
10028 /* Cause whatever we put into unread-command-events
10029 to echo as if it were being freshly read from the keyboard. */
10030 this_command_key_count_reset
= 1;
10035 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10036 Sclear_this_command_keys
, 0, 1, 0,
10037 doc
: /* Clear out the vector that `this-command-keys' returns.
10038 Also clear the record of the last 100 events, unless optional arg
10039 KEEP-RECORD is non-nil. */)
10041 Lisp_Object keep_record
;
10045 this_command_key_count
= 0;
10046 this_command_key_count_reset
= 0;
10048 if (NILP (keep_record
))
10050 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10051 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10053 recent_keys_index
= 0;
10058 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10059 doc
: /* Return the current depth in recursive edits. */)
10063 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10067 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10068 "FOpen dribble file: ",
10069 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10070 If FILE is nil, close any open dribble file. */)
10081 file
= Fexpand_file_name (file
, Qnil
);
10082 dribble
= fopen (SDATA (file
), "w");
10084 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10089 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10090 doc
: /* Discard the contents of the terminal input buffer.
10091 Also end any kbd macro being defined. */)
10094 if (!NILP (current_kboard
->defining_kbd_macro
))
10096 /* Discard the last command from the macro. */
10097 Fcancel_kbd_macro_events ();
10101 update_mode_lines
++;
10103 Vunread_command_events
= Qnil
;
10104 unread_command_char
= -1;
10106 discard_tty_input ();
10108 kbd_fetch_ptr
= kbd_store_ptr
;
10114 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10115 doc
: /* Stop Emacs and return to superior process. You can resume later.
10116 If `cannot-suspend' is non-nil, or if the system doesn't support job
10117 control, run a subshell instead.
10119 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10120 to be read as terminal input by Emacs's parent, after suspension.
10122 Before suspending, run the normal hook `suspend-hook'.
10123 After resumption run the normal hook `suspend-resume-hook'.
10125 Some operating systems cannot stop the Emacs process and resume it later.
10126 On such systems, Emacs starts a subshell instead of suspending. */)
10128 Lisp_Object stuffstring
;
10130 int count
= SPECPDL_INDEX ();
10131 int old_height
, old_width
;
10133 struct gcpro gcpro1
;
10135 if (!NILP (stuffstring
))
10136 CHECK_STRING (stuffstring
);
10138 /* Run the functions in suspend-hook. */
10139 if (!NILP (Vrun_hooks
))
10140 call1 (Vrun_hooks
, intern ("suspend-hook"));
10142 GCPRO1 (stuffstring
);
10143 get_frame_size (&old_width
, &old_height
);
10144 reset_sys_modes ();
10145 /* sys_suspend can get an error if it tries to fork a subshell
10146 and the system resources aren't available for that. */
10147 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10149 stuff_buffered_input (stuffstring
);
10150 if (cannot_suspend
)
10154 unbind_to (count
, Qnil
);
10156 /* Check if terminal/window size has changed.
10157 Note that this is not useful when we are running directly
10158 with a window system; but suspend should be disabled in that case. */
10159 get_frame_size (&width
, &height
);
10160 if (width
!= old_width
|| height
!= old_height
)
10161 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10163 /* Run suspend-resume-hook. */
10164 if (!NILP (Vrun_hooks
))
10165 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10171 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10172 Then in any case stuff anything Emacs has read ahead and not used. */
10175 stuff_buffered_input (stuffstring
)
10176 Lisp_Object stuffstring
;
10178 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10179 register unsigned char *p
;
10181 if (STRINGP (stuffstring
))
10183 register int count
;
10185 p
= SDATA (stuffstring
);
10186 count
= SBYTES (stuffstring
);
10187 while (count
-- > 0)
10192 /* Anything we have read ahead, put back for the shell to read. */
10193 /* ?? What should this do when we have multiple keyboards??
10194 Should we ignore anything that was typed in at the "wrong" kboard?
10196 rms: we should stuff everything back into the kboard
10198 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10201 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10202 kbd_fetch_ptr
= kbd_buffer
;
10203 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10204 stuff_char (kbd_fetch_ptr
->code
);
10206 clear_event (kbd_fetch_ptr
);
10210 #endif /* SIGTSTP */
10214 set_waiting_for_input (time_to_clear
)
10215 EMACS_TIME
*time_to_clear
;
10217 input_available_clear_time
= time_to_clear
;
10219 /* Tell interrupt_signal to throw back to read_char, */
10220 waiting_for_input
= 1;
10222 /* If interrupt_signal was called before and buffered a C-g,
10223 make it run again now, to avoid timing error. */
10224 if (!NILP (Vquit_flag
))
10225 quit_throw_to_read_char ();
10229 clear_waiting_for_input ()
10231 /* Tell interrupt_signal not to throw back to read_char, */
10232 waiting_for_input
= 0;
10233 input_available_clear_time
= 0;
10236 /* This routine is called at interrupt level in response to C-g.
10238 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10239 is called from kbd_buffer_store_event, in handling SIGIO or
10242 If `waiting_for_input' is non zero, then unless `echoing' is
10243 nonzero, immediately throw back to read_char.
10245 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10246 eval to throw, when it gets a chance. If quit-flag is already
10247 non-nil, it stops the job right away. */
10250 interrupt_signal (signalnum
) /* If we don't have an argument, */
10251 int signalnum
; /* some compilers complain in signal calls. */
10254 /* Must preserve main program's value of errno. */
10255 int old_errno
= errno
;
10256 struct frame
*sf
= SELECTED_FRAME ();
10258 #if defined (USG) && !defined (POSIX_SIGNALS)
10259 if (!read_socket_hook
&& NILP (Vwindow_system
))
10261 /* USG systems forget handlers when they are used;
10262 must reestablish each time */
10263 signal (SIGINT
, interrupt_signal
);
10264 signal (SIGQUIT
, interrupt_signal
);
10268 SIGNAL_THREAD_CHECK (signalnum
);
10271 if (!NILP (Vquit_flag
)
10272 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10274 /* If SIGINT isn't blocked, don't let us be interrupted by
10275 another SIGINT, it might be harmful due to non-reentrancy
10276 in I/O functions. */
10277 sigblock (sigmask (SIGINT
));
10280 reset_sys_modes ();
10282 #ifdef SIGTSTP /* Support possible in later USG versions */
10284 * On systems which can suspend the current process and return to the original
10285 * shell, this command causes the user to end up back at the shell.
10286 * The "Auto-save" and "Abort" questions are not asked until
10287 * the user elects to return to emacs, at which point he can save the current
10288 * job and either dump core or continue.
10293 if (sys_suspend () == -1)
10295 printf ("Not running as a subprocess;\n");
10296 printf ("you can continue or abort.\n");
10298 #else /* not VMS */
10299 /* Perhaps should really fork an inferior shell?
10300 But that would not provide any way to get back
10301 to the original shell, ever. */
10302 printf ("No support for stopping a process on this operating system;\n");
10303 printf ("you can continue or abort.\n");
10304 #endif /* not VMS */
10305 #endif /* not SIGTSTP */
10307 /* We must remain inside the screen area when the internal terminal
10308 is used. Note that [Enter] is not echoed by dos. */
10311 /* It doesn't work to autosave while GC is in progress;
10312 the code used for auto-saving doesn't cope with the mark bit. */
10313 if (!gc_in_progress
)
10315 printf ("Auto-save? (y or n) ");
10317 if (((c
= getchar ()) & ~040) == 'Y')
10319 Fdo_auto_save (Qt
, Qnil
);
10321 printf ("\r\nAuto-save done");
10322 #else /* not MSDOS */
10323 printf ("Auto-save done\n");
10324 #endif /* not MSDOS */
10326 while (c
!= '\n') c
= getchar ();
10330 /* During GC, it must be safe to reenable quitting again. */
10331 Vinhibit_quit
= Qnil
;
10334 #endif /* not MSDOS */
10335 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10336 printf ("but will instead do a real quit after garbage collection ends\r\n");
10341 printf ("\r\nAbort? (y or n) ");
10342 #else /* not MSDOS */
10344 printf ("Abort (and enter debugger)? (y or n) ");
10345 #else /* not VMS */
10346 printf ("Abort (and dump core)? (y or n) ");
10347 #endif /* not VMS */
10348 #endif /* not MSDOS */
10350 if (((c
= getchar ()) & ~040) == 'Y')
10352 while (c
!= '\n') c
= getchar ();
10354 printf ("\r\nContinuing...\r\n");
10355 #else /* not MSDOS */
10356 printf ("Continuing...\n");
10357 #endif /* not MSDOS */
10364 /* If executing a function that wants to be interrupted out of
10365 and the user has not deferred quitting by binding `inhibit-quit'
10366 then quit right away. */
10367 if (immediate_quit
&& NILP (Vinhibit_quit
))
10369 struct gl_state_s saved
;
10370 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10372 immediate_quit
= 0;
10375 GCPRO4 (saved
.object
, saved
.global_code
,
10376 saved
.current_syntax_table
, saved
.old_prop
);
10377 Fsignal (Qquit
, Qnil
);
10382 /* Else request quit when it's safe */
10386 if (waiting_for_input
&& !echoing
)
10387 quit_throw_to_read_char ();
10392 /* Handle a C-g by making read_char return C-g. */
10395 quit_throw_to_read_char ()
10398 /* Prevent another signal from doing this before we finish. */
10399 clear_waiting_for_input ();
10402 Vunread_command_events
= Qnil
;
10403 unread_command_char
= -1;
10405 #if 0 /* Currently, sit_for is called from read_char without turning
10406 off polling. And that can call set_waiting_for_input.
10407 It seems to be harmless. */
10408 #ifdef POLL_FOR_INPUT
10409 /* May be > 1 if in recursive minibuffer. */
10410 if (poll_suppress_count
== 0)
10414 if (FRAMEP (internal_last_event_frame
)
10415 && !EQ (internal_last_event_frame
, selected_frame
))
10416 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10419 _longjmp (getcjmp
, 1);
10422 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10423 doc
: /* Set mode of reading keyboard input.
10424 First arg INTERRUPT non-nil means use input interrupts;
10425 nil means use CBREAK mode.
10426 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10427 (no effect except in CBREAK mode).
10428 Third arg META t means accept 8-bit input (for a Meta key).
10429 META nil means ignore the top bit, on the assumption it is parity.
10430 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10431 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10432 See also `current-input-mode'. */)
10433 (interrupt
, flow
, meta
, quit
)
10434 Lisp_Object interrupt
, flow
, meta
, quit
;
10437 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10438 error ("set-input-mode: QUIT must be an ASCII character");
10440 #ifdef POLL_FOR_INPUT
10445 /* this causes startup screen to be restored and messes with the mouse */
10446 reset_sys_modes ();
10450 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10451 if (read_socket_hook
)
10453 /* When using X, don't give the user a real choice,
10454 because we haven't implemented the mechanisms to support it. */
10455 #ifdef NO_SOCK_SIGIO
10456 interrupt_input
= 0;
10457 #else /* not NO_SOCK_SIGIO */
10458 interrupt_input
= 1;
10459 #endif /* NO_SOCK_SIGIO */
10462 interrupt_input
= !NILP (interrupt
);
10463 #else /* not SIGIO */
10464 interrupt_input
= 0;
10465 #endif /* not SIGIO */
10467 /* Our VMS input only works by interrupts, as of now. */
10469 interrupt_input
= 1;
10472 flow_control
= !NILP (flow
);
10475 else if (EQ (meta
, Qt
))
10480 /* Don't let this value be out of range. */
10481 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10487 #ifdef POLL_FOR_INPUT
10488 poll_suppress_count
= 1;
10494 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10495 doc
: /* Return information about the way Emacs currently reads keyboard input.
10496 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10497 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10498 nil, Emacs is using CBREAK mode.
10499 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10500 terminal; this does not apply if Emacs uses interrupt-driven input.
10501 META is t if accepting 8-bit input with 8th bit as Meta flag.
10502 META nil means ignoring the top bit, on the assumption it is parity.
10503 META is neither t nor nil if accepting 8-bit input and using
10504 all 8 bits as the character code.
10505 QUIT is the character Emacs currently uses to quit.
10506 The elements of this list correspond to the arguments of
10507 `set-input-mode'. */)
10510 Lisp_Object val
[4];
10512 val
[0] = interrupt_input
? Qt
: Qnil
;
10513 val
[1] = flow_control
? Qt
: Qnil
;
10514 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10515 XSETFASTINT (val
[3], quit_char
);
10517 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10520 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10521 doc
: /* Return position information for pixel coordinates X and Y.
10522 By default, X and Y are relative to text area of the selected window.
10523 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10524 If optional fourth arg WHOLE is non-nil, X is relative to the left
10525 edge of the window.
10527 The return value is similar to a mouse click position:
10528 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10529 IMAGE (DX . DY) (WIDTH . HEIGHT))
10530 The `posn-' functions access elements of such lists. */)
10531 (x
, y
, frame_or_window
, whole
)
10532 Lisp_Object x
, y
, frame_or_window
, whole
;
10534 if (NILP (frame_or_window
))
10535 frame_or_window
= selected_window
;
10537 if (WINDOWP (frame_or_window
))
10541 CHECK_LIVE_WINDOW (frame_or_window
);
10543 w
= XWINDOW (frame_or_window
);
10544 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10546 ? window_box_left_offset (w
, TEXT_AREA
)
10547 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10548 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10549 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10550 frame_or_window
= w
->frame
;
10553 CHECK_LIVE_FRAME (frame_or_window
);
10555 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10558 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10559 doc
: /* Return position information for buffer POS in WINDOW.
10560 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10562 Return nil if position is not visible in window. Otherwise,
10563 the return value is similar to that returned by `event-start' for
10564 a mouse click at the upper left corner of the glyph corresponding
10565 to the given buffer position:
10566 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10567 IMAGE (DX . DY) (WIDTH . HEIGHT))
10568 The `posn-' functions access elements of such lists. */)
10570 Lisp_Object pos
, window
;
10574 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10576 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10582 * Set up a new kboard object with reasonable initial values.
10588 kb
->Voverriding_terminal_local_map
= Qnil
;
10589 kb
->Vlast_command
= Qnil
;
10590 kb
->Vreal_last_command
= Qnil
;
10591 kb
->Vprefix_arg
= Qnil
;
10592 kb
->Vlast_prefix_arg
= Qnil
;
10593 kb
->kbd_queue
= Qnil
;
10594 kb
->kbd_queue_has_data
= 0;
10595 kb
->immediate_echo
= 0;
10596 kb
->echo_string
= Qnil
;
10597 kb
->echo_after_prompt
= -1;
10598 kb
->kbd_macro_buffer
= 0;
10599 kb
->kbd_macro_bufsize
= 0;
10600 kb
->defining_kbd_macro
= Qnil
;
10601 kb
->Vlast_kbd_macro
= Qnil
;
10602 kb
->reference_count
= 0;
10603 kb
->Vsystem_key_alist
= Qnil
;
10604 kb
->system_key_syms
= Qnil
;
10605 kb
->Vdefault_minibuffer_frame
= Qnil
;
10609 * Destroy the contents of a kboard object, but not the object itself.
10610 * We use this just before deleting it, or if we're going to initialize
10611 * it a second time.
10617 if (kb
->kbd_macro_buffer
)
10618 xfree (kb
->kbd_macro_buffer
);
10621 #ifdef MULTI_KBOARD
10623 /* Free KB and memory referenced from it. */
10631 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10634 *kbp
= kb
->next_kboard
;
10636 /* Prevent a dangling reference to KB. */
10637 if (kb
== current_kboard
10638 && FRAMEP (selected_frame
)
10639 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10641 current_kboard
= XFRAME (selected_frame
)->kboard
;
10642 if (current_kboard
== kb
)
10650 #endif /* MULTI_KBOARD */
10655 /* This is correct before outermost invocation of the editor loop */
10656 command_loop_level
= -1;
10657 immediate_quit
= 0;
10658 quit_char
= Ctl ('g');
10659 Vunread_command_events
= Qnil
;
10660 unread_command_char
= -1;
10661 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10663 recent_keys_index
= 0;
10664 kbd_fetch_ptr
= kbd_buffer
;
10665 kbd_store_ptr
= kbd_buffer
;
10667 do_mouse_tracking
= Qnil
;
10671 /* This means that command_loop_1 won't try to select anything the first
10673 internal_last_event_frame
= Qnil
;
10674 Vlast_event_frame
= internal_last_event_frame
;
10676 #ifdef MULTI_KBOARD
10677 current_kboard
= initial_kboard
;
10679 wipe_kboard (current_kboard
);
10680 init_kboard (current_kboard
);
10682 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10684 signal (SIGINT
, interrupt_signal
);
10685 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10686 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10687 SIGQUIT and we can't tell which one it will give us. */
10688 signal (SIGQUIT
, interrupt_signal
);
10689 #endif /* HAVE_TERMIO */
10691 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10693 if (!noninteractive
)
10694 signal (SIGIO
, input_available_signal
);
10697 /* Use interrupt input by default, if it works and noninterrupt input
10698 has deficiencies. */
10700 #ifdef INTERRUPT_INPUT
10701 interrupt_input
= 1;
10703 interrupt_input
= 0;
10706 /* Our VMS input only works by interrupts, as of now. */
10708 interrupt_input
= 1;
10714 if (keyboard_init_hook
)
10715 (*keyboard_init_hook
) ();
10717 #ifdef POLL_FOR_INPUT
10718 poll_suppress_count
= 1;
10723 /* At least provide an escape route since C-g doesn't work. */
10724 signal (SIGINT
, interrupt_signal
);
10728 /* This type's only use is in syms_of_keyboard, to initialize the
10729 event header symbols and put properties on them. */
10730 struct event_head
{
10736 struct event_head head_table
[] = {
10737 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10738 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10739 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10740 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10741 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10742 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10743 /* `select-window' should be handled just like `switch-frame'
10744 in read_key_sequence. */
10745 {&Qselect_window
, "select-window", &Qswitch_frame
}
10749 syms_of_keyboard ()
10751 Vpre_help_message
= Qnil
;
10752 staticpro (&Vpre_help_message
);
10754 Vlispy_mouse_stem
= build_string ("mouse");
10755 staticpro (&Vlispy_mouse_stem
);
10758 QCimage
= intern (":image");
10759 staticpro (&QCimage
);
10761 staticpro (&Qhelp_echo
);
10762 Qhelp_echo
= intern ("help-echo");
10764 staticpro (&item_properties
);
10765 item_properties
= Qnil
;
10767 staticpro (&tool_bar_item_properties
);
10768 tool_bar_item_properties
= Qnil
;
10769 staticpro (&tool_bar_items_vector
);
10770 tool_bar_items_vector
= Qnil
;
10772 staticpro (&real_this_command
);
10773 real_this_command
= Qnil
;
10775 Qtimer_event_handler
= intern ("timer-event-handler");
10776 staticpro (&Qtimer_event_handler
);
10778 Qdisabled_command_function
= intern ("disabled-command-function");
10779 staticpro (&Qdisabled_command_function
);
10781 Qself_insert_command
= intern ("self-insert-command");
10782 staticpro (&Qself_insert_command
);
10784 Qforward_char
= intern ("forward-char");
10785 staticpro (&Qforward_char
);
10787 Qbackward_char
= intern ("backward-char");
10788 staticpro (&Qbackward_char
);
10790 Qdisabled
= intern ("disabled");
10791 staticpro (&Qdisabled
);
10793 Qundefined
= intern ("undefined");
10794 staticpro (&Qundefined
);
10796 Qpre_command_hook
= intern ("pre-command-hook");
10797 staticpro (&Qpre_command_hook
);
10799 Qpost_command_hook
= intern ("post-command-hook");
10800 staticpro (&Qpost_command_hook
);
10802 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10803 staticpro (&Qpost_command_idle_hook
);
10805 Qdeferred_action_function
= intern ("deferred-action-function");
10806 staticpro (&Qdeferred_action_function
);
10808 Qcommand_hook_internal
= intern ("command-hook-internal");
10809 staticpro (&Qcommand_hook_internal
);
10811 Qfunction_key
= intern ("function-key");
10812 staticpro (&Qfunction_key
);
10813 Qmouse_click
= intern ("mouse-click");
10814 staticpro (&Qmouse_click
);
10816 Qlanguage_change
= intern ("language-change");
10817 staticpro (&Qlanguage_change
);
10819 Qdrag_n_drop
= intern ("drag-n-drop");
10820 staticpro (&Qdrag_n_drop
);
10822 Qsave_session
= intern ("save-session");
10823 staticpro(&Qsave_session
);
10825 Qusr1_signal
= intern ("usr1-signal");
10826 staticpro (&Qusr1_signal
);
10827 Qusr2_signal
= intern ("usr2-signal");
10828 staticpro (&Qusr2_signal
);
10830 Qmenu_enable
= intern ("menu-enable");
10831 staticpro (&Qmenu_enable
);
10832 Qmenu_alias
= intern ("menu-alias");
10833 staticpro (&Qmenu_alias
);
10834 QCenable
= intern (":enable");
10835 staticpro (&QCenable
);
10836 QCvisible
= intern (":visible");
10837 staticpro (&QCvisible
);
10838 QChelp
= intern (":help");
10839 staticpro (&QChelp
);
10840 QCfilter
= intern (":filter");
10841 staticpro (&QCfilter
);
10842 QCbutton
= intern (":button");
10843 staticpro (&QCbutton
);
10844 QCkeys
= intern (":keys");
10845 staticpro (&QCkeys
);
10846 QCkey_sequence
= intern (":key-sequence");
10847 staticpro (&QCkey_sequence
);
10848 QCtoggle
= intern (":toggle");
10849 staticpro (&QCtoggle
);
10850 QCradio
= intern (":radio");
10851 staticpro (&QCradio
);
10853 Qmode_line
= intern ("mode-line");
10854 staticpro (&Qmode_line
);
10855 Qvertical_line
= intern ("vertical-line");
10856 staticpro (&Qvertical_line
);
10857 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10858 staticpro (&Qvertical_scroll_bar
);
10859 Qmenu_bar
= intern ("menu-bar");
10860 staticpro (&Qmenu_bar
);
10862 Qabove_handle
= intern ("above-handle");
10863 staticpro (&Qabove_handle
);
10864 Qhandle
= intern ("handle");
10865 staticpro (&Qhandle
);
10866 Qbelow_handle
= intern ("below-handle");
10867 staticpro (&Qbelow_handle
);
10868 Qup
= intern ("up");
10870 Qdown
= intern ("down");
10871 staticpro (&Qdown
);
10872 Qtop
= intern ("top");
10874 Qbottom
= intern ("bottom");
10875 staticpro (&Qbottom
);
10876 Qend_scroll
= intern ("end-scroll");
10877 staticpro (&Qend_scroll
);
10878 Qratio
= intern ("ratio");
10879 staticpro (&Qratio
);
10881 Qevent_kind
= intern ("event-kind");
10882 staticpro (&Qevent_kind
);
10883 Qevent_symbol_elements
= intern ("event-symbol-elements");
10884 staticpro (&Qevent_symbol_elements
);
10885 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10886 staticpro (&Qevent_symbol_element_mask
);
10887 Qmodifier_cache
= intern ("modifier-cache");
10888 staticpro (&Qmodifier_cache
);
10890 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10891 staticpro (&Qrecompute_lucid_menubar
);
10892 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10893 staticpro (&Qactivate_menubar_hook
);
10895 Qpolling_period
= intern ("polling-period");
10896 staticpro (&Qpolling_period
);
10898 Qinput_method_function
= intern ("input-method-function");
10899 staticpro (&Qinput_method_function
);
10901 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10902 staticpro (&Qinput_method_exit_on_first_char
);
10903 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10904 staticpro (&Qinput_method_use_echo_area
);
10906 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10907 Fset (Qinput_method_use_echo_area
, Qnil
);
10909 last_point_position_buffer
= Qnil
;
10912 struct event_head
*p
;
10914 for (p
= head_table
;
10915 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10918 *p
->var
= intern (p
->name
);
10919 staticpro (p
->var
);
10920 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10921 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10925 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10926 staticpro (&button_down_location
);
10927 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10928 staticpro (&mouse_syms
);
10929 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10930 staticpro (&wheel_syms
);
10934 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10936 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10937 for (i
= 0; i
< len
; i
++)
10938 if (modifier_names
[i
])
10939 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10940 staticpro (&modifier_symbols
);
10943 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10944 staticpro (&recent_keys
);
10946 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10947 staticpro (&this_command_keys
);
10949 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10950 staticpro (&raw_keybuf
);
10952 Qextended_command_history
= intern ("extended-command-history");
10953 Fset (Qextended_command_history
, Qnil
);
10954 staticpro (&Qextended_command_history
);
10956 accent_key_syms
= Qnil
;
10957 staticpro (&accent_key_syms
);
10959 func_key_syms
= Qnil
;
10960 staticpro (&func_key_syms
);
10962 drag_n_drop_syms
= Qnil
;
10963 staticpro (&drag_n_drop_syms
);
10965 unread_switch_frame
= Qnil
;
10966 staticpro (&unread_switch_frame
);
10968 internal_last_event_frame
= Qnil
;
10969 staticpro (&internal_last_event_frame
);
10971 read_key_sequence_cmd
= Qnil
;
10972 staticpro (&read_key_sequence_cmd
);
10974 menu_bar_one_keymap_changed_items
= Qnil
;
10975 staticpro (&menu_bar_one_keymap_changed_items
);
10977 defsubr (&Sevent_convert_list
);
10978 defsubr (&Sread_key_sequence
);
10979 defsubr (&Sread_key_sequence_vector
);
10980 defsubr (&Srecursive_edit
);
10982 defsubr (&Strack_mouse
);
10984 defsubr (&Sinput_pending_p
);
10985 defsubr (&Scommand_execute
);
10986 defsubr (&Srecent_keys
);
10987 defsubr (&Sthis_command_keys
);
10988 defsubr (&Sthis_command_keys_vector
);
10989 defsubr (&Sthis_single_command_keys
);
10990 defsubr (&Sthis_single_command_raw_keys
);
10991 defsubr (&Sreset_this_command_lengths
);
10992 defsubr (&Sclear_this_command_keys
);
10993 defsubr (&Ssuspend_emacs
);
10994 defsubr (&Sabort_recursive_edit
);
10995 defsubr (&Sexit_recursive_edit
);
10996 defsubr (&Srecursion_depth
);
10997 defsubr (&Stop_level
);
10998 defsubr (&Sdiscard_input
);
10999 defsubr (&Sopen_dribble_file
);
11000 defsubr (&Sset_input_mode
);
11001 defsubr (&Scurrent_input_mode
);
11002 defsubr (&Sexecute_extended_command
);
11003 defsubr (&Sposn_at_point
);
11004 defsubr (&Sposn_at_x_y
);
11006 DEFVAR_LISP ("last-command-char", &last_command_char
,
11007 doc
: /* Last input event that was part of a command. */);
11009 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11010 doc
: /* Last input event that was part of a command. */);
11012 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11013 doc
: /* Last input event in a command, except for mouse menu events.
11014 Mouse menus give back keys that don't look like mouse events;
11015 this variable holds the actual mouse event that led to the menu,
11016 so that you can determine whether the command was run by mouse or not. */);
11018 DEFVAR_LISP ("last-input-char", &last_input_char
,
11019 doc
: /* Last input event. */);
11021 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11022 doc
: /* Last input event. */);
11024 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11025 doc
: /* List of events to be read as the command input.
11026 These events are processed first, before actual keyboard input. */);
11027 Vunread_command_events
= Qnil
;
11029 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11030 doc
: /* If not -1, an object to be read as next command input event. */);
11032 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11033 doc
: /* List of events to be processed as input by input methods.
11034 These events are processed after `unread-command-events', but
11035 before actual keyboard input. */);
11036 Vunread_post_input_method_events
= Qnil
;
11038 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11039 doc
: /* List of events to be processed as input by input methods.
11040 These events are processed after `unread-command-events', but
11041 before actual keyboard input. */);
11042 Vunread_input_method_events
= Qnil
;
11044 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11045 doc
: /* Meta-prefix character code.
11046 Meta-foo as command input turns into this character followed by foo. */);
11047 XSETINT (meta_prefix_char
, 033);
11049 DEFVAR_KBOARD ("last-command", Vlast_command
,
11050 doc
: /* The last command executed.
11051 Normally a symbol with a function definition, but can be whatever was found
11052 in the keymap, or whatever the variable `this-command' was set to by that
11055 The value `mode-exit' is special; it means that the previous command
11056 read an event that told it to exit, and it did so and unread that event.
11057 In other words, the present command is the event that made the previous
11060 The value `kill-region' is special; it means that the previous command
11061 was a kill command. */);
11063 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11064 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11066 DEFVAR_LISP ("this-command", &Vthis_command
,
11067 doc
: /* The command now being executed.
11068 The command can set this variable; whatever is put here
11069 will be in `last-command' during the following command. */);
11070 Vthis_command
= Qnil
;
11072 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11073 doc
: /* The command bound to the current key sequence before remapping.
11074 It equals `this-command' if the original command was not remapped through
11075 any of the active keymaps. Otherwise, the value of `this-command' is the
11076 result of looking up the original command in the active keymaps. */);
11077 Vthis_original_command
= Qnil
;
11079 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11080 doc
: /* *Number of input events between auto-saves.
11081 Zero means disable autosaving due to number of characters typed. */);
11082 auto_save_interval
= 300;
11084 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11085 doc
: /* *Number of seconds idle time before auto-save.
11086 Zero or nil means disable auto-saving due to idleness.
11087 After auto-saving due to this many seconds of idle time,
11088 Emacs also does a garbage collection if that seems to be warranted. */);
11089 XSETFASTINT (Vauto_save_timeout
, 30);
11091 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11092 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11093 The value may be integer or floating point. */);
11094 Vecho_keystrokes
= make_number (1);
11096 DEFVAR_INT ("polling-period", &polling_period
,
11097 doc
: /* *Interval between polling for input during Lisp execution.
11098 The reason for polling is to make C-g work to stop a running program.
11099 Polling is needed only when using X windows and SIGIO does not work.
11100 Polling is automatically disabled in all other cases. */);
11101 polling_period
= 2;
11103 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11104 doc
: /* *Maximum time between mouse clicks to make a double-click.
11105 Measured in milliseconds. nil means disable double-click recognition;
11106 t means double-clicks have no time limit and are detected
11107 by position only. */);
11108 Vdouble_click_time
= make_number (500);
11110 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11111 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11112 On window-system frames, value is the number of pixels the mouse may have
11113 moved horizontally or vertically between two clicks to make a double-click.
11114 On non window-system frames, value is interpreted in units of 1/8 characters
11117 This variable is also the threshold for motion of the mouse
11118 to count as a drag. */);
11119 double_click_fuzz
= 3;
11121 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11122 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11123 inhibit_local_menu_bar_menus
= 0;
11125 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11126 doc
: /* Number of complete key sequences read as input so far.
11127 This includes key sequences read from keyboard macros.
11128 The number is effectively the number of interactive command invocations. */);
11129 num_input_keys
= 0;
11131 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11132 doc
: /* Number of input events read from the keyboard so far.
11133 This does not include events generated by keyboard macros. */);
11134 num_nonmacro_input_events
= 0;
11136 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11137 doc
: /* The frame in which the most recently read event occurred.
11138 If the last event came from a keyboard macro, this is set to `macro'. */);
11139 Vlast_event_frame
= Qnil
;
11141 /* This variable is set up in sysdep.c. */
11142 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11143 doc
: /* The ERASE character as set by the user with stty. */);
11145 DEFVAR_LISP ("help-char", &Vhelp_char
,
11146 doc
: /* Character to recognize as meaning Help.
11147 When it is read, do `(eval help-form)', and display result if it's a string.
11148 If the value of `help-form' is nil, this char can be read normally. */);
11149 XSETINT (Vhelp_char
, Ctl ('H'));
11151 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11152 doc
: /* List of input events to recognize as meaning Help.
11153 These work just like the value of `help-char' (see that). */);
11154 Vhelp_event_list
= Qnil
;
11156 DEFVAR_LISP ("help-form", &Vhelp_form
,
11157 doc
: /* Form to execute when character `help-char' is read.
11158 If the form returns a string, that string is displayed.
11159 If `help-form' is nil, the help char is not recognized. */);
11162 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11163 doc
: /* Command to run when `help-char' character follows a prefix key.
11164 This command is used only when there is no actual binding
11165 for that character after that prefix key. */);
11166 Vprefix_help_command
= Qnil
;
11168 DEFVAR_LISP ("top-level", &Vtop_level
,
11169 doc
: /* Form to evaluate when Emacs starts up.
11170 Useful to set before you dump a modified Emacs. */);
11173 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11174 doc
: /* Translate table for keyboard input, or nil.
11175 If non-nil, the value should be a char-table. Each character read
11176 from the keyboard is looked up in this char-table. If the value found
11177 there is non-nil, then it is used instead of the actual input character.
11179 The value can also be a string or vector, but this is considered obsolete.
11180 If it is a string or vector of length N, character codes N and up are left
11181 untranslated. In a vector, an element which is nil means "no translation".
11183 This is applied to the characters supplied to input methods, not their
11184 output. See also `translation-table-for-input'. */);
11185 Vkeyboard_translate_table
= Qnil
;
11187 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11188 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11189 \(Even if the operating system has support for stopping a process.\) */);
11190 cannot_suspend
= 0;
11192 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11193 doc
: /* Non-nil means prompt with menus when appropriate.
11194 This is done when reading from a keymap that has a prompt string,
11195 for elements that have prompt strings.
11196 The menu is displayed on the screen
11197 if X menus were enabled at configuration
11198 time and the previous event was a mouse click prefix key.
11199 Otherwise, menu prompting uses the echo area. */);
11200 menu_prompting
= 1;
11202 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11203 doc
: /* Character to see next line of menu prompt.
11204 Type this character while in a menu prompt to rotate around the lines of it. */);
11205 XSETINT (menu_prompt_more_char
, ' ');
11207 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11208 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11209 Emacs applies the modifiers of the character stored here to each keyboard
11210 character it reads. For example, after evaluating the expression
11211 (setq extra-keyboard-modifiers ?\\C-x)
11212 all input characters will have the control modifier applied to them.
11214 Note that the character ?\\C-@, equivalent to the integer zero, does
11215 not count as a control character; rather, it counts as a character
11216 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11217 cancels any modification. */);
11218 extra_keyboard_modifiers
= 0;
11220 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11221 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11222 The command loop sets this to nil before each command,
11223 and tests the value when the command returns.
11224 Buffer modification stores t in this variable. */);
11225 Vdeactivate_mark
= Qnil
;
11227 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11228 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11229 Vcommand_hook_internal
= Qnil
;
11231 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11232 doc
: /* Normal hook run before each command is executed.
11233 If an unhandled error happens in running this hook,
11234 the hook value is set to nil, since otherwise the error
11235 might happen repeatedly and make Emacs nonfunctional. */);
11236 Vpre_command_hook
= Qnil
;
11238 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11239 doc
: /* Normal hook run after each command is executed.
11240 If an unhandled error happens in running this hook,
11241 the hook value is set to nil, since otherwise the error
11242 might happen repeatedly and make Emacs nonfunctional. */);
11243 Vpost_command_hook
= Qnil
;
11245 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11246 doc
: /* Normal hook run after each command is executed, if idle.
11247 Errors running the hook are caught and ignored. */);
11248 Vpost_command_idle_hook
= Qnil
;
11250 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11251 doc
: /* Delay time before running `post-command-idle-hook'.
11252 This is measured in microseconds. */);
11253 post_command_idle_delay
= 100000;
11256 DEFVAR_LISP ("echo-area-clear-hook", ...,
11257 doc
: /* Normal hook run when clearing the echo area. */);
11259 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11260 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11262 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11263 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11264 Vlucid_menu_bar_dirty_flag
= Qnil
;
11266 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11267 doc
: /* List of menu bar items to move to the end of the menu bar.
11268 The elements of the list are event types that may have menu bar bindings. */);
11269 Vmenu_bar_final_items
= Qnil
;
11271 DEFVAR_KBOARD ("overriding-terminal-local-map",
11272 Voverriding_terminal_local_map
,
11273 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11274 If this variable is non-nil, it is used as a keymap instead of the
11275 buffer's local map, and the minor mode keymaps and text property keymaps.
11276 It also replaces `overriding-local-map'.
11278 This variable is intended to let commands such as `universal-argument'
11279 set up a different keymap for reading the next command. */);
11281 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11282 doc
: /* Keymap that overrides all other local keymaps.
11283 If this variable is non-nil, it is used as a keymap--replacing the
11284 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11285 Voverriding_local_map
= Qnil
;
11287 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11288 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11289 Otherwise, the menu bar continues to reflect the buffer's local map
11290 and the minor mode maps regardless of `overriding-local-map'. */);
11291 Voverriding_local_map_menu_flag
= Qnil
;
11293 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11294 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11295 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11297 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11298 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11300 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11301 doc
: /* Alist of system-specific X windows key symbols.
11302 Each element should have the form (N . SYMBOL) where N is the
11303 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11304 and SYMBOL is its name. */);
11306 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11307 doc
: /* List of deferred actions to be performed at a later time.
11308 The precise format isn't relevant here; we just check whether it is nil. */);
11309 Vdeferred_action_list
= Qnil
;
11311 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11312 doc
: /* Function to call to handle deferred actions, after each command.
11313 This function is called with no arguments after each command
11314 whenever `deferred-action-list' is non-nil. */);
11315 Vdeferred_action_function
= Qnil
;
11317 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11318 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11319 The value can be a length of time to show the message for.
11320 If the value is non-nil and not a number, we wait 2 seconds. */);
11321 Vsuggest_key_bindings
= Qt
;
11323 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11324 doc
: /* List of active absolute time timers in order of increasing time. */);
11325 Vtimer_list
= Qnil
;
11327 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11328 doc
: /* List of active idle-time timers in order of increasing time. */);
11329 Vtimer_idle_list
= Qnil
;
11331 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11332 doc
: /* If non-nil, the function that implements the current input method.
11333 It's called with one argument, a printing character that was just read.
11334 \(That means a character with code 040...0176.)
11335 Typically this function uses `read-event' to read additional events.
11336 When it does so, it should first bind `input-method-function' to nil
11337 so it will not be called recursively.
11339 The function should return a list of zero or more events
11340 to be used as input. If it wants to put back some events
11341 to be reconsidered, separately, by the input method,
11342 it can add them to the beginning of `unread-command-events'.
11344 The input method function can find in `input-method-previous-method'
11345 the previous echo area message.
11347 The input method function should refer to the variables
11348 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11349 for guidance on what to do. */);
11350 Vinput_method_function
= Qnil
;
11352 DEFVAR_LISP ("input-method-previous-message",
11353 &Vinput_method_previous_message
,
11354 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11355 This variable exists because `read-event' clears the echo area
11356 before running the input method. It is nil if there was no message. */);
11357 Vinput_method_previous_message
= Qnil
;
11359 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11360 doc
: /* If non-nil, the function that implements the display of help.
11361 It's called with one argument, the help string to display. */);
11362 Vshow_help_function
= Qnil
;
11364 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11365 doc
: /* If non-nil, suppress point adjustment after executing a command.
11367 After a command is executed, if point is moved into a region that has
11368 special properties (e.g. composition, display), we adjust point to
11369 the boundary of the region. But, when a command sets this variable to
11370 non-nil, we suppress the point adjustment.
11372 This variable is set to nil before reading a command, and is checked
11373 just after executing the command. */);
11374 Vdisable_point_adjustment
= Qnil
;
11376 DEFVAR_LISP ("global-disable-point-adjustment",
11377 &Vglobal_disable_point_adjustment
,
11378 doc
: /* *If non-nil, always suppress point adjustment.
11380 The default value is nil, in which case, point adjustment are
11381 suppressed only after special commands that set
11382 `disable-point-adjustment' (which see) to non-nil. */);
11383 Vglobal_disable_point_adjustment
= Qnil
;
11385 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11386 doc
: /* Non-nil means updating menu bindings is allowed.
11387 A value of nil means menu bindings should not be updated.
11388 Used during Emacs' startup. */);
11389 update_menu_bindings
= 1;
11391 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11392 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11393 If the value is not a number, such messages don't time out. */);
11394 Vminibuffer_message_timeout
= make_number (2);
11396 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11397 doc
: /* If non-nil, any keyboard input throws to this symbol.
11398 The value of that variable is passed to `quit-flag' and later causes a
11399 peculiar kind of quitting. */);
11400 Vthrow_on_input
= Qnil
;
11404 keys_of_keyboard ()
11406 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11407 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11408 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11409 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11410 initial_define_key (meta_map
, 'x', "execute-extended-command");
11412 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11413 "handle-delete-frame");
11414 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11416 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11418 /* Handling it at such a low-level causes read_key_sequence to get
11419 * confused because it doesn't realize that the current_buffer was
11420 * changed by read_char.
11422 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11423 * "handle-select-window"); */
11424 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11425 "handle-save-session");
11428 /* Mark the pointers in the kboard objects.
11429 Called by the Fgarbage_collector. */
11435 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11437 if (kb
->kbd_macro_buffer
)
11438 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11440 mark_object (kb
->Voverriding_terminal_local_map
);
11441 mark_object (kb
->Vlast_command
);
11442 mark_object (kb
->Vreal_last_command
);
11443 mark_object (kb
->Vprefix_arg
);
11444 mark_object (kb
->Vlast_prefix_arg
);
11445 mark_object (kb
->kbd_queue
);
11446 mark_object (kb
->defining_kbd_macro
);
11447 mark_object (kb
->Vlast_kbd_macro
);
11448 mark_object (kb
->Vsystem_key_alist
);
11449 mark_object (kb
->system_key_syms
);
11450 mark_object (kb
->Vdefault_minibuffer_frame
);
11451 mark_object (kb
->echo_string
);
11454 struct input_event
*event
;
11455 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11457 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11458 event
= kbd_buffer
;
11459 if (event
->kind
!= SELECTION_REQUEST_EVENT
11460 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11462 mark_object (event
->x
);
11463 mark_object (event
->y
);
11465 mark_object (event
->frame_or_window
);
11466 mark_object (event
->arg
);
11471 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11472 (do not change this comment) */