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>
68 /* This is to get the definitions of the XK_ symbols. */
75 #endif /* HAVE_NTGUI */
85 /* Variables for blockinput.h: */
87 /* Non-zero if interrupt input is blocked right now. */
88 int interrupt_input_blocked
;
90 /* Nonzero means an input interrupt has arrived
91 during the current critical section. */
92 int interrupt_input_pending
;
95 /* File descriptor to use for input. */
98 #ifdef HAVE_WINDOW_SYSTEM
99 /* Make all keyboard buffers much bigger when using X windows. */
101 /* But not too big (local data > 32K error) if on Mac OS Classic. */
102 #define KBD_BUFFER_SIZE 512
104 #define KBD_BUFFER_SIZE 4096
106 #else /* No X-windows, character input */
107 #define KBD_BUFFER_SIZE 4096
108 #endif /* No X-windows */
110 #define abs(x) ((x) >= 0 ? (x) : -(x))
112 /* Following definition copied from eval.c */
116 struct backtrace
*next
;
117 Lisp_Object
*function
;
118 Lisp_Object
*args
; /* Points to vector of args. */
119 int nargs
; /* length of vector. If nargs is UNEVALLED,
120 args points to slot holding list of
123 /* Nonzero means call value of debugger when done with this operation. */
128 KBOARD
*initial_kboard
;
129 KBOARD
*current_kboard
;
133 KBOARD the_only_kboard
;
136 /* Non-nil disable property on a command means
137 do not execute it; call disabled-command-function's value instead. */
138 Lisp_Object Qdisabled
, Qdisabled_command_function
;
140 #define NUM_RECENT_KEYS (100)
141 int recent_keys_index
; /* Index for storing next element into recent_keys */
142 int total_keys
; /* Total number of elements stored into recent_keys */
143 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
145 /* Vector holding the key sequence that invoked the current command.
146 It is reused for each command, and it may be longer than the current
147 sequence; this_command_key_count indicates how many elements
148 actually mean something.
149 It's easier to staticpro a single Lisp_Object than an array. */
150 Lisp_Object this_command_keys
;
151 int this_command_key_count
;
153 /* 1 after calling Freset_this_command_lengths.
155 int this_command_key_count_reset
;
157 /* This vector is used as a buffer to record the events that were actually read
158 by read_key_sequence. */
159 Lisp_Object raw_keybuf
;
160 int raw_keybuf_count
;
162 #define GROW_RAW_KEYBUF \
163 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
165 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
167 new = Fmake_vector (make_number (newsize), Qnil); \
168 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
169 raw_keybuf_count * sizeof (Lisp_Object)); \
173 /* Number of elements of this_command_keys
174 that precede this key sequence. */
175 int this_single_command_key_start
;
177 /* Record values of this_command_key_count and echo_length ()
178 before this command was read. */
179 static int before_command_key_count
;
180 static int before_command_echo_length
;
182 extern int minbuf_level
;
184 extern int message_enable_multibyte
;
186 extern struct backtrace
*backtrace_list
;
188 /* If non-nil, the function that implements the display of help.
189 It's called with one argument, the help string to display. */
191 Lisp_Object Vshow_help_function
;
193 /* If a string, the message displayed before displaying a help-echo
196 Lisp_Object Vpre_help_message
;
198 /* Nonzero means do menu prompting. */
200 static int menu_prompting
;
202 /* Character to see next line of menu prompt. */
204 static Lisp_Object menu_prompt_more_char
;
206 /* For longjmp to where kbd input is being done. */
208 static jmp_buf getcjmp
;
210 /* True while doing kbd input. */
211 int waiting_for_input
;
213 /* True while displaying for echoing. Delays C-g throwing. */
217 /* Non-null means we can start echoing at the next input pause even
218 though there is something in the echo area. */
220 static struct kboard
*ok_to_echo_at_next_pause
;
222 /* The kboard last echoing, or null for none. Reset to 0 in
223 cancel_echoing. If non-null, and a current echo area message
224 exists, and echo_message_buffer is eq to the current message
225 buffer, we know that the message comes from echo_kboard. */
227 struct kboard
*echo_kboard
;
229 /* The buffer used for echoing. Set in echo_now, reset in
232 Lisp_Object echo_message_buffer
;
234 /* Nonzero means disregard local maps for the menu bar. */
235 static int inhibit_local_menu_bar_menus
;
237 /* Nonzero means C-g should cause immediate error-signal. */
240 /* The user's ERASE setting. */
241 Lisp_Object Vtty_erase_char
;
243 /* Character to recognize as the help char. */
244 Lisp_Object Vhelp_char
;
246 /* List of other event types to recognize as meaning "help". */
247 Lisp_Object Vhelp_event_list
;
249 /* Form to execute when help char is typed. */
250 Lisp_Object Vhelp_form
;
252 /* Command to run when the help character follows a prefix key. */
253 Lisp_Object Vprefix_help_command
;
255 /* List of items that should move to the end of the menu bar. */
256 Lisp_Object Vmenu_bar_final_items
;
258 /* Non-nil means show the equivalent key-binding for
259 any M-x command that has one.
260 The value can be a length of time to show the message for.
261 If the value is non-nil and not a number, we wait 2 seconds. */
262 Lisp_Object Vsuggest_key_bindings
;
264 /* How long to display an echo-area message when the minibuffer is active.
265 If the value is not a number, such messages don't time out. */
266 Lisp_Object Vminibuffer_message_timeout
;
268 /* Character that causes a quit. Normally C-g.
270 If we are running on an ordinary terminal, this must be an ordinary
271 ASCII char, since we want to make it our interrupt character.
273 If we are not running on an ordinary terminal, it still needs to be
274 an ordinary ASCII char. This character needs to be recognized in
275 the input interrupt handler. At this point, the keystroke is
276 represented as a struct input_event, while the desired quit
277 character is specified as a lispy event. The mapping from struct
278 input_events to lispy events cannot run in an interrupt handler,
279 and the reverse mapping is difficult for anything but ASCII
282 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
286 extern Lisp_Object current_global_map
;
287 extern int minibuf_level
;
289 /* If non-nil, this is a map that overrides all other local maps. */
290 Lisp_Object Voverriding_local_map
;
292 /* If non-nil, Voverriding_local_map applies to the menu bar. */
293 Lisp_Object Voverriding_local_map_menu_flag
;
295 /* Keymap that defines special misc events that should
296 be processed immediately at a low level. */
297 Lisp_Object Vspecial_event_map
;
299 /* Current depth in recursive edits. */
300 int command_loop_level
;
302 /* Total number of times command_loop has read a key sequence. */
303 EMACS_INT num_input_keys
;
305 /* Last input character read as a command. */
306 Lisp_Object last_command_char
;
308 /* Last input character read as a command, not counting menus
309 reached by the mouse. */
310 Lisp_Object last_nonmenu_event
;
312 /* Last input character read for any purpose. */
313 Lisp_Object last_input_char
;
315 /* If not Qnil, a list of objects to be read as subsequent command input. */
316 Lisp_Object Vunread_command_events
;
318 /* If not Qnil, a list of objects to be read as subsequent command input
319 including input method processing. */
320 Lisp_Object Vunread_input_method_events
;
322 /* If not Qnil, a list of objects to be read as subsequent command input
323 but NOT including input method processing. */
324 Lisp_Object Vunread_post_input_method_events
;
326 /* If not -1, an event to be read as subsequent command input. */
327 EMACS_INT unread_command_char
;
329 /* If not Qnil, this is a switch-frame event which we decided to put
330 off until the end of a key sequence. This should be read as the
331 next command input, after any unread_command_events.
333 read_key_sequence uses this to delay switch-frame events until the
334 end of the key sequence; Fread_char uses it to put off switch-frame
335 events until a non-ASCII event is acceptable as input. */
336 Lisp_Object unread_switch_frame
;
338 /* A mask of extra modifier bits to put into every keyboard char. */
339 EMACS_INT extra_keyboard_modifiers
;
341 /* Char to use as prefix when a meta character is typed in.
342 This is bound on entry to minibuffer in case ESC is changed there. */
344 Lisp_Object meta_prefix_char
;
346 /* Last size recorded for a current buffer which is not a minibuffer. */
347 static int last_non_minibuf_size
;
349 /* Number of idle seconds before an auto-save and garbage collection. */
350 static Lisp_Object Vauto_save_timeout
;
352 /* Total number of times read_char has returned. */
353 int num_input_events
;
355 /* Total number of times read_char has returned, outside of macros. */
356 EMACS_INT num_nonmacro_input_events
;
358 /* Auto-save automatically when this many characters have been typed
359 since the last time. */
361 static EMACS_INT auto_save_interval
;
363 /* Value of num_nonmacro_input_events as of last auto save. */
367 /* The command being executed by the command loop.
368 Commands may set this, and the value set will be copied into
369 current_kboard->Vlast_command instead of the actual command. */
370 Lisp_Object Vthis_command
;
372 /* This is like Vthis_command, except that commands never set it. */
373 Lisp_Object real_this_command
;
375 /* If the lookup of the command returns a binding, the original
376 command is stored in this-original-command. It is nil otherwise. */
377 Lisp_Object Vthis_original_command
;
379 /* The value of point when the last command was executed. */
380 int last_point_position
;
382 /* The buffer that was current when the last command was started. */
383 Lisp_Object last_point_position_buffer
;
385 /* The frame in which the last input event occurred, or Qmacro if the
386 last event came from a macro. We use this to determine when to
387 generate switch-frame events. This may be cleared by functions
388 like Fselect_frame, to make sure that a switch-frame event is
389 generated by the next character. */
390 Lisp_Object internal_last_event_frame
;
392 /* A user-visible version of the above, intended to allow users to
393 figure out where the last event came from, if the event doesn't
394 carry that information itself (i.e. if it was a character). */
395 Lisp_Object Vlast_event_frame
;
397 /* The timestamp of the last input event we received from the X server.
398 X Windows wants this for selection ownership. */
399 unsigned long last_event_timestamp
;
401 Lisp_Object Qself_insert_command
;
402 Lisp_Object Qforward_char
;
403 Lisp_Object Qbackward_char
;
404 Lisp_Object Qundefined
;
405 Lisp_Object Qtimer_event_handler
;
407 /* read_key_sequence stores here the command definition of the
408 key sequence that it reads. */
409 Lisp_Object read_key_sequence_cmd
;
411 /* Echo unfinished commands after this many seconds of pause. */
412 Lisp_Object Vecho_keystrokes
;
414 /* Form to evaluate (if non-nil) when Emacs is started. */
415 Lisp_Object Vtop_level
;
417 /* User-supplied table to translate input characters. */
418 Lisp_Object Vkeyboard_translate_table
;
420 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
421 extern Lisp_Object Vfunction_key_map
;
423 /* Another keymap that maps key sequences into key sequences.
424 This one takes precedence over ordinary definitions. */
425 extern Lisp_Object Vkey_translation_map
;
427 /* If non-nil, this implements the current input method. */
428 Lisp_Object Vinput_method_function
;
429 Lisp_Object Qinput_method_function
;
431 /* When we call Vinput_method_function,
432 this holds the echo area message that was just erased. */
433 Lisp_Object Vinput_method_previous_message
;
435 /* Non-nil means deactivate the mark at end of this command. */
436 Lisp_Object Vdeactivate_mark
;
438 /* Menu bar specified in Lucid Emacs fashion. */
440 Lisp_Object Vlucid_menu_bar_dirty_flag
;
441 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
443 Lisp_Object Qecho_area_clear_hook
;
445 /* Hooks to run before and after each command. */
446 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
447 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
448 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
449 /* Hook run after a command if there's no more input soon. */
450 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
452 /* Delay time in microseconds before running post-command-idle-hook. */
453 EMACS_INT post_command_idle_delay
;
455 /* List of deferred actions to be performed at a later time.
456 The precise format isn't relevant here; we just check whether it is nil. */
457 Lisp_Object Vdeferred_action_list
;
459 /* Function to call to handle deferred actions, when there are any. */
460 Lisp_Object Vdeferred_action_function
;
461 Lisp_Object Qdeferred_action_function
;
463 Lisp_Object Qinput_method_exit_on_first_char
;
464 Lisp_Object Qinput_method_use_echo_area
;
466 /* File in which we write all commands we read. */
469 /* Nonzero if input is available. */
472 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
473 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
477 /* Non-zero means force key bindings update in parse_menu_item. */
479 int update_menu_bindings
;
481 extern char *pending_malloc_warning
;
483 /* Circular buffer for pre-read keyboard input. */
485 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
487 /* Pointer to next available character in kbd_buffer.
488 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
489 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
490 next available char is in kbd_buffer[0]. */
491 static struct input_event
*kbd_fetch_ptr
;
493 /* Pointer to next place to store character in kbd_buffer. This
494 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
495 character should go in kbd_buffer[0]. */
496 static struct input_event
* volatile kbd_store_ptr
;
498 /* The above pair of variables forms a "queue empty" flag. When we
499 enqueue a non-hook event, we increment kbd_store_ptr. When we
500 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
501 there is input available iff the two pointers are not equal.
503 Why not just have a flag set and cleared by the enqueuing and
504 dequeuing functions? Such a flag could be screwed up by interrupts
505 at inopportune times. */
507 /* If this flag is non-nil, we check mouse_moved to see when the
508 mouse moves, and motion events will appear in the input stream.
509 Otherwise, mouse motion is ignored. */
510 Lisp_Object do_mouse_tracking
;
512 /* Symbols to head events. */
513 Lisp_Object Qmouse_movement
;
514 Lisp_Object Qscroll_bar_movement
;
515 Lisp_Object Qswitch_frame
;
516 Lisp_Object Qdelete_frame
;
517 Lisp_Object Qiconify_frame
;
518 Lisp_Object Qmake_frame_visible
;
519 Lisp_Object Qselect_window
;
520 Lisp_Object Qhelp_echo
;
522 /* Symbols to denote kinds of events. */
523 Lisp_Object Qfunction_key
;
524 Lisp_Object Qmouse_click
;
526 Lisp_Object Qlanguage_change
;
528 Lisp_Object Qdrag_n_drop
;
529 Lisp_Object Qsave_session
;
531 /* Lisp_Object Qmouse_movement; - also an event header */
533 /* Properties of event headers. */
534 Lisp_Object Qevent_kind
;
535 Lisp_Object Qevent_symbol_elements
;
537 /* menu item parts */
538 Lisp_Object Qmenu_alias
;
539 Lisp_Object Qmenu_enable
;
540 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
541 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
542 extern Lisp_Object Vdefine_key_rebound_commands
;
543 extern Lisp_Object Qmenu_item
;
545 /* An event header symbol HEAD may have a property named
546 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
547 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
548 mask of modifiers applied to it. If present, this is used to help
549 speed up parse_modifiers. */
550 Lisp_Object Qevent_symbol_element_mask
;
552 /* An unmodified event header BASE may have a property named
553 Qmodifier_cache, which is an alist mapping modifier masks onto
554 modified versions of BASE. If present, this helps speed up
556 Lisp_Object Qmodifier_cache
;
558 /* Symbols to use for parts of windows. */
559 Lisp_Object Qmode_line
;
560 Lisp_Object Qvertical_line
;
561 Lisp_Object Qvertical_scroll_bar
;
562 Lisp_Object Qmenu_bar
;
563 extern Lisp_Object Qleft_margin
, Qright_margin
;
564 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
565 extern Lisp_Object QCmap
;
567 Lisp_Object
recursive_edit_unwind (), command_loop ();
568 Lisp_Object
Fthis_command_keys ();
569 Lisp_Object Qextended_command_history
;
570 EMACS_TIME
timer_check ();
572 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
574 extern char *x_get_keysym_name ();
576 static void record_menu_key ();
577 static int echo_length ();
579 Lisp_Object Qpolling_period
;
581 /* List of absolute timers. Appears in order of next scheduled event. */
582 Lisp_Object Vtimer_list
;
584 /* List of idle time timers. Appears in order of next scheduled event. */
585 Lisp_Object Vtimer_idle_list
;
587 /* Incremented whenever a timer is run. */
590 extern Lisp_Object Vprint_level
, Vprint_length
;
592 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
594 EMACS_TIME
*input_available_clear_time
;
596 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
597 Default is 1 if INTERRUPT_INPUT is defined. */
600 /* Nonzero while interrupts are temporarily deferred during redisplay. */
601 int interrupts_deferred
;
603 /* Nonzero means use ^S/^Q for flow control. */
606 /* Allow m- file to inhibit use of FIONREAD. */
607 #ifdef BROKEN_FIONREAD
611 /* We are unable to use interrupts if FIONREAD is not available,
612 so flush SIGIO so we won't try. */
613 #if !defined (FIONREAD)
619 /* If we support a window system, turn on the code to poll periodically
620 to detect C-g. It isn't actually used when doing interrupt input. */
621 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
622 #define POLL_FOR_INPUT
625 /* After a command is executed, if point is moved into a region that
626 has specific properties (e.g. composition, display), we adjust
627 point to the boundary of the region. But, if a command sets this
628 variable to non-nil, we suppress this point adjustment. This
629 variable is set to nil before reading a command. */
631 Lisp_Object Vdisable_point_adjustment
;
633 /* If non-nil, always disable point adjustment. */
635 Lisp_Object Vglobal_disable_point_adjustment
;
637 /* The time when Emacs started being idle. */
639 static EMACS_TIME timer_idleness_start_time
;
641 /* After Emacs stops being idle, this saves the last value
642 of timer_idleness_start_time from when it was idle. */
644 static EMACS_TIME timer_last_idleness_start_time
;
647 /* Global variable declarations. */
649 /* Function for init_keyboard to call with no args (if nonzero). */
650 void (*keyboard_init_hook
) ();
652 static int read_avail_input
P_ ((int));
653 static void get_input_pending
P_ ((int *, int));
654 static void get_filtered_input_pending
P_ ((int *, int, int));
655 static int readable_events
P_ ((int));
656 static int readable_filtered_events
P_ ((int, int));
657 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
658 Lisp_Object
, int *));
659 static Lisp_Object
read_char_x_menu_prompt ();
660 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
662 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
664 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
665 enum scroll_bar_part
,
666 Lisp_Object
, Lisp_Object
,
669 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
670 Lisp_Object
, char **,
671 Lisp_Object
*, unsigned));
672 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
673 static int parse_solitary_modifier
P_ ((Lisp_Object
));
674 static int parse_solitary_modifier ();
675 static void save_getcjmp
P_ ((jmp_buf));
676 static void save_getcjmp ();
677 static void restore_getcjmp
P_ ((jmp_buf));
678 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
679 static void clear_event
P_ ((struct input_event
*));
680 static void any_kboard_state
P_ ((void));
681 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
682 static void timer_start_idle
P_ ((void));
683 static void timer_stop_idle
P_ ((void));
684 static void timer_resume_idle
P_ ((void));
686 /* Nonzero means don't try to suspend even if the operating system seems
688 static int cannot_suspend
;
690 extern Lisp_Object Qidentity
, Qonly
;
692 /* Install the string STR as the beginning of the string of echoing,
693 so that it serves as a prompt for the next character.
694 Also start echoing. */
700 current_kboard
->echo_string
= str
;
701 current_kboard
->echo_after_prompt
= SCHARS (str
);
705 /* Add C to the echo string, if echoing is going on.
706 C can be a character, which is printed prettily ("M-C-x" and all that
707 jazz), or a symbol, whose name is printed. */
713 if (current_kboard
->immediate_echo
)
715 int size
= KEY_DESCRIPTION_SIZE
+ 100;
716 char *buffer
= (char *) alloca (size
);
718 Lisp_Object echo_string
;
720 echo_string
= current_kboard
->echo_string
;
722 /* If someone has passed us a composite event, use its head symbol. */
727 ptr
= push_key_description (XINT (c
), ptr
, 1);
729 else if (SYMBOLP (c
))
731 Lisp_Object name
= SYMBOL_NAME (c
);
732 int nbytes
= SBYTES (name
);
734 if (size
- (ptr
- buffer
) < nbytes
)
736 int offset
= ptr
- buffer
;
737 size
= max (2 * size
, size
+ nbytes
);
738 buffer
= (char *) alloca (size
);
739 ptr
= buffer
+ offset
;
742 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
743 STRING_MULTIBYTE (name
), 1);
746 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
749 const char *text
= " (Type ? for further options)";
750 int len
= strlen (text
);
752 if (size
- (ptr
- buffer
) < len
)
754 int offset
= ptr
- buffer
;
756 buffer
= (char *) alloca (size
);
757 ptr
= buffer
+ offset
;
760 bcopy (text
, ptr
, len
);
764 /* Replace a dash from echo_dash with a space, otherwise
765 add a space at the end as a separator between keys. */
766 if (STRINGP (echo_string
)
767 && SCHARS (echo_string
) > 1)
769 Lisp_Object last_char
, prev_char
, idx
;
771 idx
= make_number (SCHARS (echo_string
) - 2);
772 prev_char
= Faref (echo_string
, idx
);
774 idx
= make_number (SCHARS (echo_string
) - 1);
775 last_char
= Faref (echo_string
, idx
);
777 /* We test PREV_CHAR to make sure this isn't the echoing
779 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
780 Faset (echo_string
, idx
, make_number (' '));
782 echo_string
= concat2 (echo_string
, build_string (" "));
785 current_kboard
->echo_string
786 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
792 /* Temporarily add a dash to the end of the echo string if it's not
793 empty, so that it serves as a mini-prompt for the very next character. */
798 /* Do nothing if not echoing at all. */
799 if (NILP (current_kboard
->echo_string
))
802 if (!current_kboard
->immediate_echo
803 && SCHARS (current_kboard
->echo_string
) == 0)
806 /* Do nothing if we just printed a prompt. */
807 if (current_kboard
->echo_after_prompt
808 == SCHARS (current_kboard
->echo_string
))
811 /* Do nothing if we have already put a dash at the end. */
812 if (SCHARS (current_kboard
->echo_string
) > 1)
814 Lisp_Object last_char
, prev_char
, idx
;
816 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
817 prev_char
= Faref (current_kboard
->echo_string
, idx
);
819 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
820 last_char
= Faref (current_kboard
->echo_string
, idx
);
822 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
826 /* Put a dash at the end of the buffer temporarily,
827 but make it go away when the next character is added. */
828 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
833 /* Display the current echo string, and begin echoing if not already
839 if (!current_kboard
->immediate_echo
)
842 current_kboard
->immediate_echo
= 1;
844 for (i
= 0; i
< this_command_key_count
; i
++)
848 /* Set before_command_echo_length to the value that would
849 have been saved before the start of this subcommand in
850 command_loop_1, if we had already been echoing then. */
851 if (i
== this_single_command_key_start
)
852 before_command_echo_length
= echo_length ();
854 c
= XVECTOR (this_command_keys
)->contents
[i
];
855 if (! (EVENT_HAS_PARAMETERS (c
)
856 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
860 /* Set before_command_echo_length to the value that would
861 have been saved before the start of this subcommand in
862 command_loop_1, if we had already been echoing then. */
863 if (this_command_key_count
== this_single_command_key_start
)
864 before_command_echo_length
= echo_length ();
866 /* Put a dash at the end to invite the user to type more. */
871 message3_nolog (current_kboard
->echo_string
,
872 SBYTES (current_kboard
->echo_string
),
873 STRING_MULTIBYTE (current_kboard
->echo_string
));
876 /* Record in what buffer we echoed, and from which kboard. */
877 echo_message_buffer
= echo_area_buffer
[0];
878 echo_kboard
= current_kboard
;
880 if (waiting_for_input
&& !NILP (Vquit_flag
))
881 quit_throw_to_read_char ();
884 /* Turn off echoing, for the start of a new command. */
889 current_kboard
->immediate_echo
= 0;
890 current_kboard
->echo_after_prompt
= -1;
891 current_kboard
->echo_string
= Qnil
;
892 ok_to_echo_at_next_pause
= NULL
;
894 echo_message_buffer
= Qnil
;
897 /* Return the length of the current echo string. */
902 return (STRINGP (current_kboard
->echo_string
)
903 ? SCHARS (current_kboard
->echo_string
)
907 /* Truncate the current echo message to its first LEN chars.
908 This and echo_char get used by read_key_sequence when the user
909 switches frames while entering a key sequence. */
912 echo_truncate (nchars
)
915 if (STRINGP (current_kboard
->echo_string
))
916 current_kboard
->echo_string
917 = Fsubstring (current_kboard
->echo_string
,
918 make_number (0), make_number (nchars
));
919 truncate_echo_area (nchars
);
923 /* Functions for manipulating this_command_keys. */
925 add_command_key (key
)
928 #if 0 /* Not needed after we made Freset_this_command_lengths
929 do the job immediately. */
930 /* If reset-this-command-length was called recently, obey it now.
931 See the doc string of that function for an explanation of why. */
932 if (before_command_restore_flag
)
934 this_command_key_count
= before_command_key_count_1
;
935 if (this_command_key_count
< this_single_command_key_start
)
936 this_single_command_key_start
= this_command_key_count
;
937 echo_truncate (before_command_echo_length_1
);
938 before_command_restore_flag
= 0;
942 if (this_command_key_count
>= ASIZE (this_command_keys
))
943 this_command_keys
= larger_vector (this_command_keys
,
944 2 * ASIZE (this_command_keys
),
947 AREF (this_command_keys
, this_command_key_count
) = key
;
948 ++this_command_key_count
;
955 int count
= SPECPDL_INDEX ();
958 if (command_loop_level
> 0)
960 specbind (Qstandard_output
, Qt
);
961 specbind (Qstandard_input
, Qt
);
964 #ifdef HAVE_X_WINDOWS
965 /* The command loop has started an hourglass timer, so we have to
966 cancel it here, otherwise it will fire because the recursive edit
967 can take some time. Do not check for display_hourglass_p here,
968 because it could already be nil. */
972 /* This function may have been called from a debugger called from
973 within redisplay, for instance by Edebugging a function called
974 from fontification-functions. We want to allow redisplay in
975 the debugging session.
977 The recursive edit is left with a `(throw exit ...)'. The `exit'
978 tag is not caught anywhere in redisplay, i.e. when we leave the
979 recursive edit, the original redisplay leading to the recursive
980 edit will be unwound. The outcome should therefore be safe. */
981 specbind (Qinhibit_redisplay
, Qnil
);
984 val
= command_loop ();
986 Fsignal (Qquit
, Qnil
);
987 /* Handle throw from read_minibuf when using minibuffer
988 while it's active but we're in another window. */
990 Fsignal (Qerror
, Fcons (val
, Qnil
));
992 return unbind_to (count
, Qnil
);
995 /* When an auto-save happens, record the "time", and don't do again soon. */
1000 last_auto_save
= num_nonmacro_input_events
;
1003 /* Make an auto save happen as soon as possible at command level. */
1006 force_auto_save_soon ()
1008 last_auto_save
= - auto_save_interval
- 1;
1010 record_asynch_buffer_change ();
1013 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1014 doc
: /* Invoke the editor command loop recursively.
1015 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1016 that tells this function to return.
1017 Alternately, `(throw 'exit t)' makes this function signal an error.
1018 This function is called by the editor initialization to begin editing. */)
1021 int count
= SPECPDL_INDEX ();
1024 /* If we enter while input is blocked, don't lock up here.
1025 This may happen through the debugger during redisplay. */
1026 if (INPUT_BLOCKED_P
)
1029 command_loop_level
++;
1030 update_mode_lines
= 1;
1032 if (command_loop_level
1033 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1034 buffer
= Fcurrent_buffer ();
1038 /* If we leave recursive_edit_1 below with a `throw' for instance,
1039 like it is done in the splash screen display, we have to
1040 make sure that we restore single_kboard as command_loop_1
1041 would have done if it were left normally. */
1042 record_unwind_protect (recursive_edit_unwind
,
1043 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1045 recursive_edit_1 ();
1046 return unbind_to (count
, Qnil
);
1050 recursive_edit_unwind (info
)
1053 if (BUFFERP (XCAR (info
)))
1054 Fset_buffer (XCAR (info
));
1056 if (NILP (XCDR (info
)))
1057 any_kboard_state ();
1059 single_kboard_state ();
1061 command_loop_level
--;
1062 update_mode_lines
= 1;
1071 #if 0 /* Theory: if there's anything in Vunread_command_events,
1072 it will right away be read by read_key_sequence,
1073 and then if we do switch KBOARDS, it will go into the side
1074 queue then. So we don't need to do anything special here -- rms. */
1075 if (CONSP (Vunread_command_events
))
1077 current_kboard
->kbd_queue
1078 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1079 current_kboard
->kbd_queue_has_data
= 1;
1081 Vunread_command_events
= Qnil
;
1087 /* Switch to the single-kboard state, making current_kboard
1088 the only KBOARD from which further input is accepted. */
1091 single_kboard_state ()
1098 /* If we're in single_kboard state for kboard KBOARD,
1102 not_single_kboard_state (kboard
)
1106 if (kboard
== current_kboard
)
1111 /* Maintain a stack of kboards, so other parts of Emacs
1112 can switch temporarily to the kboard of a given frame
1113 and then revert to the previous status. */
1118 struct kboard_stack
*next
;
1121 static struct kboard_stack
*kboard_stack
;
1124 push_frame_kboard (f
)
1128 struct kboard_stack
*p
1129 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1131 p
->next
= kboard_stack
;
1132 p
->kboard
= current_kboard
;
1135 current_kboard
= FRAME_KBOARD (f
);
1143 struct kboard_stack
*p
= kboard_stack
;
1144 current_kboard
= p
->kboard
;
1145 kboard_stack
= p
->next
;
1150 /* Handle errors that are not handled at inner levels
1151 by printing an error message and returning to the editor command loop. */
1157 Lisp_Object old_level
, old_length
;
1158 char macroerror
[50];
1160 #ifdef HAVE_X_WINDOWS
1161 if (display_hourglass_p
)
1162 cancel_hourglass ();
1165 if (!NILP (executing_macro
))
1167 if (executing_macro_iterations
== 1)
1168 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1170 sprintf (macroerror
, "After %d kbd macro iterations: ",
1171 executing_macro_iterations
);
1176 Vstandard_output
= Qt
;
1177 Vstandard_input
= Qt
;
1178 Vexecuting_macro
= Qnil
;
1179 executing_macro
= Qnil
;
1180 current_kboard
->Vprefix_arg
= Qnil
;
1181 current_kboard
->Vlast_prefix_arg
= Qnil
;
1184 /* Avoid unquittable loop if data contains a circular list. */
1185 old_level
= Vprint_level
;
1186 old_length
= Vprint_length
;
1187 XSETFASTINT (Vprint_level
, 10);
1188 XSETFASTINT (Vprint_length
, 10);
1189 cmd_error_internal (data
, macroerror
);
1190 Vprint_level
= old_level
;
1191 Vprint_length
= old_length
;
1195 Vinhibit_quit
= Qnil
;
1197 if (command_loop_level
== 0 && minibuf_level
== 0)
1198 any_kboard_state ();
1201 return make_number (0);
1204 /* Take actions on handling an error. DATA is the data that describes
1207 CONTEXT is a C-string containing ASCII characters only which
1208 describes the context in which the error happened. If we need to
1209 generalize CONTEXT to allow multibyte characters, make it a Lisp
1213 cmd_error_internal (data
, context
)
1218 int kill_emacs_p
= 0;
1219 struct frame
*sf
= SELECTED_FRAME ();
1223 clear_message (1, 0);
1225 /* If the window system or terminal frame hasn't been initialized
1226 yet, or we're not interactive, it's best to dump this message out
1227 to stderr and exit. */
1228 if (!sf
->glyphs_initialized_p
1229 /* This is the case of the frame dumped with Emacs, when we're
1230 running under a window system. */
1231 || (!NILP (Vwindow_system
)
1232 && !inhibit_window_system
1233 && FRAME_TERMCAP_P (sf
))
1236 stream
= Qexternal_debugging_output
;
1242 message_log_maybe_newline ();
1247 /* The immediate context is not interesting for Quits,
1248 since they are asyncronous. */
1249 if (EQ (XCAR (data
), Qquit
))
1250 Vsignaling_function
= Qnil
;
1252 print_error_message (data
, stream
, context
, Vsignaling_function
);
1254 Vsignaling_function
= Qnil
;
1256 /* If the window system or terminal frame hasn't been initialized
1257 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1261 Fkill_emacs (make_number (-1));
1265 Lisp_Object
command_loop_1 ();
1266 Lisp_Object
command_loop_2 ();
1267 Lisp_Object
top_level_1 ();
1269 /* Entry to editor-command-loop.
1270 This level has the catches for exiting/returning to editor command loop.
1271 It returns nil to exit recursive edit, t to abort it. */
1276 if (command_loop_level
> 0 || minibuf_level
> 0)
1279 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1280 executing_macro
= Qnil
;
1286 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1287 /* Reset single_kboard in case top-level set it while
1288 evaluating an -f option, or we are stuck there for some
1290 any_kboard_state ();
1291 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1292 executing_macro
= Qnil
;
1294 /* End of file in -batch run causes exit here. */
1300 /* Here we catch errors in execution of commands within the
1301 editing loop, and reenter the editing loop.
1302 When there is an error, cmd_error runs and returns a non-nil
1303 value to us. A value of nil means that command_loop_1 itself
1304 returned due to end of file (or end of kbd macro). */
1309 register Lisp_Object val
;
1312 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1313 while (!NILP (val
));
1321 return Feval (Vtop_level
);
1327 /* On entry to the outer level, run the startup file */
1328 if (!NILP (Vtop_level
))
1329 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1330 else if (!NILP (Vpurify_flag
))
1331 message ("Bare impure Emacs (standard Lisp code not loaded)");
1333 message ("Bare Emacs (standard Lisp code not loaded)");
1337 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1338 doc
: /* Exit all recursive editing levels. */)
1341 #ifdef HAVE_X_WINDOWS
1342 if (display_hourglass_p
)
1343 cancel_hourglass ();
1346 /* Unblock input if we enter with input blocked. This may happen if
1347 redisplay traps e.g. during tool-bar update with input blocked. */
1348 while (INPUT_BLOCKED_P
)
1351 return Fthrow (Qtop_level
, Qnil
);
1354 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1355 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1358 if (command_loop_level
> 0 || minibuf_level
> 0)
1359 Fthrow (Qexit
, Qnil
);
1361 error ("No recursive edit is in progress");
1365 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1366 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1369 if (command_loop_level
> 0 || minibuf_level
> 0)
1372 error ("No recursive edit is in progress");
1376 /* This is the actual command reading loop,
1377 sans error-handling encapsulation. */
1379 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1381 void safe_run_hooks
P_ ((Lisp_Object
));
1382 static void adjust_point_for_property
P_ ((int, int));
1384 /* Cancel hourglass from protect_unwind.
1386 #ifdef HAVE_X_WINDOWS
1388 cancel_hourglass_unwind (arg
)
1391 cancel_hourglass ();
1402 Lisp_Object keybuf
[30];
1406 struct buffer
*prev_buffer
= NULL
;
1408 int was_locked
= single_kboard
;
1410 int already_adjusted
;
1412 current_kboard
->Vprefix_arg
= Qnil
;
1413 current_kboard
->Vlast_prefix_arg
= Qnil
;
1414 Vdeactivate_mark
= Qnil
;
1415 waiting_for_input
= 0;
1419 this_command_key_count
= 0;
1420 this_command_key_count_reset
= 0;
1421 this_single_command_key_start
= 0;
1423 if (NILP (Vmemory_full
))
1425 /* Make sure this hook runs after commands that get errors and
1426 throw to top level. */
1427 /* Note that the value cell will never directly contain nil
1428 if the symbol is a local variable. */
1429 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1430 safe_run_hooks (Qpost_command_hook
);
1432 /* If displaying a message, resize the echo area window to fit
1433 that message's size exactly. */
1434 if (!NILP (echo_area_buffer
[0]))
1435 resize_echo_area_exactly ();
1437 if (!NILP (Vdeferred_action_list
))
1438 call0 (Vdeferred_action_function
);
1440 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1442 if (NILP (Vunread_command_events
)
1443 && NILP (Vunread_input_method_events
)
1444 && NILP (Vunread_post_input_method_events
)
1445 && NILP (Vexecuting_macro
)
1446 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1447 safe_run_hooks (Qpost_command_idle_hook
);
1451 Vmemory_full
= Qnil
;
1453 /* Do this after running Vpost_command_hook, for consistency. */
1454 current_kboard
->Vlast_command
= Vthis_command
;
1455 current_kboard
->Vreal_last_command
= real_this_command
;
1459 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1462 /* Make sure the current window's buffer is selected. */
1463 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1464 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1466 /* Display any malloc warning that just came out. Use while because
1467 displaying one warning can cause another. */
1469 while (pending_malloc_warning
)
1470 display_malloc_warning ();
1474 Vdeactivate_mark
= Qnil
;
1476 /* If minibuffer on and echo area in use,
1477 wait a short time and redraw minibuffer. */
1480 && !NILP (echo_area_buffer
[0])
1481 && EQ (minibuf_window
, echo_area_window
)
1482 && NUMBERP (Vminibuffer_message_timeout
))
1484 /* Bind inhibit-quit to t so that C-g gets read in
1485 rather than quitting back to the minibuffer. */
1486 int count
= SPECPDL_INDEX ();
1487 specbind (Qinhibit_quit
, Qt
);
1489 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1490 /* Clear the echo area. */
1492 safe_run_hooks (Qecho_area_clear_hook
);
1494 unbind_to (count
, Qnil
);
1496 /* If a C-g came in before, treat it as input now. */
1497 if (!NILP (Vquit_flag
))
1500 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1505 alloca (0); /* Cause a garbage collection now */
1506 /* Since we can free the most stuff here. */
1507 #endif /* C_ALLOCA */
1510 /* Select the frame that the last event came from. Usually,
1511 switch-frame events will take care of this, but if some lisp
1512 code swallows a switch-frame event, we'll fix things up here.
1513 Is this a good idea? */
1514 if (FRAMEP (internal_last_event_frame
)
1515 && !EQ (internal_last_event_frame
, selected_frame
))
1516 Fselect_frame (internal_last_event_frame
, Qnil
);
1518 /* If it has changed current-menubar from previous value,
1519 really recompute the menubar from the value. */
1520 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1521 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1522 call0 (Qrecompute_lucid_menubar
);
1524 before_command_key_count
= this_command_key_count
;
1525 before_command_echo_length
= echo_length ();
1527 Vthis_command
= Qnil
;
1528 real_this_command
= Qnil
;
1530 /* Read next key sequence; i gets its length. */
1531 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1534 /* A filter may have run while we were reading the input. */
1535 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1537 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1538 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1542 /* Now we have read a key sequence of length I,
1543 or else I is 0 and we found end of file. */
1545 if (i
== 0) /* End of file -- happens only in */
1546 return Qnil
; /* a kbd macro, at the end. */
1547 /* -1 means read_key_sequence got a menu that was rejected.
1548 Just loop around and read another command. */
1552 this_command_key_count
= 0;
1553 this_command_key_count_reset
= 0;
1554 this_single_command_key_start
= 0;
1558 last_command_char
= keybuf
[i
- 1];
1560 /* If the previous command tried to force a specific window-start,
1561 forget about that, in case this command moves point far away
1562 from that position. But also throw away beg_unchanged and
1563 end_unchanged information in that case, so that redisplay will
1564 update the whole window properly. */
1565 if (!NILP (XWINDOW (selected_window
)->force_start
))
1568 XWINDOW (selected_window
)->force_start
= Qnil
;
1569 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1570 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1573 cmd
= read_key_sequence_cmd
;
1574 if (!NILP (Vexecuting_macro
))
1576 if (!NILP (Vquit_flag
))
1578 Vexecuting_macro
= Qt
;
1579 QUIT
; /* Make some noise. */
1580 /* Will return since macro now empty. */
1584 /* Do redisplay processing after this command except in special
1585 cases identified below. */
1586 prev_buffer
= current_buffer
;
1587 prev_modiff
= MODIFF
;
1588 last_point_position
= PT
;
1589 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1591 /* By default, we adjust point to a boundary of a region that
1592 has such a property that should be treated intangible
1593 (e.g. composition, display). But, some commands will set
1594 this variable differently. */
1595 Vdisable_point_adjustment
= Qnil
;
1597 /* Process filters and timers may have messed with deactivate-mark.
1598 reset it before we execute the command. */
1599 Vdeactivate_mark
= Qnil
;
1601 /* Remap command through active keymaps */
1602 Vthis_original_command
= cmd
;
1606 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1610 /* Execute the command. */
1612 Vthis_command
= cmd
;
1613 real_this_command
= cmd
;
1614 /* Note that the value cell will never directly contain nil
1615 if the symbol is a local variable. */
1616 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1617 safe_run_hooks (Qpre_command_hook
);
1619 already_adjusted
= 0;
1621 if (NILP (Vthis_command
))
1623 /* nil means key is undefined. */
1624 Lisp_Object keys
= Fvector (i
, keybuf
);
1625 keys
= Fkey_description (keys
, Qnil
);
1627 message_with_string ("%s is undefined", keys
, 0);
1628 current_kboard
->defining_kbd_macro
= Qnil
;
1629 update_mode_lines
= 1;
1630 current_kboard
->Vprefix_arg
= Qnil
;
1634 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1636 /* In case we jump to directly_done. */
1637 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1639 /* Recognize some common commands in common situations and
1640 do them directly. */
1641 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1643 struct Lisp_Char_Table
*dp
1644 = window_display_table (XWINDOW (selected_window
));
1645 lose
= FETCH_CHAR (PT_BYTE
);
1647 if (! NILP (Vpost_command_hook
))
1648 /* Put this before calling adjust_point_for_property
1649 so it will only get called once in any case. */
1651 if (current_buffer
== prev_buffer
1652 && last_point_position
!= PT
1653 && NILP (Vdisable_point_adjustment
)
1654 && NILP (Vglobal_disable_point_adjustment
))
1655 adjust_point_for_property (last_point_position
, 0);
1656 already_adjusted
= 1;
1657 if (PT
== last_point_position
+ 1
1659 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1660 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1661 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1662 && (lose
>= 0x20 && lose
< 0x7f)))
1663 : (lose
>= 0x20 && lose
< 0x7f))
1664 /* To extract the case of continuation on
1665 wide-column characters. */
1666 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1667 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1669 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1671 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1673 && !windows_or_buffers_changed
1674 && EQ (current_buffer
->selective_display
, Qnil
)
1675 && !detect_input_pending ()
1676 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1677 && NILP (Vexecuting_macro
))
1678 direct_output_forward_char (1);
1681 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1683 struct Lisp_Char_Table
*dp
1684 = window_display_table (XWINDOW (selected_window
));
1686 lose
= FETCH_CHAR (PT_BYTE
);
1687 if (! NILP (Vpost_command_hook
))
1689 if (current_buffer
== prev_buffer
1690 && last_point_position
!= PT
1691 && NILP (Vdisable_point_adjustment
)
1692 && NILP (Vglobal_disable_point_adjustment
))
1693 adjust_point_for_property (last_point_position
, 0);
1694 already_adjusted
= 1;
1695 if (PT
== last_point_position
- 1
1697 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1698 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1699 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1700 && (lose
>= 0x20 && lose
< 0x7f)))
1701 : (lose
>= 0x20 && lose
< 0x7f))
1702 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1704 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1706 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1708 && !windows_or_buffers_changed
1709 && EQ (current_buffer
->selective_display
, Qnil
)
1710 && !detect_input_pending ()
1711 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1712 && NILP (Vexecuting_macro
))
1713 direct_output_forward_char (-1);
1716 else if (EQ (Vthis_command
, Qself_insert_command
)
1717 /* Try this optimization only on char keystrokes. */
1718 && NATNUMP (last_command_char
)
1719 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1722 = translate_char (Vtranslation_table_for_input
,
1723 XFASTINT (last_command_char
), 0, 0, 0);
1725 if (NILP (Vexecuting_macro
)
1726 && !EQ (minibuf_window
, selected_window
))
1728 if (!nonundocount
|| nonundocount
>= 20)
1736 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1738 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1740 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1742 || MODIFF
<= SAVE_MODIFF
1743 || windows_or_buffers_changed
1744 || !EQ (current_buffer
->selective_display
, Qnil
)
1745 || detect_input_pending ()
1746 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1747 || !NILP (Vexecuting_macro
));
1749 value
= internal_self_insert (c
, 0);
1754 if (! NILP (Vpost_command_hook
))
1755 /* Put this before calling adjust_point_for_property
1756 so it will only get called once in any case. */
1759 /* VALUE == 1 when AFTER-CHANGE functions are
1760 installed which is the case most of the time
1761 because FONT-LOCK installs one. */
1762 if (!lose
&& !value
)
1763 direct_output_for_insert (c
);
1768 /* Here for a command that isn't executed directly */
1771 #ifdef HAVE_X_WINDOWS
1772 int scount
= SPECPDL_INDEX ();
1774 if (display_hourglass_p
1775 && NILP (Vexecuting_macro
))
1777 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1783 if (NILP (current_kboard
->Vprefix_arg
))
1785 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1787 #ifdef HAVE_X_WINDOWS
1788 /* Do not check display_hourglass_p here, because
1789 Fcommand_execute could change it, but we should cancel
1790 hourglass cursor anyway.
1791 But don't cancel the hourglass within a macro
1792 just because a command in the macro finishes. */
1793 if (NILP (Vexecuting_macro
))
1794 unbind_to (scount
, Qnil
);
1799 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1801 /* Note that the value cell will never directly contain nil
1802 if the symbol is a local variable. */
1803 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1804 safe_run_hooks (Qpost_command_hook
);
1806 /* If displaying a message, resize the echo area window to fit
1807 that message's size exactly. */
1808 if (!NILP (echo_area_buffer
[0]))
1809 resize_echo_area_exactly ();
1811 if (!NILP (Vdeferred_action_list
))
1812 safe_run_hooks (Qdeferred_action_function
);
1814 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1816 if (NILP (Vunread_command_events
)
1817 && NILP (Vunread_input_method_events
)
1818 && NILP (Vunread_post_input_method_events
)
1819 && NILP (Vexecuting_macro
)
1820 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1821 safe_run_hooks (Qpost_command_idle_hook
);
1824 /* If there is a prefix argument,
1825 1) We don't want Vlast_command to be ``universal-argument''
1826 (that would be dumb), so don't set Vlast_command,
1827 2) we want to leave echoing on so that the prefix will be
1828 echoed as part of this key sequence, so don't call
1830 3) we want to leave this_command_key_count non-zero, so that
1831 read_char will realize that it is re-reading a character, and
1832 not echo it a second time.
1834 If the command didn't actually create a prefix arg,
1835 but is merely a frame event that is transparent to prefix args,
1836 then the above doesn't apply. */
1837 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1839 current_kboard
->Vlast_command
= Vthis_command
;
1840 current_kboard
->Vreal_last_command
= real_this_command
;
1842 this_command_key_count
= 0;
1843 this_command_key_count_reset
= 0;
1844 this_single_command_key_start
= 0;
1847 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1849 /* Setting transient-mark-mode to `only' is a way of
1850 turning it on for just one command. */
1852 if (EQ (Vtransient_mark_mode
, Qidentity
))
1853 Vtransient_mark_mode
= Qnil
;
1854 if (EQ (Vtransient_mark_mode
, Qonly
))
1855 Vtransient_mark_mode
= Qidentity
;
1857 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1859 /* We could also call `deactivate'mark'. */
1860 if (EQ (Vtransient_mark_mode
, Qlambda
))
1861 Vtransient_mark_mode
= Qnil
;
1864 current_buffer
->mark_active
= Qnil
;
1865 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1868 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1869 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1874 if (current_buffer
== prev_buffer
1875 && last_point_position
!= PT
1876 && NILP (Vdisable_point_adjustment
)
1877 && NILP (Vglobal_disable_point_adjustment
)
1878 && !already_adjusted
)
1879 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1881 /* Install chars successfully executed in kbd macro. */
1883 if (!NILP (current_kboard
->defining_kbd_macro
)
1884 && NILP (current_kboard
->Vprefix_arg
))
1885 finalize_kbd_macro_chars ();
1889 any_kboard_state ();
1894 extern Lisp_Object Qcomposition
, Qdisplay
;
1896 /* Adjust point to a boundary of a region that has such a property
1897 that should be treated intangible. For the moment, we check
1898 `composition', `display' and `invisible' properties.
1899 LAST_PT is the last position of point. */
1901 extern Lisp_Object Qafter_string
, Qbefore_string
;
1902 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1905 adjust_point_for_property (last_pt
, modified
)
1910 Lisp_Object val
, overlay
, tmp
;
1911 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1914 /* FIXME: cycling is probably not necessary because these properties
1915 can't be usefully combined anyway. */
1916 while (check_composition
|| check_display
|| check_invisible
)
1918 if (check_composition
1919 && PT
> BEGV
&& PT
< ZV
1920 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1921 && COMPOSITION_VALID_P (beg
, end
, val
)
1922 && beg
< PT
/* && end > PT <- It's always the case. */
1923 && (last_pt
<= beg
|| last_pt
>= end
))
1926 SET_PT (PT
< last_pt
? beg
: end
);
1927 check_display
= check_invisible
= 1;
1929 check_composition
= 0;
1931 && PT
> BEGV
&& PT
< ZV
1932 && !NILP (val
= get_char_property_and_overlay
1933 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1934 && display_prop_intangible_p (val
)
1935 && (!OVERLAYP (overlay
)
1936 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1937 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1938 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1939 && beg
< PT
) /* && end > PT <- It's always the case. */
1942 SET_PT (PT
< last_pt
? beg
: end
);
1943 check_composition
= check_invisible
= 1;
1946 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1948 int inv
, ellipsis
= 0;
1951 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1953 && !NILP (val
= get_char_property_and_overlay
1954 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1955 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1957 ellipsis
= ellipsis
|| inv
> 1
1958 || (OVERLAYP (overlay
)
1959 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1960 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1961 tmp
= Fnext_single_char_property_change
1962 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1963 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1966 && !NILP (val
= get_char_property_and_overlay
1967 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1968 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1970 ellipsis
= ellipsis
|| inv
> 1
1971 || (OVERLAYP (overlay
)
1972 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1973 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1974 tmp
= Fprevious_single_char_property_change
1975 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1976 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1979 /* Move away from the inside area. */
1980 if (beg
< PT
&& end
> PT
)
1982 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1983 /* We haven't moved yet (so we don't need to fear
1984 infinite-looping) and we were outside the range
1985 before (so either end of the range still corresponds
1986 to a move in the right direction): pretend we moved
1987 less than we actually did, so that we still have
1988 more freedom below in choosing which end of the range
1990 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1991 /* We either have moved already or the last point
1992 was already in the range: we don't get to choose
1993 which end of the range we have to go to. */
1994 : (PT
< last_pt
? beg
: end
));
1995 check_composition
= check_display
= 1;
1997 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1998 the point to something other than its argument, due to
1999 point-motion hooks, intangibility, etc. */
2000 xassert (PT
== beg
|| PT
== end
);
2003 /* Pretend the area doesn't exist if the buffer is not
2005 if (!modified
&& !ellipsis
&& beg
< end
)
2007 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2008 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2009 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2010 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2011 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2012 /* We've already moved as far as we can. Trying to go
2013 to the other end would mean moving backwards and thus
2014 could lead to an infinite loop. */
2016 else if (val
= get_pos_property (make_number (PT
),
2018 TEXT_PROP_MEANS_INVISIBLE (val
)
2019 && (val
= get_pos_property
2020 (make_number (PT
== beg
? end
: beg
),
2022 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2023 (check_composition
= check_display
= 1,
2024 SET_PT (PT
== beg
? end
: beg
));
2027 check_invisible
= 0;
2031 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2034 safe_run_hooks_1 (hook
)
2037 return call1 (Vrun_hooks
, Vinhibit_quit
);
2040 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2043 safe_run_hooks_error (data
)
2046 Lisp_Object args
[3];
2047 args
[0] = build_string ("Error in %s: %s");
2048 args
[1] = Vinhibit_quit
;
2051 return Fset (Vinhibit_quit
, Qnil
);
2054 /* If we get an error while running the hook, cause the hook variable
2055 to be nil. Also inhibit quits, so that C-g won't cause the hook
2056 to mysteriously evaporate. */
2059 safe_run_hooks (hook
)
2062 int count
= SPECPDL_INDEX ();
2063 specbind (Qinhibit_quit
, hook
);
2065 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2067 unbind_to (count
, Qnil
);
2071 /* Number of seconds between polling for input. This is a Lisp
2072 variable that can be bound. */
2074 EMACS_INT polling_period
;
2076 /* Nonzero means polling for input is temporarily suppressed. */
2078 int poll_suppress_count
;
2080 /* Asynchronous timer for polling. */
2082 struct atimer
*poll_timer
;
2085 #ifdef POLL_FOR_INPUT
2087 /* Poll for input, so what we catch a C-g if it comes in. This
2088 function is called from x_make_frame_visible, see comment
2094 if (interrupt_input_blocked
== 0
2095 && !waiting_for_input
)
2096 read_avail_input (0);
2099 /* Timer callback function for poll_timer. TIMER is equal to
2103 poll_for_input (timer
)
2104 struct atimer
*timer
;
2106 if (poll_suppress_count
== 0)
2107 poll_for_input_1 ();
2110 #endif /* POLL_FOR_INPUT */
2112 /* Begin signals to poll for input, if they are appropriate.
2113 This function is called unconditionally from various places. */
2118 #ifdef POLL_FOR_INPUT
2119 if (read_socket_hook
&& !interrupt_input
)
2121 /* Turn alarm handling on unconditionally. It might have
2122 been turned off in process.c. */
2123 turn_on_atimers (1);
2125 /* If poll timer doesn't exist, are we need one with
2126 a different interval, start a new one. */
2127 if (poll_timer
== NULL
2128 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2130 EMACS_TIME interval
;
2133 cancel_atimer (poll_timer
);
2135 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2136 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2137 poll_for_input
, NULL
);
2140 /* Let the timer's callback function poll for input
2141 if this becomes zero. */
2142 --poll_suppress_count
;
2147 /* Nonzero if we are using polling to handle input asynchronously. */
2150 input_polling_used ()
2152 #ifdef POLL_FOR_INPUT
2153 return read_socket_hook
&& !interrupt_input
;
2159 /* Turn off polling. */
2164 #ifdef POLL_FOR_INPUT
2165 if (read_socket_hook
&& !interrupt_input
)
2166 ++poll_suppress_count
;
2170 /* Set the value of poll_suppress_count to COUNT
2171 and start or stop polling accordingly. */
2174 set_poll_suppress_count (count
)
2177 #ifdef POLL_FOR_INPUT
2178 if (count
== 0 && poll_suppress_count
!= 0)
2180 poll_suppress_count
= 1;
2183 else if (count
!= 0 && poll_suppress_count
== 0)
2187 poll_suppress_count
= count
;
2191 /* Bind polling_period to a value at least N.
2192 But don't decrease it. */
2195 bind_polling_period (n
)
2198 #ifdef POLL_FOR_INPUT
2199 int new = polling_period
;
2204 stop_other_atimers (poll_timer
);
2206 specbind (Qpolling_period
, make_number (new));
2207 /* Start a new alarm with the new period. */
2212 /* Apply the control modifier to CHARACTER. */
2218 /* Save the upper bits here. */
2219 int upper
= c
& ~0177;
2223 /* Everything in the columns containing the upper-case letters
2224 denotes a control character. */
2225 if (c
>= 0100 && c
< 0140)
2229 /* Set the shift modifier for a control char
2230 made from a shifted letter. But only for letters! */
2231 if (oc
>= 'A' && oc
<= 'Z')
2232 c
|= shift_modifier
;
2235 /* The lower-case letters denote control characters too. */
2236 else if (c
>= 'a' && c
<= 'z')
2239 /* Include the bits for control and shift
2240 only if the basic ASCII code can't indicate them. */
2244 /* Replace the high bits. */
2245 c
|= (upper
& ~ctrl_modifier
);
2250 /* Display help echo in the echo area.
2252 HELP a string means display that string, HELP nil means clear the
2253 help echo. If HELP is a function, call it with OBJECT and POS as
2254 arguments; the function should return a help string or nil for
2255 none. For all other types of HELP evaluate it to obtain a string.
2257 WINDOW is the window in which the help was generated, if any.
2258 It is nil if not in a window.
2260 If OBJECT is a buffer, POS is the position in the buffer where the
2261 `help-echo' text property was found.
2263 If OBJECT is an overlay, that overlay has a `help-echo' property,
2264 and POS is the position in the overlay's buffer under the mouse.
2266 If OBJECT is a string (an overlay string or a string displayed with
2267 the `display' property). POS is the position in that string under
2270 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2271 echo overwrites a keystroke echo currently displayed in the echo
2274 Note: this function may only be called with HELP nil or a string
2275 from X code running asynchronously. */
2278 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2279 Lisp_Object help
, window
, object
, pos
;
2280 int ok_to_overwrite_keystroke_echo
;
2282 if (!NILP (help
) && !STRINGP (help
))
2284 if (FUNCTIONP (help
))
2286 Lisp_Object args
[4];
2291 help
= safe_call (4, args
);
2294 help
= safe_eval (help
);
2296 if (!STRINGP (help
))
2300 if (STRINGP (help
) || NILP (help
))
2302 if (!NILP (Vshow_help_function
))
2303 call1 (Vshow_help_function
, help
);
2304 else if (/* Don't overwrite minibuffer contents. */
2305 !MINI_WINDOW_P (XWINDOW (selected_window
))
2306 /* Don't overwrite a keystroke echo. */
2307 && (NILP (echo_message_buffer
)
2308 || ok_to_overwrite_keystroke_echo
)
2309 /* Don't overwrite a prompt. */
2310 && !cursor_in_echo_area
)
2314 int count
= SPECPDL_INDEX ();
2316 if (!help_echo_showing_p
)
2317 Vpre_help_message
= current_message ();
2319 specbind (Qmessage_truncate_lines
, Qt
);
2320 message3_nolog (help
, SBYTES (help
),
2321 STRING_MULTIBYTE (help
));
2322 unbind_to (count
, Qnil
);
2324 else if (STRINGP (Vpre_help_message
))
2326 message3_nolog (Vpre_help_message
,
2327 SBYTES (Vpre_help_message
),
2328 STRING_MULTIBYTE (Vpre_help_message
));
2329 Vpre_help_message
= Qnil
;
2335 help_echo_showing_p
= STRINGP (help
);
2341 /* Input of single characters from keyboard */
2343 Lisp_Object
print_help ();
2344 static Lisp_Object
kbd_buffer_get_event ();
2345 static void record_char ();
2348 static jmp_buf wrong_kboard_jmpbuf
;
2351 #define STOP_POLLING \
2352 do { if (! polling_stopped_here) stop_polling (); \
2353 polling_stopped_here = 1; } while (0)
2355 #define RESUME_POLLING \
2356 do { if (polling_stopped_here) start_polling (); \
2357 polling_stopped_here = 0; } while (0)
2359 /* read a character from the keyboard; call the redisplay if needed */
2360 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2361 -1 means do not do redisplay, but do do autosaving.
2364 /* The arguments MAPS and NMAPS are for menu prompting.
2365 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2367 PREV_EVENT is the previous input event, or nil if we are reading
2368 the first event of a key sequence (or not reading a key sequence).
2369 If PREV_EVENT is t, that is a "magic" value that says
2370 not to run input methods, but in other respects to act as if
2371 not reading a key sequence.
2373 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2374 if we used a mouse menu to read the input, or zero otherwise. If
2375 USED_MOUSE_MENU is null, we don't dereference it.
2377 Value is t if we showed a menu and the user rejected it. */
2380 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2384 Lisp_Object prev_event
;
2385 int *used_mouse_menu
;
2387 volatile Lisp_Object c
;
2389 jmp_buf local_getcjmp
;
2391 volatile int key_already_recorded
= 0;
2392 Lisp_Object tem
, save
;
2393 volatile Lisp_Object previous_echo_area_message
;
2394 volatile Lisp_Object also_record
;
2395 volatile int reread
;
2396 struct gcpro gcpro1
, gcpro2
;
2397 int polling_stopped_here
= 0;
2401 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2402 before_command_key_count
= this_command_key_count
;
2403 before_command_echo_length
= echo_length ();
2406 previous_echo_area_message
= Qnil
;
2408 GCPRO2 (c
, previous_echo_area_message
);
2413 if (CONSP (Vunread_post_input_method_events
))
2415 c
= XCAR (Vunread_post_input_method_events
);
2416 Vunread_post_input_method_events
2417 = XCDR (Vunread_post_input_method_events
);
2419 /* Undo what read_char_x_menu_prompt did when it unread
2420 additional keys returned by Fx_popup_menu. */
2422 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2430 if (unread_command_char
!= -1)
2432 XSETINT (c
, unread_command_char
);
2433 unread_command_char
= -1;
2439 if (CONSP (Vunread_command_events
))
2441 c
= XCAR (Vunread_command_events
);
2442 Vunread_command_events
= XCDR (Vunread_command_events
);
2444 /* Undo what read_char_x_menu_prompt did when it unread
2445 additional keys returned by Fx_popup_menu. */
2447 && EQ (XCDR (c
), Qdisabled
)
2448 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2451 /* If the queued event is something that used the mouse,
2452 set used_mouse_menu accordingly. */
2454 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2455 *used_mouse_menu
= 1;
2458 goto reread_for_input_method
;
2461 if (CONSP (Vunread_input_method_events
))
2463 c
= XCAR (Vunread_input_method_events
);
2464 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2466 /* Undo what read_char_x_menu_prompt did when it unread
2467 additional keys returned by Fx_popup_menu. */
2469 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2473 goto reread_for_input_method
;
2476 this_command_key_count_reset
= 0;
2478 if (!NILP (Vexecuting_macro
))
2480 /* We set this to Qmacro; since that's not a frame, nobody will
2481 try to switch frames on us, and the selected window will
2484 Since this event came from a macro, it would be misleading to
2485 leave internal_last_event_frame set to wherever the last
2486 real event came from. Normally, a switch-frame event selects
2487 internal_last_event_frame after each command is read, but
2488 events read from a macro should never cause a new frame to be
2490 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2492 /* Exit the macro if we are at the end.
2493 Also, some things replace the macro with t
2494 to force an early exit. */
2495 if (EQ (Vexecuting_macro
, Qt
)
2496 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2502 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2503 if (STRINGP (Vexecuting_macro
)
2504 && (XINT (c
) & 0x80))
2505 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2507 executing_macro_index
++;
2512 if (!NILP (unread_switch_frame
))
2514 c
= unread_switch_frame
;
2515 unread_switch_frame
= Qnil
;
2517 /* This event should make it into this_command_keys, and get echoed
2518 again, so we do not set `reread'. */
2522 /* if redisplay was requested */
2523 if (commandflag
>= 0)
2525 /* If there is pending input, process any events which are not
2526 user-visible, such as X selection_request events. */
2528 || detect_input_pending_run_timers (0))
2529 swallow_events (0); /* may clear input_pending */
2531 /* Redisplay if no pending input. */
2532 while (!input_pending
)
2534 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2535 redisplay_preserve_echo_area (5);
2540 /* Normal case: no input arrived during redisplay. */
2543 /* Input arrived and pre-empted redisplay.
2544 Process any events which are not user-visible. */
2546 /* If that cleared input_pending, try again to redisplay. */
2550 /* Message turns off echoing unless more keystrokes turn it on again.
2552 The code in 20.x for the condition was
2554 1. echo_area_glyphs && *echo_area_glyphs
2555 2. && echo_area_glyphs != current_kboard->echobuf
2556 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2558 (1) means there's a current message displayed
2560 (2) means it's not the message from echoing from the current
2563 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2564 is set to a non-null value. This is done in read_char and it is
2565 set to echo_area_glyphs after a call to echo_char. That means
2566 ok_to_echo_at_next_pause is either null or
2567 current_kboard->echobuf with the appropriate current_kboard at
2570 So, condition (3) means in clear text ok_to_echo_at_next_pause
2571 must be either null, or the current message isn't from echoing at
2572 all, or it's from echoing from a different kboard than the
2575 if (/* There currently is something in the echo area. */
2576 !NILP (echo_area_buffer
[0])
2577 && (/* And it's either not from echoing. */
2578 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2579 /* Or it's an echo from a different kboard. */
2580 || echo_kboard
!= current_kboard
2581 /* Or we explicitly allow overwriting whatever there is. */
2582 || ok_to_echo_at_next_pause
== NULL
))
2587 /* Try reading a character via menu prompting in the minibuf.
2588 Try this before the sit-for, because the sit-for
2589 would do the wrong thing if we are supposed to do
2590 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2591 after a mouse event so don't try a minibuf menu. */
2593 if (nmaps
> 0 && INTERACTIVE
2594 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2595 /* Don't bring up a menu if we already have another event. */
2596 && NILP (Vunread_command_events
)
2597 && unread_command_char
< 0
2598 && !detect_input_pending_run_timers (0))
2600 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2603 key_already_recorded
= 1;
2608 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2609 We will do that below, temporarily for short sections of code,
2610 when appropriate. local_getcjmp must be in effect
2611 around any call to sit_for or kbd_buffer_get_event;
2612 it *must not* be in effect when we call redisplay. */
2614 if (_setjmp (local_getcjmp
))
2616 XSETINT (c
, quit_char
);
2617 internal_last_event_frame
= selected_frame
;
2618 Vlast_event_frame
= internal_last_event_frame
;
2619 /* If we report the quit char as an event,
2620 don't do so more than once. */
2621 if (!NILP (Vinhibit_quit
))
2626 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2627 if (kb
!= current_kboard
)
2629 Lisp_Object link
= kb
->kbd_queue
;
2630 /* We shouldn't get here if we were in single-kboard mode! */
2635 while (CONSP (XCDR (link
)))
2637 if (!NILP (XCDR (link
)))
2641 kb
->kbd_queue
= Fcons (c
, Qnil
);
2643 XSETCDR (link
, Fcons (c
, Qnil
));
2644 kb
->kbd_queue_has_data
= 1;
2645 current_kboard
= kb
;
2646 /* This is going to exit from read_char
2647 so we had better get rid of this frame's stuff. */
2649 longjmp (wrong_kboard_jmpbuf
, 1);
2656 timer_start_idle ();
2658 /* If in middle of key sequence and minibuffer not active,
2659 start echoing if enough time elapses. */
2661 if (minibuf_level
== 0
2662 && !current_kboard
->immediate_echo
2663 && this_command_key_count
> 0
2665 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2666 && NILP (Fzerop (Vecho_keystrokes
))
2667 && (/* No message. */
2668 NILP (echo_area_buffer
[0])
2669 /* Or empty message. */
2670 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2671 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2672 /* Or already echoing from same kboard. */
2673 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2674 /* Or not echoing before and echoing allowed. */
2675 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2679 /* After a mouse event, start echoing right away.
2680 This is because we are probably about to display a menu,
2681 and we don't want to delay before doing so. */
2682 if (EVENT_HAS_PARAMETERS (prev_event
))
2687 double duration
= extract_float (Vecho_keystrokes
);
2688 sec
= (int) duration
;
2689 usec
= (duration
- sec
) * 1000000;
2690 save_getcjmp (save_jump
);
2691 restore_getcjmp (local_getcjmp
);
2692 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2693 restore_getcjmp (save_jump
);
2695 && ! CONSP (Vunread_command_events
))
2700 /* Maybe auto save due to number of keystrokes. */
2702 if (commandflag
!= 0
2703 && auto_save_interval
> 0
2704 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2705 && !detect_input_pending_run_timers (0))
2707 Fdo_auto_save (Qnil
, Qnil
);
2708 /* Hooks can actually change some buffers in auto save. */
2712 /* Try reading using an X menu.
2713 This is never confused with reading using the minibuf
2714 because the recursive call of read_char in read_char_minibuf_menu_prompt
2715 does not pass on any keymaps. */
2717 if (nmaps
> 0 && INTERACTIVE
2718 && !NILP (prev_event
)
2719 && EVENT_HAS_PARAMETERS (prev_event
)
2720 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2721 && !EQ (XCAR (prev_event
), Qtool_bar
)
2722 /* Don't bring up a menu if we already have another event. */
2723 && NILP (Vunread_command_events
)
2724 && unread_command_char
< 0)
2726 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2728 /* Now that we have read an event, Emacs is not idle. */
2734 /* Maybe autosave and/or garbage collect due to idleness. */
2736 if (INTERACTIVE
&& NILP (c
))
2738 int delay_level
, buffer_size
;
2740 /* Slow down auto saves logarithmically in size of current buffer,
2741 and garbage collect while we're at it. */
2742 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2743 last_non_minibuf_size
= Z
- BEG
;
2744 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2746 while (buffer_size
> 64)
2747 delay_level
++, buffer_size
-= buffer_size
>> 2;
2748 if (delay_level
< 4) delay_level
= 4;
2749 /* delay_level is 4 for files under around 50k, 7 at 100k,
2750 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2752 /* Auto save if enough time goes by without input. */
2753 if (commandflag
!= 0
2754 && num_nonmacro_input_events
> last_auto_save
2755 && INTEGERP (Vauto_save_timeout
)
2756 && XINT (Vauto_save_timeout
) > 0)
2760 save_getcjmp (save_jump
);
2761 restore_getcjmp (local_getcjmp
);
2762 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2764 restore_getcjmp (save_jump
);
2767 && ! CONSP (Vunread_command_events
))
2769 Fdo_auto_save (Qnil
, Qnil
);
2771 /* If we have auto-saved and there is still no input
2772 available, garbage collect if there has been enough
2773 consing going on to make it worthwhile. */
2774 if (!detect_input_pending_run_timers (0)
2775 && consing_since_gc
> gc_cons_threshold
/ 2)
2776 Fgarbage_collect ();
2783 /* If this has become non-nil here, it has been set by a timer
2784 or sentinel or filter. */
2785 if (CONSP (Vunread_command_events
))
2787 c
= XCAR (Vunread_command_events
);
2788 Vunread_command_events
= XCDR (Vunread_command_events
);
2791 /* Read something from current KBOARD's side queue, if possible. */
2795 if (current_kboard
->kbd_queue_has_data
)
2797 if (!CONSP (current_kboard
->kbd_queue
))
2799 c
= XCAR (current_kboard
->kbd_queue
);
2800 current_kboard
->kbd_queue
2801 = XCDR (current_kboard
->kbd_queue
);
2802 if (NILP (current_kboard
->kbd_queue
))
2803 current_kboard
->kbd_queue_has_data
= 0;
2804 input_pending
= readable_events (0);
2805 if (EVENT_HAS_PARAMETERS (c
)
2806 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2807 internal_last_event_frame
= XCAR (XCDR (c
));
2808 Vlast_event_frame
= internal_last_event_frame
;
2813 /* If current_kboard's side queue is empty check the other kboards.
2814 If one of them has data that we have not yet seen here,
2815 switch to it and process the data waiting for it.
2817 Note: if the events queued up for another kboard
2818 have already been seen here, and therefore are not a complete command,
2819 the kbd_queue_has_data field is 0, so we skip that kboard here.
2820 That's to avoid an infinite loop switching between kboards here. */
2821 if (NILP (c
) && !single_kboard
)
2824 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2825 if (kb
->kbd_queue_has_data
)
2827 current_kboard
= kb
;
2828 /* This is going to exit from read_char
2829 so we had better get rid of this frame's stuff. */
2831 longjmp (wrong_kboard_jmpbuf
, 1);
2840 /* Finally, we read from the main queue,
2841 and if that gives us something we can't use yet, we put it on the
2842 appropriate side queue and try again. */
2848 /* Actually read a character, waiting if necessary. */
2849 save_getcjmp (save_jump
);
2850 restore_getcjmp (local_getcjmp
);
2851 timer_start_idle ();
2852 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2853 restore_getcjmp (save_jump
);
2856 if (! NILP (c
) && (kb
!= current_kboard
))
2858 Lisp_Object link
= kb
->kbd_queue
;
2861 while (CONSP (XCDR (link
)))
2863 if (!NILP (XCDR (link
)))
2867 kb
->kbd_queue
= Fcons (c
, Qnil
);
2869 XSETCDR (link
, Fcons (c
, Qnil
));
2870 kb
->kbd_queue_has_data
= 1;
2874 current_kboard
= kb
;
2875 /* This is going to exit from read_char
2876 so we had better get rid of this frame's stuff. */
2878 longjmp (wrong_kboard_jmpbuf
, 1);
2883 /* Terminate Emacs in batch mode if at eof. */
2884 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2885 Fkill_emacs (make_number (1));
2889 /* Add in any extra modifiers, where appropriate. */
2890 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2891 || ((extra_keyboard_modifiers
& 0177) < ' '
2892 && (extra_keyboard_modifiers
& 0177) != 0))
2893 XSETINT (c
, make_ctrl_char (XINT (c
)));
2895 /* Transfer any other modifier bits directly from
2896 extra_keyboard_modifiers to c. Ignore the actual character code
2897 in the low 16 bits of extra_keyboard_modifiers. */
2898 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2908 if (commandflag
>= 0
2909 && !input_pending
&& !detect_input_pending_run_timers (0))
2917 /* Buffer switch events are only for internal wakeups
2918 so don't show them to the user.
2919 Also, don't record a key if we already did. */
2920 if (BUFFERP (c
) || key_already_recorded
)
2923 /* Process special events within read_char
2924 and loop around to read another event. */
2927 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2932 int was_locked
= single_kboard
;
2934 last_input_char
= c
;
2935 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2937 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2938 /* We stopped being idle for this event; undo that. This
2939 prevents automatic window selection (under
2940 mouse_autoselect_window from acting as a real input event, for
2941 example banishing the mouse under mouse-avoidance-mode. */
2942 timer_resume_idle ();
2944 /* Resume allowing input from any kboard, if that was true before. */
2946 any_kboard_state ();
2951 /* Handle things that only apply to characters. */
2954 /* If kbd_buffer_get_event gave us an EOF, return that. */
2958 if ((STRINGP (Vkeyboard_translate_table
)
2959 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2960 || (VECTORP (Vkeyboard_translate_table
)
2961 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2962 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2963 && CHAR_VALID_P (XINT (c
), 0)))
2966 d
= Faref (Vkeyboard_translate_table
, c
);
2967 /* nil in keyboard-translate-table means no translation. */
2973 /* If this event is a mouse click in the menu bar,
2974 return just menu-bar for now. Modify the mouse click event
2975 so we won't do this twice, then queue it up. */
2976 if (EVENT_HAS_PARAMETERS (c
)
2978 && CONSP (EVENT_START (c
))
2979 && CONSP (XCDR (EVENT_START (c
))))
2983 posn
= POSN_POSN (EVENT_START (c
));
2984 /* Handle menu-bar events:
2985 insert the dummy prefix event `menu-bar'. */
2986 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2988 /* Change menu-bar to (menu-bar) as the event "position". */
2989 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2992 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2997 /* Store these characters into recent_keys, the dribble file if any,
2998 and the keyboard macro being defined, if any. */
3000 if (! NILP (also_record
))
3001 record_char (also_record
);
3003 /* Wipe the echo area.
3004 But first, if we are about to use an input method,
3005 save the echo area contents for it to refer to. */
3007 && ! NILP (Vinput_method_function
)
3008 && (unsigned) XINT (c
) >= ' '
3009 && (unsigned) XINT (c
) != 127
3010 && (unsigned) XINT (c
) < 256)
3012 previous_echo_area_message
= Fcurrent_message ();
3013 Vinput_method_previous_message
= previous_echo_area_message
;
3016 /* Now wipe the echo area, except for help events which do their
3017 own stuff with the echo area. */
3019 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3020 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3022 if (!NILP (echo_area_buffer
[0]))
3023 safe_run_hooks (Qecho_area_clear_hook
);
3024 clear_message (1, 0);
3027 reread_for_input_method
:
3029 /* Pass this to the input method, if appropriate. */
3031 && ! NILP (Vinput_method_function
)
3032 /* Don't run the input method within a key sequence,
3033 after the first event of the key sequence. */
3034 && NILP (prev_event
)
3035 && (unsigned) XINT (c
) >= ' '
3036 && (unsigned) XINT (c
) != 127
3037 && (unsigned) XINT (c
) < 256)
3040 int key_count
, key_count_reset
;
3041 struct gcpro gcpro1
;
3042 int count
= SPECPDL_INDEX ();
3044 /* Save the echo status. */
3045 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3046 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3047 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3050 if (before_command_restore_flag
)
3052 this_command_key_count
= before_command_key_count_1
;
3053 if (this_command_key_count
< this_single_command_key_start
)
3054 this_single_command_key_start
= this_command_key_count
;
3055 echo_truncate (before_command_echo_length_1
);
3056 before_command_restore_flag
= 0;
3060 /* Save the this_command_keys status. */
3061 key_count
= this_command_key_count
;
3062 key_count_reset
= this_command_key_count_reset
;
3065 keys
= Fcopy_sequence (this_command_keys
);
3070 /* Clear out this_command_keys. */
3071 this_command_key_count
= 0;
3072 this_command_key_count_reset
= 0;
3074 /* Now wipe the echo area. */
3075 if (!NILP (echo_area_buffer
[0]))
3076 safe_run_hooks (Qecho_area_clear_hook
);
3077 clear_message (1, 0);
3080 /* If we are not reading a key sequence,
3081 never use the echo area. */
3084 specbind (Qinput_method_use_echo_area
, Qt
);
3087 /* Call the input method. */
3088 tem
= call1 (Vinput_method_function
, c
);
3090 tem
= unbind_to (count
, tem
);
3092 /* Restore the saved echoing state
3093 and this_command_keys state. */
3094 this_command_key_count
= key_count
;
3095 this_command_key_count_reset
= key_count_reset
;
3097 this_command_keys
= keys
;
3100 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3101 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3102 if (saved_immediate_echo
)
3107 /* The input method can return no events. */
3110 /* Bring back the previous message, if any. */
3111 if (! NILP (previous_echo_area_message
))
3112 message_with_string ("%s", previous_echo_area_message
, 0);
3115 /* It returned one event or more. */
3117 Vunread_post_input_method_events
3118 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3123 /* Display help if not echoing. */
3124 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3126 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3127 Lisp_Object help
, object
, position
, window
, tem
;
3129 tem
= Fcdr (XCDR (c
));
3132 window
= Fcar (tem
);
3134 object
= Fcar (tem
);
3136 position
= Fcar (tem
);
3138 show_help_echo (help
, window
, object
, position
, 0);
3140 /* We stopped being idle for this event; undo that. */
3141 timer_resume_idle ();
3145 if (! reread
|| this_command_key_count
== 0
3146 || this_command_key_count_reset
)
3149 /* Don't echo mouse motion events. */
3150 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3151 && NILP (Fzerop (Vecho_keystrokes
))
3152 && ! (EVENT_HAS_PARAMETERS (c
)
3153 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3156 if (! NILP (also_record
))
3157 echo_char (also_record
);
3158 /* Once we reread a character, echoing can happen
3159 the next time we pause to read a new one. */
3160 ok_to_echo_at_next_pause
= current_kboard
;
3163 /* Record this character as part of the current key. */
3164 add_command_key (c
);
3165 if (! NILP (also_record
))
3166 add_command_key (also_record
);
3169 last_input_char
= c
;
3172 /* Process the help character specially if enabled */
3173 if (!NILP (Vhelp_form
) && help_char_p (c
))
3176 count
= SPECPDL_INDEX ();
3178 record_unwind_protect (Fset_window_configuration
,
3179 Fcurrent_window_configuration (Qnil
));
3181 tem0
= Feval (Vhelp_form
);
3183 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3187 c
= read_char (0, 0, 0, Qnil
, 0);
3188 while (BUFFERP (c
));
3189 /* Remove the help from the frame */
3190 unbind_to (count
, Qnil
);
3193 if (EQ (c
, make_number (040)))
3197 c
= read_char (0, 0, 0, Qnil
, 0);
3198 while (BUFFERP (c
));
3207 /* Record a key that came from a mouse menu.
3208 Record it for echoing, for this-command-keys, and so on. */
3214 /* Wipe the echo area. */
3215 clear_message (1, 0);
3220 before_command_key_count
= this_command_key_count
;
3221 before_command_echo_length
= echo_length ();
3224 /* Don't echo mouse motion events. */
3225 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3226 && NILP (Fzerop (Vecho_keystrokes
)))
3230 /* Once we reread a character, echoing can happen
3231 the next time we pause to read a new one. */
3232 ok_to_echo_at_next_pause
= 0;
3235 /* Record this character as part of the current key. */
3236 add_command_key (c
);
3238 /* Re-reading in the middle of a command */
3239 last_input_char
= c
;
3243 /* Return 1 if should recognize C as "the help character". */
3251 if (EQ (c
, Vhelp_char
))
3253 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3254 if (EQ (c
, XCAR (tail
)))
3259 /* Record the input event C in various ways. */
3267 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3269 /* To avoid filling recent_keys with help-echo and mouse-movement
3270 events, we filter out repeated help-echo events, only store the
3271 first and last in a series of mouse-movement events, and don't
3272 store repeated help-echo events which are only separated by
3273 mouse-movement events. */
3275 Lisp_Object ev1
, ev2
, ev3
;
3278 if ((ix1
= recent_keys_index
- 1) < 0)
3279 ix1
= NUM_RECENT_KEYS
- 1;
3280 ev1
= AREF (recent_keys
, ix1
);
3282 if ((ix2
= ix1
- 1) < 0)
3283 ix2
= NUM_RECENT_KEYS
- 1;
3284 ev2
= AREF (recent_keys
, ix2
);
3286 if ((ix3
= ix2
- 1) < 0)
3287 ix3
= NUM_RECENT_KEYS
- 1;
3288 ev3
= AREF (recent_keys
, ix3
);
3290 if (EQ (XCAR (c
), Qhelp_echo
))
3292 /* Don't record `help-echo' in recent_keys unless it shows some help
3293 message, and a different help than the previously recorded
3295 Lisp_Object help
, last_help
;
3297 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3298 if (!STRINGP (help
))
3300 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3301 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3303 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3304 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3305 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3307 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3308 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3309 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3310 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3313 else if (EQ (XCAR (c
), Qmouse_movement
))
3315 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3316 So additional mouse movement events replace the last element. */
3317 Lisp_Object last_window
, window
;
3319 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3320 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3321 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3322 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3323 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3325 ASET (recent_keys
, ix1
, c
);
3331 store_kbd_macro_char (c
);
3336 ASET (recent_keys
, recent_keys_index
, c
);
3337 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3338 recent_keys_index
= 0;
3340 else if (recorded
< 0)
3342 /* We need to remove one or two events from recent_keys.
3343 To do this, we simply put nil at those events and move the
3344 recent_keys_index backwards over those events. Usually,
3345 users will never see those nil events, as they will be
3346 overwritten by the command keys entered to see recent_keys
3349 while (recorded
++ < 0 && total_keys
> 0)
3351 if (total_keys
< NUM_RECENT_KEYS
)
3353 if (--recent_keys_index
< 0)
3354 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3355 ASET (recent_keys
, recent_keys_index
, Qnil
);
3359 num_nonmacro_input_events
++;
3361 /* Write c to the dribble file. If c is a lispy event, write
3362 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3363 If you, dear reader, have a better idea, you've got the source. :-) */
3368 if (XUINT (c
) < 0x100)
3369 putc (XINT (c
), dribble
);
3371 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3375 Lisp_Object dribblee
;
3377 /* If it's a structured event, take the event header. */
3378 dribblee
= EVENT_HEAD (c
);
3380 if (SYMBOLP (dribblee
))
3382 putc ('<', dribble
);
3383 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3384 SBYTES (SYMBOL_NAME (dribblee
)),
3386 putc ('>', dribble
);
3398 struct buffer
*old
= current_buffer
;
3399 Fprinc (object
, Qnil
);
3400 set_buffer_internal (XBUFFER (Vstandard_output
));
3401 call0 (intern ("help-mode"));
3402 set_buffer_internal (old
);
3406 /* Copy out or in the info on where C-g should throw to.
3407 This is used when running Lisp code from within get_char,
3408 in case get_char is called recursively.
3409 See read_process_output. */
3415 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3419 restore_getcjmp (temp
)
3422 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3427 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3428 of this function. */
3431 tracking_off (old_value
)
3432 Lisp_Object old_value
;
3434 do_mouse_tracking
= old_value
;
3435 if (NILP (old_value
))
3437 /* Redisplay may have been preempted because there was input
3438 available, and it assumes it will be called again after the
3439 input has been processed. If the only input available was
3440 the sort that we have just disabled, then we need to call
3442 if (!readable_events (1))
3444 redisplay_preserve_echo_area (6);
3445 get_input_pending (&input_pending
, 1);
3451 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3452 doc
: /* Evaluate BODY with mouse movement events enabled.
3453 Within a `track-mouse' form, mouse motion generates input events that
3454 you can read with `read-event'.
3455 Normally, mouse motion is ignored.
3456 usage: (track-mouse BODY ...) */)
3460 int count
= SPECPDL_INDEX ();
3463 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3465 do_mouse_tracking
= Qt
;
3467 val
= Fprogn (args
);
3468 return unbind_to (count
, val
);
3471 /* If mouse has moved on some frame, return one of those frames.
3472 Return 0 otherwise. */
3477 Lisp_Object tail
, frame
;
3479 FOR_EACH_FRAME (tail
, frame
)
3481 if (XFRAME (frame
)->mouse_moved
)
3482 return XFRAME (frame
);
3488 #endif /* HAVE_MOUSE */
3490 /* Low level keyboard/mouse input.
3491 kbd_buffer_store_event places events in kbd_buffer, and
3492 kbd_buffer_get_event retrieves them. */
3494 /* Return true iff there are any events in the queue that read-char
3495 would return. If this returns false, a read-char would block. */
3497 readable_filtered_events (do_timers_now
, filter_events
)
3502 timer_check (do_timers_now
);
3504 /* If the buffer contains only FOCUS_IN_EVENT events,
3505 and FILTER_EVENTS is nonzero, report it as empty. */
3506 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3508 int have_live_event
= 1;
3512 struct input_event
*event
;
3514 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3518 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3521 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3523 if (event
== kbd_store_ptr
)
3524 have_live_event
= 0;
3527 if (have_live_event
) return 1;
3531 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3536 if (current_kboard
->kbd_queue_has_data
)
3542 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3543 if (kb
->kbd_queue_has_data
)
3549 /* Return true iff there are any events in the queue that read-char
3550 would return. If this returns false, a read-char would block. */
3552 readable_events (do_timers_now
)
3555 return readable_filtered_events (do_timers_now
, 0);
3558 /* Set this for debugging, to have a way to get out */
3563 event_to_kboard (event
)
3564 struct input_event
*event
;
3567 frame
= event
->frame_or_window
;
3569 frame
= XCAR (frame
);
3570 else if (WINDOWP (frame
))
3571 frame
= WINDOW_FRAME (XWINDOW (frame
));
3573 /* There are still some events that don't set this field.
3574 For now, just ignore the problem.
3575 Also ignore dead frames here. */
3576 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3579 return FRAME_KBOARD (XFRAME (frame
));
3583 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3586 kbd_buffer_store_event (event
)
3587 register struct input_event
*event
;
3589 kbd_buffer_store_event_hold (event
, 0);
3592 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3594 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3595 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3596 Else, if EVENT is a quit event, store the quit event
3597 in HOLD_QUIT, and return (thus ignoring further events).
3599 This is used in read_avail_input to postpone the processing
3600 of the quit event until all subsequent input events have been
3601 parsed (and discarded).
3605 kbd_buffer_store_event_hold (event
, hold_quit
)
3606 register struct input_event
*event
;
3607 struct input_event
*hold_quit
;
3609 if (event
->kind
== NO_EVENT
)
3612 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3615 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3617 register int c
= event
->code
& 0377;
3619 if (event
->modifiers
& ctrl_modifier
)
3620 c
= make_ctrl_char (c
);
3622 c
|= (event
->modifiers
3623 & (meta_modifier
| alt_modifier
3624 | hyper_modifier
| super_modifier
));
3630 struct input_event
*sp
;
3633 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3634 kb
!= current_kboard
))
3637 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3638 Fcons (make_number (c
), Qnil
));
3639 kb
->kbd_queue_has_data
= 1;
3640 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3642 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3645 if (event_to_kboard (sp
) == kb
)
3647 sp
->kind
= NO_EVENT
;
3648 sp
->frame_or_window
= Qnil
;
3658 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3662 /* If this results in a quit_char being returned to Emacs as
3663 input, set Vlast_event_frame properly. If this doesn't
3664 get returned to Emacs as an event, the next event read
3665 will set Vlast_event_frame again, so this is safe to do. */
3669 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3671 focus
= event
->frame_or_window
;
3672 internal_last_event_frame
= focus
;
3673 Vlast_event_frame
= focus
;
3676 last_event_timestamp
= event
->timestamp
;
3677 interrupt_signal (0 /* dummy */);
3681 if (c
&& c
== stop_character
)
3687 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3688 Just ignore the second one. */
3689 else if (event
->kind
== BUFFER_SWITCH_EVENT
3690 && kbd_fetch_ptr
!= kbd_store_ptr
3691 && ((kbd_store_ptr
== kbd_buffer
3692 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3693 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3696 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3697 kbd_store_ptr
= kbd_buffer
;
3699 /* Don't let the very last slot in the buffer become full,
3700 since that would make the two pointers equal,
3701 and that is indistinguishable from an empty buffer.
3702 Discard the event if it would fill the last slot. */
3703 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3705 *kbd_store_ptr
= *event
;
3711 /* Put an input event back in the head of the event queue. */
3714 kbd_buffer_unget_event (event
)
3715 register struct input_event
*event
;
3717 if (kbd_fetch_ptr
== kbd_buffer
)
3718 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3720 /* Don't let the very last slot in the buffer become full, */
3721 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3724 *kbd_fetch_ptr
= *event
;
3729 /* Generate HELP_EVENT input_events in BUFP which has room for
3730 SIZE events. If there's not enough room in BUFP, ignore this
3733 HELP is the help form.
3735 FRAME is the frame on which the help is generated. OBJECT is the
3736 Lisp object where the help was found (a buffer, a string, an
3737 overlay, or nil if neither from a string nor from a buffer. POS is
3738 the position within OBJECT where the help was found.
3740 Value is the number of input_events generated. */
3743 gen_help_event (help
, frame
, window
, object
, pos
)
3744 Lisp_Object help
, frame
, object
, window
;
3747 struct input_event event
;
3751 event
.kind
= HELP_EVENT
;
3752 event
.frame_or_window
= frame
;
3754 event
.x
= WINDOWP (window
) ? window
: frame
;
3757 kbd_buffer_store_event (&event
);
3761 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3764 kbd_buffer_store_help_event (frame
, help
)
3765 Lisp_Object frame
, help
;
3767 struct input_event event
;
3769 event
.kind
= HELP_EVENT
;
3770 event
.frame_or_window
= frame
;
3775 kbd_buffer_store_event (&event
);
3779 /* Discard any mouse events in the event buffer by setting them to
3782 discard_mouse_events ()
3784 struct input_event
*sp
;
3785 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3787 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3790 if (sp
->kind
== MOUSE_CLICK_EVENT
3791 || sp
->kind
== WHEEL_EVENT
3793 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3795 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3797 sp
->kind
= NO_EVENT
;
3803 /* Return non-zero if there are any real events waiting in the event
3804 buffer, not counting `NO_EVENT's.
3806 If DISCARD is non-zero, discard NO_EVENT events at the front of
3807 the input queue, possibly leaving the input queue empty if there
3808 are no real input events. */
3811 kbd_buffer_events_waiting (discard
)
3814 struct input_event
*sp
;
3816 for (sp
= kbd_fetch_ptr
;
3817 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3820 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3827 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3831 /* Clear input event EVENT. */
3835 struct input_event
*event
;
3837 event
->kind
= NO_EVENT
;
3841 /* Read one event from the event buffer, waiting if necessary.
3842 The value is a Lisp object representing the event.
3843 The value is nil for an event that should be ignored,
3844 or that was handled here.
3845 We always read and discard one event. */
3848 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3850 int *used_mouse_menu
;
3859 *kbp
= current_kboard
;
3863 /* Wait until there is input available. */
3866 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3869 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3873 /* If the quit flag is set, then read_char will return
3874 quit_char, so that counts as "available input." */
3875 if (!NILP (Vquit_flag
))
3876 quit_throw_to_read_char ();
3878 /* One way or another, wait until input is available; then, if
3879 interrupt handlers have not read it, read it now. */
3882 wait_for_kbd_input ();
3884 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3888 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3891 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3895 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3897 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3898 /* Pass 1 for EXPECT since we just waited to have input. */
3899 read_avail_input (1);
3901 #endif /* not VMS */
3904 if (CONSP (Vunread_command_events
))
3907 first
= XCAR (Vunread_command_events
);
3908 Vunread_command_events
= XCDR (Vunread_command_events
);
3909 *kbp
= current_kboard
;
3913 /* At this point, we know that there is a readable event available
3914 somewhere. If the event queue is empty, then there must be a
3915 mouse movement enabled and available. */
3916 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3918 struct input_event
*event
;
3920 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3924 last_event_timestamp
= event
->timestamp
;
3927 *kbp
= event_to_kboard (event
);
3929 *kbp
= current_kboard
; /* Better than returning null ptr? */
3931 *kbp
= &the_only_kboard
;
3936 /* These two kinds of events get special handling
3937 and don't actually appear to the command loop.
3938 We return nil for them. */
3939 if (event
->kind
== SELECTION_REQUEST_EVENT
3940 || event
->kind
== SELECTION_CLEAR_EVENT
)
3943 struct input_event copy
;
3945 /* Remove it from the buffer before processing it,
3946 since otherwise swallow_events will see it
3947 and process it again. */
3949 kbd_fetch_ptr
= event
+ 1;
3950 input_pending
= readable_events (0);
3951 x_handle_selection_event (©
);
3953 /* We're getting selection request events, but we don't have
3959 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3960 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3962 /* Make an event (delete-frame (FRAME)). */
3963 obj
= Fcons (event
->frame_or_window
, Qnil
);
3964 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3965 kbd_fetch_ptr
= event
+ 1;
3968 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3969 else if (event
->kind
== ICONIFY_EVENT
)
3971 /* Make an event (iconify-frame (FRAME)). */
3972 obj
= Fcons (event
->frame_or_window
, Qnil
);
3973 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3974 kbd_fetch_ptr
= event
+ 1;
3976 else if (event
->kind
== DEICONIFY_EVENT
)
3978 /* Make an event (make-frame-visible (FRAME)). */
3979 obj
= Fcons (event
->frame_or_window
, Qnil
);
3980 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3981 kbd_fetch_ptr
= event
+ 1;
3984 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3986 /* The value doesn't matter here; only the type is tested. */
3987 XSETBUFFER (obj
, current_buffer
);
3988 kbd_fetch_ptr
= event
+ 1;
3990 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3991 || defined (USE_GTK)
3992 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3994 kbd_fetch_ptr
= event
+ 1;
3995 input_pending
= readable_events (0);
3996 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3997 x_activate_menubar (XFRAME (event
->frame_or_window
));
4001 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4003 /* Make an event (language-change (FRAME CHARSET LCID)). */
4004 obj
= Fcons (event
->frame_or_window
, Qnil
);
4005 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4006 kbd_fetch_ptr
= event
+ 1;
4009 else if (event
->kind
== SAVE_SESSION_EVENT
)
4011 obj
= Fcons (Qsave_session
, Qnil
);
4012 kbd_fetch_ptr
= event
+ 1;
4014 /* Just discard these, by returning nil.
4015 With MULTI_KBOARD, these events are used as placeholders
4016 when we need to randomly delete events from the queue.
4017 (They shouldn't otherwise be found in the buffer,
4018 but on some machines it appears they do show up
4019 even without MULTI_KBOARD.) */
4020 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4021 mouse events during a popup-menu call. */
4022 else if (event
->kind
== NO_EVENT
)
4023 kbd_fetch_ptr
= event
+ 1;
4024 else if (event
->kind
== HELP_EVENT
)
4026 Lisp_Object object
, position
, help
, frame
, window
;
4028 frame
= event
->frame_or_window
;
4029 object
= event
->arg
;
4030 position
= make_number (event
->code
);
4033 clear_event (event
);
4035 kbd_fetch_ptr
= event
+ 1;
4036 if (!WINDOWP (window
))
4038 obj
= Fcons (Qhelp_echo
,
4039 list5 (frame
, help
, window
, object
, position
));
4041 else if (event
->kind
== FOCUS_IN_EVENT
)
4043 /* Notification of a FocusIn event. The frame receiving the
4044 focus is in event->frame_or_window. Generate a
4045 switch-frame event if necessary. */
4046 Lisp_Object frame
, focus
;
4048 frame
= event
->frame_or_window
;
4049 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4053 if (!EQ (frame
, internal_last_event_frame
)
4054 && !EQ (frame
, selected_frame
))
4055 obj
= make_lispy_switch_frame (frame
);
4056 internal_last_event_frame
= frame
;
4057 kbd_fetch_ptr
= event
+ 1;
4061 /* If this event is on a different frame, return a switch-frame this
4062 time, and leave the event in the queue for next time. */
4066 frame
= event
->frame_or_window
;
4068 frame
= XCAR (frame
);
4069 else if (WINDOWP (frame
))
4070 frame
= WINDOW_FRAME (XWINDOW (frame
));
4072 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4076 if (! EQ (frame
, internal_last_event_frame
)
4077 && !EQ (frame
, selected_frame
))
4078 obj
= make_lispy_switch_frame (frame
);
4079 internal_last_event_frame
= frame
;
4081 /* If we didn't decide to make a switch-frame event, go ahead
4082 and build a real event from the queue entry. */
4086 obj
= make_lispy_event (event
);
4088 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4089 || defined (USE_GTK)
4090 /* If this was a menu selection, then set the flag to inhibit
4091 writing to last_nonmenu_event. Don't do this if the event
4092 we're returning is (menu-bar), though; that indicates the
4093 beginning of the menu sequence, and we might as well leave
4094 that as the `event with parameters' for this selection. */
4096 && !EQ (event
->frame_or_window
, event
->arg
)
4097 && (event
->kind
== MENU_BAR_EVENT
4098 || event
->kind
== TOOL_BAR_EVENT
))
4099 *used_mouse_menu
= 1;
4102 /* Wipe out this event, to catch bugs. */
4103 clear_event (event
);
4104 kbd_fetch_ptr
= event
+ 1;
4109 /* Try generating a mouse motion event. */
4110 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4112 FRAME_PTR f
= some_mouse_moved ();
4113 Lisp_Object bar_window
;
4114 enum scroll_bar_part part
;
4118 *kbp
= current_kboard
;
4119 /* Note that this uses F to determine which display to look at.
4120 If there is no valid info, it does not store anything
4121 so x remains nil. */
4123 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4127 /* Decide if we should generate a switch-frame event. Don't
4128 generate switch-frame events for motion outside of all Emacs
4134 frame
= FRAME_FOCUS_FRAME (f
);
4136 XSETFRAME (frame
, f
);
4138 if (! EQ (frame
, internal_last_event_frame
)
4139 && !EQ (frame
, selected_frame
))
4140 obj
= make_lispy_switch_frame (frame
);
4141 internal_last_event_frame
= frame
;
4144 /* If we didn't decide to make a switch-frame event, go ahead and
4145 return a mouse-motion event. */
4146 if (!NILP (x
) && NILP (obj
))
4147 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4149 #endif /* HAVE_MOUSE */
4151 /* We were promised by the above while loop that there was
4152 something for us to read! */
4155 input_pending
= readable_events (0);
4157 Vlast_event_frame
= internal_last_event_frame
;
4162 /* Process any events that are not user-visible,
4163 then return, without reading any user-visible events. */
4166 swallow_events (do_display
)
4171 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4173 struct input_event
*event
;
4175 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4179 last_event_timestamp
= event
->timestamp
;
4181 /* These two kinds of events get special handling
4182 and don't actually appear to the command loop. */
4183 if (event
->kind
== SELECTION_REQUEST_EVENT
4184 || event
->kind
== SELECTION_CLEAR_EVENT
)
4187 struct input_event copy
;
4189 /* Remove it from the buffer before processing it,
4190 since otherwise swallow_events called recursively could see it
4191 and process it again. */
4193 kbd_fetch_ptr
= event
+ 1;
4194 input_pending
= readable_events (0);
4195 x_handle_selection_event (©
);
4197 /* We're getting selection request events, but we don't have
4206 old_timers_run
= timers_run
;
4207 get_input_pending (&input_pending
, 1);
4209 if (timers_run
!= old_timers_run
&& do_display
)
4210 redisplay_preserve_echo_area (7);
4213 /* Record the start of when Emacs is idle,
4214 for the sake of running idle-time timers. */
4221 /* If we are already in the idle state, do nothing. */
4222 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4225 EMACS_GET_TIME (timer_idleness_start_time
);
4227 timer_last_idleness_start_time
= timer_idleness_start_time
;
4229 /* Mark all idle-time timers as once again candidates for running. */
4230 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4234 timer
= XCAR (timers
);
4236 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4238 XVECTOR (timer
)->contents
[0] = Qnil
;
4242 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4247 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4250 /* Resume idle timer from last idle start time. */
4253 timer_resume_idle ()
4255 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4258 timer_idleness_start_time
= timer_last_idleness_start_time
;
4261 /* This is only for debugging. */
4262 struct input_event last_timer_event
;
4264 /* Check whether a timer has fired. To prevent larger problems we simply
4265 disregard elements that are not proper timers. Do not make a circular
4266 timer list for the time being.
4268 Returns the number of seconds to wait until the next timer fires. If a
4269 timer is triggering now, return zero seconds.
4270 If no timer is active, return -1 seconds.
4272 If a timer is ripe, we run it, with quitting turned off.
4274 DO_IT_NOW is now ignored. It used to mean that we should
4275 run the timer directly instead of queueing a timer-event.
4276 Now we always run timers directly. */
4279 timer_check (do_it_now
)
4282 EMACS_TIME nexttime
;
4283 EMACS_TIME now
, idleness_now
;
4284 Lisp_Object timers
, idle_timers
, chosen_timer
;
4285 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4287 EMACS_SET_SECS (nexttime
, -1);
4288 EMACS_SET_USECS (nexttime
, -1);
4290 /* Always consider the ordinary timers. */
4291 timers
= Vtimer_list
;
4292 /* Consider the idle timers only if Emacs is idle. */
4293 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4294 idle_timers
= Vtimer_idle_list
;
4297 chosen_timer
= Qnil
;
4298 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4300 if (CONSP (timers
) || CONSP (idle_timers
))
4302 EMACS_GET_TIME (now
);
4303 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4304 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4307 while (CONSP (timers
) || CONSP (idle_timers
))
4309 Lisp_Object
*vector
;
4310 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4311 EMACS_TIME timer_time
, idle_timer_time
;
4312 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4314 /* Skip past invalid timers and timers already handled. */
4317 timer
= XCAR (timers
);
4318 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4320 timers
= XCDR (timers
);
4323 vector
= XVECTOR (timer
)->contents
;
4325 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4326 || !INTEGERP (vector
[3])
4327 || ! NILP (vector
[0]))
4329 timers
= XCDR (timers
);
4333 if (!NILP (idle_timers
))
4335 timer
= XCAR (idle_timers
);
4336 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4338 idle_timers
= XCDR (idle_timers
);
4341 vector
= XVECTOR (timer
)->contents
;
4343 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4344 || !INTEGERP (vector
[3])
4345 || ! NILP (vector
[0]))
4347 idle_timers
= XCDR (idle_timers
);
4352 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4353 based on the next ordinary timer.
4354 TIMER_DIFFERENCE is the distance in time from NOW to when
4355 this timer becomes ripe (negative if it's already ripe). */
4358 timer
= XCAR (timers
);
4359 vector
= XVECTOR (timer
)->contents
;
4360 EMACS_SET_SECS (timer_time
,
4361 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4362 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4363 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4366 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4367 based on the next idle timer. */
4368 if (!NILP (idle_timers
))
4370 idle_timer
= XCAR (idle_timers
);
4371 vector
= XVECTOR (idle_timer
)->contents
;
4372 EMACS_SET_SECS (idle_timer_time
,
4373 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4374 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4375 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4378 /* Decide which timer is the next timer,
4379 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4380 Also step down the list where we found that timer. */
4382 if (! NILP (timers
) && ! NILP (idle_timers
))
4385 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4386 if (EMACS_TIME_NEG_P (temp
))
4388 chosen_timer
= timer
;
4389 timers
= XCDR (timers
);
4390 difference
= timer_difference
;
4394 chosen_timer
= idle_timer
;
4395 idle_timers
= XCDR (idle_timers
);
4396 difference
= idle_timer_difference
;
4399 else if (! NILP (timers
))
4401 chosen_timer
= timer
;
4402 timers
= XCDR (timers
);
4403 difference
= timer_difference
;
4407 chosen_timer
= idle_timer
;
4408 idle_timers
= XCDR (idle_timers
);
4409 difference
= idle_timer_difference
;
4411 vector
= XVECTOR (chosen_timer
)->contents
;
4413 /* If timer is ripe, run it if it hasn't been run. */
4414 if (EMACS_TIME_NEG_P (difference
)
4415 || (EMACS_SECS (difference
) == 0
4416 && EMACS_USECS (difference
) == 0))
4418 if (NILP (vector
[0]))
4420 int was_locked
= single_kboard
;
4421 int count
= SPECPDL_INDEX ();
4422 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4424 /* Mark the timer as triggered to prevent problems if the lisp
4425 code fails to reschedule it right. */
4428 specbind (Qinhibit_quit
, Qt
);
4430 call1 (Qtimer_event_handler
, chosen_timer
);
4431 Vdeactivate_mark
= old_deactivate_mark
;
4433 unbind_to (count
, Qnil
);
4435 /* Resume allowing input from any kboard, if that was true before. */
4437 any_kboard_state ();
4439 /* Since we have handled the event,
4440 we don't need to tell the caller to wake up and do it. */
4444 /* When we encounter a timer that is still waiting,
4445 return the amount of time to wait before it is ripe. */
4452 /* No timers are pending in the future. */
4453 /* Return 0 if we generated an event, and -1 if not. */
4458 /* Caches for modify_event_symbol. */
4459 static Lisp_Object accent_key_syms
;
4460 static Lisp_Object func_key_syms
;
4461 static Lisp_Object mouse_syms
;
4462 static Lisp_Object wheel_syms
;
4463 static Lisp_Object drag_n_drop_syms
;
4465 /* This is a list of keysym codes for special "accent" characters.
4466 It parallels lispy_accent_keys. */
4468 static int lispy_accent_codes
[] =
4470 #ifdef XK_dead_circumflex
4475 #ifdef XK_dead_grave
4480 #ifdef XK_dead_tilde
4485 #ifdef XK_dead_diaeresis
4490 #ifdef XK_dead_macron
4495 #ifdef XK_dead_degree
4500 #ifdef XK_dead_acute
4505 #ifdef XK_dead_cedilla
4510 #ifdef XK_dead_breve
4515 #ifdef XK_dead_ogonek
4520 #ifdef XK_dead_caron
4525 #ifdef XK_dead_doubleacute
4526 XK_dead_doubleacute
,
4530 #ifdef XK_dead_abovedot
4535 #ifdef XK_dead_abovering
4545 #ifdef XK_dead_belowdot
4550 #ifdef XK_dead_voiced_sound
4551 XK_dead_voiced_sound
,
4555 #ifdef XK_dead_semivoiced_sound
4556 XK_dead_semivoiced_sound
,
4572 /* This is a list of Lisp names for special "accent" characters.
4573 It parallels lispy_accent_codes. */
4575 static char *lispy_accent_keys
[] =
4593 "dead-voiced-sound",
4594 "dead-semivoiced-sound",
4600 #define FUNCTION_KEY_OFFSET 0x0
4602 char *lispy_function_keys
[] =
4606 0, /* VK_LBUTTON 0x01 */
4607 0, /* VK_RBUTTON 0x02 */
4608 "cancel", /* VK_CANCEL 0x03 */
4609 0, /* VK_MBUTTON 0x04 */
4611 0, 0, 0, /* 0x05 .. 0x07 */
4613 "backspace", /* VK_BACK 0x08 */
4614 "tab", /* VK_TAB 0x09 */
4616 0, 0, /* 0x0A .. 0x0B */
4618 "clear", /* VK_CLEAR 0x0C */
4619 "return", /* VK_RETURN 0x0D */
4621 0, 0, /* 0x0E .. 0x0F */
4623 0, /* VK_SHIFT 0x10 */
4624 0, /* VK_CONTROL 0x11 */
4625 0, /* VK_MENU 0x12 */
4626 "pause", /* VK_PAUSE 0x13 */
4627 "capslock", /* VK_CAPITAL 0x14 */
4629 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4631 "escape", /* VK_ESCAPE 0x1B */
4633 0, 0, 0, 0, /* 0x1C .. 0x1F */
4635 0, /* VK_SPACE 0x20 */
4636 "prior", /* VK_PRIOR 0x21 */
4637 "next", /* VK_NEXT 0x22 */
4638 "end", /* VK_END 0x23 */
4639 "home", /* VK_HOME 0x24 */
4640 "left", /* VK_LEFT 0x25 */
4641 "up", /* VK_UP 0x26 */
4642 "right", /* VK_RIGHT 0x27 */
4643 "down", /* VK_DOWN 0x28 */
4644 "select", /* VK_SELECT 0x29 */
4645 "print", /* VK_PRINT 0x2A */
4646 "execute", /* VK_EXECUTE 0x2B */
4647 "snapshot", /* VK_SNAPSHOT 0x2C */
4648 "insert", /* VK_INSERT 0x2D */
4649 "delete", /* VK_DELETE 0x2E */
4650 "help", /* VK_HELP 0x2F */
4652 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4654 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4656 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4658 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4660 0, 0, 0, 0, 0, 0, 0, 0, 0,
4661 0, 0, 0, 0, 0, 0, 0, 0, 0,
4662 0, 0, 0, 0, 0, 0, 0, 0,
4664 "lwindow", /* VK_LWIN 0x5B */
4665 "rwindow", /* VK_RWIN 0x5C */
4666 "apps", /* VK_APPS 0x5D */
4668 0, 0, /* 0x5E .. 0x5F */
4670 "kp-0", /* VK_NUMPAD0 0x60 */
4671 "kp-1", /* VK_NUMPAD1 0x61 */
4672 "kp-2", /* VK_NUMPAD2 0x62 */
4673 "kp-3", /* VK_NUMPAD3 0x63 */
4674 "kp-4", /* VK_NUMPAD4 0x64 */
4675 "kp-5", /* VK_NUMPAD5 0x65 */
4676 "kp-6", /* VK_NUMPAD6 0x66 */
4677 "kp-7", /* VK_NUMPAD7 0x67 */
4678 "kp-8", /* VK_NUMPAD8 0x68 */
4679 "kp-9", /* VK_NUMPAD9 0x69 */
4680 "kp-multiply", /* VK_MULTIPLY 0x6A */
4681 "kp-add", /* VK_ADD 0x6B */
4682 "kp-separator", /* VK_SEPARATOR 0x6C */
4683 "kp-subtract", /* VK_SUBTRACT 0x6D */
4684 "kp-decimal", /* VK_DECIMAL 0x6E */
4685 "kp-divide", /* VK_DIVIDE 0x6F */
4686 "f1", /* VK_F1 0x70 */
4687 "f2", /* VK_F2 0x71 */
4688 "f3", /* VK_F3 0x72 */
4689 "f4", /* VK_F4 0x73 */
4690 "f5", /* VK_F5 0x74 */
4691 "f6", /* VK_F6 0x75 */
4692 "f7", /* VK_F7 0x76 */
4693 "f8", /* VK_F8 0x77 */
4694 "f9", /* VK_F9 0x78 */
4695 "f10", /* VK_F10 0x79 */
4696 "f11", /* VK_F11 0x7A */
4697 "f12", /* VK_F12 0x7B */
4698 "f13", /* VK_F13 0x7C */
4699 "f14", /* VK_F14 0x7D */
4700 "f15", /* VK_F15 0x7E */
4701 "f16", /* VK_F16 0x7F */
4702 "f17", /* VK_F17 0x80 */
4703 "f18", /* VK_F18 0x81 */
4704 "f19", /* VK_F19 0x82 */
4705 "f20", /* VK_F20 0x83 */
4706 "f21", /* VK_F21 0x84 */
4707 "f22", /* VK_F22 0x85 */
4708 "f23", /* VK_F23 0x86 */
4709 "f24", /* VK_F24 0x87 */
4711 0, 0, 0, 0, /* 0x88 .. 0x8B */
4712 0, 0, 0, 0, /* 0x8C .. 0x8F */
4714 "kp-numlock", /* VK_NUMLOCK 0x90 */
4715 "scroll", /* VK_SCROLL 0x91 */
4717 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4718 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4719 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4720 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4721 "kp-end", /* VK_NUMPAD_END 0x96 */
4722 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4723 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4724 "kp-up", /* VK_NUMPAD_UP 0x99 */
4725 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4726 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4727 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4728 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4730 0, 0, /* 0x9E .. 0x9F */
4733 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4734 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4735 * No other API or message will distinguish left and right keys this way.
4739 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4740 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4741 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4742 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4743 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4749 "attn", /* VK_ATTN 0xF6 */
4750 "crsel", /* VK_CRSEL 0xF7 */
4751 "exsel", /* VK_EXSEL 0xF8 */
4752 "ereof", /* VK_EREOF 0xF9 */
4753 "play", /* VK_PLAY 0xFA */
4754 "zoom", /* VK_ZOOM 0xFB */
4755 "noname", /* VK_NONAME 0xFC */
4756 "pa1", /* VK_PA1 0xFD */
4757 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4761 #else /* not HAVE_NTGUI */
4763 /* This should be dealt with in XTread_socket now, and that doesn't
4764 depend on the client system having the Kana syms defined. See also
4765 the XK_kana_A case below. */
4768 static char *lispy_kana_keys
[] =
4770 /* X Keysym value */
4771 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4772 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4773 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4774 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4775 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4776 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4777 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4778 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4779 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4780 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4781 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4782 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4783 "kana-i", "kana-u", "kana-e", "kana-o",
4784 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4785 "prolongedsound", "kana-A", "kana-I", "kana-U",
4786 "kana-E", "kana-O", "kana-KA", "kana-KI",
4787 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4788 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4789 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4790 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4791 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4792 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4793 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4794 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4795 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4796 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4797 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4798 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4800 #endif /* XK_kana_A */
4803 #define FUNCTION_KEY_OFFSET 0xff00
4805 /* You'll notice that this table is arranged to be conveniently
4806 indexed by X Windows keysym values. */
4807 static char *lispy_function_keys
[] =
4809 /* X Keysym value */
4811 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4812 "backspace", "tab", "linefeed", "clear",
4814 0, 0, 0, "pause", /* 0xff10...1f */
4815 0, 0, 0, 0, 0, 0, 0, "escape",
4817 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4818 "romaji", "hiragana", "katakana", "hiragana-katakana",
4819 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4820 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4821 "eisu-toggle", /* 0xff30...3f */
4822 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4823 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4825 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4826 "down", "prior", "next", "end",
4827 "begin", 0, 0, 0, 0, 0, 0, 0,
4828 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4839 "break", /* 0xff6b */
4842 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4843 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4844 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4845 0, 0, 0, 0, 0, 0, 0, 0,
4846 "kp-tab", /* 0xff89 */
4848 "kp-enter", /* 0xff8d */
4850 "kp-f1", /* 0xff91 */
4854 "kp-home", /* 0xff95 */
4859 "kp-prior", /* kp-page-up */
4860 "kp-next", /* kp-page-down */
4866 0, 0, 0, 0, 0, 0, 0, 0, 0,
4867 "kp-multiply", /* 0xffaa */
4872 "kp-divide", /* 0xffaf */
4873 "kp-0", /* 0xffb0 */
4874 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4877 "kp-equal", /* 0xffbd */
4878 "f1", /* 0xffbe */ /* IsFunctionKey */
4880 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4881 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4882 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4883 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4884 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4885 0, 0, 0, 0, 0, 0, 0, 0,
4886 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4887 0, 0, 0, 0, 0, 0, 0, "delete"
4890 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4891 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4893 static char *iso_lispy_function_keys
[] =
4895 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4896 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4897 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4898 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4899 "iso-lefttab", /* 0xfe20 */
4900 "iso-move-line-up", "iso-move-line-down",
4901 "iso-partial-line-up", "iso-partial-line-down",
4902 "iso-partial-space-left", "iso-partial-space-right",
4903 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4904 "iso-release-margin-left", "iso-release-margin-right",
4905 "iso-release-both-margins",
4906 "iso-fast-cursor-left", "iso-fast-cursor-right",
4907 "iso-fast-cursor-up", "iso-fast-cursor-down",
4908 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4909 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4912 #endif /* not HAVE_NTGUI */
4914 Lisp_Object Vlispy_mouse_stem
;
4916 static char *lispy_wheel_names
[] =
4918 "wheel-up", "wheel-down"
4921 /* drag-n-drop events are generated when a set of selected files are
4922 dragged from another application and dropped onto an Emacs window. */
4923 static char *lispy_drag_n_drop_names
[] =
4928 /* Scroll bar parts. */
4929 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4930 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4931 Lisp_Object Qtop
, Qratio
;
4933 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4934 Lisp_Object
*scroll_bar_parts
[] = {
4935 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4936 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4939 /* User signal events. */
4940 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4942 Lisp_Object
*lispy_user_signals
[] =
4944 &Qusr1_signal
, &Qusr2_signal
4948 /* A vector, indexed by button number, giving the down-going location
4949 of currently depressed buttons, both scroll bar and non-scroll bar.
4951 The elements have the form
4952 (BUTTON-NUMBER MODIFIER-MASK . REST)
4953 where REST is the cdr of a position as it would be reported in the event.
4955 The make_lispy_event function stores positions here to tell the
4956 difference between click and drag events, and to store the starting
4957 location to be included in drag events. */
4959 static Lisp_Object button_down_location
;
4961 /* Information about the most recent up-going button event: Which
4962 button, what location, and what time. */
4964 static int last_mouse_button
;
4965 static int last_mouse_x
;
4966 static int last_mouse_y
;
4967 static unsigned long button_down_time
;
4969 /* The maximum time between clicks to make a double-click, or Qnil to
4970 disable double-click detection, or Qt for no time limit. */
4972 Lisp_Object Vdouble_click_time
;
4974 /* Maximum number of pixels the mouse may be moved between clicks
4975 to make a double-click. */
4977 EMACS_INT double_click_fuzz
;
4979 /* The number of clicks in this multiple-click. */
4981 int double_click_count
;
4983 /* Return position of a mouse click or wheel event */
4986 make_lispy_position (f
, x
, y
, time
)
4992 enum window_part part
;
4993 Lisp_Object posn
= Qnil
;
4994 Lisp_Object extra_info
= Qnil
;
4997 /* Set `window' to the window under frame pixel coordinates (x,y) */
4999 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5000 &part
, &wx
, &wy
, 0);
5004 if (WINDOWP (window
))
5006 /* It's a click in window window at frame coordinates (x,y) */
5007 struct window
*w
= XWINDOW (window
);
5008 Lisp_Object string_info
= Qnil
;
5009 int textpos
= -1, rx
= -1, ry
= -1;
5010 int dx
= -1, dy
= -1;
5011 int width
= -1, height
= -1;
5012 Lisp_Object object
= Qnil
;
5014 /* Set event coordinates to window-relative coordinates
5015 for constructing the Lisp event below. */
5019 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5021 /* Mode line or header line. Look for a string under
5022 the mouse that may have a `local-map' property. */
5026 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5028 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5029 &object
, &dx
, &dy
, &width
, &height
);
5030 if (STRINGP (string
))
5031 string_info
= Fcons (string
, make_number (charpos
));
5032 if (w
== XWINDOW (selected_window
))
5035 textpos
= XMARKER (w
->pointm
)->charpos
;
5037 else if (part
== ON_VERTICAL_BORDER
)
5039 posn
= Qvertical_line
;
5044 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5049 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5051 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5052 &object
, &dx
, &dy
, &width
, &height
);
5053 if (STRINGP (string
))
5054 string_info
= Fcons (string
, make_number (charpos
));
5056 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5058 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5061 if (part
== ON_RIGHT_FRINGE
)
5062 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5063 + window_box_width (w
, TEXT_AREA
)
5064 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5065 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5067 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5068 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5073 Lisp_Object string2
, object2
= Qnil
;
5074 struct display_pos p
;
5076 int width2
, height2
;
5077 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5078 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5079 &object2
, &dx2
, &dy2
,
5081 textpos
= CHARPOS (p
.pos
);
5082 if (rx
< 0) rx
= wx
;
5083 if (ry
< 0) ry
= wy
;
5084 if (dx
< 0) dx
= dx2
;
5085 if (dy
< 0) dy
= dy2
;
5086 if (width
< 0) width
= width2
;
5087 if (height
< 0) height
= height2
;
5091 posn
= make_number (textpos
);
5092 if (STRINGP (string2
))
5093 string_info
= Fcons (string2
,
5094 make_number (CHARPOS (p
.string_pos
)));
5100 #ifdef HAVE_WINDOW_SYSTEM
5101 if (IMAGEP (object
))
5103 Lisp_Object image_map
, hotspot
;
5104 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5106 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5108 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5109 posn
= XCAR (hotspot
);
5114 extra_info
= Fcons (object
,
5115 Fcons (Fcons (make_number (dx
),
5117 Fcons (Fcons (make_number (width
),
5118 make_number (height
)),
5122 extra_info
= Fcons (string_info
,
5123 Fcons (make_number (textpos
),
5124 Fcons (Fcons (make_number (rx
),
5130 XSETFRAME (window
, f
);
5135 XSETFASTINT (*x
, 0);
5136 XSETFASTINT (*y
, 0);
5139 return Fcons (window
,
5141 Fcons (Fcons (*x
, *y
),
5142 Fcons (make_number (time
),
5146 /* Given a struct input_event, build the lisp event which represents
5147 it. If EVENT is 0, build a mouse movement event from the mouse
5148 movement buffer, which should have a movement event in it.
5150 Note that events must be passed to this function in the order they
5151 are received; this function stores the location of button presses
5152 in order to build drag events when the button is released. */
5155 make_lispy_event (event
)
5156 struct input_event
*event
;
5160 switch (SWITCH_ENUM_CAST (event
->kind
))
5162 /* A simple keystroke. */
5163 case ASCII_KEYSTROKE_EVENT
:
5165 Lisp_Object lispy_c
;
5166 int c
= event
->code
& 0377;
5167 /* Turn ASCII characters into control characters
5169 if (event
->modifiers
& ctrl_modifier
)
5170 c
= make_ctrl_char (c
);
5172 /* Add in the other modifier bits. We took care of ctrl_modifier
5173 just above, and the shift key was taken care of by the X code,
5174 and applied to control characters by make_ctrl_char. */
5175 c
|= (event
->modifiers
5176 & (meta_modifier
| alt_modifier
5177 | hyper_modifier
| super_modifier
));
5178 /* Distinguish Shift-SPC from SPC. */
5179 if ((event
->code
& 0377) == 040
5180 && event
->modifiers
& shift_modifier
)
5181 c
|= shift_modifier
;
5182 button_down_time
= 0;
5183 XSETFASTINT (lispy_c
, c
);
5187 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5189 Lisp_Object lispy_c
;
5190 int c
= event
->code
;
5192 /* Add in the other modifier bits. We took care of ctrl_modifier
5193 just above, and the shift key was taken care of by the X code,
5194 and applied to control characters by make_ctrl_char. */
5195 c
|= (event
->modifiers
5196 & (meta_modifier
| alt_modifier
5197 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5198 /* What about the `shift' modifier ? */
5199 button_down_time
= 0;
5200 XSETFASTINT (lispy_c
, c
);
5204 /* A function key. The symbol may need to have modifier prefixes
5206 case NON_ASCII_KEYSTROKE_EVENT
:
5207 button_down_time
= 0;
5209 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5210 if (event
->code
== lispy_accent_codes
[i
])
5211 return modify_event_symbol (i
,
5213 Qfunction_key
, Qnil
,
5214 lispy_accent_keys
, &accent_key_syms
,
5215 (sizeof (lispy_accent_keys
)
5216 / sizeof (lispy_accent_keys
[0])));
5220 if (event
->code
>= 0x400 && event
->code
< 0x500)
5221 return modify_event_symbol (event
->code
- 0x400,
5222 event
->modifiers
& ~shift_modifier
,
5223 Qfunction_key
, Qnil
,
5224 lispy_kana_keys
, &func_key_syms
,
5225 (sizeof (lispy_kana_keys
)
5226 / sizeof (lispy_kana_keys
[0])));
5227 #endif /* XK_kana_A */
5230 #ifdef ISO_FUNCTION_KEY_OFFSET
5231 if (event
->code
< FUNCTION_KEY_OFFSET
5232 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5233 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5235 Qfunction_key
, Qnil
,
5236 iso_lispy_function_keys
, &func_key_syms
,
5237 (sizeof (iso_lispy_function_keys
)
5238 / sizeof (iso_lispy_function_keys
[0])));
5241 /* Handle system-specific or unknown keysyms. */
5242 if (event
->code
& (1 << 28)
5243 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5244 || (event
->code
- FUNCTION_KEY_OFFSET
5245 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5246 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5248 /* We need to use an alist rather than a vector as the cache
5249 since we can't make a vector long enuf. */
5250 if (NILP (current_kboard
->system_key_syms
))
5251 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5252 return modify_event_symbol (event
->code
,
5255 current_kboard
->Vsystem_key_alist
,
5256 0, ¤t_kboard
->system_key_syms
,
5260 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5262 Qfunction_key
, Qnil
,
5263 lispy_function_keys
, &func_key_syms
,
5264 (sizeof (lispy_function_keys
)
5265 / sizeof (lispy_function_keys
[0])));
5268 /* A mouse click. Figure out where it is, decide whether it's
5269 a press, click or drag, and build the appropriate structure. */
5270 case MOUSE_CLICK_EVENT
:
5271 #ifndef USE_TOOLKIT_SCROLL_BARS
5272 case SCROLL_BAR_CLICK_EVENT
:
5275 int button
= event
->code
;
5277 Lisp_Object position
;
5278 Lisp_Object
*start_pos_ptr
;
5279 Lisp_Object start_pos
;
5283 /* Build the position as appropriate for this mouse click. */
5284 if (event
->kind
== MOUSE_CLICK_EVENT
)
5286 struct frame
*f
= XFRAME (event
->frame_or_window
);
5287 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5291 /* Ignore mouse events that were made on frame that
5292 have been deleted. */
5293 if (! FRAME_LIVE_P (f
))
5296 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5297 /* EVENT->x and EVENT->y are frame-relative pixel
5298 coordinates at this place. Under old redisplay, COLUMN
5299 and ROW are set to frame relative glyph coordinates
5300 which are then used to determine whether this click is
5301 in a menu (non-toolkit version). */
5302 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5303 &column
, &row
, NULL
, 1);
5305 /* In the non-toolkit version, clicks on the menu bar
5306 are ordinary button events in the event buffer.
5307 Distinguish them, and invoke the menu.
5309 (In the toolkit version, the toolkit handles the menu bar
5310 and Emacs doesn't know about it until after the user
5311 makes a selection.) */
5312 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5313 && (event
->modifiers
& down_modifier
))
5315 Lisp_Object items
, item
;
5320 /* Activate the menu bar on the down event. If the
5321 up event comes in before the menu code can deal with it,
5323 if (! (event
->modifiers
& down_modifier
))
5327 /* Find the menu bar item under `column'. */
5329 items
= FRAME_MENU_BAR_ITEMS (f
);
5330 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5332 Lisp_Object pos
, string
;
5333 string
= AREF (items
, i
+ 1);
5334 pos
= AREF (items
, i
+ 3);
5337 if (column
>= XINT (pos
)
5338 && column
< XINT (pos
) + SCHARS (string
))
5340 item
= AREF (items
, i
);
5345 /* ELisp manual 2.4b says (x y) are window relative but
5346 code says they are frame-relative. */
5348 = Fcons (event
->frame_or_window
,
5350 Fcons (Fcons (event
->x
, event
->y
),
5351 Fcons (make_number (event
->timestamp
),
5354 return Fcons (item
, Fcons (position
, Qnil
));
5356 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5358 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5361 #ifndef USE_TOOLKIT_SCROLL_BARS
5364 /* It's a scrollbar click. */
5366 Lisp_Object portion_whole
;
5369 window
= event
->frame_or_window
;
5370 portion_whole
= Fcons (event
->x
, event
->y
);
5371 part
= *scroll_bar_parts
[(int) event
->part
];
5375 Fcons (Qvertical_scroll_bar
,
5376 Fcons (portion_whole
,
5377 Fcons (make_number (event
->timestamp
),
5378 Fcons (part
, Qnil
)))));
5380 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5382 if (button
>= ASIZE (button_down_location
))
5384 button_down_location
= larger_vector (button_down_location
,
5386 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5389 start_pos_ptr
= &AREF (button_down_location
, button
);
5390 start_pos
= *start_pos_ptr
;
5391 *start_pos_ptr
= Qnil
;
5394 /* On window-system frames, use the value of
5395 double-click-fuzz as is. On other frames, interpret it
5396 as a multiple of 1/8 characters. */
5400 if (WINDOWP (event
->frame_or_window
))
5401 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5402 else if (FRAMEP (event
->frame_or_window
))
5403 f
= XFRAME (event
->frame_or_window
);
5407 if (FRAME_WINDOW_P (f
))
5408 fuzz
= double_click_fuzz
;
5410 fuzz
= double_click_fuzz
/ 8;
5412 is_double
= (button
== last_mouse_button
5413 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5414 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5415 && button_down_time
!= 0
5416 && (EQ (Vdouble_click_time
, Qt
)
5417 || (INTEGERP (Vdouble_click_time
)
5418 && ((int)(event
->timestamp
- button_down_time
)
5419 < XINT (Vdouble_click_time
)))));
5422 last_mouse_button
= button
;
5423 last_mouse_x
= XINT (event
->x
);
5424 last_mouse_y
= XINT (event
->y
);
5426 /* If this is a button press, squirrel away the location, so
5427 we can decide later whether it was a click or a drag. */
5428 if (event
->modifiers
& down_modifier
)
5432 double_click_count
++;
5433 event
->modifiers
|= ((double_click_count
> 2)
5438 double_click_count
= 1;
5439 button_down_time
= event
->timestamp
;
5440 *start_pos_ptr
= Fcopy_alist (position
);
5443 /* Now we're releasing a button - check the co-ordinates to
5444 see if this was a click or a drag. */
5445 else if (event
->modifiers
& up_modifier
)
5447 /* If we did not see a down before this up, ignore the up.
5448 Probably this happened because the down event chose a
5449 menu item. It would be an annoyance to treat the
5450 release of the button that chose the menu item as a
5453 if (!CONSP (start_pos
))
5456 event
->modifiers
&= ~up_modifier
;
5457 #if 0 /* Formerly we treated an up with no down as a click event. */
5458 if (!CONSP (start_pos
))
5459 event
->modifiers
|= click_modifier
;
5464 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5466 /* The third element of every position
5467 should be the (x,y) pair. */
5468 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5470 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5472 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5473 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5476 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5477 && ydiff
< double_click_fuzz
5478 && ydiff
> - double_click_fuzz
)
5479 /* Mouse hasn't moved (much). */
5480 event
->modifiers
|= click_modifier
;
5483 button_down_time
= 0;
5484 event
->modifiers
|= drag_modifier
;
5487 /* Don't check is_double; treat this as multiple
5488 if the down-event was multiple. */
5489 if (double_click_count
> 1)
5490 event
->modifiers
|= ((double_click_count
> 2)
5496 /* Every mouse event should either have the down_modifier or
5497 the up_modifier set. */
5501 /* Get the symbol we should use for the mouse click. */
5504 head
= modify_event_symbol (button
,
5506 Qmouse_click
, Vlispy_mouse_stem
,
5509 XVECTOR (mouse_syms
)->size
);
5510 if (event
->modifiers
& drag_modifier
)
5515 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5518 Fcons (make_number (double_click_count
),
5529 Lisp_Object position
;
5532 /* Build the position as appropriate for this mouse click. */
5533 struct frame
*f
= XFRAME (event
->frame_or_window
);
5535 /* Ignore wheel events that were made on frame that have been
5537 if (! FRAME_LIVE_P (f
))
5540 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5543 /* Set double or triple modifiers to indicate the wheel speed. */
5545 /* On window-system frames, use the value of
5546 double-click-fuzz as is. On other frames, interpret it
5547 as a multiple of 1/8 characters. */
5552 if (WINDOWP (event
->frame_or_window
))
5553 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5554 else if (FRAMEP (event
->frame_or_window
))
5555 f
= XFRAME (event
->frame_or_window
);
5559 if (FRAME_WINDOW_P (f
))
5560 fuzz
= double_click_fuzz
;
5562 fuzz
= double_click_fuzz
/ 8;
5564 is_double
= (last_mouse_button
< 0
5565 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5566 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5567 && button_down_time
!= 0
5568 && (EQ (Vdouble_click_time
, Qt
)
5569 || (INTEGERP (Vdouble_click_time
)
5570 && ((int)(event
->timestamp
- button_down_time
)
5571 < XINT (Vdouble_click_time
)))));
5574 double_click_count
++;
5575 event
->modifiers
|= ((double_click_count
> 2)
5581 double_click_count
= 1;
5582 event
->modifiers
|= click_modifier
;
5585 button_down_time
= event
->timestamp
;
5586 /* Use a negative value to distinguish wheel from mouse button. */
5587 last_mouse_button
= -1;
5588 last_mouse_x
= XINT (event
->x
);
5589 last_mouse_y
= XINT (event
->y
);
5595 if (event
->modifiers
& up_modifier
)
5597 /* Emit a wheel-up event. */
5598 event
->modifiers
&= ~up_modifier
;
5601 else if (event
->modifiers
& down_modifier
)
5603 /* Emit a wheel-down event. */
5604 event
->modifiers
&= ~down_modifier
;
5608 /* Every wheel event should either have the down_modifier or
5609 the up_modifier set. */
5612 /* Get the symbol we should use for the wheel event. */
5613 head
= modify_event_symbol (symbol_num
,
5619 ASIZE (wheel_syms
));
5622 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5625 Fcons (make_number (double_click_count
),
5634 #ifdef USE_TOOLKIT_SCROLL_BARS
5636 /* We don't have down and up events if using toolkit scroll bars,
5637 so make this always a click event. Store in the `part' of
5638 the Lisp event a symbol which maps to the following actions:
5640 `above_handle' page up
5641 `below_handle' page down
5645 `bottom' bottom of buffer
5646 `handle' thumb has been dragged.
5647 `end-scroll' end of interaction with scroll bar
5649 The incoming input_event contains in its `part' member an
5650 index of type `enum scroll_bar_part' which we can use as an
5651 index in scroll_bar_parts to get the appropriate symbol. */
5653 case SCROLL_BAR_CLICK_EVENT
:
5655 Lisp_Object position
, head
, window
, portion_whole
, part
;
5657 window
= event
->frame_or_window
;
5658 portion_whole
= Fcons (event
->x
, event
->y
);
5659 part
= *scroll_bar_parts
[(int) event
->part
];
5663 Fcons (Qvertical_scroll_bar
,
5664 Fcons (portion_whole
,
5665 Fcons (make_number (event
->timestamp
),
5666 Fcons (part
, Qnil
)))));
5668 /* Always treat scroll bar events as clicks. */
5669 event
->modifiers
|= click_modifier
;
5670 event
->modifiers
&= ~up_modifier
;
5672 if (event
->code
>= ASIZE (mouse_syms
))
5673 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5675 /* Get the symbol we should use for the mouse click. */
5676 head
= modify_event_symbol (event
->code
,
5681 XVECTOR (mouse_syms
)->size
);
5682 return Fcons (head
, Fcons (position
, Qnil
));
5685 #endif /* USE_TOOLKIT_SCROLL_BARS */
5688 case W32_SCROLL_BAR_CLICK_EVENT
:
5690 int button
= event
->code
;
5692 Lisp_Object position
;
5693 Lisp_Object
*start_pos_ptr
;
5694 Lisp_Object start_pos
;
5698 Lisp_Object portion_whole
;
5701 window
= event
->frame_or_window
;
5702 portion_whole
= Fcons (event
->x
, event
->y
);
5703 part
= *scroll_bar_parts
[(int) event
->part
];
5707 Fcons (Qvertical_scroll_bar
,
5708 Fcons (portion_whole
,
5709 Fcons (make_number (event
->timestamp
),
5710 Fcons (part
, Qnil
)))));
5713 /* Always treat W32 scroll bar events as clicks. */
5714 event
->modifiers
|= click_modifier
;
5717 /* Get the symbol we should use for the mouse click. */
5720 head
= modify_event_symbol (button
,
5725 XVECTOR (mouse_syms
)->size
);
5731 #endif /* WINDOWSNT */
5733 case DRAG_N_DROP_EVENT
:
5736 Lisp_Object head
, position
;
5739 /* The frame_or_window field should be a cons of the frame in
5740 which the event occurred and a list of the filenames
5742 if (! CONSP (event
->frame_or_window
))
5745 f
= XFRAME (XCAR (event
->frame_or_window
));
5746 files
= XCDR (event
->frame_or_window
);
5748 /* Ignore mouse events that were made on frames that
5749 have been deleted. */
5750 if (! FRAME_LIVE_P (f
))
5753 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5756 head
= modify_event_symbol (0, event
->modifiers
,
5758 lispy_drag_n_drop_names
,
5759 &drag_n_drop_syms
, 1);
5765 #endif /* HAVE_MOUSE */
5767 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5768 || defined (USE_GTK)
5769 case MENU_BAR_EVENT
:
5770 if (EQ (event
->arg
, event
->frame_or_window
))
5771 /* This is the prefix key. We translate this to
5772 `(menu_bar)' because the code in keyboard.c for menu
5773 events, which we use, relies on this. */
5774 return Fcons (Qmenu_bar
, Qnil
);
5778 case SELECT_WINDOW_EVENT
:
5779 /* Make an event (select-window (WINDOW)). */
5780 return Fcons (Qselect_window
,
5781 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5784 case TOOL_BAR_EVENT
:
5785 if (EQ (event
->arg
, event
->frame_or_window
))
5786 /* This is the prefix key. We translate this to
5787 `(tool_bar)' because the code in keyboard.c for tool bar
5788 events, which we use, relies on this. */
5789 return Fcons (Qtool_bar
, Qnil
);
5790 else if (SYMBOLP (event
->arg
))
5791 return apply_modifiers (event
->modifiers
, event
->arg
);
5794 case USER_SIGNAL_EVENT
:
5795 /* A user signal. */
5796 return *lispy_user_signals
[event
->code
];
5798 case SAVE_SESSION_EVENT
:
5799 return Qsave_session
;
5801 /* The 'kind' field of the event is something we don't recognize. */
5810 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5812 Lisp_Object bar_window
;
5813 enum scroll_bar_part part
;
5817 /* Is it a scroll bar movement? */
5818 if (frame
&& ! NILP (bar_window
))
5820 Lisp_Object part_sym
;
5822 part_sym
= *scroll_bar_parts
[(int) part
];
5823 return Fcons (Qscroll_bar_movement
,
5824 (Fcons (Fcons (bar_window
,
5825 Fcons (Qvertical_scroll_bar
,
5826 Fcons (Fcons (x
, y
),
5827 Fcons (make_number (time
),
5833 /* Or is it an ordinary mouse movement? */
5836 Lisp_Object position
;
5838 position
= make_lispy_position (frame
, &x
, &y
, time
);
5840 return Fcons (Qmouse_movement
,
5846 #endif /* HAVE_MOUSE */
5848 /* Construct a switch frame event. */
5850 make_lispy_switch_frame (frame
)
5853 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5856 /* Manipulating modifiers. */
5858 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5860 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5861 SYMBOL's name of the end of the modifiers; the string from this
5862 position is the unmodified symbol name.
5864 This doesn't use any caches. */
5867 parse_modifiers_uncached (symbol
, modifier_end
)
5875 CHECK_SYMBOL (symbol
);
5878 name
= SYMBOL_NAME (symbol
);
5880 for (i
= 0; i
+2 <= SBYTES (name
); )
5882 int this_mod_end
= 0;
5885 /* See if the name continues with a modifier word.
5886 Check that the word appears, but don't check what follows it.
5887 Set this_mod and this_mod_end to record what we find. */
5889 switch (SREF (name
, i
))
5891 #define SINGLE_LETTER_MOD(BIT) \
5892 (this_mod_end = i + 1, this_mod = BIT)
5895 SINGLE_LETTER_MOD (alt_modifier
);
5899 SINGLE_LETTER_MOD (ctrl_modifier
);
5903 SINGLE_LETTER_MOD (hyper_modifier
);
5907 SINGLE_LETTER_MOD (meta_modifier
);
5911 SINGLE_LETTER_MOD (shift_modifier
);
5915 SINGLE_LETTER_MOD (super_modifier
);
5918 #undef SINGLE_LETTER_MOD
5920 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5921 if (i + LEN + 1 <= SBYTES (name) \
5922 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5924 this_mod_end = i + LEN; \
5929 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5930 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5931 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5935 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5937 #undef MULTI_LETTER_MOD
5941 /* If we found no modifier, stop looking for them. */
5942 if (this_mod_end
== 0)
5945 /* Check there is a dash after the modifier, so that it
5946 really is a modifier. */
5947 if (this_mod_end
>= SBYTES (name
)
5948 || SREF (name
, this_mod_end
) != '-')
5951 /* This modifier is real; look for another. */
5952 modifiers
|= this_mod
;
5953 i
= this_mod_end
+ 1;
5956 /* Should we include the `click' modifier? */
5957 if (! (modifiers
& (down_modifier
| drag_modifier
5958 | double_modifier
| triple_modifier
))
5959 && i
+ 7 == SBYTES (name
)
5960 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5961 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5962 modifiers
|= click_modifier
;
5970 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5971 prepended to the string BASE[0..BASE_LEN-1].
5972 This doesn't use any caches. */
5974 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5977 int base_len
, base_len_byte
;
5979 /* Since BASE could contain nulls, we can't use intern here; we have
5980 to use Fintern, which expects a genuine Lisp_String, and keeps a
5983 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5989 /* Only the event queue may use the `up' modifier; it should always
5990 be turned into a click or drag event before presented to lisp code. */
5991 if (modifiers
& up_modifier
)
5994 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5995 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5996 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5997 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5998 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5999 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6000 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6001 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6002 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6003 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6004 /* The click modifier is denoted by the absence of other modifiers. */
6008 mod_len
= p
- new_mods
;
6012 Lisp_Object new_name
;
6014 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6015 mod_len
+ base_len_byte
);
6016 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6017 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6019 return Fintern (new_name
, Qnil
);
6024 static char *modifier_names
[] =
6026 "up", "down", "drag", "click", "double", "triple", 0, 0,
6027 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6028 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6030 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6032 static Lisp_Object modifier_symbols
;
6034 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6036 lispy_modifier_list (modifiers
)
6039 Lisp_Object modifier_list
;
6042 modifier_list
= Qnil
;
6043 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6044 if (modifiers
& (1<<i
))
6045 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6048 return modifier_list
;
6052 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6053 where UNMODIFIED is the unmodified form of SYMBOL,
6054 MASK is the set of modifiers present in SYMBOL's name.
6055 This is similar to parse_modifiers_uncached, but uses the cache in
6056 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6057 Qevent_symbol_elements property. */
6060 parse_modifiers (symbol
)
6063 Lisp_Object elements
;
6065 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6066 if (CONSP (elements
))
6071 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6072 Lisp_Object unmodified
;
6075 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6076 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6079 if (modifiers
& ~INTMASK
)
6081 XSETFASTINT (mask
, modifiers
);
6082 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6084 /* Cache the parsing results on SYMBOL. */
6085 Fput (symbol
, Qevent_symbol_element_mask
,
6087 Fput (symbol
, Qevent_symbol_elements
,
6088 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6090 /* Since we know that SYMBOL is modifiers applied to unmodified,
6091 it would be nice to put that in unmodified's cache.
6092 But we can't, since we're not sure that parse_modifiers is
6099 /* Apply the modifiers MODIFIERS to the symbol BASE.
6100 BASE must be unmodified.
6102 This is like apply_modifiers_uncached, but uses BASE's
6103 Qmodifier_cache property, if present. It also builds
6104 Qevent_symbol_elements properties, since it has that info anyway.
6106 apply_modifiers copies the value of BASE's Qevent_kind property to
6107 the modified symbol. */
6109 apply_modifiers (modifiers
, base
)
6113 Lisp_Object cache
, index
, entry
, new_symbol
;
6115 /* Mask out upper bits. We don't know where this value's been. */
6116 modifiers
&= INTMASK
;
6118 /* The click modifier never figures into cache indices. */
6119 cache
= Fget (base
, Qmodifier_cache
);
6120 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6121 entry
= assq_no_quit (index
, cache
);
6124 new_symbol
= XCDR (entry
);
6127 /* We have to create the symbol ourselves. */
6128 new_symbol
= apply_modifiers_uncached (modifiers
,
6129 SDATA (SYMBOL_NAME (base
)),
6130 SCHARS (SYMBOL_NAME (base
)),
6131 SBYTES (SYMBOL_NAME (base
)));
6133 /* Add the new symbol to the base's cache. */
6134 entry
= Fcons (index
, new_symbol
);
6135 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6137 /* We have the parsing info now for free, so we could add it to
6139 XSETFASTINT (index, modifiers);
6140 Fput (new_symbol, Qevent_symbol_element_mask,
6141 Fcons (base, Fcons (index, Qnil)));
6142 Fput (new_symbol, Qevent_symbol_elements,
6143 Fcons (base, lispy_modifier_list (modifiers)));
6144 Sadly, this is only correct if `base' is indeed a base event,
6145 which is not necessarily the case. -stef */
6148 /* Make sure this symbol is of the same kind as BASE.
6150 You'd think we could just set this once and for all when we
6151 intern the symbol above, but reorder_modifiers may call us when
6152 BASE's property isn't set right; we can't assume that just
6153 because it has a Qmodifier_cache property it must have its
6154 Qevent_kind set right as well. */
6155 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6159 kind
= Fget (base
, Qevent_kind
);
6161 Fput (new_symbol
, Qevent_kind
, kind
);
6168 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6169 return a symbol with the modifiers placed in the canonical order.
6170 Canonical order is alphabetical, except for down and drag, which
6171 always come last. The 'click' modifier is never written out.
6173 Fdefine_key calls this to make sure that (for example) C-M-foo
6174 and M-C-foo end up being equivalent in the keymap. */
6177 reorder_modifiers (symbol
)
6180 /* It's hopefully okay to write the code this way, since everything
6181 will soon be in caches, and no consing will be done at all. */
6184 parsed
= parse_modifiers (symbol
);
6185 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6190 /* For handling events, we often want to produce a symbol whose name
6191 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6192 to some base, like the name of a function key or mouse button.
6193 modify_event_symbol produces symbols of this sort.
6195 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6196 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6199 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6200 into symbol names, or a string specifying a name stem used to
6201 construct a symbol name or the form `STEM-N', where N is the decimal
6202 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6203 non-nil; otherwise NAME_TABLE is used.
6205 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6206 persist between calls to modify_event_symbol that it can use to
6207 store a cache of the symbols it's generated for this NAME_TABLE
6208 before. The object stored there may be a vector or an alist.
6210 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6212 MODIFIERS is a set of modifier bits (as given in struct input_events)
6213 whose prefixes should be applied to the symbol name.
6215 SYMBOL_KIND is the value to be placed in the event_kind property of
6216 the returned symbol.
6218 The symbols we create are supposed to have an
6219 `event-symbol-elements' property, which lists the modifiers present
6220 in the symbol's name. */
6223 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6224 name_table
, symbol_table
, table_size
)
6227 Lisp_Object symbol_kind
;
6228 Lisp_Object name_alist_or_stem
;
6230 Lisp_Object
*symbol_table
;
6231 unsigned int table_size
;
6234 Lisp_Object symbol_int
;
6236 /* Get rid of the "vendor-specific" bit here. */
6237 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6239 /* Is this a request for a valid symbol? */
6240 if (symbol_num
< 0 || symbol_num
>= table_size
)
6243 if (CONSP (*symbol_table
))
6244 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6246 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6247 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6248 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6249 we've never used that symbol before. */
6252 if (! VECTORP (*symbol_table
)
6253 || XVECTOR (*symbol_table
)->size
!= table_size
)
6257 XSETFASTINT (size
, table_size
);
6258 *symbol_table
= Fmake_vector (size
, Qnil
);
6261 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6264 /* Have we already used this symbol before? */
6267 /* No; let's create it. */
6268 if (CONSP (name_alist_or_stem
))
6269 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6270 else if (STRINGP (name_alist_or_stem
))
6272 int len
= SBYTES (name_alist_or_stem
);
6273 char *buf
= (char *) alloca (len
+ 50);
6274 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6275 (long) XINT (symbol_int
) + 1);
6276 value
= intern (buf
);
6278 else if (name_table
!= 0 && name_table
[symbol_num
])
6279 value
= intern (name_table
[symbol_num
]);
6281 #ifdef HAVE_WINDOW_SYSTEM
6284 char *name
= x_get_keysym_name (symbol_num
);
6286 value
= intern (name
);
6293 sprintf (buf
, "key-%d", symbol_num
);
6294 value
= intern (buf
);
6297 if (CONSP (*symbol_table
))
6298 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6300 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6302 /* Fill in the cache entries for this symbol; this also
6303 builds the Qevent_symbol_elements property, which the user
6305 apply_modifiers (modifiers
& click_modifier
, value
);
6306 Fput (value
, Qevent_kind
, symbol_kind
);
6309 /* Apply modifiers to that symbol. */
6310 return apply_modifiers (modifiers
, value
);
6313 /* Convert a list that represents an event type,
6314 such as (ctrl meta backspace), into the usual representation of that
6315 event type as a number or a symbol. */
6317 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6318 doc
: /* Convert the event description list EVENT-DESC to an event type.
6319 EVENT-DESC should contain one base event type (a character or symbol)
6320 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6321 drag, down, double or triple). The base must be last.
6322 The return value is an event type (a character or symbol) which
6323 has the same base event type and all the specified modifiers. */)
6325 Lisp_Object event_desc
;
6333 while (CONSP (rest
))
6341 /* Given a symbol, see if it is a modifier name. */
6342 if (SYMBOLP (elt
) && CONSP (rest
))
6343 this = parse_solitary_modifier (elt
);
6347 else if (!NILP (base
))
6348 error ("Two bases given in one event");
6354 /* Let the symbol A refer to the character A. */
6355 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6356 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6358 if (INTEGERP (base
))
6360 /* Turn (shift a) into A. */
6361 if ((modifiers
& shift_modifier
) != 0
6362 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6364 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6365 modifiers
&= ~shift_modifier
;
6368 /* Turn (control a) into C-a. */
6369 if (modifiers
& ctrl_modifier
)
6370 return make_number ((modifiers
& ~ctrl_modifier
)
6371 | make_ctrl_char (XINT (base
)));
6373 return make_number (modifiers
| XINT (base
));
6375 else if (SYMBOLP (base
))
6376 return apply_modifiers (modifiers
, base
);
6379 error ("Invalid base event");
6384 /* Try to recognize SYMBOL as a modifier name.
6385 Return the modifier flag bit, or 0 if not recognized. */
6388 parse_solitary_modifier (symbol
)
6391 Lisp_Object name
= SYMBOL_NAME (symbol
);
6393 switch (SREF (name
, 0))
6395 #define SINGLE_LETTER_MOD(BIT) \
6396 if (SBYTES (name) == 1) \
6399 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6400 if (LEN == SBYTES (name) \
6401 && ! strncmp (SDATA (name), NAME, LEN)) \
6405 SINGLE_LETTER_MOD (alt_modifier
);
6409 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6413 SINGLE_LETTER_MOD (ctrl_modifier
);
6417 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6418 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6422 SINGLE_LETTER_MOD (hyper_modifier
);
6426 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6430 SINGLE_LETTER_MOD (meta_modifier
);
6434 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6438 SINGLE_LETTER_MOD (shift_modifier
);
6442 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6443 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6444 SINGLE_LETTER_MOD (super_modifier
);
6448 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6449 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6450 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6454 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6457 #undef SINGLE_LETTER_MOD
6458 #undef MULTI_LETTER_MOD
6464 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6465 Such a list is not valid as an event,
6466 but it can be a Lucid-style event type list. */
6469 lucid_event_type_list_p (object
)
6474 if (! CONSP (object
))
6477 if (EQ (XCAR (object
), Qhelp_echo
)
6478 || EQ (XCAR (object
), Qvertical_line
)
6479 || EQ (XCAR (object
), Qmode_line
)
6480 || EQ (XCAR (object
), Qheader_line
))
6483 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6487 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6494 /* Store into *addr a value nonzero if terminal input chars are available.
6495 Serves the purpose of ioctl (0, FIONREAD, addr)
6496 but works even if FIONREAD does not exist.
6497 (In fact, this may actually read some input.)
6499 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6500 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6503 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6508 /* First of all, have we already counted some input? */
6509 *addr
= (!NILP (Vquit_flag
)
6510 || readable_filtered_events (do_timers_now
, filter_events
));
6512 /* If input is being read as it arrives, and we have none, there is none. */
6513 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6516 /* Try to read some input and see how much we get. */
6518 *addr
= (!NILP (Vquit_flag
)
6519 || readable_filtered_events (do_timers_now
, filter_events
));
6522 /* Store into *addr a value nonzero if terminal input chars are available.
6523 Serves the purpose of ioctl (0, FIONREAD, addr)
6524 but works even if FIONREAD does not exist.
6525 (In fact, this may actually read some input.)
6527 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6530 get_input_pending (addr
, do_timers_now
)
6534 get_filtered_input_pending (addr
, do_timers_now
, 0);
6537 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6540 gobble_input (expected
)
6545 if (interrupt_input
)
6548 mask
= sigblock (sigmask (SIGIO
));
6549 read_avail_input (expected
);
6553 #ifdef POLL_FOR_INPUT
6554 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6557 mask
= sigblock (sigmask (SIGALRM
));
6558 read_avail_input (expected
);
6564 read_avail_input (expected
);
6568 /* Put a BUFFER_SWITCH_EVENT in the buffer
6569 so that read_key_sequence will notice the new current buffer. */
6572 record_asynch_buffer_change ()
6574 struct input_event event
;
6578 event
.kind
= BUFFER_SWITCH_EVENT
;
6579 event
.frame_or_window
= Qnil
;
6583 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6584 The purpose of the event is to make read_key_sequence look up the
6585 keymaps again. If we aren't in read_key_sequence, we don't need one,
6586 and the event could cause trouble by messing up (input-pending-p). */
6587 tem
= Fwaiting_for_user_input_p ();
6591 /* We never need these events if we have no asynchronous subprocesses. */
6595 /* Make sure no interrupt happens while storing the event. */
6597 if (interrupt_input
)
6600 mask
= sigblock (sigmask (SIGIO
));
6601 kbd_buffer_store_event (&event
);
6608 kbd_buffer_store_event (&event
);
6615 /* Read any terminal input already buffered up by the system
6616 into the kbd_buffer, but do not wait.
6618 EXPECTED should be nonzero if the caller knows there is some input.
6620 Except on VMS, all input is read by this function.
6621 If interrupt_input is nonzero, this function MUST be called
6622 only when SIGIO is blocked.
6624 Returns the number of keyboard chars read, or -1 meaning
6625 this is a bad time to try to read input. */
6628 read_avail_input (expected
)
6634 if (read_socket_hook
)
6637 struct input_event hold_quit
;
6639 EVENT_INIT (hold_quit
);
6640 hold_quit
.kind
= NO_EVENT
;
6642 /* No need for FIONREAD or fcntl; just say don't wait. */
6643 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6648 if (hold_quit
.kind
!= NO_EVENT
)
6649 kbd_buffer_store_event (&hold_quit
);
6653 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6654 the kbd_buffer can really hold. That may prevent loss
6655 of characters on some systems when input is stuffed at us. */
6656 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6659 /* Determine how many characters we should *try* to read. */
6662 #else /* not WINDOWSNT */
6664 n_to_read
= dos_keysns ();
6667 #else /* not MSDOS */
6669 /* Find out how much input is available. */
6670 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6671 /* Formerly simply reported no input, but that sometimes led to
6672 a failure of Emacs to terminate.
6673 SIGHUP seems appropriate if we can't reach the terminal. */
6674 /* ??? Is it really right to send the signal just to this process
6675 rather than to the whole process group?
6676 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6678 if (! noninteractive
)
6679 kill (getpid (), SIGHUP
);
6685 if (n_to_read
> sizeof cbuf
)
6686 n_to_read
= sizeof cbuf
;
6687 #else /* no FIONREAD */
6688 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6689 /* Read some input if available, but don't wait. */
6690 n_to_read
= sizeof cbuf
;
6691 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6696 #endif /* not MSDOS */
6697 #endif /* not WINDOWSNT */
6699 /* Now read; for one reason or another, this will not block.
6700 NREAD is set to the number of chars read. */
6704 cbuf
[0] = dos_keyread ();
6707 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6709 /* POSIX infers that processes which are not in the session leader's
6710 process group won't get SIGHUP's at logout time. BSDI adheres to
6711 this part standard and returns -1 from read (0) with errno==EIO
6712 when the control tty is taken away.
6713 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6714 if (nread
== -1 && errno
== EIO
)
6716 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6717 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6718 This looks incorrect, but it isn't, because _BSD causes
6719 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6720 and that causes a value other than 0 when there is no input. */
6726 /* We used to retry the read if it was interrupted.
6727 But this does the wrong thing when O_NDELAY causes
6728 an EAGAIN error. Does anybody know of a situation
6729 where a retry is actually needed? */
6731 nread
< 0 && (errno
== EAGAIN
6745 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6746 fcntl (input_fd
, F_SETFL
, 0);
6747 #endif /* USG or DGUX or CYGWIN */
6748 #endif /* no FIONREAD */
6749 for (i
= 0; i
< nread
; i
++)
6751 struct input_event buf
;
6753 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6755 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6756 buf
.modifiers
= meta_modifier
;
6761 buf
.frame_or_window
= selected_frame
;
6764 kbd_buffer_store_event (&buf
);
6765 /* Don't look at input that follows a C-g too closely.
6766 This reduces lossage due to autorepeat on C-g. */
6767 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6768 && buf
.code
== quit_char
)
6775 #endif /* not VMS */
6778 handle_async_input ()
6781 extern int select_alarmed
;
6783 #if ! defined (SYSTEM_MALLOC) && defined (HAVE_GTK_AND_PTHREAD)
6784 extern pthread_t main_thread
;
6785 if (pthread_self () != main_thread
)
6787 /* POSIX says any thread can receive the signal. On GNU/Linux that is
6788 not true, but for other systems (FreeBSD at least) it is. So direct
6789 the signal to the correct thread and block it from this thread. */
6793 sigemptyset (&new_mask
);
6794 sigaddset (&new_mask
, SIGIO
);
6795 pthread_sigmask (SIG_BLOCK
, &new_mask
, 0);
6796 pthread_kill (main_thread
, SIGIO
);
6802 interrupt_input_pending
= 0;
6807 nread
= read_avail_input (1);
6808 /* -1 means it's not ok to read the input now.
6809 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6810 0 means there was no keyboard input available. */
6815 select_alarmed
= 1; /* Force the select emulator back to life */
6820 #ifdef SIGIO /* for entire page */
6821 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6824 input_available_signal (signo
)
6827 /* Must preserve main program's value of errno. */
6828 int old_errno
= errno
;
6829 #if ! defined (SYSTEM_MALLOC) && defined (HAVE_GTK_AND_PTHREAD)
6830 extern pthread_t main_thread
;
6831 if (pthread_self () != main_thread
)
6833 /* POSIX says any thread can receive the signal. On GNU/Linux that is
6834 not true, but for other systems (FreeBSD at least) it is. So direct
6835 the signal to the correct thread and block it from this thread. */
6838 sigemptyset (&new_mask
);
6839 sigaddset (&new_mask
, SIGIO
);
6840 pthread_sigmask (SIG_BLOCK
, &new_mask
, 0);
6841 pthread_kill (main_thread
, SIGIO
);
6844 #endif /* HAVE_GTK_AND_PTHREAD */
6845 #if defined (USG) && !defined (POSIX_SIGNALS)
6846 /* USG systems forget handlers when they are used;
6847 must reestablish each time */
6848 signal (signo
, input_available_signal
);
6855 if (input_available_clear_time
)
6856 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6859 interrupt_input_pending
= 1;
6861 handle_async_input ();
6871 /* Send ourselves a SIGIO.
6873 This function exists so that the UNBLOCK_INPUT macro in
6874 blockinput.h can have some way to take care of input we put off
6875 dealing with, without assuming that every file which uses
6876 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6878 reinvoke_input_signal ()
6881 handle_async_input ();
6887 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6888 static Lisp_Object menu_bar_one_keymap_changed_items
;
6890 /* These variables hold the vector under construction within
6891 menu_bar_items and its subroutines, and the current index
6892 for storing into that vector. */
6893 static Lisp_Object menu_bar_items_vector
;
6894 static int menu_bar_items_index
;
6896 /* Return a vector of menu items for a menu bar, appropriate
6897 to the current buffer. Each item has three elements in the vector:
6900 OLD is an old vector we can optionally reuse, or nil. */
6903 menu_bar_items (old
)
6906 /* The number of keymaps we're scanning right now, and the number of
6907 keymaps we have allocated space for. */
6910 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6911 in the current keymaps, or nil where it is not a prefix. */
6914 Lisp_Object def
, tail
;
6923 struct gcpro gcpro1
;
6925 /* In order to build the menus, we need to call the keymap
6926 accessors. They all call QUIT. But this function is called
6927 during redisplay, during which a quit is fatal. So inhibit
6928 quitting while building the menus.
6929 We do this instead of specbind because (1) errors will clear it anyway
6930 and (2) this avoids risk of specpdl overflow. */
6931 oquit
= Vinhibit_quit
;
6935 menu_bar_items_vector
= old
;
6937 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6938 menu_bar_items_index
= 0;
6940 GCPRO1 (menu_bar_items_vector
);
6942 /* Build our list of keymaps.
6943 If we recognize a function key and replace its escape sequence in
6944 keybuf with its symbol, or if the sequence starts with a mouse
6945 click and we need to switch buffers, we jump back here to rebuild
6946 the initial keymaps from the current buffer. */
6950 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6951 if (!NILP (Voverriding_local_map_menu_flag
))
6953 /* Yes, use them (if non-nil) as well as the global map. */
6954 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6956 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6957 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6958 if (!NILP (Voverriding_local_map
))
6959 maps
[nmaps
++] = Voverriding_local_map
;
6963 /* No, so use major and minor mode keymaps and keymap property.
6964 Note that menu-bar bindings in the local-map and keymap
6965 properties may not work reliable, as they are only
6966 recognized when the menu-bar (or mode-line) is updated,
6967 which does not normally happen after every command. */
6970 nminor
= current_minor_maps (NULL
, &tmaps
);
6971 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6973 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6974 maps
[nmaps
++] = tem
;
6975 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6977 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6979 maps
[nmaps
++] = current_global_map
;
6982 /* Look up in each map the dummy prefix key `menu-bar'. */
6986 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6987 if (!NILP (maps
[mapno
]))
6989 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6993 menu_bar_one_keymap_changed_items
= Qnil
;
6994 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6998 /* Move to the end those items that should be at the end. */
7000 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7003 int end
= menu_bar_items_index
;
7005 for (i
= 0; i
< end
; i
+= 4)
7006 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7008 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7009 /* Move the item at index I to the end,
7010 shifting all the others forward. */
7011 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7012 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7013 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7014 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7016 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7017 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7018 (end
- i
- 4) * sizeof (Lisp_Object
));
7019 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7020 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7021 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7022 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7027 /* Add nil, nil, nil, nil at the end. */
7028 i
= menu_bar_items_index
;
7029 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7032 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7033 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7034 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7035 menu_bar_items_vector
= tem
;
7037 /* Add this item. */
7038 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7039 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7040 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7041 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7042 menu_bar_items_index
= i
;
7044 Vinhibit_quit
= oquit
;
7046 return menu_bar_items_vector
;
7049 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7050 If there's already an item for KEY, add this DEF to it. */
7052 Lisp_Object item_properties
;
7055 menu_bar_item (key
, item
, dummy1
, dummy2
)
7056 Lisp_Object key
, item
, dummy1
;
7059 struct gcpro gcpro1
;
7063 if (EQ (item
, Qundefined
))
7065 /* If a map has an explicit `undefined' as definition,
7066 discard any previously made menu bar item. */
7068 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7069 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7071 if (menu_bar_items_index
> i
+ 4)
7072 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7073 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7074 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7075 menu_bar_items_index
-= 4;
7079 /* If this keymap has already contributed to this KEY,
7080 don't contribute to it a second time. */
7081 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7082 if (!NILP (tem
) || NILP (item
))
7085 menu_bar_one_keymap_changed_items
7086 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7088 /* We add to menu_bar_one_keymap_changed_items before doing the
7089 parse_menu_item, so that if it turns out it wasn't a menu item,
7090 it still correctly hides any further menu item. */
7092 i
= parse_menu_item (item
, 0, 1);
7097 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7099 /* Find any existing item for this KEY. */
7100 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7101 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7104 /* If we did not find this KEY, add it at the end. */
7105 if (i
== menu_bar_items_index
)
7107 /* If vector is too small, get a bigger one. */
7108 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7111 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7112 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7113 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7114 menu_bar_items_vector
= tem
;
7117 /* Add this item. */
7118 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7119 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7120 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7121 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7122 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7123 menu_bar_items_index
= i
;
7125 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7129 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7130 /* If the new and the old items are not both keymaps,
7131 the lookup will only find `item'. */
7132 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7133 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7137 /* This is used as the handler when calling menu_item_eval_property. */
7139 menu_item_eval_property_1 (arg
)
7142 /* If we got a quit from within the menu computation,
7143 quit all the way out of it. This takes care of C-] in the debugger. */
7144 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7145 Fsignal (Qquit
, Qnil
);
7150 /* Evaluate an expression and return the result (or nil if something
7151 went wrong). Used to evaluate dynamic parts of menu items. */
7153 menu_item_eval_property (sexpr
)
7156 int count
= SPECPDL_INDEX ();
7158 specbind (Qinhibit_redisplay
, Qt
);
7159 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7160 menu_item_eval_property_1
);
7161 return unbind_to (count
, val
);
7164 /* This function parses a menu item and leaves the result in the
7165 vector item_properties.
7166 ITEM is a key binding, a possible menu item.
7167 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7168 evaluate dynamic expressions in the menu item.
7169 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7171 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7172 parse_menu_item returns true if the item is a menu item and false
7176 parse_menu_item (item
, notreal
, inmenubar
)
7178 int notreal
, inmenubar
;
7180 Lisp_Object def
, tem
, item_string
, start
;
7181 Lisp_Object cachelist
;
7183 Lisp_Object keyhint
;
7194 /* Create item_properties vector if necessary. */
7195 if (NILP (item_properties
))
7197 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7199 /* Initialize optional entries. */
7200 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7201 AREF (item_properties
, i
) = Qnil
;
7202 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7204 /* Save the item here to protect it from GC. */
7205 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7207 item_string
= XCAR (item
);
7211 if (STRINGP (item_string
))
7213 /* Old format menu item. */
7214 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7216 /* Maybe help string. */
7217 if (CONSP (item
) && STRINGP (XCAR (item
)))
7219 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7224 /* Maybe key binding cache. */
7225 if (CONSP (item
) && CONSP (XCAR (item
))
7226 && (NILP (XCAR (XCAR (item
)))
7227 || VECTORP (XCAR (XCAR (item
)))))
7229 cachelist
= XCAR (item
);
7233 /* This is the real definition--the function to run. */
7234 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7236 /* Get enable property, if any. */
7239 tem
= Fget (item
, Qmenu_enable
);
7241 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7244 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7246 /* New format menu item. */
7247 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7248 start
= XCDR (item
);
7251 /* We have a real binding. */
7252 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7254 item
= XCDR (start
);
7255 /* Is there a cache list with key equivalences. */
7256 if (CONSP (item
) && CONSP (XCAR (item
)))
7258 cachelist
= XCAR (item
);
7262 /* Parse properties. */
7263 while (CONSP (item
) && CONSP (XCDR (item
)))
7268 if (EQ (tem
, QCenable
))
7269 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7270 else if (EQ (tem
, QCvisible
) && !notreal
)
7272 /* If got a visible property and that evaluates to nil
7273 then ignore this item. */
7274 tem
= menu_item_eval_property (XCAR (item
));
7278 else if (EQ (tem
, QChelp
))
7279 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7280 else if (EQ (tem
, QCfilter
))
7282 else if (EQ (tem
, QCkey_sequence
))
7285 if (NILP (cachelist
)
7286 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7287 /* Be GC protected. Set keyhint to item instead of tem. */
7290 else if (EQ (tem
, QCkeys
))
7293 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7294 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7296 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7301 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7303 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7305 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7312 else if (inmenubar
|| !NILP (start
))
7316 return 0; /* not a menu item */
7318 /* If item string is not a string, evaluate it to get string.
7319 If we don't get a string, skip this item. */
7320 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7321 if (!(STRINGP (item_string
) || notreal
))
7323 item_string
= menu_item_eval_property (item_string
);
7324 if (!STRINGP (item_string
))
7326 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7329 /* If got a filter apply it on definition. */
7330 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7333 def
= menu_item_eval_property (list2 (XCAR (filter
),
7334 list2 (Qquote
, def
)));
7336 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7339 /* Enable or disable selection of item. */
7340 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7346 tem
= menu_item_eval_property (tem
);
7347 if (inmenubar
&& NILP (tem
))
7348 return 0; /* Ignore disabled items in menu bar. */
7349 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7352 /* If we got no definition, this item is just unselectable text which
7353 is OK in a submenu but not in the menubar. */
7355 return (inmenubar
? 0 : 1);
7357 /* See if this is a separate pane or a submenu. */
7358 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7359 tem
= get_keymap (def
, 0, 1);
7360 /* For a subkeymap, just record its details and exit. */
7363 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7364 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7368 /* At the top level in the menu bar, do likewise for commands also.
7369 The menu bar does not display equivalent key bindings anyway.
7370 ITEM_PROPERTY_DEF is already set up properly. */
7374 /* This is a command. See if there is an equivalent key binding. */
7375 if (NILP (cachelist
))
7377 /* We have to create a cachelist. */
7378 CHECK_IMPURE (start
);
7379 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7380 cachelist
= XCAR (XCDR (start
));
7382 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7383 if (!NILP (keyhint
))
7385 XSETCAR (cachelist
, XCAR (keyhint
));
7388 else if (STRINGP (tem
))
7390 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7391 XSETCAR (cachelist
, Qt
);
7395 tem
= XCAR (cachelist
);
7402 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7404 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7407 def
= XCAR (prefix
);
7408 prefix
= XCDR (prefix
);
7411 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7413 if (!update_menu_bindings
)
7415 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7417 if (newcache
/* Always check first time. */
7418 /* Should we check everything when precomputing key
7420 /* If something had no key binding before, don't recheck it
7421 because that is too slow--except if we have a list of
7422 rebound commands in Vdefine_key_rebound_commands, do
7423 recheck any command that appears in that list. */
7424 || (CONSP (Vdefine_key_rebound_commands
)
7425 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7428 /* We had a saved key. Is it still bound to the command? */
7431 /* If the command is an alias for another
7432 (such as lmenu.el set it up), check if the
7433 original command matches the cached command. */
7434 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7435 chkcache
= 1; /* Need to recompute key binding. */
7439 /* Recompute equivalent key binding. If the command is an alias
7440 for another (such as lmenu.el set it up), see if the original
7441 command name has equivalent keys. Otherwise look up the
7442 specified command itself. We don't try both, because that
7443 makes lmenu menus slow. */
7445 && SYMBOLP (XSYMBOL (def
)->function
)
7446 && ! NILP (Fget (def
, Qmenu_alias
)))
7447 def
= XSYMBOL (def
)->function
;
7448 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7449 XSETCAR (cachelist
, tem
);
7452 XSETCDR (cachelist
, Qnil
);
7456 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7458 tem
= XCAR (cachelist
);
7462 newcache
= chkcache
;
7465 tem
= Fkey_description (tem
, Qnil
);
7468 if (STRINGP (XCAR (prefix
)))
7469 tem
= concat2 (XCAR (prefix
), tem
);
7470 if (STRINGP (XCDR (prefix
)))
7471 tem
= concat2 (tem
, XCDR (prefix
));
7473 XSETCDR (cachelist
, tem
);
7477 tem
= XCDR (cachelist
);
7478 if (newcache
&& !NILP (tem
))
7480 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7481 XSETCDR (cachelist
, tem
);
7484 /* If we only want to precompute equivalent key bindings, stop here. */
7488 /* If we have an equivalent key binding, use that. */
7489 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7491 /* Include this when menu help is implemented.
7492 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7493 if (!(NILP (tem) || STRINGP (tem)))
7495 tem = menu_item_eval_property (tem);
7498 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7502 /* Handle radio buttons or toggle boxes. */
7503 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7505 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7506 = menu_item_eval_property (tem
);
7513 /***********************************************************************
7515 ***********************************************************************/
7517 /* A vector holding tool bar items while they are parsed in function
7518 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7521 static Lisp_Object tool_bar_items_vector
;
7523 /* A vector holding the result of parse_tool_bar_item. Layout is like
7524 the one for a single item in tool_bar_items_vector. */
7526 static Lisp_Object tool_bar_item_properties
;
7528 /* Next free index in tool_bar_items_vector. */
7530 static int ntool_bar_items
;
7532 /* The symbols `tool-bar', and `:image'. */
7534 extern Lisp_Object Qtool_bar
;
7535 Lisp_Object QCimage
;
7537 /* Function prototypes. */
7539 static void init_tool_bar_items
P_ ((Lisp_Object
));
7540 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7541 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7542 static void append_tool_bar_item
P_ ((void));
7545 /* Return a vector of tool bar items for keymaps currently in effect.
7546 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7547 tool bar items found. */
7550 tool_bar_items (reuse
, nitems
)
7561 /* In order to build the menus, we need to call the keymap
7562 accessors. They all call QUIT. But this function is called
7563 during redisplay, during which a quit is fatal. So inhibit
7564 quitting while building the menus. We do this instead of
7565 specbind because (1) errors will clear it anyway and (2) this
7566 avoids risk of specpdl overflow. */
7567 oquit
= Vinhibit_quit
;
7570 /* Initialize tool_bar_items_vector and protect it from GC. */
7571 init_tool_bar_items (reuse
);
7573 /* Build list of keymaps in maps. Set nmaps to the number of maps
7576 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7577 if (!NILP (Voverriding_local_map_menu_flag
))
7579 /* Yes, use them (if non-nil) as well as the global map. */
7580 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7582 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7583 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7584 if (!NILP (Voverriding_local_map
))
7585 maps
[nmaps
++] = Voverriding_local_map
;
7589 /* No, so use major and minor mode keymaps and keymap property.
7590 Note that tool-bar bindings in the local-map and keymap
7591 properties may not work reliable, as they are only
7592 recognized when the tool-bar (or mode-line) is updated,
7593 which does not normally happen after every command. */
7596 nminor
= current_minor_maps (NULL
, &tmaps
);
7597 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7599 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7600 maps
[nmaps
++] = tem
;
7601 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7603 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7606 /* Add global keymap at the end. */
7607 maps
[nmaps
++] = current_global_map
;
7609 /* Process maps in reverse order and look up in each map the prefix
7611 for (i
= nmaps
- 1; i
>= 0; --i
)
7612 if (!NILP (maps
[i
]))
7616 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7621 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7622 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7624 Lisp_Object keydef
= XCAR (tail
);
7626 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7631 Vinhibit_quit
= oquit
;
7632 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7633 return tool_bar_items_vector
;
7637 /* Process the definition of KEY which is DEF. */
7640 process_tool_bar_item (key
, def
)
7641 Lisp_Object key
, def
;
7644 extern Lisp_Object Qundefined
;
7645 struct gcpro gcpro1
, gcpro2
;
7647 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7651 if (EQ (def
, Qundefined
))
7653 /* If a map has an explicit `undefined' as definition,
7654 discard any previously made item. */
7655 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7657 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7659 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7661 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7662 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7663 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7664 * sizeof (Lisp_Object
)));
7665 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7670 else if (parse_tool_bar_item (key
, def
))
7671 /* Append a new tool bar item to tool_bar_items_vector. Accept
7672 more than one definition for the same key. */
7673 append_tool_bar_item ();
7679 /* Parse a tool bar item specification ITEM for key KEY and return the
7680 result in tool_bar_item_properties. Value is zero if ITEM is
7683 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7685 CAPTION is the caption of the item, If it's not a string, it is
7686 evaluated to get a string.
7688 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7689 as binding are currently ignored.
7691 The following properties are recognized:
7695 FORM is evaluated and specifies whether the tool bar item is
7696 enabled or disabled.
7700 FORM is evaluated and specifies whether the tool bar item is visible.
7702 - `:filter FUNCTION'
7704 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7705 result is stored as the new binding.
7707 - `:button (TYPE SELECTED)'
7709 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7710 and specifies whether the button is selected (pressed) or not.
7714 IMAGES is either a single image specification or a vector of four
7715 image specifications. See enum tool_bar_item_images.
7717 - `:help HELP-STRING'.
7719 Gives a help string to display for the tool bar item. */
7722 parse_tool_bar_item (key
, item
)
7723 Lisp_Object key
, item
;
7725 /* Access slot with index IDX of vector tool_bar_item_properties. */
7726 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7728 Lisp_Object filter
= Qnil
;
7729 Lisp_Object caption
;
7732 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7733 Rule out items that aren't lists, don't start with
7734 `menu-item' or whose rest following `tool-bar-item' is not a
7737 || !EQ (XCAR (item
), Qmenu_item
)
7738 || (item
= XCDR (item
),
7742 /* Create tool_bar_item_properties vector if necessary. Reset it to
7744 if (VECTORP (tool_bar_item_properties
))
7746 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7750 tool_bar_item_properties
7751 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7754 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7755 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7757 /* Get the caption of the item. If the caption is not a string,
7758 evaluate it to get a string. If we don't get a string, skip this
7760 caption
= XCAR (item
);
7761 if (!STRINGP (caption
))
7763 caption
= menu_item_eval_property (caption
);
7764 if (!STRINGP (caption
))
7767 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7769 /* Give up if rest following the caption is not a list. */
7774 /* Store the binding. */
7775 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7778 /* Ignore cached key binding, if any. */
7779 if (CONSP (item
) && CONSP (XCAR (item
)))
7782 /* Process the rest of the properties. */
7783 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7785 Lisp_Object key
, value
;
7788 value
= XCAR (XCDR (item
));
7790 if (EQ (key
, QCenable
))
7791 /* `:enable FORM'. */
7792 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7793 else if (EQ (key
, QCvisible
))
7795 /* `:visible FORM'. If got a visible property and that
7796 evaluates to nil then ignore this item. */
7797 if (NILP (menu_item_eval_property (value
)))
7800 else if (EQ (key
, QChelp
))
7801 /* `:help HELP-STRING'. */
7802 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7803 else if (EQ (key
, QCfilter
))
7804 /* ':filter FORM'. */
7806 else if (EQ (key
, QCbutton
) && CONSP (value
))
7808 /* `:button (TYPE . SELECTED)'. */
7809 Lisp_Object type
, selected
;
7811 type
= XCAR (value
);
7812 selected
= XCDR (value
);
7813 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7815 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7816 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7819 else if (EQ (key
, QCimage
)
7821 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7822 /* Value is either a single image specification or a vector
7823 of 4 such specifications for the different button states. */
7824 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7827 /* If got a filter apply it on binding. */
7829 PROP (TOOL_BAR_ITEM_BINDING
)
7830 = menu_item_eval_property (list2 (filter
,
7832 PROP (TOOL_BAR_ITEM_BINDING
))));
7834 /* See if the binding is a keymap. Give up if it is. */
7835 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7838 /* Enable or disable selection of item. */
7839 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7840 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7841 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7843 /* Handle radio buttons or toggle boxes. */
7844 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7845 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7846 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7854 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7855 that can be reused. */
7858 init_tool_bar_items (reuse
)
7861 if (VECTORP (reuse
))
7862 tool_bar_items_vector
= reuse
;
7864 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7865 ntool_bar_items
= 0;
7869 /* Append parsed tool bar item properties from
7870 tool_bar_item_properties */
7873 append_tool_bar_item ()
7875 Lisp_Object
*to
, *from
;
7877 /* Enlarge tool_bar_items_vector if necessary. */
7878 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7879 >= XVECTOR (tool_bar_items_vector
)->size
)
7881 Lisp_Object new_vector
;
7882 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7884 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7885 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7886 XVECTOR (new_vector
)->contents
,
7887 old_size
* sizeof (Lisp_Object
));
7888 tool_bar_items_vector
= new_vector
;
7891 /* Append entries from tool_bar_item_properties to the end of
7892 tool_bar_items_vector. */
7893 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7894 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7895 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7896 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7903 /* Read a character using menus based on maps in the array MAPS.
7904 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7905 Return t if we displayed a menu but the user rejected it.
7907 PREV_EVENT is the previous input event, or nil if we are reading
7908 the first event of a key sequence.
7910 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7911 if we used a mouse menu to read the input, or zero otherwise. If
7912 USED_MOUSE_MENU is null, we don't dereference it.
7914 The prompting is done based on the prompt-string of the map
7915 and the strings associated with various map elements.
7917 This can be done with X menus or with menus put in the minibuf.
7918 These are done in different ways, depending on how the input will be read.
7919 Menus using X are done after auto-saving in read-char, getting the input
7920 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7921 and do auto-saving in the inner call of read_char. */
7924 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7927 Lisp_Object prev_event
;
7928 int *used_mouse_menu
;
7931 register Lisp_Object name
= Qnil
;
7933 if (used_mouse_menu
)
7934 *used_mouse_menu
= 0;
7936 /* Use local over global Menu maps */
7938 if (! menu_prompting
)
7941 /* Optionally disregard all but the global map. */
7942 if (inhibit_local_menu_bar_menus
)
7944 maps
+= (nmaps
- 1);
7948 /* Get the menu name from the first map that has one (a prompt string). */
7949 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7951 name
= Fkeymap_prompt (maps
[mapno
]);
7956 /* If we don't have any menus, just read a character normally. */
7957 if (!STRINGP (name
))
7961 /* If we got to this point via a mouse click,
7962 use a real menu for mouse selection. */
7963 if (EVENT_HAS_PARAMETERS (prev_event
)
7964 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7965 && !EQ (XCAR (prev_event
), Qtool_bar
))
7967 /* Display the menu and get the selection. */
7968 Lisp_Object
*realmaps
7969 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7973 /* Use the maps that are not nil. */
7974 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7975 if (!NILP (maps
[mapno
]))
7976 realmaps
[nmaps1
++] = maps
[mapno
];
7978 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7983 record_menu_key (XCAR (value
));
7985 /* If we got multiple events, unread all but
7987 There is no way to prevent those unread events
7988 from showing up later in last_nonmenu_event.
7989 So turn symbol and integer events into lists,
7990 to indicate that they came from a mouse menu,
7991 so that when present in last_nonmenu_event
7992 they won't confuse things. */
7993 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7995 record_menu_key (XCAR (tem
));
7996 if (SYMBOLP (XCAR (tem
))
7997 || INTEGERP (XCAR (tem
)))
7998 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8001 /* If we got more than one event, put all but the first
8002 onto this list to be read later.
8003 Return just the first event now. */
8004 Vunread_command_events
8005 = nconc2 (XCDR (value
), Vunread_command_events
);
8006 value
= XCAR (value
);
8008 else if (NILP (value
))
8010 if (used_mouse_menu
)
8011 *used_mouse_menu
= 1;
8014 #endif /* HAVE_MENUS */
8018 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8019 We make this bigger when necessary, and never free it. */
8020 static char *read_char_minibuf_menu_text
;
8021 /* Size of that buffer. */
8022 static int read_char_minibuf_menu_width
;
8025 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8031 register Lisp_Object name
;
8033 /* FIXME: Use the minibuffer's frame width. */
8034 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8037 Lisp_Object rest
, vector
;
8043 if (! menu_prompting
)
8046 /* Make sure we have a big enough buffer for the menu text. */
8047 if (read_char_minibuf_menu_text
== 0)
8049 read_char_minibuf_menu_width
= width
+ 4;
8050 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8052 else if (width
+ 4 > read_char_minibuf_menu_width
)
8054 read_char_minibuf_menu_width
= width
+ 4;
8055 read_char_minibuf_menu_text
8056 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8058 menu
= read_char_minibuf_menu_text
;
8060 /* Get the menu name from the first map that has one (a prompt string). */
8061 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8063 name
= Fkeymap_prompt (maps
[mapno
]);
8068 /* If we don't have any menus, just read a character normally. */
8069 if (!STRINGP (name
))
8072 /* Prompt string always starts with map's prompt, and a space. */
8073 strcpy (menu
, SDATA (name
));
8074 nlength
= SBYTES (name
);
8075 menu
[nlength
++] = ':';
8076 menu
[nlength
++] = ' ';
8079 /* Start prompting at start of first map. */
8083 /* Present the documented bindings, a line at a time. */
8090 Lisp_Object orig_defn_macro
;
8092 /* Loop over elements of map. */
8097 /* If reached end of map, start at beginning of next map. */
8101 /* At end of last map, wrap around to first map if just starting,
8102 or end this line if already have something on it. */
8106 if (notfirst
|| nobindings
) break;
8111 /* Look at the next element of the map. */
8113 elt
= XVECTOR (vector
)->contents
[idx
];
8115 elt
= Fcar_safe (rest
);
8117 if (idx
< 0 && VECTORP (elt
))
8119 /* If we found a dense table in the keymap,
8120 advanced past it, but start scanning its contents. */
8121 rest
= Fcdr_safe (rest
);
8127 /* An ordinary element. */
8128 Lisp_Object event
, tem
;
8132 event
= Fcar_safe (elt
); /* alist */
8133 elt
= Fcdr_safe (elt
);
8137 XSETINT (event
, idx
); /* vector */
8140 /* Ignore the element if it has no prompt string. */
8141 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8143 /* 1 if the char to type matches the string. */
8145 Lisp_Object upcased_event
, downcased_event
;
8146 Lisp_Object desc
= Qnil
;
8148 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8150 upcased_event
= Fupcase (event
);
8151 downcased_event
= Fdowncase (event
);
8152 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8153 || XINT (downcased_event
) == SREF (s
, 0));
8155 desc
= Fsingle_key_description (event
, Qnil
);
8157 #if 0 /* It is redundant to list the equivalent key bindings because
8158 the prefix is what the user has already typed. */
8160 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8162 /* Insert equivalent keybinding. */
8163 s
= concat2 (s
, tem
);
8166 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8167 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8169 /* Insert button prefix. */
8170 Lisp_Object selected
8171 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8172 if (EQ (tem
, QCradio
))
8173 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8175 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8176 s
= concat2 (tem
, s
);
8180 /* If we have room for the prompt string, add it to this line.
8181 If this is the first on the line, always add it. */
8182 if ((SCHARS (s
) + i
+ 2
8183 + (char_matches
? 0 : SCHARS (desc
) + 3))
8189 /* Punctuate between strings. */
8192 strcpy (menu
+ i
, ", ");
8198 /* If the char to type doesn't match the string's
8199 first char, explicitly show what char to type. */
8202 /* Add as much of string as fits. */
8203 thiswidth
= SCHARS (desc
);
8204 if (thiswidth
+ i
> width
)
8205 thiswidth
= width
- i
;
8206 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8208 strcpy (menu
+ i
, " = ");
8212 /* Add as much of string as fits. */
8213 thiswidth
= SCHARS (s
);
8214 if (thiswidth
+ i
> width
)
8215 thiswidth
= width
- i
;
8216 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8222 /* If this element does not fit, end the line now,
8223 and save the element for the next line. */
8224 strcpy (menu
+ i
, "...");
8229 /* Move past this element. */
8230 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8231 /* Handle reaching end of dense table. */
8236 rest
= Fcdr_safe (rest
);
8240 /* Prompt with that and read response. */
8241 message2_nolog (menu
, strlen (menu
),
8242 ! NILP (current_buffer
->enable_multibyte_characters
));
8244 /* Make believe its not a keyboard macro in case the help char
8245 is pressed. Help characters are not recorded because menu prompting
8246 is not used on replay.
8248 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8249 current_kboard
->defining_kbd_macro
= Qnil
;
8251 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8252 while (BUFFERP (obj
));
8253 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8255 if (!INTEGERP (obj
))
8260 if (! EQ (obj
, menu_prompt_more_char
)
8261 && (!INTEGERP (menu_prompt_more_char
)
8262 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8264 if (!NILP (current_kboard
->defining_kbd_macro
))
8265 store_kbd_macro_char (obj
);
8268 /* Help char - go round again */
8272 /* Reading key sequences. */
8274 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8275 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8276 keymap, or nil otherwise. Return the index of the first keymap in
8277 which KEY has any binding, or NMAPS if no map has a binding.
8279 If KEY is a meta ASCII character, treat it like meta-prefix-char
8280 followed by the corresponding non-meta character. Keymaps in
8281 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8284 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8287 NEXT may be the same array as CURRENT. */
8290 follow_key (key
, nmaps
, current
, defs
, next
)
8292 Lisp_Object
*current
, *defs
, *next
;
8295 int i
, first_binding
;
8297 first_binding
= nmaps
;
8298 for (i
= nmaps
- 1; i
>= 0; i
--)
8300 if (! NILP (current
[i
]))
8302 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8303 if (! NILP (defs
[i
]))
8310 /* Given the set of bindings we've found, produce the next set of maps. */
8311 if (first_binding
< nmaps
)
8312 for (i
= 0; i
< nmaps
; i
++)
8313 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8315 return first_binding
;
8318 /* Structure used to keep track of partial application of key remapping
8319 such as Vfunction_key_map and Vkey_translation_map. */
8320 typedef struct keyremap
8322 Lisp_Object map
, parent
;
8326 /* Lookup KEY in MAP.
8327 MAP is a keymap mapping keys to key vectors or functions.
8328 If the mapping is a function and DO_FUNCTION is non-zero, then
8329 the function is called with PROMPT as parameter and its return
8330 value is used as the return value of this function (after checking
8331 that it is indeed a vector). */
8334 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8335 Lisp_Object map
, key
, prompt
;
8340 next
= access_keymap (map
, key
, 1, 0, 1);
8342 /* Handle symbol with autoload definition. */
8343 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8344 && CONSP (XSYMBOL (next
)->function
)
8345 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8346 do_autoload (XSYMBOL (next
)->function
, next
);
8348 /* Handle a symbol whose function definition is a keymap
8350 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8351 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8352 || KEYMAPP (XSYMBOL (next
)->function
)))
8353 next
= XSYMBOL (next
)->function
;
8355 /* If the keymap gives a function, not an
8356 array, then call the function with one arg and use
8357 its value instead. */
8358 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8363 next
= call1 (next
, prompt
);
8364 /* If the function returned something invalid,
8365 barf--don't ignore it.
8366 (To ignore it safely, we would need to gcpro a bunch of
8367 other variables.) */
8368 if (! (VECTORP (next
) || STRINGP (next
)))
8369 error ("Function %s returns invalid key sequence", tem
);
8374 /* Do one step of the key remapping used for function-key-map and
8375 key-translation-map:
8376 KEYBUF is the buffer holding the input events.
8377 BUFSIZE is its maximum size.
8378 FKEY is a pointer to the keyremap structure to use.
8379 INPUT is the index of the last element in KEYBUF.
8380 DOIT if non-zero says that the remapping can actually take place.
8381 DIFF is used to return the number of keys added/removed by the remapping.
8382 PARENT is the root of the keymap.
8383 PROMPT is the prompt to use if the remapping happens through a function.
8384 The return value is non-zero if the remapping actually took place. */
8387 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8388 Lisp_Object
*keybuf
, prompt
;
8390 int input
, doit
, *diff
, bufsize
;
8392 Lisp_Object next
, key
;
8394 key
= keybuf
[fkey
->end
++];
8395 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8397 /* If keybuf[fkey->start..fkey->end] is bound in the
8398 map and we're in a position to do the key remapping, replace it with
8399 the binding and restart with fkey->start at the end. */
8400 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8402 int len
= XFASTINT (Flength (next
));
8405 *diff
= len
- (fkey
->end
- fkey
->start
);
8407 if (input
+ *diff
>= bufsize
)
8408 error ("Key sequence too long");
8410 /* Shift the keys that follow fkey->end. */
8412 for (i
= fkey
->end
; i
< input
; i
++)
8413 keybuf
[i
+ *diff
] = keybuf
[i
];
8415 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8416 keybuf
[i
+ *diff
] = keybuf
[i
];
8417 /* Overwrite the old keys with the new ones. */
8418 for (i
= 0; i
< len
; i
++)
8419 keybuf
[fkey
->start
+ i
]
8420 = Faref (next
, make_number (i
));
8422 fkey
->start
= fkey
->end
+= *diff
;
8423 fkey
->map
= fkey
->parent
;
8428 fkey
->map
= get_keymap (next
, 0, 1);
8430 /* If we no longer have a bound suffix, try a new position for
8432 if (!CONSP (fkey
->map
))
8434 fkey
->end
= ++fkey
->start
;
8435 fkey
->map
= fkey
->parent
;
8440 /* Read a sequence of keys that ends with a non prefix character,
8441 storing it in KEYBUF, a buffer of size BUFSIZE.
8443 Return the length of the key sequence stored.
8444 Return -1 if the user rejected a command menu.
8446 Echo starting immediately unless `prompt' is 0.
8448 Where a key sequence ends depends on the currently active keymaps.
8449 These include any minor mode keymaps active in the current buffer,
8450 the current buffer's local map, and the global map.
8452 If a key sequence has no other bindings, we check Vfunction_key_map
8453 to see if some trailing subsequence might be the beginning of a
8454 function key's sequence. If so, we try to read the whole function
8455 key, and substitute its symbolic name into the key sequence.
8457 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8458 `double-' events into similar click events, if that would make them
8459 bound. We try to turn `triple-' events first into `double-' events,
8462 If we get a mouse click in a mode line, vertical divider, or other
8463 non-text area, we treat the click as if it were prefixed by the
8464 symbol denoting that area - `mode-line', `vertical-line', or
8467 If the sequence starts with a mouse click, we read the key sequence
8468 with respect to the buffer clicked on, not the current buffer.
8470 If the user switches frames in the midst of a key sequence, we put
8471 off the switch-frame event until later; the next call to
8472 read_char will return it.
8474 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8475 from the selected window's buffer. */
8478 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8479 can_return_switch_frame
, fix_current_buffer
)
8480 Lisp_Object
*keybuf
;
8483 int dont_downcase_last
;
8484 int can_return_switch_frame
;
8485 int fix_current_buffer
;
8487 volatile Lisp_Object from_string
;
8488 volatile int count
= SPECPDL_INDEX ();
8490 /* How many keys there are in the current key sequence. */
8493 /* The length of the echo buffer when we started reading, and
8494 the length of this_command_keys when we started reading. */
8495 volatile int echo_start
;
8496 volatile int keys_start
;
8498 /* The number of keymaps we're scanning right now, and the number of
8499 keymaps we have allocated space for. */
8501 volatile int nmaps_allocated
= 0;
8503 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8504 the current keymaps. */
8505 Lisp_Object
*volatile defs
= NULL
;
8507 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8508 in the current keymaps, or nil where it is not a prefix. */
8509 Lisp_Object
*volatile submaps
= NULL
;
8511 /* The local map to start out with at start of key sequence. */
8512 volatile Lisp_Object orig_local_map
;
8514 /* The map from the `keymap' property to start out with at start of
8516 volatile Lisp_Object orig_keymap
;
8518 /* 1 if we have already considered switching to the local-map property
8519 of the place where a mouse click occurred. */
8520 volatile int localized_local_map
= 0;
8522 /* The index in defs[] of the first keymap that has a binding for
8523 this key sequence. In other words, the lowest i such that
8524 defs[i] is non-nil. */
8525 volatile int first_binding
;
8526 /* Index of the first key that has no binding.
8527 It is useless to try fkey.start larger than that. */
8528 volatile int first_unbound
;
8530 /* If t < mock_input, then KEYBUF[t] should be read as the next
8533 We use this to recover after recognizing a function key. Once we
8534 realize that a suffix of the current key sequence is actually a
8535 function key's escape sequence, we replace the suffix with the
8536 function key's binding from Vfunction_key_map. Now keybuf
8537 contains a new and different key sequence, so the echo area,
8538 this_command_keys, and the submaps and defs arrays are wrong. In
8539 this situation, we set mock_input to t, set t to 0, and jump to
8540 restart_sequence; the loop will read keys from keybuf up until
8541 mock_input, thus rebuilding the state; and then it will resume
8542 reading characters from the keyboard. */
8543 volatile int mock_input
= 0;
8545 /* If the sequence is unbound in submaps[], then
8546 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8547 and fkey.map is its binding.
8549 These might be > t, indicating that all function key scanning
8550 should hold off until t reaches them. We do this when we've just
8551 recognized a function key, to avoid searching for the function
8552 key's again in Vfunction_key_map. */
8553 volatile keyremap fkey
;
8555 /* Likewise, for key_translation_map. */
8556 volatile keyremap keytran
;
8558 /* If we receive a `switch-frame' or `select-window' event in the middle of
8559 a key sequence, we put it off for later.
8560 While we're reading, we keep the event here. */
8561 volatile Lisp_Object delayed_switch_frame
;
8563 /* See the comment below... */
8564 #if defined (GOBBLE_FIRST_EVENT)
8565 Lisp_Object first_event
;
8568 volatile Lisp_Object original_uppercase
;
8569 volatile int original_uppercase_position
= -1;
8571 /* Gets around Microsoft compiler limitations. */
8574 struct buffer
*starting_buffer
;
8576 /* List of events for which a fake prefix key has been generated. */
8577 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8579 #if defined (GOBBLE_FIRST_EVENT)
8583 struct gcpro gcpro1
;
8585 GCPRO1 (fake_prefixed_keys
);
8586 raw_keybuf_count
= 0;
8588 last_nonmenu_event
= Qnil
;
8590 delayed_switch_frame
= Qnil
;
8591 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8592 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8593 /* If there is no translation-map, turn off scanning. */
8594 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8595 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8600 echo_prompt (prompt
);
8601 else if (cursor_in_echo_area
8602 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8603 && NILP (Fzerop (Vecho_keystrokes
)))
8604 /* This doesn't put in a dash if the echo buffer is empty, so
8605 you don't always see a dash hanging out in the minibuffer. */
8609 /* Record the initial state of the echo area and this_command_keys;
8610 we will need to restore them if we replay a key sequence. */
8612 echo_start
= echo_length ();
8613 keys_start
= this_command_key_count
;
8614 this_single_command_key_start
= keys_start
;
8616 #if defined (GOBBLE_FIRST_EVENT)
8617 /* This doesn't quite work, because some of the things that read_char
8618 does cannot safely be bypassed. It seems too risky to try to make
8621 /* Read the first char of the sequence specially, before setting
8622 up any keymaps, in case a filter runs and switches buffers on us. */
8623 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8625 #endif /* GOBBLE_FIRST_EVENT */
8627 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8628 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8631 /* We jump here when the key sequence has been thoroughly changed, and
8632 we need to rescan it starting from the beginning. When we jump here,
8633 keybuf[0..mock_input] holds the sequence we should reread. */
8636 starting_buffer
= current_buffer
;
8637 first_unbound
= bufsize
+ 1;
8639 /* Build our list of keymaps.
8640 If we recognize a function key and replace its escape sequence in
8641 keybuf with its symbol, or if the sequence starts with a mouse
8642 click and we need to switch buffers, we jump back here to rebuild
8643 the initial keymaps from the current buffer. */
8646 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8647 || !NILP (Voverriding_local_map
))
8649 if (3 > nmaps_allocated
)
8651 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8652 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8653 nmaps_allocated
= 3;
8655 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8656 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8657 if (!NILP (Voverriding_local_map
))
8658 submaps
[nmaps
++] = Voverriding_local_map
;
8666 nminor
= current_minor_maps (0, &maps
);
8667 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8669 if (total
> nmaps_allocated
)
8671 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8672 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8673 nmaps_allocated
= total
;
8676 if (!NILP (orig_keymap
))
8677 submaps
[nmaps
++] = orig_keymap
;
8679 bcopy (maps
, (void *) (submaps
+ nmaps
),
8680 nminor
* sizeof (submaps
[0]));
8684 submaps
[nmaps
++] = orig_local_map
;
8686 submaps
[nmaps
++] = current_global_map
;
8688 /* Find an accurate initial value for first_binding. */
8689 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8690 if (! NILP (submaps
[first_binding
]))
8693 /* Start from the beginning in keybuf. */
8696 /* These are no-ops the first time through, but if we restart, they
8697 revert the echo area and this_command_keys to their original state. */
8698 this_command_key_count
= keys_start
;
8699 if (INTERACTIVE
&& t
< mock_input
)
8700 echo_truncate (echo_start
);
8702 /* If the best binding for the current key sequence is a keymap, or
8703 we may be looking at a function key's escape sequence, keep on
8705 while (first_binding
< nmaps
8706 /* Keep reading as long as there's a prefix binding. */
8707 ? !NILP (submaps
[first_binding
])
8708 /* Don't return in the middle of a possible function key sequence,
8709 if the only bindings we found were via case conversion.
8710 Thus, if ESC O a has a function-key-map translation
8711 and ESC o has a binding, don't return after ESC O,
8712 so that we can translate ESC O plus the next character. */
8713 : (fkey
.start
< t
|| keytran
.start
< t
))
8716 int used_mouse_menu
= 0;
8718 /* Where the last real key started. If we need to throw away a
8719 key that has expanded into more than one element of keybuf
8720 (say, a mouse click on the mode line which is being treated
8721 as [mode-line (mouse-...)], then we backtrack to this point
8723 volatile int last_real_key_start
;
8725 /* These variables are analogous to echo_start and keys_start;
8726 while those allow us to restart the entire key sequence,
8727 echo_local_start and keys_local_start allow us to throw away
8729 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8731 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8732 eassert (fkey
.start
<= fkey
.end
);
8733 eassert (keytran
.start
<= keytran
.end
);
8734 /* key-translation-map is applied *after* function-key-map. */
8735 eassert (keytran
.end
<= fkey
.start
);
8737 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8738 { /* The prefix upto first_unbound has no binding and has
8739 no translation left to do either, so we know it's unbound.
8740 If we don't stop now, we risk staying here indefinitely
8741 (if the user keeps entering fkey or keytran prefixes
8742 like C-c ESC ESC ESC ESC ...) */
8744 for (i
= first_unbound
+ 1; i
< t
; i
++)
8745 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8746 mock_input
= t
- first_unbound
- 1;
8747 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8748 fkey
.map
= fkey
.parent
;
8749 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8750 keytran
.map
= keytran
.parent
;
8751 goto replay_sequence
;
8755 error ("Key sequence too long");
8758 echo_local_start
= echo_length ();
8759 keys_local_start
= this_command_key_count
;
8760 local_first_binding
= first_binding
;
8763 /* These are no-ops, unless we throw away a keystroke below and
8764 jumped back up to replay_key; in that case, these restore the
8765 variables to their original state, allowing us to replay the
8767 if (INTERACTIVE
&& t
< mock_input
)
8768 echo_truncate (echo_local_start
);
8769 this_command_key_count
= keys_local_start
;
8770 first_binding
= local_first_binding
;
8772 /* By default, assume each event is "real". */
8773 last_real_key_start
= t
;
8775 /* Does mock_input indicate that we are re-reading a key sequence? */
8779 add_command_key (key
);
8780 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8781 && NILP (Fzerop (Vecho_keystrokes
)))
8785 /* If not, we should actually read a character. */
8790 KBOARD
*interrupted_kboard
= current_kboard
;
8791 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8792 if (setjmp (wrong_kboard_jmpbuf
))
8794 if (!NILP (delayed_switch_frame
))
8796 interrupted_kboard
->kbd_queue
8797 = Fcons (delayed_switch_frame
,
8798 interrupted_kboard
->kbd_queue
);
8799 delayed_switch_frame
= Qnil
;
8802 interrupted_kboard
->kbd_queue
8803 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8805 /* If the side queue is non-empty, ensure it begins with a
8806 switch-frame, so we'll replay it in the right context. */
8807 if (CONSP (interrupted_kboard
->kbd_queue
)
8808 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8809 !(EVENT_HAS_PARAMETERS (key
)
8810 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8814 XSETFRAME (frame
, interrupted_frame
);
8815 interrupted_kboard
->kbd_queue
8816 = Fcons (make_lispy_switch_frame (frame
),
8817 interrupted_kboard
->kbd_queue
);
8820 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8821 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8822 goto replay_sequence
;
8825 key
= read_char (NILP (prompt
), nmaps
,
8826 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8830 /* read_char returns t when it shows a menu and the user rejects it.
8834 unbind_to (count
, Qnil
);
8839 /* read_char returns -1 at the end of a macro.
8840 Emacs 18 handles this by returning immediately with a
8841 zero, so that's what we'll do. */
8842 if (INTEGERP (key
) && XINT (key
) == -1)
8845 /* The Microsoft C compiler can't handle the goto that
8851 /* If the current buffer has been changed from under us, the
8852 keymap may have changed, so replay the sequence. */
8855 timer_resume_idle ();
8858 /* Reset the current buffer from the selected window
8859 in case something changed the former and not the latter.
8860 This is to be more consistent with the behavior
8861 of the command_loop_1. */
8862 if (fix_current_buffer
)
8864 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8866 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8867 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8870 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8871 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8872 goto replay_sequence
;
8875 /* If we have a quit that was typed in another frame, and
8876 quit_throw_to_read_char switched buffers,
8877 replay to get the right keymap. */
8879 && XINT (key
) == quit_char
8880 && current_buffer
!= starting_buffer
)
8883 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8887 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8888 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8889 goto replay_sequence
;
8894 if (EVENT_HAS_PARAMETERS (key
)
8895 /* Either a `switch-frame' or a `select-window' event. */
8896 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8898 /* If we're at the beginning of a key sequence, and the caller
8899 says it's okay, go ahead and return this event. If we're
8900 in the midst of a key sequence, delay it until the end. */
8901 if (t
> 0 || !can_return_switch_frame
)
8903 delayed_switch_frame
= key
;
8909 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8912 /* Clicks in non-text areas get prefixed by the symbol
8913 in their CHAR-ADDRESS field. For example, a click on
8914 the mode line is prefixed by the symbol `mode-line'.
8916 Furthermore, key sequences beginning with mouse clicks
8917 are read using the keymaps of the buffer clicked on, not
8918 the current buffer. So we may have to switch the buffer
8921 When we turn one event into two events, we must make sure
8922 that neither of the two looks like the original--so that,
8923 if we replay the events, they won't be expanded again.
8924 If not for this, such reexpansion could happen either here
8925 or when user programs play with this-command-keys. */
8926 if (EVENT_HAS_PARAMETERS (key
))
8931 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8932 if (EQ (kind
, Qmouse_click
))
8934 Lisp_Object window
, posn
;
8936 window
= POSN_WINDOW (EVENT_START (key
));
8937 posn
= POSN_POSN (EVENT_START (key
));
8940 || (!NILP (fake_prefixed_keys
)
8941 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8943 /* We're looking a second time at an event for which
8944 we generated a fake prefix key. Set
8945 last_real_key_start appropriately. */
8947 last_real_key_start
= t
- 1;
8950 /* Key sequences beginning with mouse clicks are
8951 read using the keymaps in the buffer clicked on,
8952 not the current buffer. If we're at the
8953 beginning of a key sequence, switch buffers. */
8954 if (last_real_key_start
== 0
8956 && BUFFERP (XWINDOW (window
)->buffer
)
8957 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8959 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8963 /* Arrange to go back to the original buffer once we're
8964 done reading the key sequence. Note that we can't
8965 use save_excursion_{save,restore} here, because they
8966 save point as well as the current buffer; we don't
8967 want to save point, because redisplay may change it,
8968 to accommodate a Fset_window_start or something. We
8969 don't want to do this at the top of the function,
8970 because we may get input from a subprocess which
8971 wants to change the selected window and stuff (say,
8973 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8975 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8977 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8978 orig_local_map
= get_local_map (PT
, current_buffer
,
8980 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8981 goto replay_sequence
;
8984 /* For a mouse click, get the local text-property keymap
8985 of the place clicked on, rather than point. */
8986 if (last_real_key_start
== 0
8987 && CONSP (XCDR (key
))
8988 && ! localized_local_map
)
8990 Lisp_Object map_here
, start
, pos
;
8992 localized_local_map
= 1;
8993 start
= EVENT_START (key
);
8995 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8997 pos
= POSN_BUFFER_POSN (start
);
8999 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9001 map_here
= get_local_map (XINT (pos
),
9002 current_buffer
, Qlocal_map
);
9003 if (!EQ (map_here
, orig_local_map
))
9005 orig_local_map
= map_here
;
9009 goto replay_sequence
;
9011 map_here
= get_local_map (XINT (pos
),
9012 current_buffer
, Qkeymap
);
9013 if (!EQ (map_here
, orig_keymap
))
9015 orig_keymap
= map_here
;
9019 goto replay_sequence
;
9025 /* Expand mode-line and scroll-bar events into two events:
9026 use posn as a fake prefix key. */
9028 && (NILP (fake_prefixed_keys
)
9029 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9031 if (t
+ 1 >= bufsize
)
9032 error ("Key sequence too long");
9035 keybuf
[t
+ 1] = key
;
9038 /* Record that a fake prefix key has been generated
9039 for KEY. Don't modify the event; this would
9040 prevent proper action when the event is pushed
9041 back into unread-command-events. */
9042 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9044 /* If on a mode line string with a local keymap,
9045 reconsider the key sequence with that keymap. */
9046 if (string
= POSN_STRING (EVENT_START (key
)),
9047 (CONSP (string
) && STRINGP (XCAR (string
))))
9049 Lisp_Object pos
, map
, map2
;
9051 pos
= XCDR (string
);
9052 string
= XCAR (string
);
9054 && XINT (pos
) < SCHARS (string
))
9056 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9058 orig_local_map
= map
;
9059 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9062 if (!NILP (map
) || !NILP (map2
))
9063 goto replay_sequence
;
9069 else if (NILP (from_string
)
9070 && (string
= POSN_STRING (EVENT_START (key
)),
9071 (CONSP (string
) && STRINGP (XCAR (string
)))))
9073 /* For a click on a string, i.e. overlay string or a
9074 string displayed via the `display' property,
9075 consider `local-map' and `keymap' properties of
9077 Lisp_Object pos
, map
, map2
;
9079 pos
= XCDR (string
);
9080 string
= XCAR (string
);
9082 && XINT (pos
) < SCHARS (string
))
9084 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9086 orig_local_map
= map
;
9087 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9091 if (!NILP (map
) || !NILP (map2
))
9093 from_string
= string
;
9094 goto replay_sequence
;
9099 else if (CONSP (XCDR (key
))
9100 && CONSP (EVENT_START (key
))
9101 && CONSP (XCDR (EVENT_START (key
))))
9105 posn
= POSN_POSN (EVENT_START (key
));
9106 /* Handle menu-bar events:
9107 insert the dummy prefix event `menu-bar'. */
9108 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9110 if (t
+ 1 >= bufsize
)
9111 error ("Key sequence too long");
9115 /* Zap the position in key, so we know that we've
9116 expanded it, and don't try to do so again. */
9117 POSN_SET_POSN (EVENT_START (key
),
9118 Fcons (posn
, Qnil
));
9121 goto replay_sequence
;
9123 else if (CONSP (posn
))
9125 /* We're looking at the second event of a
9126 sequence which we expanded before. Set
9127 last_real_key_start appropriately. */
9128 if (last_real_key_start
== t
&& t
> 0)
9129 last_real_key_start
= t
- 1;
9134 /* We have finally decided that KEY is something we might want
9136 first_binding
= (follow_key (key
,
9137 nmaps
- first_binding
,
9138 submaps
+ first_binding
,
9139 defs
+ first_binding
,
9140 submaps
+ first_binding
)
9143 /* If KEY wasn't bound, we'll try some fallbacks. */
9144 if (first_binding
< nmaps
)
9145 /* This is needed for the following scenario:
9146 event 0: a down-event that gets dropped by calling replay_key.
9147 event 1: some normal prefix like C-h.
9148 After event 0, first_unbound is 0, after event 1 fkey.start
9149 and keytran.start are both 1, so when we see that C-h is bound,
9150 we need to update first_unbound. */
9151 first_unbound
= max (t
+ 1, first_unbound
);
9156 /* Remember the position to put an upper bound on fkey.start. */
9157 first_unbound
= min (t
, first_unbound
);
9159 head
= EVENT_HEAD (key
);
9160 if (help_char_p (head
) && t
> 0)
9162 read_key_sequence_cmd
= Vprefix_help_command
;
9164 last_nonmenu_event
= key
;
9165 /* The Microsoft C compiler can't handle the goto that
9173 Lisp_Object breakdown
;
9176 breakdown
= parse_modifiers (head
);
9177 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9178 /* Attempt to reduce an unbound mouse event to a simpler
9179 event that is bound:
9180 Drags reduce to clicks.
9181 Double-clicks reduce to clicks.
9182 Triple-clicks reduce to double-clicks, then to clicks.
9183 Down-clicks are eliminated.
9184 Double-downs reduce to downs, then are eliminated.
9185 Triple-downs reduce to double-downs, then to downs,
9186 then are eliminated. */
9187 if (modifiers
& (down_modifier
| drag_modifier
9188 | double_modifier
| triple_modifier
))
9190 while (modifiers
& (down_modifier
| drag_modifier
9191 | double_modifier
| triple_modifier
))
9193 Lisp_Object new_head
, new_click
;
9194 if (modifiers
& triple_modifier
)
9195 modifiers
^= (double_modifier
| triple_modifier
);
9196 else if (modifiers
& double_modifier
)
9197 modifiers
&= ~double_modifier
;
9198 else if (modifiers
& drag_modifier
)
9199 modifiers
&= ~drag_modifier
;
9202 /* Dispose of this `down' event by simply jumping
9203 back to replay_key, to get another event.
9205 Note that if this event came from mock input,
9206 then just jumping back to replay_key will just
9207 hand it to us again. So we have to wipe out any
9210 We could delete keybuf[t] and shift everything
9211 after that to the left by one spot, but we'd also
9212 have to fix up any variable that points into
9213 keybuf, and shifting isn't really necessary
9216 Adding prefixes for non-textual mouse clicks
9217 creates two characters of mock input, and both
9218 must be thrown away. If we're only looking at
9219 the prefix now, we can just jump back to
9220 replay_key. On the other hand, if we've already
9221 processed the prefix, and now the actual click
9222 itself is giving us trouble, then we've lost the
9223 state of the keymaps we want to backtrack to, and
9224 we need to replay the whole sequence to rebuild
9227 Beyond that, only function key expansion could
9228 create more than two keys, but that should never
9229 generate mouse events, so it's okay to zero
9230 mock_input in that case too.
9232 FIXME: The above paragraph seems just plain
9233 wrong, if you consider things like
9234 xterm-mouse-mode. -stef
9236 Isn't this just the most wonderful code ever? */
9238 /* If mock_input > t + 1, the above simplification
9239 will actually end up dropping keys on the floor.
9240 This is probably OK for now, but even
9241 if mock_input <= t + 1, we need to adjust fkey
9243 Typical case [header-line down-mouse-N]:
9244 mock_input = 2, t = 1, fkey.end = 1,
9245 last_real_key_start = 0. */
9246 if (fkey
.end
> last_real_key_start
)
9248 fkey
.end
= fkey
.start
9249 = min (last_real_key_start
, fkey
.start
);
9250 fkey
.map
= fkey
.parent
;
9251 if (keytran
.end
> last_real_key_start
)
9253 keytran
.end
= keytran
.start
9254 = min (last_real_key_start
, keytran
.start
);
9255 keytran
.map
= keytran
.parent
;
9258 if (t
== last_real_key_start
)
9265 mock_input
= last_real_key_start
;
9266 goto replay_sequence
;
9271 = apply_modifiers (modifiers
, XCAR (breakdown
));
9273 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9275 /* Look for a binding for this new key. follow_key
9276 promises that it didn't munge submaps the
9277 last time we called it, since key was unbound. */
9279 = (follow_key (new_click
,
9280 nmaps
- local_first_binding
,
9281 submaps
+ local_first_binding
,
9282 defs
+ local_first_binding
,
9283 submaps
+ local_first_binding
)
9284 + local_first_binding
);
9286 /* If that click is bound, go for it. */
9287 if (first_binding
< nmaps
)
9292 /* Otherwise, we'll leave key set to the drag event. */
9299 /* Normally, last_nonmenu_event gets the previous key we read.
9300 But when a mouse popup menu is being used,
9301 we don't update last_nonmenu_event; it continues to hold the mouse
9302 event that preceded the first level of menu. */
9303 if (!used_mouse_menu
)
9304 last_nonmenu_event
= key
;
9306 /* Record what part of this_command_keys is the current key sequence. */
9307 this_single_command_key_start
= this_command_key_count
- t
;
9309 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9310 /* There is a binding and it's not a prefix.
9311 There is thus no function-key in this sequence.
9312 Moving fkey.start is important in this case to allow keytran.start
9313 to go over the sequence before we return (since we keep the
9314 invariant that keytran.end <= fkey.start). */
9317 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9320 /* If the sequence is unbound, see if we can hang a function key
9321 off the end of it. */
9322 /* Continue scan from fkey.end until we find a bound suffix. */
9323 while (fkey
.end
< t
)
9325 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9328 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9329 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9330 max (t
, mock_input
),
9331 /* If there's a binding (i.e.
9332 first_binding >= nmaps) we don't want
9333 to apply this function-key-mapping. */
9334 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9339 mock_input
= diff
+ max (t
, mock_input
);
9340 goto replay_sequence
;
9344 /* Look for this sequence in key-translation-map.
9345 Scan from keytran.end until we find a bound suffix. */
9346 while (keytran
.end
< fkey
.start
)
9348 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9351 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9352 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9357 mock_input
= diff
+ max (t
, mock_input
);
9358 /* Adjust the function-key-map counters. */
9362 goto replay_sequence
;
9366 /* If KEY is not defined in any of the keymaps,
9367 and cannot be part of a function key or translation,
9368 and is an upper case letter
9369 use the corresponding lower-case letter instead. */
9370 if (first_binding
>= nmaps
9371 && fkey
.start
>= t
&& keytran
.start
>= t
9373 && ((((XINT (key
) & 0x3ffff)
9374 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9375 && UPPERCASEP (XINT (key
) & 0x3ffff))
9376 || (XINT (key
) & shift_modifier
)))
9378 Lisp_Object new_key
;
9380 original_uppercase
= key
;
9381 original_uppercase_position
= t
- 1;
9383 if (XINT (key
) & shift_modifier
)
9384 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9386 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9387 | (XINT (key
) & ~0x3ffff)));
9389 /* We have to do this unconditionally, regardless of whether
9390 the lower-case char is defined in the keymaps, because they
9391 might get translated through function-key-map. */
9392 keybuf
[t
- 1] = new_key
;
9393 mock_input
= max (t
, mock_input
);
9395 goto replay_sequence
;
9397 /* If KEY is not defined in any of the keymaps,
9398 and cannot be part of a function key or translation,
9399 and is a shifted function key,
9400 use the corresponding unshifted function key instead. */
9401 if (first_binding
>= nmaps
9402 && fkey
.start
>= t
&& keytran
.start
>= t
9405 Lisp_Object breakdown
;
9408 breakdown
= parse_modifiers (key
);
9409 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9410 if (modifiers
& shift_modifier
)
9412 Lisp_Object new_key
;
9414 original_uppercase
= key
;
9415 original_uppercase_position
= t
- 1;
9417 modifiers
&= ~shift_modifier
;
9418 new_key
= apply_modifiers (modifiers
,
9421 keybuf
[t
- 1] = new_key
;
9422 mock_input
= max (t
, mock_input
);
9423 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9424 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9426 goto replay_sequence
;
9432 read_key_sequence_cmd
= (first_binding
< nmaps
9433 ? defs
[first_binding
]
9436 unread_switch_frame
= delayed_switch_frame
;
9437 unbind_to (count
, Qnil
);
9439 /* Don't downcase the last character if the caller says don't.
9440 Don't downcase it if the result is undefined, either. */
9441 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9442 && t
- 1 == original_uppercase_position
)
9443 keybuf
[t
- 1] = original_uppercase
;
9445 /* Occasionally we fabricate events, perhaps by expanding something
9446 according to function-key-map, or by adding a prefix symbol to a
9447 mouse click in the scroll bar or modeline. In this cases, return
9448 the entire generated key sequence, even if we hit an unbound
9449 prefix or a definition before the end. This means that you will
9450 be able to push back the event properly, and also means that
9451 read-key-sequence will always return a logical unit.
9454 for (; t
< mock_input
; t
++)
9456 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9457 && NILP (Fzerop (Vecho_keystrokes
)))
9458 echo_char (keybuf
[t
]);
9459 add_command_key (keybuf
[t
]);
9468 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9469 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9470 The sequence is sufficient to specify a non-prefix command in the
9471 current local and global maps.
9473 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9474 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9475 as a continuation of the previous key.
9477 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9478 convert the last event to lower case. (Normally any upper case event
9479 is converted to lower case if the original event is undefined and the lower
9480 case equivalent is defined.) A non-nil value is appropriate for reading
9481 a key sequence to be defined.
9483 A C-g typed while in this function is treated like any other character,
9484 and `quit-flag' is not set.
9486 If the key sequence starts with a mouse click, then the sequence is read
9487 using the keymaps of the buffer of the window clicked in, not the buffer
9488 of the selected window as normal.
9490 `read-key-sequence' drops unbound button-down events, since you normally
9491 only care about the click or drag events which follow them. If a drag
9492 or multi-click event is unbound, but the corresponding click event would
9493 be bound, `read-key-sequence' turns the event into a click event at the
9494 drag's starting position. This means that you don't have to distinguish
9495 between click and drag, double, or triple events unless you want to.
9497 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9498 lines separating windows, and scroll bars with imaginary keys
9499 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9501 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9502 function will process a switch-frame event if the user switches frames
9503 before typing anything. If the user switches frames in the middle of a
9504 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9505 is nil, then the event will be put off until after the current key sequence.
9507 `read-key-sequence' checks `function-key-map' for function key
9508 sequences, where they wouldn't conflict with ordinary bindings. See
9509 `function-key-map' for more details.
9511 The optional fifth argument COMMAND-LOOP, if non-nil, means
9512 that this key sequence is being read by something that will
9513 read commands one after another. It should be nil if the caller
9514 will read just one key sequence. */)
9515 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9517 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9518 Lisp_Object can_return_switch_frame
, command_loop
;
9520 Lisp_Object keybuf
[30];
9522 struct gcpro gcpro1
;
9523 int count
= SPECPDL_INDEX ();
9526 CHECK_STRING (prompt
);
9529 specbind (Qinput_method_exit_on_first_char
,
9530 (NILP (command_loop
) ? Qt
: Qnil
));
9531 specbind (Qinput_method_use_echo_area
,
9532 (NILP (command_loop
) ? Qt
: Qnil
));
9534 bzero (keybuf
, sizeof keybuf
);
9536 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9538 if (NILP (continue_echo
))
9540 this_command_key_count
= 0;
9541 this_command_key_count_reset
= 0;
9542 this_single_command_key_start
= 0;
9545 #ifdef HAVE_X_WINDOWS
9546 if (display_hourglass_p
)
9547 cancel_hourglass ();
9550 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9551 prompt
, ! NILP (dont_downcase_last
),
9552 ! NILP (can_return_switch_frame
), 0);
9554 #if 0 /* The following is fine for code reading a key sequence and
9555 then proceeding with a lenghty computation, but it's not good
9556 for code reading keys in a loop, like an input method. */
9557 #ifdef HAVE_X_WINDOWS
9558 if (display_hourglass_p
)
9569 return unbind_to (count
, make_event_array (i
, keybuf
));
9572 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9573 Sread_key_sequence_vector
, 1, 5, 0,
9574 doc
: /* Like `read-key-sequence' but always return a vector. */)
9575 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9577 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9578 Lisp_Object can_return_switch_frame
, command_loop
;
9580 Lisp_Object keybuf
[30];
9582 struct gcpro gcpro1
;
9583 int count
= SPECPDL_INDEX ();
9586 CHECK_STRING (prompt
);
9589 specbind (Qinput_method_exit_on_first_char
,
9590 (NILP (command_loop
) ? Qt
: Qnil
));
9591 specbind (Qinput_method_use_echo_area
,
9592 (NILP (command_loop
) ? Qt
: Qnil
));
9594 bzero (keybuf
, sizeof keybuf
);
9596 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9598 if (NILP (continue_echo
))
9600 this_command_key_count
= 0;
9601 this_command_key_count_reset
= 0;
9602 this_single_command_key_start
= 0;
9605 #ifdef HAVE_X_WINDOWS
9606 if (display_hourglass_p
)
9607 cancel_hourglass ();
9610 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9611 prompt
, ! NILP (dont_downcase_last
),
9612 ! NILP (can_return_switch_frame
), 0);
9614 #ifdef HAVE_X_WINDOWS
9615 if (display_hourglass_p
)
9625 return unbind_to (count
, Fvector (i
, keybuf
));
9628 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9629 doc
: /* Execute CMD as an editor command.
9630 CMD must be a symbol that satisfies the `commandp' predicate.
9631 Optional second arg RECORD-FLAG non-nil
9632 means unconditionally put this command in `command-history'.
9633 Otherwise, that is done only if an arg is read using the minibuffer.
9634 The argument KEYS specifies the value to use instead of (this-command-keys)
9635 when reading the arguments; if it is nil, (this-command-keys) is used.
9636 The argument SPECIAL, if non-nil, means that this command is executing
9637 a special event, so ignore the prefix argument and don't clear it. */)
9638 (cmd
, record_flag
, keys
, special
)
9639 Lisp_Object cmd
, record_flag
, keys
, special
;
9641 register Lisp_Object final
;
9642 register Lisp_Object tem
;
9643 Lisp_Object prefixarg
;
9644 struct backtrace backtrace
;
9645 extern int debug_on_next_call
;
9647 debug_on_next_call
= 0;
9651 prefixarg
= current_kboard
->Vprefix_arg
;
9652 Vcurrent_prefix_arg
= prefixarg
;
9653 current_kboard
->Vprefix_arg
= Qnil
;
9660 tem
= Fget (cmd
, Qdisabled
);
9661 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9663 tem
= Fsymbol_value (Qdisabled_command_function
);
9665 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9671 final
= Findirect_function (cmd
);
9673 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9675 struct gcpro gcpro1
, gcpro2
;
9677 GCPRO2 (cmd
, prefixarg
);
9678 do_autoload (final
, cmd
);
9685 if (STRINGP (final
) || VECTORP (final
))
9687 /* If requested, place the macro in the command history. For
9688 other sorts of commands, call-interactively takes care of
9690 if (!NILP (record_flag
))
9693 = Fcons (Fcons (Qexecute_kbd_macro
,
9694 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9697 /* Don't keep command history around forever. */
9698 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9700 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9702 XSETCDR (tem
, Qnil
);
9706 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9709 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9711 backtrace
.next
= backtrace_list
;
9712 backtrace_list
= &backtrace
;
9713 backtrace
.function
= &Qcall_interactively
;
9714 backtrace
.args
= &cmd
;
9715 backtrace
.nargs
= 1;
9716 backtrace
.evalargs
= 0;
9717 backtrace
.debug_on_exit
= 0;
9719 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9721 backtrace_list
= backtrace
.next
;
9729 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9731 doc
: /* Read function name, then read its arguments and call it. */)
9733 Lisp_Object prefixarg
;
9735 Lisp_Object function
;
9737 int saved_last_point_position
;
9738 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9739 Lisp_Object bindings
, value
;
9740 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9742 saved_keys
= Fvector (this_command_key_count
,
9743 XVECTOR (this_command_keys
)->contents
);
9744 saved_last_point_position_buffer
= last_point_position_buffer
;
9745 saved_last_point_position
= last_point_position
;
9747 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9749 if (EQ (prefixarg
, Qminus
))
9751 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9752 strcpy (buf
, "C-u ");
9753 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9754 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9755 else if (INTEGERP (prefixarg
))
9756 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9758 /* This isn't strictly correct if execute-extended-command
9759 is bound to anything else. Perhaps it should use
9760 this_command_keys? */
9761 strcat (buf
, "M-x ");
9763 /* Prompt with buf, and then read a string, completing from and
9764 restricting to the set of all defined commands. Don't provide
9765 any initial input. Save the command read on the extended-command
9767 function
= Fcompleting_read (build_string (buf
),
9768 Vobarray
, Qcommandp
,
9769 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9772 if (STRINGP (function
) && SCHARS (function
) == 0)
9773 error ("No command name given");
9775 /* Set this_command_keys to the concatenation of saved_keys and
9776 function, followed by a RET. */
9781 this_command_key_count
= 0;
9782 this_command_key_count_reset
= 0;
9783 this_single_command_key_start
= 0;
9785 keys
= XVECTOR (saved_keys
)->contents
;
9786 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9787 add_command_key (keys
[i
]);
9789 for (i
= 0; i
< SCHARS (function
); i
++)
9790 add_command_key (Faref (function
, make_number (i
)));
9792 add_command_key (make_number ('\015'));
9795 last_point_position
= saved_last_point_position
;
9796 last_point_position_buffer
= saved_last_point_position_buffer
;
9800 function
= Fintern (function
, Qnil
);
9801 current_kboard
->Vprefix_arg
= prefixarg
;
9802 Vthis_command
= function
;
9803 real_this_command
= function
;
9805 /* If enabled, show which key runs this command. */
9806 if (!NILP (Vsuggest_key_bindings
)
9807 && NILP (Vexecuting_macro
)
9808 && SYMBOLP (function
))
9809 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9815 GCPRO2 (bindings
, value
);
9816 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9818 /* If the command has a key binding, print it now. */
9819 if (!NILP (bindings
)
9820 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9823 /* But first wait, and skip the message if there is input. */
9825 if (!NILP (echo_area_buffer
[0]))
9826 /* This command displayed something in the echo area;
9827 so wait a few seconds, then display our suggestion message. */
9828 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9829 ? XINT (Vsuggest_key_bindings
) : 2);
9831 /* This command left the echo area empty,
9832 so display our message immediately. */
9835 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9836 && ! CONSP (Vunread_command_events
))
9838 Lisp_Object binding
;
9840 int message_p
= push_message ();
9841 int count
= SPECPDL_INDEX ();
9843 record_unwind_protect (pop_message_unwind
, Qnil
);
9844 binding
= Fkey_description (bindings
, Qnil
);
9847 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9850 sprintf (newmessage
, "You can run the command `%s' with %s",
9851 SDATA (SYMBOL_NAME (function
)),
9853 message2_nolog (newmessage
,
9854 strlen (newmessage
),
9855 STRING_MULTIBYTE (binding
));
9856 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9857 ? Vsuggest_key_bindings
: make_number (2)),
9862 unbind_to (count
, Qnil
);
9866 RETURN_UNGCPRO (value
);
9870 /* Return nonzero if input events are pending. */
9873 detect_input_pending ()
9876 get_input_pending (&input_pending
, 0);
9878 return input_pending
;
9881 /* Return nonzero if input events are pending, and run any pending timers. */
9884 detect_input_pending_run_timers (do_display
)
9887 int old_timers_run
= timers_run
;
9890 get_input_pending (&input_pending
, 1);
9892 if (old_timers_run
!= timers_run
&& do_display
)
9894 redisplay_preserve_echo_area (8);
9895 /* The following fixes a bug when using lazy-lock with
9896 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9897 from an idle timer function. The symptom of the bug is that
9898 the cursor sometimes doesn't become visible until the next X
9899 event is processed. --gerd. */
9901 rif
->flush_display (NULL
);
9904 return input_pending
;
9907 /* This is called in some cases before a possible quit.
9908 It cases the next call to detect_input_pending to recompute input_pending.
9909 So calling this function unnecessarily can't do any harm. */
9912 clear_input_pending ()
9917 /* Return nonzero if there are pending requeued events.
9918 This isn't used yet. The hope is to make wait_reading_process_output
9919 call it, and return if it runs Lisp code that unreads something.
9920 The problem is, kbd_buffer_get_event needs to be fixed to know what
9921 to do in that case. It isn't trivial. */
9924 requeued_events_pending_p ()
9926 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9930 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9931 doc
: /* Return t if command input is currently available with no wait.
9932 Actually, the value is nil only if we can be sure that no input is available;
9933 if there is a doubt, the value is t. */)
9936 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9939 get_filtered_input_pending (&input_pending
, 1, 1);
9940 return input_pending
> 0 ? Qt
: Qnil
;
9943 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9944 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9947 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9950 if (total_keys
< NUM_RECENT_KEYS
)
9951 return Fvector (total_keys
, keys
);
9954 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9955 bcopy (keys
+ recent_keys_index
,
9956 XVECTOR (val
)->contents
,
9957 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9959 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9960 recent_keys_index
* sizeof (Lisp_Object
));
9965 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9966 doc
: /* Return the key sequence that invoked this command.
9967 However, if the command has called `read-key-sequence', it returns
9968 the last key sequence that has been read.
9969 The value is a string or a vector. */)
9972 return make_event_array (this_command_key_count
,
9973 XVECTOR (this_command_keys
)->contents
);
9976 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9977 doc
: /* Return the key sequence that invoked this command, as a vector.
9978 However, if the command has called `read-key-sequence', it returns
9979 the last key sequence that has been read. */)
9982 return Fvector (this_command_key_count
,
9983 XVECTOR (this_command_keys
)->contents
);
9986 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9987 Sthis_single_command_keys
, 0, 0, 0,
9988 doc
: /* Return the key sequence that invoked this command.
9989 More generally, it returns the last key sequence read, either by
9990 the command loop or by `read-key-sequence'.
9991 Unlike `this-command-keys', this function's value
9992 does not include prefix arguments.
9993 The value is always a vector. */)
9996 return Fvector (this_command_key_count
9997 - this_single_command_key_start
,
9998 (XVECTOR (this_command_keys
)->contents
9999 + this_single_command_key_start
));
10002 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10003 Sthis_single_command_raw_keys
, 0, 0, 0,
10004 doc
: /* Return the raw events that were read for this command.
10005 More generally, it returns the last key sequence read, either by
10006 the command loop or by `read-key-sequence'.
10007 Unlike `this-single-command-keys', this function's value
10008 shows the events before all translations (except for input methods).
10009 The value is always a vector. */)
10012 return Fvector (raw_keybuf_count
,
10013 (XVECTOR (raw_keybuf
)->contents
));
10016 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10017 Sreset_this_command_lengths
, 0, 0, 0,
10018 doc
: /* Make the unread events replace the last command and echo.
10019 Used in `universal-argument-other-key'.
10021 `universal-argument-other-key' rereads the event just typed.
10022 It then gets translated through `function-key-map'.
10023 The translated event has to replace the real events,
10024 both in the value of (this-command-keys) and in echoing.
10025 To achieve this, `universal-argument-other-key' calls
10026 `reset-this-command-lengths', which discards the record of reading
10027 these events the first time. */)
10030 this_command_key_count
= before_command_key_count
;
10031 if (this_command_key_count
< this_single_command_key_start
)
10032 this_single_command_key_start
= this_command_key_count
;
10034 echo_truncate (before_command_echo_length
);
10036 /* Cause whatever we put into unread-command-events
10037 to echo as if it were being freshly read from the keyboard. */
10038 this_command_key_count_reset
= 1;
10043 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10044 Sclear_this_command_keys
, 0, 1, 0,
10045 doc
: /* Clear out the vector that `this-command-keys' returns.
10046 Also clear the record of the last 100 events, unless optional arg
10047 KEEP-RECORD is non-nil. */)
10049 Lisp_Object keep_record
;
10053 this_command_key_count
= 0;
10054 this_command_key_count_reset
= 0;
10056 if (NILP (keep_record
))
10058 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10059 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10061 recent_keys_index
= 0;
10066 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10067 doc
: /* Return the current depth in recursive edits. */)
10071 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10075 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10076 "FOpen dribble file: ",
10077 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10078 If FILE is nil, close any open dribble file. */)
10089 file
= Fexpand_file_name (file
, Qnil
);
10090 dribble
= fopen (SDATA (file
), "w");
10092 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10097 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10098 doc
: /* Discard the contents of the terminal input buffer.
10099 Also end any kbd macro being defined. */)
10102 if (!NILP (current_kboard
->defining_kbd_macro
))
10104 /* Discard the last command from the macro. */
10105 Fcancel_kbd_macro_events ();
10109 update_mode_lines
++;
10111 Vunread_command_events
= Qnil
;
10112 unread_command_char
= -1;
10114 discard_tty_input ();
10116 kbd_fetch_ptr
= kbd_store_ptr
;
10122 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10123 doc
: /* Stop Emacs and return to superior process. You can resume later.
10124 If `cannot-suspend' is non-nil, or if the system doesn't support job
10125 control, run a subshell instead.
10127 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10128 to be read as terminal input by Emacs's parent, after suspension.
10130 Before suspending, run the normal hook `suspend-hook'.
10131 After resumption run the normal hook `suspend-resume-hook'.
10133 Some operating systems cannot stop the Emacs process and resume it later.
10134 On such systems, Emacs starts a subshell instead of suspending. */)
10136 Lisp_Object stuffstring
;
10138 int count
= SPECPDL_INDEX ();
10139 int old_height
, old_width
;
10141 struct gcpro gcpro1
;
10143 if (!NILP (stuffstring
))
10144 CHECK_STRING (stuffstring
);
10146 /* Run the functions in suspend-hook. */
10147 if (!NILP (Vrun_hooks
))
10148 call1 (Vrun_hooks
, intern ("suspend-hook"));
10150 GCPRO1 (stuffstring
);
10151 get_frame_size (&old_width
, &old_height
);
10152 reset_sys_modes ();
10153 /* sys_suspend can get an error if it tries to fork a subshell
10154 and the system resources aren't available for that. */
10155 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10157 stuff_buffered_input (stuffstring
);
10158 if (cannot_suspend
)
10162 unbind_to (count
, Qnil
);
10164 /* Check if terminal/window size has changed.
10165 Note that this is not useful when we are running directly
10166 with a window system; but suspend should be disabled in that case. */
10167 get_frame_size (&width
, &height
);
10168 if (width
!= old_width
|| height
!= old_height
)
10169 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10171 /* Run suspend-resume-hook. */
10172 if (!NILP (Vrun_hooks
))
10173 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10179 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10180 Then in any case stuff anything Emacs has read ahead and not used. */
10183 stuff_buffered_input (stuffstring
)
10184 Lisp_Object stuffstring
;
10186 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10187 register unsigned char *p
;
10189 if (STRINGP (stuffstring
))
10191 register int count
;
10193 p
= SDATA (stuffstring
);
10194 count
= SBYTES (stuffstring
);
10195 while (count
-- > 0)
10200 /* Anything we have read ahead, put back for the shell to read. */
10201 /* ?? What should this do when we have multiple keyboards??
10202 Should we ignore anything that was typed in at the "wrong" kboard?
10204 rms: we should stuff everything back into the kboard
10206 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10209 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10210 kbd_fetch_ptr
= kbd_buffer
;
10211 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10212 stuff_char (kbd_fetch_ptr
->code
);
10214 clear_event (kbd_fetch_ptr
);
10218 #endif /* SIGTSTP */
10222 set_waiting_for_input (time_to_clear
)
10223 EMACS_TIME
*time_to_clear
;
10225 input_available_clear_time
= time_to_clear
;
10227 /* Tell interrupt_signal to throw back to read_char, */
10228 waiting_for_input
= 1;
10230 /* If interrupt_signal was called before and buffered a C-g,
10231 make it run again now, to avoid timing error. */
10232 if (!NILP (Vquit_flag
))
10233 quit_throw_to_read_char ();
10237 clear_waiting_for_input ()
10239 /* Tell interrupt_signal not to throw back to read_char, */
10240 waiting_for_input
= 0;
10241 input_available_clear_time
= 0;
10244 /* This routine is called at interrupt level in response to C-g.
10246 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10247 is called from kbd_buffer_store_event, in handling SIGIO or
10250 If `waiting_for_input' is non zero, then unless `echoing' is
10251 nonzero, immediately throw back to read_char.
10253 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10254 eval to throw, when it gets a chance. If quit-flag is already
10255 non-nil, it stops the job right away. */
10258 interrupt_signal (signalnum
) /* If we don't have an argument, */
10259 int signalnum
; /* some compilers complain in signal calls. */
10262 /* Must preserve main program's value of errno. */
10263 int old_errno
= errno
;
10264 struct frame
*sf
= SELECTED_FRAME ();
10266 #if defined (USG) && !defined (POSIX_SIGNALS)
10267 if (!read_socket_hook
&& NILP (Vwindow_system
))
10269 /* USG systems forget handlers when they are used;
10270 must reestablish each time */
10271 signal (SIGINT
, interrupt_signal
);
10272 signal (SIGQUIT
, interrupt_signal
);
10278 if (!NILP (Vquit_flag
)
10279 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10281 /* If SIGINT isn't blocked, don't let us be interrupted by
10282 another SIGINT, it might be harmful due to non-reentrancy
10283 in I/O functions. */
10284 sigblock (sigmask (SIGINT
));
10287 reset_sys_modes ();
10289 #ifdef SIGTSTP /* Support possible in later USG versions */
10291 * On systems which can suspend the current process and return to the original
10292 * shell, this command causes the user to end up back at the shell.
10293 * The "Auto-save" and "Abort" questions are not asked until
10294 * the user elects to return to emacs, at which point he can save the current
10295 * job and either dump core or continue.
10300 if (sys_suspend () == -1)
10302 printf ("Not running as a subprocess;\n");
10303 printf ("you can continue or abort.\n");
10305 #else /* not VMS */
10306 /* Perhaps should really fork an inferior shell?
10307 But that would not provide any way to get back
10308 to the original shell, ever. */
10309 printf ("No support for stopping a process on this operating system;\n");
10310 printf ("you can continue or abort.\n");
10311 #endif /* not VMS */
10312 #endif /* not SIGTSTP */
10314 /* We must remain inside the screen area when the internal terminal
10315 is used. Note that [Enter] is not echoed by dos. */
10318 /* It doesn't work to autosave while GC is in progress;
10319 the code used for auto-saving doesn't cope with the mark bit. */
10320 if (!gc_in_progress
)
10322 printf ("Auto-save? (y or n) ");
10324 if (((c
= getchar ()) & ~040) == 'Y')
10326 Fdo_auto_save (Qt
, Qnil
);
10328 printf ("\r\nAuto-save done");
10329 #else /* not MSDOS */
10330 printf ("Auto-save done\n");
10331 #endif /* not MSDOS */
10333 while (c
!= '\n') c
= getchar ();
10337 /* During GC, it must be safe to reenable quitting again. */
10338 Vinhibit_quit
= Qnil
;
10341 #endif /* not MSDOS */
10342 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10343 printf ("but will instead do a real quit after garbage collection ends\r\n");
10348 printf ("\r\nAbort? (y or n) ");
10349 #else /* not MSDOS */
10351 printf ("Abort (and enter debugger)? (y or n) ");
10352 #else /* not VMS */
10353 printf ("Abort (and dump core)? (y or n) ");
10354 #endif /* not VMS */
10355 #endif /* not MSDOS */
10357 if (((c
= getchar ()) & ~040) == 'Y')
10359 while (c
!= '\n') c
= getchar ();
10361 printf ("\r\nContinuing...\r\n");
10362 #else /* not MSDOS */
10363 printf ("Continuing...\n");
10364 #endif /* not MSDOS */
10371 /* If executing a function that wants to be interrupted out of
10372 and the user has not deferred quitting by binding `inhibit-quit'
10373 then quit right away. */
10374 if (immediate_quit
&& NILP (Vinhibit_quit
))
10376 struct gl_state_s saved
;
10377 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10379 immediate_quit
= 0;
10382 GCPRO4 (saved
.object
, saved
.global_code
,
10383 saved
.current_syntax_table
, saved
.old_prop
);
10384 Fsignal (Qquit
, Qnil
);
10389 /* Else request quit when it's safe */
10393 if (waiting_for_input
&& !echoing
)
10394 quit_throw_to_read_char ();
10399 /* Handle a C-g by making read_char return C-g. */
10402 quit_throw_to_read_char ()
10405 /* Prevent another signal from doing this before we finish. */
10406 clear_waiting_for_input ();
10409 Vunread_command_events
= Qnil
;
10410 unread_command_char
= -1;
10412 #if 0 /* Currently, sit_for is called from read_char without turning
10413 off polling. And that can call set_waiting_for_input.
10414 It seems to be harmless. */
10415 #ifdef POLL_FOR_INPUT
10416 /* May be > 1 if in recursive minibuffer. */
10417 if (poll_suppress_count
== 0)
10421 if (FRAMEP (internal_last_event_frame
)
10422 && !EQ (internal_last_event_frame
, selected_frame
))
10423 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10426 _longjmp (getcjmp
, 1);
10429 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10430 doc
: /* Set mode of reading keyboard input.
10431 First arg INTERRUPT non-nil means use input interrupts;
10432 nil means use CBREAK mode.
10433 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10434 (no effect except in CBREAK mode).
10435 Third arg META t means accept 8-bit input (for a Meta key).
10436 META nil means ignore the top bit, on the assumption it is parity.
10437 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10438 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10439 See also `current-input-mode'. */)
10440 (interrupt
, flow
, meta
, quit
)
10441 Lisp_Object interrupt
, flow
, meta
, quit
;
10444 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10445 error ("set-input-mode: QUIT must be an ASCII character");
10447 #ifdef POLL_FOR_INPUT
10452 /* this causes startup screen to be restored and messes with the mouse */
10453 reset_sys_modes ();
10457 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10458 if (read_socket_hook
)
10460 /* When using X, don't give the user a real choice,
10461 because we haven't implemented the mechanisms to support it. */
10462 #ifdef NO_SOCK_SIGIO
10463 interrupt_input
= 0;
10464 #else /* not NO_SOCK_SIGIO */
10465 interrupt_input
= 1;
10466 #endif /* NO_SOCK_SIGIO */
10469 interrupt_input
= !NILP (interrupt
);
10470 #else /* not SIGIO */
10471 interrupt_input
= 0;
10472 #endif /* not SIGIO */
10474 /* Our VMS input only works by interrupts, as of now. */
10476 interrupt_input
= 1;
10479 flow_control
= !NILP (flow
);
10482 else if (EQ (meta
, Qt
))
10487 /* Don't let this value be out of range. */
10488 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10494 #ifdef POLL_FOR_INPUT
10495 poll_suppress_count
= 1;
10501 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10502 doc
: /* Return information about the way Emacs currently reads keyboard input.
10503 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10504 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10505 nil, Emacs is using CBREAK mode.
10506 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10507 terminal; this does not apply if Emacs uses interrupt-driven input.
10508 META is t if accepting 8-bit input with 8th bit as Meta flag.
10509 META nil means ignoring the top bit, on the assumption it is parity.
10510 META is neither t nor nil if accepting 8-bit input and using
10511 all 8 bits as the character code.
10512 QUIT is the character Emacs currently uses to quit.
10513 The elements of this list correspond to the arguments of
10514 `set-input-mode'. */)
10517 Lisp_Object val
[4];
10519 val
[0] = interrupt_input
? Qt
: Qnil
;
10520 val
[1] = flow_control
? Qt
: Qnil
;
10521 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10522 XSETFASTINT (val
[3], quit_char
);
10524 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10527 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 3, 0,
10528 doc
: /* Return position information for pixel coordinates X and Y.
10529 By default, X and Y are relative to text area of the selected window.
10530 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10532 The return value is similar to a mouse click position:
10533 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10534 IMAGE (DX . DY) (WIDTH . HEIGHT))
10535 The `posn-' functions access elements of such lists. */)
10536 (x
, y
, frame_or_window
)
10537 Lisp_Object x
, y
, frame_or_window
;
10539 if (NILP (frame_or_window
))
10540 frame_or_window
= selected_window
;
10542 if (WINDOWP (frame_or_window
))
10546 CHECK_LIVE_WINDOW (frame_or_window
);
10548 w
= XWINDOW (frame_or_window
);
10549 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10550 + window_box_left_offset (w
, TEXT_AREA
)));
10551 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10552 frame_or_window
= w
->frame
;
10555 CHECK_LIVE_FRAME (frame_or_window
);
10557 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10560 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10561 doc
: /* Return position information for buffer POS in WINDOW.
10562 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10564 Return nil if position is not visible in window. Otherwise,
10565 the return value is similar to that returned by `event-start' for
10566 a mouse click at the upper left corner of the glyph corresponding
10567 to the given buffer position:
10568 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10569 IMAGE (DX . DY) (WIDTH . HEIGHT))
10570 The `posn-' functions access elements of such lists. */)
10572 Lisp_Object pos
, window
;
10576 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10578 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
);
10584 * Set up a new kboard object with reasonable initial values.
10590 kb
->Voverriding_terminal_local_map
= Qnil
;
10591 kb
->Vlast_command
= Qnil
;
10592 kb
->Vreal_last_command
= Qnil
;
10593 kb
->Vprefix_arg
= Qnil
;
10594 kb
->Vlast_prefix_arg
= Qnil
;
10595 kb
->kbd_queue
= Qnil
;
10596 kb
->kbd_queue_has_data
= 0;
10597 kb
->immediate_echo
= 0;
10598 kb
->echo_string
= Qnil
;
10599 kb
->echo_after_prompt
= -1;
10600 kb
->kbd_macro_buffer
= 0;
10601 kb
->kbd_macro_bufsize
= 0;
10602 kb
->defining_kbd_macro
= Qnil
;
10603 kb
->Vlast_kbd_macro
= Qnil
;
10604 kb
->reference_count
= 0;
10605 kb
->Vsystem_key_alist
= Qnil
;
10606 kb
->system_key_syms
= Qnil
;
10607 kb
->Vdefault_minibuffer_frame
= Qnil
;
10611 * Destroy the contents of a kboard object, but not the object itself.
10612 * We use this just before deleting it, or if we're going to initialize
10613 * it a second time.
10619 if (kb
->kbd_macro_buffer
)
10620 xfree (kb
->kbd_macro_buffer
);
10623 #ifdef MULTI_KBOARD
10625 /* Free KB and memory referenced from it. */
10633 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10636 *kbp
= kb
->next_kboard
;
10638 /* Prevent a dangling reference to KB. */
10639 if (kb
== current_kboard
10640 && FRAMEP (selected_frame
)
10641 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10643 current_kboard
= XFRAME (selected_frame
)->kboard
;
10644 if (current_kboard
== kb
)
10652 #endif /* MULTI_KBOARD */
10657 /* This is correct before outermost invocation of the editor loop */
10658 command_loop_level
= -1;
10659 immediate_quit
= 0;
10660 quit_char
= Ctl ('g');
10661 Vunread_command_events
= Qnil
;
10662 unread_command_char
= -1;
10663 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10665 recent_keys_index
= 0;
10666 kbd_fetch_ptr
= kbd_buffer
;
10667 kbd_store_ptr
= kbd_buffer
;
10669 do_mouse_tracking
= Qnil
;
10673 /* This means that command_loop_1 won't try to select anything the first
10675 internal_last_event_frame
= Qnil
;
10676 Vlast_event_frame
= internal_last_event_frame
;
10678 #ifdef MULTI_KBOARD
10679 current_kboard
= initial_kboard
;
10681 wipe_kboard (current_kboard
);
10682 init_kboard (current_kboard
);
10684 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10686 signal (SIGINT
, interrupt_signal
);
10687 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10688 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10689 SIGQUIT and we can't tell which one it will give us. */
10690 signal (SIGQUIT
, interrupt_signal
);
10691 #endif /* HAVE_TERMIO */
10693 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10695 if (!noninteractive
)
10696 signal (SIGIO
, input_available_signal
);
10699 /* Use interrupt input by default, if it works and noninterrupt input
10700 has deficiencies. */
10702 #ifdef INTERRUPT_INPUT
10703 interrupt_input
= 1;
10705 interrupt_input
= 0;
10708 /* Our VMS input only works by interrupts, as of now. */
10710 interrupt_input
= 1;
10716 if (keyboard_init_hook
)
10717 (*keyboard_init_hook
) ();
10719 #ifdef POLL_FOR_INPUT
10720 poll_suppress_count
= 1;
10725 /* At least provide an escape route since C-g doesn't work. */
10726 signal (SIGINT
, interrupt_signal
);
10730 /* This type's only use is in syms_of_keyboard, to initialize the
10731 event header symbols and put properties on them. */
10732 struct event_head
{
10738 struct event_head head_table
[] = {
10739 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10740 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10741 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10742 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10743 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10744 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10745 /* `select-window' should be handled just like `switch-frame'
10746 in read_key_sequence. */
10747 {&Qselect_window
, "select-window", &Qswitch_frame
}
10751 syms_of_keyboard ()
10753 Vpre_help_message
= Qnil
;
10754 staticpro (&Vpre_help_message
);
10756 Vlispy_mouse_stem
= build_string ("mouse");
10757 staticpro (&Vlispy_mouse_stem
);
10760 QCimage
= intern (":image");
10761 staticpro (&QCimage
);
10763 staticpro (&Qhelp_echo
);
10764 Qhelp_echo
= intern ("help-echo");
10766 staticpro (&item_properties
);
10767 item_properties
= Qnil
;
10769 staticpro (&tool_bar_item_properties
);
10770 tool_bar_item_properties
= Qnil
;
10771 staticpro (&tool_bar_items_vector
);
10772 tool_bar_items_vector
= Qnil
;
10774 staticpro (&real_this_command
);
10775 real_this_command
= Qnil
;
10777 Qtimer_event_handler
= intern ("timer-event-handler");
10778 staticpro (&Qtimer_event_handler
);
10780 Qdisabled_command_function
= intern ("disabled-command-function");
10781 staticpro (&Qdisabled_command_function
);
10783 Qself_insert_command
= intern ("self-insert-command");
10784 staticpro (&Qself_insert_command
);
10786 Qforward_char
= intern ("forward-char");
10787 staticpro (&Qforward_char
);
10789 Qbackward_char
= intern ("backward-char");
10790 staticpro (&Qbackward_char
);
10792 Qdisabled
= intern ("disabled");
10793 staticpro (&Qdisabled
);
10795 Qundefined
= intern ("undefined");
10796 staticpro (&Qundefined
);
10798 Qpre_command_hook
= intern ("pre-command-hook");
10799 staticpro (&Qpre_command_hook
);
10801 Qpost_command_hook
= intern ("post-command-hook");
10802 staticpro (&Qpost_command_hook
);
10804 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10805 staticpro (&Qpost_command_idle_hook
);
10807 Qdeferred_action_function
= intern ("deferred-action-function");
10808 staticpro (&Qdeferred_action_function
);
10810 Qcommand_hook_internal
= intern ("command-hook-internal");
10811 staticpro (&Qcommand_hook_internal
);
10813 Qfunction_key
= intern ("function-key");
10814 staticpro (&Qfunction_key
);
10815 Qmouse_click
= intern ("mouse-click");
10816 staticpro (&Qmouse_click
);
10818 Qlanguage_change
= intern ("language-change");
10819 staticpro (&Qlanguage_change
);
10821 Qdrag_n_drop
= intern ("drag-n-drop");
10822 staticpro (&Qdrag_n_drop
);
10824 Qsave_session
= intern ("save-session");
10825 staticpro(&Qsave_session
);
10827 Qusr1_signal
= intern ("usr1-signal");
10828 staticpro (&Qusr1_signal
);
10829 Qusr2_signal
= intern ("usr2-signal");
10830 staticpro (&Qusr2_signal
);
10832 Qmenu_enable
= intern ("menu-enable");
10833 staticpro (&Qmenu_enable
);
10834 Qmenu_alias
= intern ("menu-alias");
10835 staticpro (&Qmenu_alias
);
10836 QCenable
= intern (":enable");
10837 staticpro (&QCenable
);
10838 QCvisible
= intern (":visible");
10839 staticpro (&QCvisible
);
10840 QChelp
= intern (":help");
10841 staticpro (&QChelp
);
10842 QCfilter
= intern (":filter");
10843 staticpro (&QCfilter
);
10844 QCbutton
= intern (":button");
10845 staticpro (&QCbutton
);
10846 QCkeys
= intern (":keys");
10847 staticpro (&QCkeys
);
10848 QCkey_sequence
= intern (":key-sequence");
10849 staticpro (&QCkey_sequence
);
10850 QCtoggle
= intern (":toggle");
10851 staticpro (&QCtoggle
);
10852 QCradio
= intern (":radio");
10853 staticpro (&QCradio
);
10855 Qmode_line
= intern ("mode-line");
10856 staticpro (&Qmode_line
);
10857 Qvertical_line
= intern ("vertical-line");
10858 staticpro (&Qvertical_line
);
10859 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10860 staticpro (&Qvertical_scroll_bar
);
10861 Qmenu_bar
= intern ("menu-bar");
10862 staticpro (&Qmenu_bar
);
10864 Qabove_handle
= intern ("above-handle");
10865 staticpro (&Qabove_handle
);
10866 Qhandle
= intern ("handle");
10867 staticpro (&Qhandle
);
10868 Qbelow_handle
= intern ("below-handle");
10869 staticpro (&Qbelow_handle
);
10870 Qup
= intern ("up");
10872 Qdown
= intern ("down");
10873 staticpro (&Qdown
);
10874 Qtop
= intern ("top");
10876 Qbottom
= intern ("bottom");
10877 staticpro (&Qbottom
);
10878 Qend_scroll
= intern ("end-scroll");
10879 staticpro (&Qend_scroll
);
10880 Qratio
= intern ("ratio");
10881 staticpro (&Qratio
);
10883 Qevent_kind
= intern ("event-kind");
10884 staticpro (&Qevent_kind
);
10885 Qevent_symbol_elements
= intern ("event-symbol-elements");
10886 staticpro (&Qevent_symbol_elements
);
10887 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10888 staticpro (&Qevent_symbol_element_mask
);
10889 Qmodifier_cache
= intern ("modifier-cache");
10890 staticpro (&Qmodifier_cache
);
10892 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10893 staticpro (&Qrecompute_lucid_menubar
);
10894 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10895 staticpro (&Qactivate_menubar_hook
);
10897 Qpolling_period
= intern ("polling-period");
10898 staticpro (&Qpolling_period
);
10900 Qinput_method_function
= intern ("input-method-function");
10901 staticpro (&Qinput_method_function
);
10903 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10904 staticpro (&Qinput_method_exit_on_first_char
);
10905 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10906 staticpro (&Qinput_method_use_echo_area
);
10908 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10909 Fset (Qinput_method_use_echo_area
, Qnil
);
10911 last_point_position_buffer
= Qnil
;
10914 struct event_head
*p
;
10916 for (p
= head_table
;
10917 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10920 *p
->var
= intern (p
->name
);
10921 staticpro (p
->var
);
10922 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10923 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10927 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10928 staticpro (&button_down_location
);
10929 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10930 staticpro (&mouse_syms
);
10931 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10932 staticpro (&wheel_syms
);
10936 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10938 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10939 for (i
= 0; i
< len
; i
++)
10940 if (modifier_names
[i
])
10941 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10942 staticpro (&modifier_symbols
);
10945 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10946 staticpro (&recent_keys
);
10948 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10949 staticpro (&this_command_keys
);
10951 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10952 staticpro (&raw_keybuf
);
10954 Qextended_command_history
= intern ("extended-command-history");
10955 Fset (Qextended_command_history
, Qnil
);
10956 staticpro (&Qextended_command_history
);
10958 accent_key_syms
= Qnil
;
10959 staticpro (&accent_key_syms
);
10961 func_key_syms
= Qnil
;
10962 staticpro (&func_key_syms
);
10964 drag_n_drop_syms
= Qnil
;
10965 staticpro (&drag_n_drop_syms
);
10967 unread_switch_frame
= Qnil
;
10968 staticpro (&unread_switch_frame
);
10970 internal_last_event_frame
= Qnil
;
10971 staticpro (&internal_last_event_frame
);
10973 read_key_sequence_cmd
= Qnil
;
10974 staticpro (&read_key_sequence_cmd
);
10976 menu_bar_one_keymap_changed_items
= Qnil
;
10977 staticpro (&menu_bar_one_keymap_changed_items
);
10979 defsubr (&Sevent_convert_list
);
10980 defsubr (&Sread_key_sequence
);
10981 defsubr (&Sread_key_sequence_vector
);
10982 defsubr (&Srecursive_edit
);
10984 defsubr (&Strack_mouse
);
10986 defsubr (&Sinput_pending_p
);
10987 defsubr (&Scommand_execute
);
10988 defsubr (&Srecent_keys
);
10989 defsubr (&Sthis_command_keys
);
10990 defsubr (&Sthis_command_keys_vector
);
10991 defsubr (&Sthis_single_command_keys
);
10992 defsubr (&Sthis_single_command_raw_keys
);
10993 defsubr (&Sreset_this_command_lengths
);
10994 defsubr (&Sclear_this_command_keys
);
10995 defsubr (&Ssuspend_emacs
);
10996 defsubr (&Sabort_recursive_edit
);
10997 defsubr (&Sexit_recursive_edit
);
10998 defsubr (&Srecursion_depth
);
10999 defsubr (&Stop_level
);
11000 defsubr (&Sdiscard_input
);
11001 defsubr (&Sopen_dribble_file
);
11002 defsubr (&Sset_input_mode
);
11003 defsubr (&Scurrent_input_mode
);
11004 defsubr (&Sexecute_extended_command
);
11005 defsubr (&Sposn_at_point
);
11006 defsubr (&Sposn_at_x_y
);
11008 DEFVAR_LISP ("last-command-char", &last_command_char
,
11009 doc
: /* Last input event that was part of a command. */);
11011 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11012 doc
: /* Last input event that was part of a command. */);
11014 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11015 doc
: /* Last input event in a command, except for mouse menu events.
11016 Mouse menus give back keys that don't look like mouse events;
11017 this variable holds the actual mouse event that led to the menu,
11018 so that you can determine whether the command was run by mouse or not. */);
11020 DEFVAR_LISP ("last-input-char", &last_input_char
,
11021 doc
: /* Last input event. */);
11023 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11024 doc
: /* Last input event. */);
11026 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11027 doc
: /* List of events to be read as the command input.
11028 These events are processed first, before actual keyboard input. */);
11029 Vunread_command_events
= Qnil
;
11031 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11032 doc
: /* If not -1, an object to be read as next command input event. */);
11034 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11035 doc
: /* List of events to be processed as input by input methods.
11036 These events are processed after `unread-command-events', but
11037 before actual keyboard input. */);
11038 Vunread_post_input_method_events
= Qnil
;
11040 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11041 doc
: /* List of events to be processed as input by input methods.
11042 These events are processed after `unread-command-events', but
11043 before actual keyboard input. */);
11044 Vunread_input_method_events
= Qnil
;
11046 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11047 doc
: /* Meta-prefix character code.
11048 Meta-foo as command input turns into this character followed by foo. */);
11049 XSETINT (meta_prefix_char
, 033);
11051 DEFVAR_KBOARD ("last-command", Vlast_command
,
11052 doc
: /* The last command executed.
11053 Normally a symbol with a function definition, but can be whatever was found
11054 in the keymap, or whatever the variable `this-command' was set to by that
11057 The value `mode-exit' is special; it means that the previous command
11058 read an event that told it to exit, and it did so and unread that event.
11059 In other words, the present command is the event that made the previous
11062 The value `kill-region' is special; it means that the previous command
11063 was a kill command. */);
11065 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11066 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11068 DEFVAR_LISP ("this-command", &Vthis_command
,
11069 doc
: /* The command now being executed.
11070 The command can set this variable; whatever is put here
11071 will be in `last-command' during the following command. */);
11072 Vthis_command
= Qnil
;
11074 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11075 doc
: /* The command bound to the current key sequence before remapping.
11076 It equals `this-command' if the original command was not remapped through
11077 any of the active keymaps. Otherwise, the value of `this-command' is the
11078 result of looking up the original command in the active keymaps. */);
11079 Vthis_original_command
= Qnil
;
11081 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11082 doc
: /* *Number of input events between auto-saves.
11083 Zero means disable autosaving due to number of characters typed. */);
11084 auto_save_interval
= 300;
11086 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11087 doc
: /* *Number of seconds idle time before auto-save.
11088 Zero or nil means disable auto-saving due to idleness.
11089 After auto-saving due to this many seconds of idle time,
11090 Emacs also does a garbage collection if that seems to be warranted. */);
11091 XSETFASTINT (Vauto_save_timeout
, 30);
11093 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11094 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11095 The value may be integer or floating point. */);
11096 Vecho_keystrokes
= make_number (1);
11098 DEFVAR_INT ("polling-period", &polling_period
,
11099 doc
: /* *Interval between polling for input during Lisp execution.
11100 The reason for polling is to make C-g work to stop a running program.
11101 Polling is needed only when using X windows and SIGIO does not work.
11102 Polling is automatically disabled in all other cases. */);
11103 polling_period
= 2;
11105 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11106 doc
: /* *Maximum time between mouse clicks to make a double-click.
11107 Measured in milliseconds. nil means disable double-click recognition;
11108 t means double-clicks have no time limit and are detected
11109 by position only. */);
11110 Vdouble_click_time
= make_number (500);
11112 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11113 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11114 On window-system frames, value is the number of pixels the mouse may have
11115 moved horizontally or vertically between two clicks to make a double-click.
11116 On non window-system frames, value is interpreted in units of 1/8 characters
11119 This variable is also the threshold for motion of the mouse
11120 to count as a drag. */);
11121 double_click_fuzz
= 3;
11123 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11124 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11125 inhibit_local_menu_bar_menus
= 0;
11127 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11128 doc
: /* Number of complete key sequences read as input so far.
11129 This includes key sequences read from keyboard macros.
11130 The number is effectively the number of interactive command invocations. */);
11131 num_input_keys
= 0;
11133 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11134 doc
: /* Number of input events read from the keyboard so far.
11135 This does not include events generated by keyboard macros. */);
11136 num_nonmacro_input_events
= 0;
11138 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11139 doc
: /* The frame in which the most recently read event occurred.
11140 If the last event came from a keyboard macro, this is set to `macro'. */);
11141 Vlast_event_frame
= Qnil
;
11143 /* This variable is set up in sysdep.c. */
11144 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11145 doc
: /* The ERASE character as set by the user with stty. */);
11147 DEFVAR_LISP ("help-char", &Vhelp_char
,
11148 doc
: /* Character to recognize as meaning Help.
11149 When it is read, do `(eval help-form)', and display result if it's a string.
11150 If the value of `help-form' is nil, this char can be read normally. */);
11151 XSETINT (Vhelp_char
, Ctl ('H'));
11153 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11154 doc
: /* List of input events to recognize as meaning Help.
11155 These work just like the value of `help-char' (see that). */);
11156 Vhelp_event_list
= Qnil
;
11158 DEFVAR_LISP ("help-form", &Vhelp_form
,
11159 doc
: /* Form to execute when character `help-char' is read.
11160 If the form returns a string, that string is displayed.
11161 If `help-form' is nil, the help char is not recognized. */);
11164 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11165 doc
: /* Command to run when `help-char' character follows a prefix key.
11166 This command is used only when there is no actual binding
11167 for that character after that prefix key. */);
11168 Vprefix_help_command
= Qnil
;
11170 DEFVAR_LISP ("top-level", &Vtop_level
,
11171 doc
: /* Form to evaluate when Emacs starts up.
11172 Useful to set before you dump a modified Emacs. */);
11175 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11176 doc
: /* Translate table for keyboard input, or nil.
11177 If non-nil, the value should be a char-table. Each character read
11178 from the keyboard is looked up in this char-table. If the value found
11179 there is non-nil, then it is used instead of the actual input character.
11181 The value can also be a string or vector, but this is considered obsolete.
11182 If it is a string or vector of length N, character codes N and up are left
11183 untranslated. In a vector, an element which is nil means "no translation".
11185 This is applied to the characters supplied to input methods, not their
11186 output. See also `translation-table-for-input'. */);
11187 Vkeyboard_translate_table
= Qnil
;
11189 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11190 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11191 \(Even if the operating system has support for stopping a process.\) */);
11192 cannot_suspend
= 0;
11194 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11195 doc
: /* Non-nil means prompt with menus when appropriate.
11196 This is done when reading from a keymap that has a prompt string,
11197 for elements that have prompt strings.
11198 The menu is displayed on the screen
11199 if X menus were enabled at configuration
11200 time and the previous event was a mouse click prefix key.
11201 Otherwise, menu prompting uses the echo area. */);
11202 menu_prompting
= 1;
11204 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11205 doc
: /* Character to see next line of menu prompt.
11206 Type this character while in a menu prompt to rotate around the lines of it. */);
11207 XSETINT (menu_prompt_more_char
, ' ');
11209 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11210 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11211 Emacs applies the modifiers of the character stored here to each keyboard
11212 character it reads. For example, after evaluating the expression
11213 (setq extra-keyboard-modifiers ?\\C-x)
11214 all input characters will have the control modifier applied to them.
11216 Note that the character ?\\C-@, equivalent to the integer zero, does
11217 not count as a control character; rather, it counts as a character
11218 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11219 cancels any modification. */);
11220 extra_keyboard_modifiers
= 0;
11222 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11223 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11224 The command loop sets this to nil before each command,
11225 and tests the value when the command returns.
11226 Buffer modification stores t in this variable. */);
11227 Vdeactivate_mark
= Qnil
;
11229 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11230 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11231 Vcommand_hook_internal
= Qnil
;
11233 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11234 doc
: /* Normal hook run before each command is executed.
11235 If an unhandled error happens in running this hook,
11236 the hook value is set to nil, since otherwise the error
11237 might happen repeatedly and make Emacs nonfunctional. */);
11238 Vpre_command_hook
= Qnil
;
11240 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11241 doc
: /* Normal hook run after each command is executed.
11242 If an unhandled error happens in running this hook,
11243 the hook value is set to nil, since otherwise the error
11244 might happen repeatedly and make Emacs nonfunctional. */);
11245 Vpost_command_hook
= Qnil
;
11247 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11248 doc
: /* Normal hook run after each command is executed, if idle.
11249 Errors running the hook are caught and ignored. */);
11250 Vpost_command_idle_hook
= Qnil
;
11252 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11253 doc
: /* Delay time before running `post-command-idle-hook'.
11254 This is measured in microseconds. */);
11255 post_command_idle_delay
= 100000;
11258 DEFVAR_LISP ("echo-area-clear-hook", ...,
11259 doc
: /* Normal hook run when clearing the echo area. */);
11261 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11262 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11264 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11265 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11266 Vlucid_menu_bar_dirty_flag
= Qnil
;
11268 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11269 doc
: /* List of menu bar items to move to the end of the menu bar.
11270 The elements of the list are event types that may have menu bar bindings. */);
11271 Vmenu_bar_final_items
= Qnil
;
11273 DEFVAR_KBOARD ("overriding-terminal-local-map",
11274 Voverriding_terminal_local_map
,
11275 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11276 If this variable is non-nil, it is used as a keymap instead of the
11277 buffer's local map, and the minor mode keymaps and text property keymaps.
11278 It also overrides `overriding-local-map'.
11279 This variable is intended to let commands such as `universal-argument'
11280 set up a different keymap for reading the next command. */);
11282 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11283 doc
: /* Keymap that overrides all other local keymaps.
11284 If this variable is non-nil, it is used as a keymap instead of the
11285 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11286 Voverriding_local_map
= Qnil
;
11288 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11289 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11290 Otherwise, the menu bar continues to reflect the buffer's local map
11291 and the minor mode maps regardless of `overriding-local-map'. */);
11292 Voverriding_local_map_menu_flag
= Qnil
;
11294 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11295 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11296 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11298 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11299 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11301 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11302 doc
: /* Alist of system-specific X windows key symbols.
11303 Each element should have the form (N . SYMBOL) where N is the
11304 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11305 and SYMBOL is its name. */);
11307 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11308 doc
: /* List of deferred actions to be performed at a later time.
11309 The precise format isn't relevant here; we just check whether it is nil. */);
11310 Vdeferred_action_list
= Qnil
;
11312 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11313 doc
: /* Function to call to handle deferred actions, after each command.
11314 This function is called with no arguments after each command
11315 whenever `deferred-action-list' is non-nil. */);
11316 Vdeferred_action_function
= Qnil
;
11318 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11319 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11320 The value can be a length of time to show the message for.
11321 If the value is non-nil and not a number, we wait 2 seconds. */);
11322 Vsuggest_key_bindings
= Qt
;
11324 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11325 doc
: /* List of active absolute time timers in order of increasing time. */);
11326 Vtimer_list
= Qnil
;
11328 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11329 doc
: /* List of active idle-time timers in order of increasing time. */);
11330 Vtimer_idle_list
= Qnil
;
11332 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11333 doc
: /* If non-nil, the function that implements the current input method.
11334 It's called with one argument, a printing character that was just read.
11335 \(That means a character with code 040...0176.)
11336 Typically this function uses `read-event' to read additional events.
11337 When it does so, it should first bind `input-method-function' to nil
11338 so it will not be called recursively.
11340 The function should return a list of zero or more events
11341 to be used as input. If it wants to put back some events
11342 to be reconsidered, separately, by the input method,
11343 it can add them to the beginning of `unread-command-events'.
11345 The input method function can find in `input-method-previous-method'
11346 the previous echo area message.
11348 The input method function should refer to the variables
11349 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11350 for guidance on what to do. */);
11351 Vinput_method_function
= Qnil
;
11353 DEFVAR_LISP ("input-method-previous-message",
11354 &Vinput_method_previous_message
,
11355 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11356 This variable exists because `read-event' clears the echo area
11357 before running the input method. It is nil if there was no message. */);
11358 Vinput_method_previous_message
= Qnil
;
11360 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11361 doc
: /* If non-nil, the function that implements the display of help.
11362 It's called with one argument, the help string to display. */);
11363 Vshow_help_function
= Qnil
;
11365 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11366 doc
: /* If non-nil, suppress point adjustment after executing a command.
11368 After a command is executed, if point is moved into a region that has
11369 special properties (e.g. composition, display), we adjust point to
11370 the boundary of the region. But, when a command sets this variable to
11371 non-nil, we suppress the point adjustment.
11373 This variable is set to nil before reading a command, and is checked
11374 just after executing the command. */);
11375 Vdisable_point_adjustment
= Qnil
;
11377 DEFVAR_LISP ("global-disable-point-adjustment",
11378 &Vglobal_disable_point_adjustment
,
11379 doc
: /* *If non-nil, always suppress point adjustment.
11381 The default value is nil, in which case, point adjustment are
11382 suppressed only after special commands that set
11383 `disable-point-adjustment' (which see) to non-nil. */);
11384 Vglobal_disable_point_adjustment
= Qnil
;
11386 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11387 doc
: /* Non-nil means updating menu bindings is allowed.
11388 A value of nil means menu bindings should not be updated.
11389 Used during Emacs' startup. */);
11390 update_menu_bindings
= 1;
11392 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11393 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11394 If the value is not a number, such messages don't time out. */);
11395 Vminibuffer_message_timeout
= make_number (2);
11399 keys_of_keyboard ()
11401 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11402 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11403 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11404 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11405 initial_define_key (meta_map
, 'x', "execute-extended-command");
11407 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11408 "handle-delete-frame");
11409 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11411 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11413 /* Handling it at such a low-level causes read_key_sequence to get
11414 * confused because it doesn't realize that the current_buffer was
11415 * changed by read_char.
11417 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11418 * "handle-select-window"); */
11419 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11420 "handle-save-session");
11423 /* Mark the pointers in the kboard objects.
11424 Called by the Fgarbage_collector. */
11430 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11432 if (kb
->kbd_macro_buffer
)
11433 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11435 mark_object (kb
->Voverriding_terminal_local_map
);
11436 mark_object (kb
->Vlast_command
);
11437 mark_object (kb
->Vreal_last_command
);
11438 mark_object (kb
->Vprefix_arg
);
11439 mark_object (kb
->Vlast_prefix_arg
);
11440 mark_object (kb
->kbd_queue
);
11441 mark_object (kb
->defining_kbd_macro
);
11442 mark_object (kb
->Vlast_kbd_macro
);
11443 mark_object (kb
->Vsystem_key_alist
);
11444 mark_object (kb
->system_key_syms
);
11445 mark_object (kb
->Vdefault_minibuffer_frame
);
11446 mark_object (kb
->echo_string
);
11449 struct input_event
*event
;
11450 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11452 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11453 event
= kbd_buffer
;
11454 if (event
->kind
!= SELECTION_REQUEST_EVENT
11455 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11457 mark_object (event
->x
);
11458 mark_object (event
->y
);
11460 mark_object (event
->frame_or_window
);
11461 mark_object (event
->arg
);
11466 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11467 (do not change this comment) */