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 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3048 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3051 if (before_command_restore_flag
)
3053 this_command_key_count
= before_command_key_count_1
;
3054 if (this_command_key_count
< this_single_command_key_start
)
3055 this_single_command_key_start
= this_command_key_count
;
3056 echo_truncate (before_command_echo_length_1
);
3057 before_command_restore_flag
= 0;
3061 /* Save the this_command_keys status. */
3062 key_count
= this_command_key_count
;
3063 key_count_reset
= this_command_key_count_reset
;
3066 keys
= Fcopy_sequence (this_command_keys
);
3071 /* Clear out this_command_keys. */
3072 this_command_key_count
= 0;
3073 this_command_key_count_reset
= 0;
3075 /* Now wipe the echo area. */
3076 if (!NILP (echo_area_buffer
[0]))
3077 safe_run_hooks (Qecho_area_clear_hook
);
3078 clear_message (1, 0);
3081 /* If we are not reading a key sequence,
3082 never use the echo area. */
3085 specbind (Qinput_method_use_echo_area
, Qt
);
3088 /* Call the input method. */
3089 tem
= call1 (Vinput_method_function
, c
);
3091 tem
= unbind_to (count
, tem
);
3093 /* Restore the saved echoing state
3094 and this_command_keys state. */
3095 this_command_key_count
= key_count
;
3096 this_command_key_count_reset
= key_count_reset
;
3098 this_command_keys
= keys
;
3101 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3102 current_kboard
->echo_string
= saved_echo_string
;
3103 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3104 if (saved_immediate_echo
)
3109 /* The input method can return no events. */
3112 /* Bring back the previous message, if any. */
3113 if (! NILP (previous_echo_area_message
))
3114 message_with_string ("%s", previous_echo_area_message
, 0);
3117 /* It returned one event or more. */
3119 Vunread_post_input_method_events
3120 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3125 /* Display help if not echoing. */
3126 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3128 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3129 Lisp_Object help
, object
, position
, window
, tem
;
3131 tem
= Fcdr (XCDR (c
));
3134 window
= Fcar (tem
);
3136 object
= Fcar (tem
);
3138 position
= Fcar (tem
);
3140 show_help_echo (help
, window
, object
, position
, 0);
3142 /* We stopped being idle for this event; undo that. */
3143 timer_resume_idle ();
3147 if (! reread
|| this_command_key_count
== 0
3148 || this_command_key_count_reset
)
3151 /* Don't echo mouse motion events. */
3152 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3153 && NILP (Fzerop (Vecho_keystrokes
))
3154 && ! (EVENT_HAS_PARAMETERS (c
)
3155 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3158 if (! NILP (also_record
))
3159 echo_char (also_record
);
3160 /* Once we reread a character, echoing can happen
3161 the next time we pause to read a new one. */
3162 ok_to_echo_at_next_pause
= current_kboard
;
3165 /* Record this character as part of the current key. */
3166 add_command_key (c
);
3167 if (! NILP (also_record
))
3168 add_command_key (also_record
);
3171 last_input_char
= c
;
3174 /* Process the help character specially if enabled */
3175 if (!NILP (Vhelp_form
) && help_char_p (c
))
3178 count
= SPECPDL_INDEX ();
3180 record_unwind_protect (Fset_window_configuration
,
3181 Fcurrent_window_configuration (Qnil
));
3183 tem0
= Feval (Vhelp_form
);
3185 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3189 c
= read_char (0, 0, 0, Qnil
, 0);
3190 while (BUFFERP (c
));
3191 /* Remove the help from the frame */
3192 unbind_to (count
, Qnil
);
3195 if (EQ (c
, make_number (040)))
3199 c
= read_char (0, 0, 0, Qnil
, 0);
3200 while (BUFFERP (c
));
3209 /* Record a key that came from a mouse menu.
3210 Record it for echoing, for this-command-keys, and so on. */
3216 /* Wipe the echo area. */
3217 clear_message (1, 0);
3222 before_command_key_count
= this_command_key_count
;
3223 before_command_echo_length
= echo_length ();
3226 /* Don't echo mouse motion events. */
3227 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3228 && NILP (Fzerop (Vecho_keystrokes
)))
3232 /* Once we reread a character, echoing can happen
3233 the next time we pause to read a new one. */
3234 ok_to_echo_at_next_pause
= 0;
3237 /* Record this character as part of the current key. */
3238 add_command_key (c
);
3240 /* Re-reading in the middle of a command */
3241 last_input_char
= c
;
3245 /* Return 1 if should recognize C as "the help character". */
3253 if (EQ (c
, Vhelp_char
))
3255 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3256 if (EQ (c
, XCAR (tail
)))
3261 /* Record the input event C in various ways. */
3269 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3271 /* To avoid filling recent_keys with help-echo and mouse-movement
3272 events, we filter out repeated help-echo events, only store the
3273 first and last in a series of mouse-movement events, and don't
3274 store repeated help-echo events which are only separated by
3275 mouse-movement events. */
3277 Lisp_Object ev1
, ev2
, ev3
;
3280 if ((ix1
= recent_keys_index
- 1) < 0)
3281 ix1
= NUM_RECENT_KEYS
- 1;
3282 ev1
= AREF (recent_keys
, ix1
);
3284 if ((ix2
= ix1
- 1) < 0)
3285 ix2
= NUM_RECENT_KEYS
- 1;
3286 ev2
= AREF (recent_keys
, ix2
);
3288 if ((ix3
= ix2
- 1) < 0)
3289 ix3
= NUM_RECENT_KEYS
- 1;
3290 ev3
= AREF (recent_keys
, ix3
);
3292 if (EQ (XCAR (c
), Qhelp_echo
))
3294 /* Don't record `help-echo' in recent_keys unless it shows some help
3295 message, and a different help than the previously recorded
3297 Lisp_Object help
, last_help
;
3299 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3300 if (!STRINGP (help
))
3302 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3303 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3305 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3306 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3307 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3309 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3310 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3311 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3312 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3315 else if (EQ (XCAR (c
), Qmouse_movement
))
3317 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3318 So additional mouse movement events replace the last element. */
3319 Lisp_Object last_window
, window
;
3321 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3322 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3323 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3324 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3325 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3327 ASET (recent_keys
, ix1
, c
);
3333 store_kbd_macro_char (c
);
3338 ASET (recent_keys
, recent_keys_index
, c
);
3339 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3340 recent_keys_index
= 0;
3342 else if (recorded
< 0)
3344 /* We need to remove one or two events from recent_keys.
3345 To do this, we simply put nil at those events and move the
3346 recent_keys_index backwards over those events. Usually,
3347 users will never see those nil events, as they will be
3348 overwritten by the command keys entered to see recent_keys
3351 while (recorded
++ < 0 && total_keys
> 0)
3353 if (total_keys
< NUM_RECENT_KEYS
)
3355 if (--recent_keys_index
< 0)
3356 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3357 ASET (recent_keys
, recent_keys_index
, Qnil
);
3361 num_nonmacro_input_events
++;
3363 /* Write c to the dribble file. If c is a lispy event, write
3364 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3365 If you, dear reader, have a better idea, you've got the source. :-) */
3370 if (XUINT (c
) < 0x100)
3371 putc (XINT (c
), dribble
);
3373 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3377 Lisp_Object dribblee
;
3379 /* If it's a structured event, take the event header. */
3380 dribblee
= EVENT_HEAD (c
);
3382 if (SYMBOLP (dribblee
))
3384 putc ('<', dribble
);
3385 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3386 SBYTES (SYMBOL_NAME (dribblee
)),
3388 putc ('>', dribble
);
3400 struct buffer
*old
= current_buffer
;
3401 Fprinc (object
, Qnil
);
3402 set_buffer_internal (XBUFFER (Vstandard_output
));
3403 call0 (intern ("help-mode"));
3404 set_buffer_internal (old
);
3408 /* Copy out or in the info on where C-g should throw to.
3409 This is used when running Lisp code from within get_char,
3410 in case get_char is called recursively.
3411 See read_process_output. */
3417 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3421 restore_getcjmp (temp
)
3424 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3429 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3430 of this function. */
3433 tracking_off (old_value
)
3434 Lisp_Object old_value
;
3436 do_mouse_tracking
= old_value
;
3437 if (NILP (old_value
))
3439 /* Redisplay may have been preempted because there was input
3440 available, and it assumes it will be called again after the
3441 input has been processed. If the only input available was
3442 the sort that we have just disabled, then we need to call
3444 if (!readable_events (1))
3446 redisplay_preserve_echo_area (6);
3447 get_input_pending (&input_pending
, 1);
3453 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3454 doc
: /* Evaluate BODY with mouse movement events enabled.
3455 Within a `track-mouse' form, mouse motion generates input events that
3456 you can read with `read-event'.
3457 Normally, mouse motion is ignored.
3458 usage: (track-mouse BODY ...) */)
3462 int count
= SPECPDL_INDEX ();
3465 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3467 do_mouse_tracking
= Qt
;
3469 val
= Fprogn (args
);
3470 return unbind_to (count
, val
);
3473 /* If mouse has moved on some frame, return one of those frames.
3474 Return 0 otherwise. */
3479 Lisp_Object tail
, frame
;
3481 FOR_EACH_FRAME (tail
, frame
)
3483 if (XFRAME (frame
)->mouse_moved
)
3484 return XFRAME (frame
);
3490 #endif /* HAVE_MOUSE */
3492 /* Low level keyboard/mouse input.
3493 kbd_buffer_store_event places events in kbd_buffer, and
3494 kbd_buffer_get_event retrieves them. */
3496 /* Return true iff there are any events in the queue that read-char
3497 would return. If this returns false, a read-char would block. */
3499 readable_filtered_events (do_timers_now
, filter_events
)
3504 timer_check (do_timers_now
);
3506 /* If the buffer contains only FOCUS_IN_EVENT events,
3507 and FILTER_EVENTS is nonzero, report it as empty. */
3508 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3510 int have_live_event
= 1;
3514 struct input_event
*event
;
3516 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3520 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3523 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3525 if (event
== kbd_store_ptr
)
3526 have_live_event
= 0;
3529 if (have_live_event
) return 1;
3533 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3538 if (current_kboard
->kbd_queue_has_data
)
3544 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3545 if (kb
->kbd_queue_has_data
)
3551 /* Return true iff there are any events in the queue that read-char
3552 would return. If this returns false, a read-char would block. */
3554 readable_events (do_timers_now
)
3557 return readable_filtered_events (do_timers_now
, 0);
3560 /* Set this for debugging, to have a way to get out */
3565 event_to_kboard (event
)
3566 struct input_event
*event
;
3569 frame
= event
->frame_or_window
;
3571 frame
= XCAR (frame
);
3572 else if (WINDOWP (frame
))
3573 frame
= WINDOW_FRAME (XWINDOW (frame
));
3575 /* There are still some events that don't set this field.
3576 For now, just ignore the problem.
3577 Also ignore dead frames here. */
3578 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3581 return FRAME_KBOARD (XFRAME (frame
));
3586 Lisp_Object Vthrow_on_input
;
3588 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3591 kbd_buffer_store_event (event
)
3592 register struct input_event
*event
;
3594 kbd_buffer_store_event_hold (event
, 0);
3597 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3599 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3600 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3601 Else, if EVENT is a quit event, store the quit event
3602 in HOLD_QUIT, and return (thus ignoring further events).
3604 This is used in read_avail_input to postpone the processing
3605 of the quit event until all subsequent input events have been
3606 parsed (and discarded).
3610 kbd_buffer_store_event_hold (event
, hold_quit
)
3611 register struct input_event
*event
;
3612 struct input_event
*hold_quit
;
3614 if (event
->kind
== NO_EVENT
)
3617 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3620 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3622 register int c
= event
->code
& 0377;
3624 if (event
->modifiers
& ctrl_modifier
)
3625 c
= make_ctrl_char (c
);
3627 c
|= (event
->modifiers
3628 & (meta_modifier
| alt_modifier
3629 | hyper_modifier
| super_modifier
));
3635 struct input_event
*sp
;
3638 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3639 kb
!= current_kboard
))
3642 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3643 Fcons (make_number (c
), Qnil
));
3644 kb
->kbd_queue_has_data
= 1;
3645 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3647 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3650 if (event_to_kboard (sp
) == kb
)
3652 sp
->kind
= NO_EVENT
;
3653 sp
->frame_or_window
= Qnil
;
3663 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3667 /* If this results in a quit_char being returned to Emacs as
3668 input, set Vlast_event_frame properly. If this doesn't
3669 get returned to Emacs as an event, the next event read
3670 will set Vlast_event_frame again, so this is safe to do. */
3674 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3676 focus
= event
->frame_or_window
;
3677 internal_last_event_frame
= focus
;
3678 Vlast_event_frame
= focus
;
3681 last_event_timestamp
= event
->timestamp
;
3682 interrupt_signal (0 /* dummy */);
3686 if (c
&& c
== stop_character
)
3692 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3693 Just ignore the second one. */
3694 else if (event
->kind
== BUFFER_SWITCH_EVENT
3695 && kbd_fetch_ptr
!= kbd_store_ptr
3696 && ((kbd_store_ptr
== kbd_buffer
3697 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3698 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3701 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3702 kbd_store_ptr
= kbd_buffer
;
3704 /* Don't let the very last slot in the buffer become full,
3705 since that would make the two pointers equal,
3706 and that is indistinguishable from an empty buffer.
3707 Discard the event if it would fill the last slot. */
3708 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3710 *kbd_store_ptr
= *event
;
3714 /* If we're inside while-no-input, and this event qualifies
3715 as input, set quit-flag to cause an interrupt. */
3716 if (!NILP (Vthrow_on_input
)
3717 && event
->kind
!= FOCUS_IN_EVENT
3718 && event
->kind
!= HELP_EVENT
3719 && event
->kind
!= DEICONIFY_EVENT
)
3721 Vquit_flag
= Vthrow_on_input
;
3722 /* If we're inside a function that wants immediate quits,
3724 if (immediate_quit
&& NILP (Vinhibit_quit
))
3734 /* Put an input event back in the head of the event queue. */
3737 kbd_buffer_unget_event (event
)
3738 register struct input_event
*event
;
3740 if (kbd_fetch_ptr
== kbd_buffer
)
3741 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3743 /* Don't let the very last slot in the buffer become full, */
3744 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3747 *kbd_fetch_ptr
= *event
;
3752 /* Generate HELP_EVENT input_events in BUFP which has room for
3753 SIZE events. If there's not enough room in BUFP, ignore this
3756 HELP is the help form.
3758 FRAME is the frame on which the help is generated. OBJECT is the
3759 Lisp object where the help was found (a buffer, a string, an
3760 overlay, or nil if neither from a string nor from a buffer. POS is
3761 the position within OBJECT where the help was found.
3763 Value is the number of input_events generated. */
3766 gen_help_event (help
, frame
, window
, object
, pos
)
3767 Lisp_Object help
, frame
, object
, window
;
3770 struct input_event event
;
3774 event
.kind
= HELP_EVENT
;
3775 event
.frame_or_window
= frame
;
3777 event
.x
= WINDOWP (window
) ? window
: frame
;
3780 kbd_buffer_store_event (&event
);
3784 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3787 kbd_buffer_store_help_event (frame
, help
)
3788 Lisp_Object frame
, help
;
3790 struct input_event event
;
3792 event
.kind
= HELP_EVENT
;
3793 event
.frame_or_window
= frame
;
3798 kbd_buffer_store_event (&event
);
3802 /* Discard any mouse events in the event buffer by setting them to
3805 discard_mouse_events ()
3807 struct input_event
*sp
;
3808 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3810 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3813 if (sp
->kind
== MOUSE_CLICK_EVENT
3814 || sp
->kind
== WHEEL_EVENT
3816 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3818 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3820 sp
->kind
= NO_EVENT
;
3826 /* Return non-zero if there are any real events waiting in the event
3827 buffer, not counting `NO_EVENT's.
3829 If DISCARD is non-zero, discard NO_EVENT events at the front of
3830 the input queue, possibly leaving the input queue empty if there
3831 are no real input events. */
3834 kbd_buffer_events_waiting (discard
)
3837 struct input_event
*sp
;
3839 for (sp
= kbd_fetch_ptr
;
3840 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3843 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3850 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3854 /* Clear input event EVENT. */
3858 struct input_event
*event
;
3860 event
->kind
= NO_EVENT
;
3864 /* Read one event from the event buffer, waiting if necessary.
3865 The value is a Lisp object representing the event.
3866 The value is nil for an event that should be ignored,
3867 or that was handled here.
3868 We always read and discard one event. */
3871 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3873 int *used_mouse_menu
;
3882 *kbp
= current_kboard
;
3886 /* Wait until there is input available. */
3889 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3892 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3896 /* If the quit flag is set, then read_char will return
3897 quit_char, so that counts as "available input." */
3898 if (!NILP (Vquit_flag
))
3899 quit_throw_to_read_char ();
3901 /* One way or another, wait until input is available; then, if
3902 interrupt handlers have not read it, read it now. */
3905 wait_for_kbd_input ();
3907 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3911 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3914 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3918 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3920 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3921 /* Pass 1 for EXPECT since we just waited to have input. */
3922 read_avail_input (1);
3924 #endif /* not VMS */
3927 if (CONSP (Vunread_command_events
))
3930 first
= XCAR (Vunread_command_events
);
3931 Vunread_command_events
= XCDR (Vunread_command_events
);
3932 *kbp
= current_kboard
;
3936 /* At this point, we know that there is a readable event available
3937 somewhere. If the event queue is empty, then there must be a
3938 mouse movement enabled and available. */
3939 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3941 struct input_event
*event
;
3943 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3947 last_event_timestamp
= event
->timestamp
;
3950 *kbp
= event_to_kboard (event
);
3952 *kbp
= current_kboard
; /* Better than returning null ptr? */
3954 *kbp
= &the_only_kboard
;
3959 /* These two kinds of events get special handling
3960 and don't actually appear to the command loop.
3961 We return nil for them. */
3962 if (event
->kind
== SELECTION_REQUEST_EVENT
3963 || event
->kind
== SELECTION_CLEAR_EVENT
)
3966 struct input_event copy
;
3968 /* Remove it from the buffer before processing it,
3969 since otherwise swallow_events will see it
3970 and process it again. */
3972 kbd_fetch_ptr
= event
+ 1;
3973 input_pending
= readable_events (0);
3974 x_handle_selection_event (©
);
3976 /* We're getting selection request events, but we don't have
3982 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3983 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3985 /* Make an event (delete-frame (FRAME)). */
3986 obj
= Fcons (event
->frame_or_window
, Qnil
);
3987 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3988 kbd_fetch_ptr
= event
+ 1;
3991 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3992 else if (event
->kind
== ICONIFY_EVENT
)
3994 /* Make an event (iconify-frame (FRAME)). */
3995 obj
= Fcons (event
->frame_or_window
, Qnil
);
3996 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3997 kbd_fetch_ptr
= event
+ 1;
3999 else if (event
->kind
== DEICONIFY_EVENT
)
4001 /* Make an event (make-frame-visible (FRAME)). */
4002 obj
= Fcons (event
->frame_or_window
, Qnil
);
4003 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4004 kbd_fetch_ptr
= event
+ 1;
4007 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4009 /* The value doesn't matter here; only the type is tested. */
4010 XSETBUFFER (obj
, current_buffer
);
4011 kbd_fetch_ptr
= event
+ 1;
4013 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4014 || defined (USE_GTK)
4015 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4017 kbd_fetch_ptr
= event
+ 1;
4018 input_pending
= readable_events (0);
4019 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4020 x_activate_menubar (XFRAME (event
->frame_or_window
));
4024 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4026 /* Make an event (language-change (FRAME CHARSET LCID)). */
4027 obj
= Fcons (event
->frame_or_window
, Qnil
);
4028 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4029 kbd_fetch_ptr
= event
+ 1;
4032 else if (event
->kind
== SAVE_SESSION_EVENT
)
4034 obj
= Fcons (Qsave_session
, Qnil
);
4035 kbd_fetch_ptr
= event
+ 1;
4037 /* Just discard these, by returning nil.
4038 With MULTI_KBOARD, these events are used as placeholders
4039 when we need to randomly delete events from the queue.
4040 (They shouldn't otherwise be found in the buffer,
4041 but on some machines it appears they do show up
4042 even without MULTI_KBOARD.) */
4043 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4044 mouse events during a popup-menu call. */
4045 else if (event
->kind
== NO_EVENT
)
4046 kbd_fetch_ptr
= event
+ 1;
4047 else if (event
->kind
== HELP_EVENT
)
4049 Lisp_Object object
, position
, help
, frame
, window
;
4051 frame
= event
->frame_or_window
;
4052 object
= event
->arg
;
4053 position
= make_number (event
->code
);
4056 clear_event (event
);
4058 kbd_fetch_ptr
= event
+ 1;
4059 if (!WINDOWP (window
))
4061 obj
= Fcons (Qhelp_echo
,
4062 list5 (frame
, help
, window
, object
, position
));
4064 else if (event
->kind
== FOCUS_IN_EVENT
)
4066 /* Notification of a FocusIn event. The frame receiving the
4067 focus is in event->frame_or_window. Generate a
4068 switch-frame event if necessary. */
4069 Lisp_Object frame
, focus
;
4071 frame
= event
->frame_or_window
;
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
;
4080 kbd_fetch_ptr
= event
+ 1;
4084 /* If this event is on a different frame, return a switch-frame this
4085 time, and leave the event in the queue for next time. */
4089 frame
= event
->frame_or_window
;
4091 frame
= XCAR (frame
);
4092 else if (WINDOWP (frame
))
4093 frame
= WINDOW_FRAME (XWINDOW (frame
));
4095 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4099 if (! EQ (frame
, internal_last_event_frame
)
4100 && !EQ (frame
, selected_frame
))
4101 obj
= make_lispy_switch_frame (frame
);
4102 internal_last_event_frame
= frame
;
4104 /* If we didn't decide to make a switch-frame event, go ahead
4105 and build a real event from the queue entry. */
4109 obj
= make_lispy_event (event
);
4111 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4112 || defined (USE_GTK)
4113 /* If this was a menu selection, then set the flag to inhibit
4114 writing to last_nonmenu_event. Don't do this if the event
4115 we're returning is (menu-bar), though; that indicates the
4116 beginning of the menu sequence, and we might as well leave
4117 that as the `event with parameters' for this selection. */
4119 && !EQ (event
->frame_or_window
, event
->arg
)
4120 && (event
->kind
== MENU_BAR_EVENT
4121 || event
->kind
== TOOL_BAR_EVENT
))
4122 *used_mouse_menu
= 1;
4125 /* Wipe out this event, to catch bugs. */
4126 clear_event (event
);
4127 kbd_fetch_ptr
= event
+ 1;
4132 /* Try generating a mouse motion event. */
4133 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4135 FRAME_PTR f
= some_mouse_moved ();
4136 Lisp_Object bar_window
;
4137 enum scroll_bar_part part
;
4141 *kbp
= current_kboard
;
4142 /* Note that this uses F to determine which display to look at.
4143 If there is no valid info, it does not store anything
4144 so x remains nil. */
4146 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4150 /* Decide if we should generate a switch-frame event. Don't
4151 generate switch-frame events for motion outside of all Emacs
4157 frame
= FRAME_FOCUS_FRAME (f
);
4159 XSETFRAME (frame
, f
);
4161 if (! EQ (frame
, internal_last_event_frame
)
4162 && !EQ (frame
, selected_frame
))
4163 obj
= make_lispy_switch_frame (frame
);
4164 internal_last_event_frame
= frame
;
4167 /* If we didn't decide to make a switch-frame event, go ahead and
4168 return a mouse-motion event. */
4169 if (!NILP (x
) && NILP (obj
))
4170 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4172 #endif /* HAVE_MOUSE */
4174 /* We were promised by the above while loop that there was
4175 something for us to read! */
4178 input_pending
= readable_events (0);
4180 Vlast_event_frame
= internal_last_event_frame
;
4185 /* Process any events that are not user-visible,
4186 then return, without reading any user-visible events. */
4189 swallow_events (do_display
)
4194 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4196 struct input_event
*event
;
4198 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4202 last_event_timestamp
= event
->timestamp
;
4204 /* These two kinds of events get special handling
4205 and don't actually appear to the command loop. */
4206 if (event
->kind
== SELECTION_REQUEST_EVENT
4207 || event
->kind
== SELECTION_CLEAR_EVENT
)
4210 struct input_event copy
;
4212 /* Remove it from the buffer before processing it,
4213 since otherwise swallow_events called recursively could see it
4214 and process it again. */
4216 kbd_fetch_ptr
= event
+ 1;
4217 input_pending
= readable_events (0);
4218 x_handle_selection_event (©
);
4220 /* We're getting selection request events, but we don't have
4229 old_timers_run
= timers_run
;
4230 get_input_pending (&input_pending
, 1);
4232 if (timers_run
!= old_timers_run
&& do_display
)
4233 redisplay_preserve_echo_area (7);
4236 /* Record the start of when Emacs is idle,
4237 for the sake of running idle-time timers. */
4244 /* If we are already in the idle state, do nothing. */
4245 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4248 EMACS_GET_TIME (timer_idleness_start_time
);
4250 timer_last_idleness_start_time
= timer_idleness_start_time
;
4252 /* Mark all idle-time timers as once again candidates for running. */
4253 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4257 timer
= XCAR (timers
);
4259 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4261 XVECTOR (timer
)->contents
[0] = Qnil
;
4265 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4270 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4273 /* Resume idle timer from last idle start time. */
4276 timer_resume_idle ()
4278 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4281 timer_idleness_start_time
= timer_last_idleness_start_time
;
4284 /* This is only for debugging. */
4285 struct input_event last_timer_event
;
4287 /* Check whether a timer has fired. To prevent larger problems we simply
4288 disregard elements that are not proper timers. Do not make a circular
4289 timer list for the time being.
4291 Returns the number of seconds to wait until the next timer fires. If a
4292 timer is triggering now, return zero seconds.
4293 If no timer is active, return -1 seconds.
4295 If a timer is ripe, we run it, with quitting turned off.
4297 DO_IT_NOW is now ignored. It used to mean that we should
4298 run the timer directly instead of queueing a timer-event.
4299 Now we always run timers directly. */
4302 timer_check (do_it_now
)
4305 EMACS_TIME nexttime
;
4306 EMACS_TIME now
, idleness_now
;
4307 Lisp_Object timers
, idle_timers
, chosen_timer
;
4308 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4310 EMACS_SET_SECS (nexttime
, -1);
4311 EMACS_SET_USECS (nexttime
, -1);
4313 /* Always consider the ordinary timers. */
4314 timers
= Vtimer_list
;
4315 /* Consider the idle timers only if Emacs is idle. */
4316 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4317 idle_timers
= Vtimer_idle_list
;
4320 chosen_timer
= Qnil
;
4321 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4323 if (CONSP (timers
) || CONSP (idle_timers
))
4325 EMACS_GET_TIME (now
);
4326 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4327 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4330 while (CONSP (timers
) || CONSP (idle_timers
))
4332 Lisp_Object
*vector
;
4333 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4334 EMACS_TIME timer_time
, idle_timer_time
;
4335 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4337 /* Skip past invalid timers and timers already handled. */
4340 timer
= XCAR (timers
);
4341 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4343 timers
= XCDR (timers
);
4346 vector
= XVECTOR (timer
)->contents
;
4348 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4349 || !INTEGERP (vector
[3])
4350 || ! NILP (vector
[0]))
4352 timers
= XCDR (timers
);
4356 if (!NILP (idle_timers
))
4358 timer
= XCAR (idle_timers
);
4359 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4361 idle_timers
= XCDR (idle_timers
);
4364 vector
= XVECTOR (timer
)->contents
;
4366 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4367 || !INTEGERP (vector
[3])
4368 || ! NILP (vector
[0]))
4370 idle_timers
= XCDR (idle_timers
);
4375 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4376 based on the next ordinary timer.
4377 TIMER_DIFFERENCE is the distance in time from NOW to when
4378 this timer becomes ripe (negative if it's already ripe). */
4381 timer
= XCAR (timers
);
4382 vector
= XVECTOR (timer
)->contents
;
4383 EMACS_SET_SECS (timer_time
,
4384 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4385 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4386 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4389 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4390 based on the next idle timer. */
4391 if (!NILP (idle_timers
))
4393 idle_timer
= XCAR (idle_timers
);
4394 vector
= XVECTOR (idle_timer
)->contents
;
4395 EMACS_SET_SECS (idle_timer_time
,
4396 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4397 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4398 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4401 /* Decide which timer is the next timer,
4402 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4403 Also step down the list where we found that timer. */
4405 if (! NILP (timers
) && ! NILP (idle_timers
))
4408 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4409 if (EMACS_TIME_NEG_P (temp
))
4411 chosen_timer
= timer
;
4412 timers
= XCDR (timers
);
4413 difference
= timer_difference
;
4417 chosen_timer
= idle_timer
;
4418 idle_timers
= XCDR (idle_timers
);
4419 difference
= idle_timer_difference
;
4422 else if (! NILP (timers
))
4424 chosen_timer
= timer
;
4425 timers
= XCDR (timers
);
4426 difference
= timer_difference
;
4430 chosen_timer
= idle_timer
;
4431 idle_timers
= XCDR (idle_timers
);
4432 difference
= idle_timer_difference
;
4434 vector
= XVECTOR (chosen_timer
)->contents
;
4436 /* If timer is ripe, run it if it hasn't been run. */
4437 if (EMACS_TIME_NEG_P (difference
)
4438 || (EMACS_SECS (difference
) == 0
4439 && EMACS_USECS (difference
) == 0))
4441 if (NILP (vector
[0]))
4443 int was_locked
= single_kboard
;
4444 int count
= SPECPDL_INDEX ();
4445 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4447 /* Mark the timer as triggered to prevent problems if the lisp
4448 code fails to reschedule it right. */
4451 specbind (Qinhibit_quit
, Qt
);
4453 call1 (Qtimer_event_handler
, chosen_timer
);
4454 Vdeactivate_mark
= old_deactivate_mark
;
4456 unbind_to (count
, Qnil
);
4458 /* Resume allowing input from any kboard, if that was true before. */
4460 any_kboard_state ();
4462 /* Since we have handled the event,
4463 we don't need to tell the caller to wake up and do it. */
4467 /* When we encounter a timer that is still waiting,
4468 return the amount of time to wait before it is ripe. */
4475 /* No timers are pending in the future. */
4476 /* Return 0 if we generated an event, and -1 if not. */
4481 /* Caches for modify_event_symbol. */
4482 static Lisp_Object accent_key_syms
;
4483 static Lisp_Object func_key_syms
;
4484 static Lisp_Object mouse_syms
;
4485 static Lisp_Object wheel_syms
;
4486 static Lisp_Object drag_n_drop_syms
;
4488 /* This is a list of keysym codes for special "accent" characters.
4489 It parallels lispy_accent_keys. */
4491 static int lispy_accent_codes
[] =
4493 #ifdef XK_dead_circumflex
4498 #ifdef XK_dead_grave
4503 #ifdef XK_dead_tilde
4508 #ifdef XK_dead_diaeresis
4513 #ifdef XK_dead_macron
4518 #ifdef XK_dead_degree
4523 #ifdef XK_dead_acute
4528 #ifdef XK_dead_cedilla
4533 #ifdef XK_dead_breve
4538 #ifdef XK_dead_ogonek
4543 #ifdef XK_dead_caron
4548 #ifdef XK_dead_doubleacute
4549 XK_dead_doubleacute
,
4553 #ifdef XK_dead_abovedot
4558 #ifdef XK_dead_abovering
4568 #ifdef XK_dead_belowdot
4573 #ifdef XK_dead_voiced_sound
4574 XK_dead_voiced_sound
,
4578 #ifdef XK_dead_semivoiced_sound
4579 XK_dead_semivoiced_sound
,
4595 /* This is a list of Lisp names for special "accent" characters.
4596 It parallels lispy_accent_codes. */
4598 static char *lispy_accent_keys
[] =
4616 "dead-voiced-sound",
4617 "dead-semivoiced-sound",
4623 #define FUNCTION_KEY_OFFSET 0x0
4625 char *lispy_function_keys
[] =
4629 0, /* VK_LBUTTON 0x01 */
4630 0, /* VK_RBUTTON 0x02 */
4631 "cancel", /* VK_CANCEL 0x03 */
4632 0, /* VK_MBUTTON 0x04 */
4634 0, 0, 0, /* 0x05 .. 0x07 */
4636 "backspace", /* VK_BACK 0x08 */
4637 "tab", /* VK_TAB 0x09 */
4639 0, 0, /* 0x0A .. 0x0B */
4641 "clear", /* VK_CLEAR 0x0C */
4642 "return", /* VK_RETURN 0x0D */
4644 0, 0, /* 0x0E .. 0x0F */
4646 0, /* VK_SHIFT 0x10 */
4647 0, /* VK_CONTROL 0x11 */
4648 0, /* VK_MENU 0x12 */
4649 "pause", /* VK_PAUSE 0x13 */
4650 "capslock", /* VK_CAPITAL 0x14 */
4652 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4654 "escape", /* VK_ESCAPE 0x1B */
4656 0, 0, 0, 0, /* 0x1C .. 0x1F */
4658 0, /* VK_SPACE 0x20 */
4659 "prior", /* VK_PRIOR 0x21 */
4660 "next", /* VK_NEXT 0x22 */
4661 "end", /* VK_END 0x23 */
4662 "home", /* VK_HOME 0x24 */
4663 "left", /* VK_LEFT 0x25 */
4664 "up", /* VK_UP 0x26 */
4665 "right", /* VK_RIGHT 0x27 */
4666 "down", /* VK_DOWN 0x28 */
4667 "select", /* VK_SELECT 0x29 */
4668 "print", /* VK_PRINT 0x2A */
4669 "execute", /* VK_EXECUTE 0x2B */
4670 "snapshot", /* VK_SNAPSHOT 0x2C */
4671 "insert", /* VK_INSERT 0x2D */
4672 "delete", /* VK_DELETE 0x2E */
4673 "help", /* VK_HELP 0x2F */
4675 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4677 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4679 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4681 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4683 0, 0, 0, 0, 0, 0, 0, 0, 0,
4684 0, 0, 0, 0, 0, 0, 0, 0, 0,
4685 0, 0, 0, 0, 0, 0, 0, 0,
4687 "lwindow", /* VK_LWIN 0x5B */
4688 "rwindow", /* VK_RWIN 0x5C */
4689 "apps", /* VK_APPS 0x5D */
4691 0, 0, /* 0x5E .. 0x5F */
4693 "kp-0", /* VK_NUMPAD0 0x60 */
4694 "kp-1", /* VK_NUMPAD1 0x61 */
4695 "kp-2", /* VK_NUMPAD2 0x62 */
4696 "kp-3", /* VK_NUMPAD3 0x63 */
4697 "kp-4", /* VK_NUMPAD4 0x64 */
4698 "kp-5", /* VK_NUMPAD5 0x65 */
4699 "kp-6", /* VK_NUMPAD6 0x66 */
4700 "kp-7", /* VK_NUMPAD7 0x67 */
4701 "kp-8", /* VK_NUMPAD8 0x68 */
4702 "kp-9", /* VK_NUMPAD9 0x69 */
4703 "kp-multiply", /* VK_MULTIPLY 0x6A */
4704 "kp-add", /* VK_ADD 0x6B */
4705 "kp-separator", /* VK_SEPARATOR 0x6C */
4706 "kp-subtract", /* VK_SUBTRACT 0x6D */
4707 "kp-decimal", /* VK_DECIMAL 0x6E */
4708 "kp-divide", /* VK_DIVIDE 0x6F */
4709 "f1", /* VK_F1 0x70 */
4710 "f2", /* VK_F2 0x71 */
4711 "f3", /* VK_F3 0x72 */
4712 "f4", /* VK_F4 0x73 */
4713 "f5", /* VK_F5 0x74 */
4714 "f6", /* VK_F6 0x75 */
4715 "f7", /* VK_F7 0x76 */
4716 "f8", /* VK_F8 0x77 */
4717 "f9", /* VK_F9 0x78 */
4718 "f10", /* VK_F10 0x79 */
4719 "f11", /* VK_F11 0x7A */
4720 "f12", /* VK_F12 0x7B */
4721 "f13", /* VK_F13 0x7C */
4722 "f14", /* VK_F14 0x7D */
4723 "f15", /* VK_F15 0x7E */
4724 "f16", /* VK_F16 0x7F */
4725 "f17", /* VK_F17 0x80 */
4726 "f18", /* VK_F18 0x81 */
4727 "f19", /* VK_F19 0x82 */
4728 "f20", /* VK_F20 0x83 */
4729 "f21", /* VK_F21 0x84 */
4730 "f22", /* VK_F22 0x85 */
4731 "f23", /* VK_F23 0x86 */
4732 "f24", /* VK_F24 0x87 */
4734 0, 0, 0, 0, /* 0x88 .. 0x8B */
4735 0, 0, 0, 0, /* 0x8C .. 0x8F */
4737 "kp-numlock", /* VK_NUMLOCK 0x90 */
4738 "scroll", /* VK_SCROLL 0x91 */
4740 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4741 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4742 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4743 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4744 "kp-end", /* VK_NUMPAD_END 0x96 */
4745 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4746 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4747 "kp-up", /* VK_NUMPAD_UP 0x99 */
4748 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4749 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4750 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4751 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4753 0, 0, /* 0x9E .. 0x9F */
4756 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4757 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4758 * No other API or message will distinguish left and right keys this way.
4762 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4763 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4764 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4765 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4766 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4772 "attn", /* VK_ATTN 0xF6 */
4773 "crsel", /* VK_CRSEL 0xF7 */
4774 "exsel", /* VK_EXSEL 0xF8 */
4775 "ereof", /* VK_EREOF 0xF9 */
4776 "play", /* VK_PLAY 0xFA */
4777 "zoom", /* VK_ZOOM 0xFB */
4778 "noname", /* VK_NONAME 0xFC */
4779 "pa1", /* VK_PA1 0xFD */
4780 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4784 #else /* not HAVE_NTGUI */
4786 /* This should be dealt with in XTread_socket now, and that doesn't
4787 depend on the client system having the Kana syms defined. See also
4788 the XK_kana_A case below. */
4791 static char *lispy_kana_keys
[] =
4793 /* X Keysym value */
4794 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4795 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4796 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4797 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4798 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4799 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4800 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4801 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4802 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4803 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4804 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4805 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4806 "kana-i", "kana-u", "kana-e", "kana-o",
4807 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4808 "prolongedsound", "kana-A", "kana-I", "kana-U",
4809 "kana-E", "kana-O", "kana-KA", "kana-KI",
4810 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4811 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4812 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4813 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4814 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4815 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4816 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4817 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4818 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4819 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4820 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4821 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4823 #endif /* XK_kana_A */
4826 #define FUNCTION_KEY_OFFSET 0xff00
4828 /* You'll notice that this table is arranged to be conveniently
4829 indexed by X Windows keysym values. */
4830 static char *lispy_function_keys
[] =
4832 /* X Keysym value */
4834 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4835 "backspace", "tab", "linefeed", "clear",
4837 0, 0, 0, "pause", /* 0xff10...1f */
4838 0, 0, 0, 0, 0, 0, 0, "escape",
4840 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4841 "romaji", "hiragana", "katakana", "hiragana-katakana",
4842 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4843 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4844 "eisu-toggle", /* 0xff30...3f */
4845 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4846 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4848 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4849 "down", "prior", "next", "end",
4850 "begin", 0, 0, 0, 0, 0, 0, 0,
4851 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4862 "break", /* 0xff6b */
4865 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4866 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4867 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4868 0, 0, 0, 0, 0, 0, 0, 0,
4869 "kp-tab", /* 0xff89 */
4871 "kp-enter", /* 0xff8d */
4873 "kp-f1", /* 0xff91 */
4877 "kp-home", /* 0xff95 */
4882 "kp-prior", /* kp-page-up */
4883 "kp-next", /* kp-page-down */
4889 0, 0, 0, 0, 0, 0, 0, 0, 0,
4890 "kp-multiply", /* 0xffaa */
4895 "kp-divide", /* 0xffaf */
4896 "kp-0", /* 0xffb0 */
4897 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4900 "kp-equal", /* 0xffbd */
4901 "f1", /* 0xffbe */ /* IsFunctionKey */
4903 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4904 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4905 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4906 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4907 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4908 0, 0, 0, 0, 0, 0, 0, 0,
4909 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4910 0, 0, 0, 0, 0, 0, 0, "delete"
4913 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4914 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4916 static char *iso_lispy_function_keys
[] =
4918 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4919 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4920 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4921 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4922 "iso-lefttab", /* 0xfe20 */
4923 "iso-move-line-up", "iso-move-line-down",
4924 "iso-partial-line-up", "iso-partial-line-down",
4925 "iso-partial-space-left", "iso-partial-space-right",
4926 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4927 "iso-release-margin-left", "iso-release-margin-right",
4928 "iso-release-both-margins",
4929 "iso-fast-cursor-left", "iso-fast-cursor-right",
4930 "iso-fast-cursor-up", "iso-fast-cursor-down",
4931 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4932 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4935 #endif /* not HAVE_NTGUI */
4937 Lisp_Object Vlispy_mouse_stem
;
4939 static char *lispy_wheel_names
[] =
4941 "wheel-up", "wheel-down"
4944 /* drag-n-drop events are generated when a set of selected files are
4945 dragged from another application and dropped onto an Emacs window. */
4946 static char *lispy_drag_n_drop_names
[] =
4951 /* Scroll bar parts. */
4952 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4953 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4954 Lisp_Object Qtop
, Qratio
;
4956 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4957 Lisp_Object
*scroll_bar_parts
[] = {
4958 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4959 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4962 /* User signal events. */
4963 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4965 Lisp_Object
*lispy_user_signals
[] =
4967 &Qusr1_signal
, &Qusr2_signal
4971 /* A vector, indexed by button number, giving the down-going location
4972 of currently depressed buttons, both scroll bar and non-scroll bar.
4974 The elements have the form
4975 (BUTTON-NUMBER MODIFIER-MASK . REST)
4976 where REST is the cdr of a position as it would be reported in the event.
4978 The make_lispy_event function stores positions here to tell the
4979 difference between click and drag events, and to store the starting
4980 location to be included in drag events. */
4982 static Lisp_Object button_down_location
;
4984 /* Information about the most recent up-going button event: Which
4985 button, what location, and what time. */
4987 static int last_mouse_button
;
4988 static int last_mouse_x
;
4989 static int last_mouse_y
;
4990 static unsigned long button_down_time
;
4992 /* The maximum time between clicks to make a double-click, or Qnil to
4993 disable double-click detection, or Qt for no time limit. */
4995 Lisp_Object Vdouble_click_time
;
4997 /* Maximum number of pixels the mouse may be moved between clicks
4998 to make a double-click. */
5000 EMACS_INT double_click_fuzz
;
5002 /* The number of clicks in this multiple-click. */
5004 int double_click_count
;
5006 /* Return position of a mouse click or wheel event */
5009 make_lispy_position (f
, x
, y
, time
)
5015 enum window_part part
;
5016 Lisp_Object posn
= Qnil
;
5017 Lisp_Object extra_info
= Qnil
;
5020 /* Set `window' to the window under frame pixel coordinates (x,y) */
5022 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5023 &part
, &wx
, &wy
, 0);
5027 if (WINDOWP (window
))
5029 /* It's a click in window window at frame coordinates (x,y) */
5030 struct window
*w
= XWINDOW (window
);
5031 Lisp_Object string_info
= Qnil
;
5032 int textpos
= -1, rx
= -1, ry
= -1;
5033 int dx
= -1, dy
= -1;
5034 int width
= -1, height
= -1;
5035 Lisp_Object object
= Qnil
;
5037 /* Set event coordinates to window-relative coordinates
5038 for constructing the Lisp event below. */
5042 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5044 /* Mode line or header line. Look for a string under
5045 the mouse that may have a `local-map' property. */
5049 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5051 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5052 &object
, &dx
, &dy
, &width
, &height
);
5053 if (STRINGP (string
))
5054 string_info
= Fcons (string
, make_number (charpos
));
5055 if (w
== XWINDOW (selected_window
))
5058 textpos
= XMARKER (w
->pointm
)->charpos
;
5060 else if (part
== ON_VERTICAL_BORDER
)
5062 posn
= Qvertical_line
;
5067 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5072 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5074 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5075 &object
, &dx
, &dy
, &width
, &height
);
5076 if (STRINGP (string
))
5077 string_info
= Fcons (string
, make_number (charpos
));
5079 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5081 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5084 if (part
== ON_RIGHT_FRINGE
)
5085 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5086 + window_box_width (w
, TEXT_AREA
)
5087 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5088 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5090 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5091 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5096 Lisp_Object string2
, object2
= Qnil
;
5097 struct display_pos p
;
5099 int width2
, height2
;
5100 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5101 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5102 &object2
, &dx2
, &dy2
,
5104 textpos
= CHARPOS (p
.pos
);
5105 if (rx
< 0) rx
= wx
;
5106 if (ry
< 0) ry
= wy
;
5107 if (dx
< 0) dx
= dx2
;
5108 if (dy
< 0) dy
= dy2
;
5109 if (width
< 0) width
= width2
;
5110 if (height
< 0) height
= height2
;
5114 posn
= make_number (textpos
);
5115 if (STRINGP (string2
))
5116 string_info
= Fcons (string2
,
5117 make_number (CHARPOS (p
.string_pos
)));
5123 #ifdef HAVE_WINDOW_SYSTEM
5124 if (IMAGEP (object
))
5126 Lisp_Object image_map
, hotspot
;
5127 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5129 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5131 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5132 posn
= XCAR (hotspot
);
5137 extra_info
= Fcons (object
,
5138 Fcons (Fcons (make_number (dx
),
5140 Fcons (Fcons (make_number (width
),
5141 make_number (height
)),
5145 extra_info
= Fcons (string_info
,
5146 Fcons (make_number (textpos
),
5147 Fcons (Fcons (make_number (rx
),
5153 XSETFRAME (window
, f
);
5158 XSETFASTINT (*x
, 0);
5159 XSETFASTINT (*y
, 0);
5162 return Fcons (window
,
5164 Fcons (Fcons (*x
, *y
),
5165 Fcons (make_number (time
),
5169 /* Given a struct input_event, build the lisp event which represents
5170 it. If EVENT is 0, build a mouse movement event from the mouse
5171 movement buffer, which should have a movement event in it.
5173 Note that events must be passed to this function in the order they
5174 are received; this function stores the location of button presses
5175 in order to build drag events when the button is released. */
5178 make_lispy_event (event
)
5179 struct input_event
*event
;
5183 switch (SWITCH_ENUM_CAST (event
->kind
))
5185 /* A simple keystroke. */
5186 case ASCII_KEYSTROKE_EVENT
:
5188 Lisp_Object lispy_c
;
5189 int c
= event
->code
& 0377;
5190 /* Turn ASCII characters into control characters
5192 if (event
->modifiers
& ctrl_modifier
)
5193 c
= make_ctrl_char (c
);
5195 /* Add in the other modifier bits. We took care of ctrl_modifier
5196 just above, and the shift key was taken care of by the X code,
5197 and applied to control characters by make_ctrl_char. */
5198 c
|= (event
->modifiers
5199 & (meta_modifier
| alt_modifier
5200 | hyper_modifier
| super_modifier
));
5201 /* Distinguish Shift-SPC from SPC. */
5202 if ((event
->code
& 0377) == 040
5203 && event
->modifiers
& shift_modifier
)
5204 c
|= shift_modifier
;
5205 button_down_time
= 0;
5206 XSETFASTINT (lispy_c
, c
);
5210 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5212 Lisp_Object lispy_c
;
5213 int c
= event
->code
;
5215 /* Add in the other modifier bits. We took care of ctrl_modifier
5216 just above, and the shift key was taken care of by the X code,
5217 and applied to control characters by make_ctrl_char. */
5218 c
|= (event
->modifiers
5219 & (meta_modifier
| alt_modifier
5220 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5221 /* What about the `shift' modifier ? */
5222 button_down_time
= 0;
5223 XSETFASTINT (lispy_c
, c
);
5227 /* A function key. The symbol may need to have modifier prefixes
5229 case NON_ASCII_KEYSTROKE_EVENT
:
5230 button_down_time
= 0;
5232 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5233 if (event
->code
== lispy_accent_codes
[i
])
5234 return modify_event_symbol (i
,
5236 Qfunction_key
, Qnil
,
5237 lispy_accent_keys
, &accent_key_syms
,
5238 (sizeof (lispy_accent_keys
)
5239 / sizeof (lispy_accent_keys
[0])));
5243 if (event
->code
>= 0x400 && event
->code
< 0x500)
5244 return modify_event_symbol (event
->code
- 0x400,
5245 event
->modifiers
& ~shift_modifier
,
5246 Qfunction_key
, Qnil
,
5247 lispy_kana_keys
, &func_key_syms
,
5248 (sizeof (lispy_kana_keys
)
5249 / sizeof (lispy_kana_keys
[0])));
5250 #endif /* XK_kana_A */
5253 #ifdef ISO_FUNCTION_KEY_OFFSET
5254 if (event
->code
< FUNCTION_KEY_OFFSET
5255 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5256 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5258 Qfunction_key
, Qnil
,
5259 iso_lispy_function_keys
, &func_key_syms
,
5260 (sizeof (iso_lispy_function_keys
)
5261 / sizeof (iso_lispy_function_keys
[0])));
5264 /* Handle system-specific or unknown keysyms. */
5265 if (event
->code
& (1 << 28)
5266 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5267 || (event
->code
- FUNCTION_KEY_OFFSET
5268 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5269 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5271 /* We need to use an alist rather than a vector as the cache
5272 since we can't make a vector long enuf. */
5273 if (NILP (current_kboard
->system_key_syms
))
5274 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5275 return modify_event_symbol (event
->code
,
5278 current_kboard
->Vsystem_key_alist
,
5279 0, ¤t_kboard
->system_key_syms
,
5283 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5285 Qfunction_key
, Qnil
,
5286 lispy_function_keys
, &func_key_syms
,
5287 (sizeof (lispy_function_keys
)
5288 / sizeof (lispy_function_keys
[0])));
5291 /* A mouse click. Figure out where it is, decide whether it's
5292 a press, click or drag, and build the appropriate structure. */
5293 case MOUSE_CLICK_EVENT
:
5294 #ifndef USE_TOOLKIT_SCROLL_BARS
5295 case SCROLL_BAR_CLICK_EVENT
:
5298 int button
= event
->code
;
5300 Lisp_Object position
;
5301 Lisp_Object
*start_pos_ptr
;
5302 Lisp_Object start_pos
;
5306 /* Build the position as appropriate for this mouse click. */
5307 if (event
->kind
== MOUSE_CLICK_EVENT
)
5309 struct frame
*f
= XFRAME (event
->frame_or_window
);
5310 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5314 /* Ignore mouse events that were made on frame that
5315 have been deleted. */
5316 if (! FRAME_LIVE_P (f
))
5319 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5320 /* EVENT->x and EVENT->y are frame-relative pixel
5321 coordinates at this place. Under old redisplay, COLUMN
5322 and ROW are set to frame relative glyph coordinates
5323 which are then used to determine whether this click is
5324 in a menu (non-toolkit version). */
5325 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5326 &column
, &row
, NULL
, 1);
5328 /* In the non-toolkit version, clicks on the menu bar
5329 are ordinary button events in the event buffer.
5330 Distinguish them, and invoke the menu.
5332 (In the toolkit version, the toolkit handles the menu bar
5333 and Emacs doesn't know about it until after the user
5334 makes a selection.) */
5335 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5336 && (event
->modifiers
& down_modifier
))
5338 Lisp_Object items
, item
;
5343 /* Activate the menu bar on the down event. If the
5344 up event comes in before the menu code can deal with it,
5346 if (! (event
->modifiers
& down_modifier
))
5350 /* Find the menu bar item under `column'. */
5352 items
= FRAME_MENU_BAR_ITEMS (f
);
5353 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5355 Lisp_Object pos
, string
;
5356 string
= AREF (items
, i
+ 1);
5357 pos
= AREF (items
, i
+ 3);
5360 if (column
>= XINT (pos
)
5361 && column
< XINT (pos
) + SCHARS (string
))
5363 item
= AREF (items
, i
);
5368 /* ELisp manual 2.4b says (x y) are window relative but
5369 code says they are frame-relative. */
5371 = Fcons (event
->frame_or_window
,
5373 Fcons (Fcons (event
->x
, event
->y
),
5374 Fcons (make_number (event
->timestamp
),
5377 return Fcons (item
, Fcons (position
, Qnil
));
5379 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5381 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5384 #ifndef USE_TOOLKIT_SCROLL_BARS
5387 /* It's a scrollbar click. */
5389 Lisp_Object portion_whole
;
5392 window
= event
->frame_or_window
;
5393 portion_whole
= Fcons (event
->x
, event
->y
);
5394 part
= *scroll_bar_parts
[(int) event
->part
];
5398 Fcons (Qvertical_scroll_bar
,
5399 Fcons (portion_whole
,
5400 Fcons (make_number (event
->timestamp
),
5401 Fcons (part
, Qnil
)))));
5403 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5405 if (button
>= ASIZE (button_down_location
))
5407 button_down_location
= larger_vector (button_down_location
,
5409 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5412 start_pos_ptr
= &AREF (button_down_location
, button
);
5413 start_pos
= *start_pos_ptr
;
5414 *start_pos_ptr
= Qnil
;
5417 /* On window-system frames, use the value of
5418 double-click-fuzz as is. On other frames, interpret it
5419 as a multiple of 1/8 characters. */
5423 if (WINDOWP (event
->frame_or_window
))
5424 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5425 else if (FRAMEP (event
->frame_or_window
))
5426 f
= XFRAME (event
->frame_or_window
);
5430 if (FRAME_WINDOW_P (f
))
5431 fuzz
= double_click_fuzz
;
5433 fuzz
= double_click_fuzz
/ 8;
5435 is_double
= (button
== last_mouse_button
5436 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5437 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5438 && button_down_time
!= 0
5439 && (EQ (Vdouble_click_time
, Qt
)
5440 || (INTEGERP (Vdouble_click_time
)
5441 && ((int)(event
->timestamp
- button_down_time
)
5442 < XINT (Vdouble_click_time
)))));
5445 last_mouse_button
= button
;
5446 last_mouse_x
= XINT (event
->x
);
5447 last_mouse_y
= XINT (event
->y
);
5449 /* If this is a button press, squirrel away the location, so
5450 we can decide later whether it was a click or a drag. */
5451 if (event
->modifiers
& down_modifier
)
5455 double_click_count
++;
5456 event
->modifiers
|= ((double_click_count
> 2)
5461 double_click_count
= 1;
5462 button_down_time
= event
->timestamp
;
5463 *start_pos_ptr
= Fcopy_alist (position
);
5466 /* Now we're releasing a button - check the co-ordinates to
5467 see if this was a click or a drag. */
5468 else if (event
->modifiers
& up_modifier
)
5470 /* If we did not see a down before this up, ignore the up.
5471 Probably this happened because the down event chose a
5472 menu item. It would be an annoyance to treat the
5473 release of the button that chose the menu item as a
5476 if (!CONSP (start_pos
))
5479 event
->modifiers
&= ~up_modifier
;
5480 #if 0 /* Formerly we treated an up with no down as a click event. */
5481 if (!CONSP (start_pos
))
5482 event
->modifiers
|= click_modifier
;
5487 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5489 /* The third element of every position
5490 should be the (x,y) pair. */
5491 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5493 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5495 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5496 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5499 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5500 && ydiff
< double_click_fuzz
5501 && ydiff
> - double_click_fuzz
)
5502 /* Mouse hasn't moved (much). */
5503 event
->modifiers
|= click_modifier
;
5506 button_down_time
= 0;
5507 event
->modifiers
|= drag_modifier
;
5510 /* Don't check is_double; treat this as multiple
5511 if the down-event was multiple. */
5512 if (double_click_count
> 1)
5513 event
->modifiers
|= ((double_click_count
> 2)
5519 /* Every mouse event should either have the down_modifier or
5520 the up_modifier set. */
5524 /* Get the symbol we should use for the mouse click. */
5527 head
= modify_event_symbol (button
,
5529 Qmouse_click
, Vlispy_mouse_stem
,
5532 XVECTOR (mouse_syms
)->size
);
5533 if (event
->modifiers
& drag_modifier
)
5538 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5541 Fcons (make_number (double_click_count
),
5552 Lisp_Object position
;
5555 /* Build the position as appropriate for this mouse click. */
5556 struct frame
*f
= XFRAME (event
->frame_or_window
);
5558 /* Ignore wheel events that were made on frame that have been
5560 if (! FRAME_LIVE_P (f
))
5563 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5566 /* Set double or triple modifiers to indicate the wheel speed. */
5568 /* On window-system frames, use the value of
5569 double-click-fuzz as is. On other frames, interpret it
5570 as a multiple of 1/8 characters. */
5575 if (WINDOWP (event
->frame_or_window
))
5576 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5577 else if (FRAMEP (event
->frame_or_window
))
5578 f
= XFRAME (event
->frame_or_window
);
5582 if (FRAME_WINDOW_P (f
))
5583 fuzz
= double_click_fuzz
;
5585 fuzz
= double_click_fuzz
/ 8;
5587 is_double
= (last_mouse_button
< 0
5588 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5589 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5590 && button_down_time
!= 0
5591 && (EQ (Vdouble_click_time
, Qt
)
5592 || (INTEGERP (Vdouble_click_time
)
5593 && ((int)(event
->timestamp
- button_down_time
)
5594 < XINT (Vdouble_click_time
)))));
5597 double_click_count
++;
5598 event
->modifiers
|= ((double_click_count
> 2)
5604 double_click_count
= 1;
5605 event
->modifiers
|= click_modifier
;
5608 button_down_time
= event
->timestamp
;
5609 /* Use a negative value to distinguish wheel from mouse button. */
5610 last_mouse_button
= -1;
5611 last_mouse_x
= XINT (event
->x
);
5612 last_mouse_y
= XINT (event
->y
);
5618 if (event
->modifiers
& up_modifier
)
5620 /* Emit a wheel-up event. */
5621 event
->modifiers
&= ~up_modifier
;
5624 else if (event
->modifiers
& down_modifier
)
5626 /* Emit a wheel-down event. */
5627 event
->modifiers
&= ~down_modifier
;
5631 /* Every wheel event should either have the down_modifier or
5632 the up_modifier set. */
5635 /* Get the symbol we should use for the wheel event. */
5636 head
= modify_event_symbol (symbol_num
,
5642 ASIZE (wheel_syms
));
5645 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5648 Fcons (make_number (double_click_count
),
5657 #ifdef USE_TOOLKIT_SCROLL_BARS
5659 /* We don't have down and up events if using toolkit scroll bars,
5660 so make this always a click event. Store in the `part' of
5661 the Lisp event a symbol which maps to the following actions:
5663 `above_handle' page up
5664 `below_handle' page down
5668 `bottom' bottom of buffer
5669 `handle' thumb has been dragged.
5670 `end-scroll' end of interaction with scroll bar
5672 The incoming input_event contains in its `part' member an
5673 index of type `enum scroll_bar_part' which we can use as an
5674 index in scroll_bar_parts to get the appropriate symbol. */
5676 case SCROLL_BAR_CLICK_EVENT
:
5678 Lisp_Object position
, head
, window
, portion_whole
, part
;
5680 window
= event
->frame_or_window
;
5681 portion_whole
= Fcons (event
->x
, event
->y
);
5682 part
= *scroll_bar_parts
[(int) event
->part
];
5686 Fcons (Qvertical_scroll_bar
,
5687 Fcons (portion_whole
,
5688 Fcons (make_number (event
->timestamp
),
5689 Fcons (part
, Qnil
)))));
5691 /* Always treat scroll bar events as clicks. */
5692 event
->modifiers
|= click_modifier
;
5693 event
->modifiers
&= ~up_modifier
;
5695 if (event
->code
>= ASIZE (mouse_syms
))
5696 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5698 /* Get the symbol we should use for the mouse click. */
5699 head
= modify_event_symbol (event
->code
,
5704 XVECTOR (mouse_syms
)->size
);
5705 return Fcons (head
, Fcons (position
, Qnil
));
5708 #endif /* USE_TOOLKIT_SCROLL_BARS */
5711 case W32_SCROLL_BAR_CLICK_EVENT
:
5713 int button
= event
->code
;
5715 Lisp_Object position
;
5716 Lisp_Object
*start_pos_ptr
;
5717 Lisp_Object start_pos
;
5721 Lisp_Object portion_whole
;
5724 window
= event
->frame_or_window
;
5725 portion_whole
= Fcons (event
->x
, event
->y
);
5726 part
= *scroll_bar_parts
[(int) event
->part
];
5730 Fcons (Qvertical_scroll_bar
,
5731 Fcons (portion_whole
,
5732 Fcons (make_number (event
->timestamp
),
5733 Fcons (part
, Qnil
)))));
5736 /* Always treat W32 scroll bar events as clicks. */
5737 event
->modifiers
|= click_modifier
;
5740 /* Get the symbol we should use for the mouse click. */
5743 head
= modify_event_symbol (button
,
5748 XVECTOR (mouse_syms
)->size
);
5754 #endif /* WINDOWSNT */
5756 case DRAG_N_DROP_EVENT
:
5759 Lisp_Object head
, position
;
5762 /* The frame_or_window field should be a cons of the frame in
5763 which the event occurred and a list of the filenames
5765 if (! CONSP (event
->frame_or_window
))
5768 f
= XFRAME (XCAR (event
->frame_or_window
));
5769 files
= XCDR (event
->frame_or_window
);
5771 /* Ignore mouse events that were made on frames that
5772 have been deleted. */
5773 if (! FRAME_LIVE_P (f
))
5776 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5779 head
= modify_event_symbol (0, event
->modifiers
,
5781 lispy_drag_n_drop_names
,
5782 &drag_n_drop_syms
, 1);
5788 #endif /* HAVE_MOUSE */
5790 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5791 || defined (USE_GTK)
5792 case MENU_BAR_EVENT
:
5793 if (EQ (event
->arg
, event
->frame_or_window
))
5794 /* This is the prefix key. We translate this to
5795 `(menu_bar)' because the code in keyboard.c for menu
5796 events, which we use, relies on this. */
5797 return Fcons (Qmenu_bar
, Qnil
);
5801 case SELECT_WINDOW_EVENT
:
5802 /* Make an event (select-window (WINDOW)). */
5803 return Fcons (Qselect_window
,
5804 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5807 case TOOL_BAR_EVENT
:
5808 if (EQ (event
->arg
, event
->frame_or_window
))
5809 /* This is the prefix key. We translate this to
5810 `(tool_bar)' because the code in keyboard.c for tool bar
5811 events, which we use, relies on this. */
5812 return Fcons (Qtool_bar
, Qnil
);
5813 else if (SYMBOLP (event
->arg
))
5814 return apply_modifiers (event
->modifiers
, event
->arg
);
5817 case USER_SIGNAL_EVENT
:
5818 /* A user signal. */
5819 return *lispy_user_signals
[event
->code
];
5821 case SAVE_SESSION_EVENT
:
5822 return Qsave_session
;
5824 /* The 'kind' field of the event is something we don't recognize. */
5833 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5835 Lisp_Object bar_window
;
5836 enum scroll_bar_part part
;
5840 /* Is it a scroll bar movement? */
5841 if (frame
&& ! NILP (bar_window
))
5843 Lisp_Object part_sym
;
5845 part_sym
= *scroll_bar_parts
[(int) part
];
5846 return Fcons (Qscroll_bar_movement
,
5847 (Fcons (Fcons (bar_window
,
5848 Fcons (Qvertical_scroll_bar
,
5849 Fcons (Fcons (x
, y
),
5850 Fcons (make_number (time
),
5856 /* Or is it an ordinary mouse movement? */
5859 Lisp_Object position
;
5861 position
= make_lispy_position (frame
, &x
, &y
, time
);
5863 return Fcons (Qmouse_movement
,
5869 #endif /* HAVE_MOUSE */
5871 /* Construct a switch frame event. */
5873 make_lispy_switch_frame (frame
)
5876 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5879 /* Manipulating modifiers. */
5881 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5883 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5884 SYMBOL's name of the end of the modifiers; the string from this
5885 position is the unmodified symbol name.
5887 This doesn't use any caches. */
5890 parse_modifiers_uncached (symbol
, modifier_end
)
5898 CHECK_SYMBOL (symbol
);
5901 name
= SYMBOL_NAME (symbol
);
5903 for (i
= 0; i
+2 <= SBYTES (name
); )
5905 int this_mod_end
= 0;
5908 /* See if the name continues with a modifier word.
5909 Check that the word appears, but don't check what follows it.
5910 Set this_mod and this_mod_end to record what we find. */
5912 switch (SREF (name
, i
))
5914 #define SINGLE_LETTER_MOD(BIT) \
5915 (this_mod_end = i + 1, this_mod = BIT)
5918 SINGLE_LETTER_MOD (alt_modifier
);
5922 SINGLE_LETTER_MOD (ctrl_modifier
);
5926 SINGLE_LETTER_MOD (hyper_modifier
);
5930 SINGLE_LETTER_MOD (meta_modifier
);
5934 SINGLE_LETTER_MOD (shift_modifier
);
5938 SINGLE_LETTER_MOD (super_modifier
);
5941 #undef SINGLE_LETTER_MOD
5943 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5944 if (i + LEN + 1 <= SBYTES (name) \
5945 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5947 this_mod_end = i + LEN; \
5952 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5953 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5954 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5958 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5960 #undef MULTI_LETTER_MOD
5964 /* If we found no modifier, stop looking for them. */
5965 if (this_mod_end
== 0)
5968 /* Check there is a dash after the modifier, so that it
5969 really is a modifier. */
5970 if (this_mod_end
>= SBYTES (name
)
5971 || SREF (name
, this_mod_end
) != '-')
5974 /* This modifier is real; look for another. */
5975 modifiers
|= this_mod
;
5976 i
= this_mod_end
+ 1;
5979 /* Should we include the `click' modifier? */
5980 if (! (modifiers
& (down_modifier
| drag_modifier
5981 | double_modifier
| triple_modifier
))
5982 && i
+ 7 == SBYTES (name
)
5983 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5984 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5985 modifiers
|= click_modifier
;
5993 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5994 prepended to the string BASE[0..BASE_LEN-1].
5995 This doesn't use any caches. */
5997 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6000 int base_len
, base_len_byte
;
6002 /* Since BASE could contain nulls, we can't use intern here; we have
6003 to use Fintern, which expects a genuine Lisp_String, and keeps a
6006 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6012 /* Only the event queue may use the `up' modifier; it should always
6013 be turned into a click or drag event before presented to lisp code. */
6014 if (modifiers
& up_modifier
)
6017 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6018 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6019 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6020 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6021 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6022 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6023 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6024 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6025 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6026 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6027 /* The click modifier is denoted by the absence of other modifiers. */
6031 mod_len
= p
- new_mods
;
6035 Lisp_Object new_name
;
6037 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6038 mod_len
+ base_len_byte
);
6039 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6040 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6042 return Fintern (new_name
, Qnil
);
6047 static char *modifier_names
[] =
6049 "up", "down", "drag", "click", "double", "triple", 0, 0,
6050 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6051 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6053 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6055 static Lisp_Object modifier_symbols
;
6057 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6059 lispy_modifier_list (modifiers
)
6062 Lisp_Object modifier_list
;
6065 modifier_list
= Qnil
;
6066 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6067 if (modifiers
& (1<<i
))
6068 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6071 return modifier_list
;
6075 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6076 where UNMODIFIED is the unmodified form of SYMBOL,
6077 MASK is the set of modifiers present in SYMBOL's name.
6078 This is similar to parse_modifiers_uncached, but uses the cache in
6079 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6080 Qevent_symbol_elements property. */
6083 parse_modifiers (symbol
)
6086 Lisp_Object elements
;
6088 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6089 if (CONSP (elements
))
6094 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6095 Lisp_Object unmodified
;
6098 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6099 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6102 if (modifiers
& ~INTMASK
)
6104 XSETFASTINT (mask
, modifiers
);
6105 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6107 /* Cache the parsing results on SYMBOL. */
6108 Fput (symbol
, Qevent_symbol_element_mask
,
6110 Fput (symbol
, Qevent_symbol_elements
,
6111 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6113 /* Since we know that SYMBOL is modifiers applied to unmodified,
6114 it would be nice to put that in unmodified's cache.
6115 But we can't, since we're not sure that parse_modifiers is
6122 /* Apply the modifiers MODIFIERS to the symbol BASE.
6123 BASE must be unmodified.
6125 This is like apply_modifiers_uncached, but uses BASE's
6126 Qmodifier_cache property, if present. It also builds
6127 Qevent_symbol_elements properties, since it has that info anyway.
6129 apply_modifiers copies the value of BASE's Qevent_kind property to
6130 the modified symbol. */
6132 apply_modifiers (modifiers
, base
)
6136 Lisp_Object cache
, index
, entry
, new_symbol
;
6138 /* Mask out upper bits. We don't know where this value's been. */
6139 modifiers
&= INTMASK
;
6141 /* The click modifier never figures into cache indices. */
6142 cache
= Fget (base
, Qmodifier_cache
);
6143 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6144 entry
= assq_no_quit (index
, cache
);
6147 new_symbol
= XCDR (entry
);
6150 /* We have to create the symbol ourselves. */
6151 new_symbol
= apply_modifiers_uncached (modifiers
,
6152 SDATA (SYMBOL_NAME (base
)),
6153 SCHARS (SYMBOL_NAME (base
)),
6154 SBYTES (SYMBOL_NAME (base
)));
6156 /* Add the new symbol to the base's cache. */
6157 entry
= Fcons (index
, new_symbol
);
6158 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6160 /* We have the parsing info now for free, so we could add it to
6162 XSETFASTINT (index, modifiers);
6163 Fput (new_symbol, Qevent_symbol_element_mask,
6164 Fcons (base, Fcons (index, Qnil)));
6165 Fput (new_symbol, Qevent_symbol_elements,
6166 Fcons (base, lispy_modifier_list (modifiers)));
6167 Sadly, this is only correct if `base' is indeed a base event,
6168 which is not necessarily the case. -stef */
6171 /* Make sure this symbol is of the same kind as BASE.
6173 You'd think we could just set this once and for all when we
6174 intern the symbol above, but reorder_modifiers may call us when
6175 BASE's property isn't set right; we can't assume that just
6176 because it has a Qmodifier_cache property it must have its
6177 Qevent_kind set right as well. */
6178 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6182 kind
= Fget (base
, Qevent_kind
);
6184 Fput (new_symbol
, Qevent_kind
, kind
);
6191 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6192 return a symbol with the modifiers placed in the canonical order.
6193 Canonical order is alphabetical, except for down and drag, which
6194 always come last. The 'click' modifier is never written out.
6196 Fdefine_key calls this to make sure that (for example) C-M-foo
6197 and M-C-foo end up being equivalent in the keymap. */
6200 reorder_modifiers (symbol
)
6203 /* It's hopefully okay to write the code this way, since everything
6204 will soon be in caches, and no consing will be done at all. */
6207 parsed
= parse_modifiers (symbol
);
6208 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6213 /* For handling events, we often want to produce a symbol whose name
6214 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6215 to some base, like the name of a function key or mouse button.
6216 modify_event_symbol produces symbols of this sort.
6218 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6219 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6222 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6223 into symbol names, or a string specifying a name stem used to
6224 construct a symbol name or the form `STEM-N', where N is the decimal
6225 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6226 non-nil; otherwise NAME_TABLE is used.
6228 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6229 persist between calls to modify_event_symbol that it can use to
6230 store a cache of the symbols it's generated for this NAME_TABLE
6231 before. The object stored there may be a vector or an alist.
6233 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6235 MODIFIERS is a set of modifier bits (as given in struct input_events)
6236 whose prefixes should be applied to the symbol name.
6238 SYMBOL_KIND is the value to be placed in the event_kind property of
6239 the returned symbol.
6241 The symbols we create are supposed to have an
6242 `event-symbol-elements' property, which lists the modifiers present
6243 in the symbol's name. */
6246 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6247 name_table
, symbol_table
, table_size
)
6250 Lisp_Object symbol_kind
;
6251 Lisp_Object name_alist_or_stem
;
6253 Lisp_Object
*symbol_table
;
6254 unsigned int table_size
;
6257 Lisp_Object symbol_int
;
6259 /* Get rid of the "vendor-specific" bit here. */
6260 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6262 /* Is this a request for a valid symbol? */
6263 if (symbol_num
< 0 || symbol_num
>= table_size
)
6266 if (CONSP (*symbol_table
))
6267 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6269 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6270 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6271 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6272 we've never used that symbol before. */
6275 if (! VECTORP (*symbol_table
)
6276 || XVECTOR (*symbol_table
)->size
!= table_size
)
6280 XSETFASTINT (size
, table_size
);
6281 *symbol_table
= Fmake_vector (size
, Qnil
);
6284 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6287 /* Have we already used this symbol before? */
6290 /* No; let's create it. */
6291 if (CONSP (name_alist_or_stem
))
6292 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6293 else if (STRINGP (name_alist_or_stem
))
6295 int len
= SBYTES (name_alist_or_stem
);
6296 char *buf
= (char *) alloca (len
+ 50);
6297 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6298 (long) XINT (symbol_int
) + 1);
6299 value
= intern (buf
);
6301 else if (name_table
!= 0 && name_table
[symbol_num
])
6302 value
= intern (name_table
[symbol_num
]);
6304 #ifdef HAVE_WINDOW_SYSTEM
6307 char *name
= x_get_keysym_name (symbol_num
);
6309 value
= intern (name
);
6316 sprintf (buf
, "key-%d", symbol_num
);
6317 value
= intern (buf
);
6320 if (CONSP (*symbol_table
))
6321 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6323 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6325 /* Fill in the cache entries for this symbol; this also
6326 builds the Qevent_symbol_elements property, which the user
6328 apply_modifiers (modifiers
& click_modifier
, value
);
6329 Fput (value
, Qevent_kind
, symbol_kind
);
6332 /* Apply modifiers to that symbol. */
6333 return apply_modifiers (modifiers
, value
);
6336 /* Convert a list that represents an event type,
6337 such as (ctrl meta backspace), into the usual representation of that
6338 event type as a number or a symbol. */
6340 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6341 doc
: /* Convert the event description list EVENT-DESC to an event type.
6342 EVENT-DESC should contain one base event type (a character or symbol)
6343 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6344 drag, down, double or triple). The base must be last.
6345 The return value is an event type (a character or symbol) which
6346 has the same base event type and all the specified modifiers. */)
6348 Lisp_Object event_desc
;
6356 while (CONSP (rest
))
6364 /* Given a symbol, see if it is a modifier name. */
6365 if (SYMBOLP (elt
) && CONSP (rest
))
6366 this = parse_solitary_modifier (elt
);
6370 else if (!NILP (base
))
6371 error ("Two bases given in one event");
6377 /* Let the symbol A refer to the character A. */
6378 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6379 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6381 if (INTEGERP (base
))
6383 /* Turn (shift a) into A. */
6384 if ((modifiers
& shift_modifier
) != 0
6385 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6387 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6388 modifiers
&= ~shift_modifier
;
6391 /* Turn (control a) into C-a. */
6392 if (modifiers
& ctrl_modifier
)
6393 return make_number ((modifiers
& ~ctrl_modifier
)
6394 | make_ctrl_char (XINT (base
)));
6396 return make_number (modifiers
| XINT (base
));
6398 else if (SYMBOLP (base
))
6399 return apply_modifiers (modifiers
, base
);
6402 error ("Invalid base event");
6407 /* Try to recognize SYMBOL as a modifier name.
6408 Return the modifier flag bit, or 0 if not recognized. */
6411 parse_solitary_modifier (symbol
)
6414 Lisp_Object name
= SYMBOL_NAME (symbol
);
6416 switch (SREF (name
, 0))
6418 #define SINGLE_LETTER_MOD(BIT) \
6419 if (SBYTES (name) == 1) \
6422 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6423 if (LEN == SBYTES (name) \
6424 && ! strncmp (SDATA (name), NAME, LEN)) \
6428 SINGLE_LETTER_MOD (alt_modifier
);
6432 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6436 SINGLE_LETTER_MOD (ctrl_modifier
);
6440 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6441 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6445 SINGLE_LETTER_MOD (hyper_modifier
);
6449 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6453 SINGLE_LETTER_MOD (meta_modifier
);
6457 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6461 SINGLE_LETTER_MOD (shift_modifier
);
6465 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6466 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6467 SINGLE_LETTER_MOD (super_modifier
);
6471 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6472 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6473 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6477 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6480 #undef SINGLE_LETTER_MOD
6481 #undef MULTI_LETTER_MOD
6487 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6488 Such a list is not valid as an event,
6489 but it can be a Lucid-style event type list. */
6492 lucid_event_type_list_p (object
)
6497 if (! CONSP (object
))
6500 if (EQ (XCAR (object
), Qhelp_echo
)
6501 || EQ (XCAR (object
), Qvertical_line
)
6502 || EQ (XCAR (object
), Qmode_line
)
6503 || EQ (XCAR (object
), Qheader_line
))
6506 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6510 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6517 /* Store into *addr a value nonzero if terminal input chars are available.
6518 Serves the purpose of ioctl (0, FIONREAD, addr)
6519 but works even if FIONREAD does not exist.
6520 (In fact, this may actually read some input.)
6522 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6523 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6526 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6531 /* First of all, have we already counted some input? */
6532 *addr
= (!NILP (Vquit_flag
)
6533 || readable_filtered_events (do_timers_now
, filter_events
));
6535 /* If input is being read as it arrives, and we have none, there is none. */
6536 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6539 /* Try to read some input and see how much we get. */
6541 *addr
= (!NILP (Vquit_flag
)
6542 || readable_filtered_events (do_timers_now
, filter_events
));
6545 /* Store into *addr a value nonzero if terminal input chars are available.
6546 Serves the purpose of ioctl (0, FIONREAD, addr)
6547 but works even if FIONREAD does not exist.
6548 (In fact, this may actually read some input.)
6550 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6553 get_input_pending (addr
, do_timers_now
)
6557 get_filtered_input_pending (addr
, do_timers_now
, 0);
6560 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6563 gobble_input (expected
)
6568 if (interrupt_input
)
6571 mask
= sigblock (sigmask (SIGIO
));
6572 read_avail_input (expected
);
6576 #ifdef POLL_FOR_INPUT
6577 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6580 mask
= sigblock (sigmask (SIGALRM
));
6581 read_avail_input (expected
);
6587 read_avail_input (expected
);
6591 /* Put a BUFFER_SWITCH_EVENT in the buffer
6592 so that read_key_sequence will notice the new current buffer. */
6595 record_asynch_buffer_change ()
6597 struct input_event event
;
6601 event
.kind
= BUFFER_SWITCH_EVENT
;
6602 event
.frame_or_window
= Qnil
;
6606 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6607 The purpose of the event is to make read_key_sequence look up the
6608 keymaps again. If we aren't in read_key_sequence, we don't need one,
6609 and the event could cause trouble by messing up (input-pending-p). */
6610 tem
= Fwaiting_for_user_input_p ();
6614 /* We never need these events if we have no asynchronous subprocesses. */
6618 /* Make sure no interrupt happens while storing the event. */
6620 if (interrupt_input
)
6623 mask
= sigblock (sigmask (SIGIO
));
6624 kbd_buffer_store_event (&event
);
6631 kbd_buffer_store_event (&event
);
6638 /* Read any terminal input already buffered up by the system
6639 into the kbd_buffer, but do not wait.
6641 EXPECTED should be nonzero if the caller knows there is some input.
6643 Except on VMS, all input is read by this function.
6644 If interrupt_input is nonzero, this function MUST be called
6645 only when SIGIO is blocked.
6647 Returns the number of keyboard chars read, or -1 meaning
6648 this is a bad time to try to read input. */
6651 read_avail_input (expected
)
6657 if (read_socket_hook
)
6660 struct input_event hold_quit
;
6662 EVENT_INIT (hold_quit
);
6663 hold_quit
.kind
= NO_EVENT
;
6665 /* No need for FIONREAD or fcntl; just say don't wait. */
6666 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6671 if (hold_quit
.kind
!= NO_EVENT
)
6672 kbd_buffer_store_event (&hold_quit
);
6676 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6677 the kbd_buffer can really hold. That may prevent loss
6678 of characters on some systems when input is stuffed at us. */
6679 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6682 /* Determine how many characters we should *try* to read. */
6685 #else /* not WINDOWSNT */
6687 n_to_read
= dos_keysns ();
6690 #else /* not MSDOS */
6692 /* Find out how much input is available. */
6693 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6694 /* Formerly simply reported no input, but that sometimes led to
6695 a failure of Emacs to terminate.
6696 SIGHUP seems appropriate if we can't reach the terminal. */
6697 /* ??? Is it really right to send the signal just to this process
6698 rather than to the whole process group?
6699 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6701 if (! noninteractive
)
6702 kill (getpid (), SIGHUP
);
6708 if (n_to_read
> sizeof cbuf
)
6709 n_to_read
= sizeof cbuf
;
6710 #else /* no FIONREAD */
6711 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6712 /* Read some input if available, but don't wait. */
6713 n_to_read
= sizeof cbuf
;
6714 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6719 #endif /* not MSDOS */
6720 #endif /* not WINDOWSNT */
6722 /* Now read; for one reason or another, this will not block.
6723 NREAD is set to the number of chars read. */
6727 cbuf
[0] = dos_keyread ();
6730 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6732 /* POSIX infers that processes which are not in the session leader's
6733 process group won't get SIGHUP's at logout time. BSDI adheres to
6734 this part standard and returns -1 from read (0) with errno==EIO
6735 when the control tty is taken away.
6736 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6737 if (nread
== -1 && errno
== EIO
)
6739 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6740 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6741 This looks incorrect, but it isn't, because _BSD causes
6742 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6743 and that causes a value other than 0 when there is no input. */
6749 /* We used to retry the read if it was interrupted.
6750 But this does the wrong thing when O_NDELAY causes
6751 an EAGAIN error. Does anybody know of a situation
6752 where a retry is actually needed? */
6754 nread
< 0 && (errno
== EAGAIN
6768 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6769 fcntl (input_fd
, F_SETFL
, 0);
6770 #endif /* USG or DGUX or CYGWIN */
6771 #endif /* no FIONREAD */
6772 for (i
= 0; i
< nread
; i
++)
6774 struct input_event buf
;
6776 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6778 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6779 buf
.modifiers
= meta_modifier
;
6784 buf
.frame_or_window
= selected_frame
;
6787 kbd_buffer_store_event (&buf
);
6788 /* Don't look at input that follows a C-g too closely.
6789 This reduces lossage due to autorepeat on C-g. */
6790 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6791 && buf
.code
== quit_char
)
6798 #endif /* not VMS */
6801 handle_async_input ()
6804 extern int select_alarmed
;
6807 interrupt_input_pending
= 0;
6812 nread
= read_avail_input (1);
6813 /* -1 means it's not ok to read the input now.
6814 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6815 0 means there was no keyboard input available. */
6820 select_alarmed
= 1; /* Force the select emulator back to life */
6825 #ifdef SIGIO /* for entire page */
6826 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6829 input_available_signal (signo
)
6832 /* Must preserve main program's value of errno. */
6833 int old_errno
= errno
;
6834 #if defined (USG) && !defined (POSIX_SIGNALS)
6835 /* USG systems forget handlers when they are used;
6836 must reestablish each time */
6837 signal (signo
, input_available_signal
);
6844 if (input_available_clear_time
)
6845 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6848 interrupt_input_pending
= 1;
6851 SIGNAL_THREAD_CHECK (signo
);
6852 handle_async_input ();
6862 /* Send ourselves a SIGIO.
6864 This function exists so that the UNBLOCK_INPUT macro in
6865 blockinput.h can have some way to take care of input we put off
6866 dealing with, without assuming that every file which uses
6867 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6869 reinvoke_input_signal ()
6872 handle_async_input ();
6878 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6879 static Lisp_Object menu_bar_one_keymap_changed_items
;
6881 /* These variables hold the vector under construction within
6882 menu_bar_items and its subroutines, and the current index
6883 for storing into that vector. */
6884 static Lisp_Object menu_bar_items_vector
;
6885 static int menu_bar_items_index
;
6887 /* Return a vector of menu items for a menu bar, appropriate
6888 to the current buffer. Each item has three elements in the vector:
6891 OLD is an old vector we can optionally reuse, or nil. */
6894 menu_bar_items (old
)
6897 /* The number of keymaps we're scanning right now, and the number of
6898 keymaps we have allocated space for. */
6901 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6902 in the current keymaps, or nil where it is not a prefix. */
6905 Lisp_Object def
, tail
;
6914 struct gcpro gcpro1
;
6916 /* In order to build the menus, we need to call the keymap
6917 accessors. They all call QUIT. But this function is called
6918 during redisplay, during which a quit is fatal. So inhibit
6919 quitting while building the menus.
6920 We do this instead of specbind because (1) errors will clear it anyway
6921 and (2) this avoids risk of specpdl overflow. */
6922 oquit
= Vinhibit_quit
;
6926 menu_bar_items_vector
= old
;
6928 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6929 menu_bar_items_index
= 0;
6931 GCPRO1 (menu_bar_items_vector
);
6933 /* Build our list of keymaps.
6934 If we recognize a function key and replace its escape sequence in
6935 keybuf with its symbol, or if the sequence starts with a mouse
6936 click and we need to switch buffers, we jump back here to rebuild
6937 the initial keymaps from the current buffer. */
6941 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6942 if (!NILP (Voverriding_local_map_menu_flag
))
6944 /* Yes, use them (if non-nil) as well as the global map. */
6945 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6947 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6948 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6949 if (!NILP (Voverriding_local_map
))
6950 maps
[nmaps
++] = Voverriding_local_map
;
6954 /* No, so use major and minor mode keymaps and keymap property.
6955 Note that menu-bar bindings in the local-map and keymap
6956 properties may not work reliable, as they are only
6957 recognized when the menu-bar (or mode-line) is updated,
6958 which does not normally happen after every command. */
6961 nminor
= current_minor_maps (NULL
, &tmaps
);
6962 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6964 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6965 maps
[nmaps
++] = tem
;
6966 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6968 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6970 maps
[nmaps
++] = current_global_map
;
6973 /* Look up in each map the dummy prefix key `menu-bar'. */
6977 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6978 if (!NILP (maps
[mapno
]))
6980 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6984 menu_bar_one_keymap_changed_items
= Qnil
;
6985 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6989 /* Move to the end those items that should be at the end. */
6991 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6994 int end
= menu_bar_items_index
;
6996 for (i
= 0; i
< end
; i
+= 4)
6997 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6999 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7000 /* Move the item at index I to the end,
7001 shifting all the others forward. */
7002 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7003 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7004 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7005 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7007 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7008 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7009 (end
- i
- 4) * sizeof (Lisp_Object
));
7010 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7011 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7012 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7013 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7018 /* Add nil, nil, nil, nil at the end. */
7019 i
= menu_bar_items_index
;
7020 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7023 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7024 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7025 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7026 menu_bar_items_vector
= tem
;
7028 /* Add this item. */
7029 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7030 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7031 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7032 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7033 menu_bar_items_index
= i
;
7035 Vinhibit_quit
= oquit
;
7037 return menu_bar_items_vector
;
7040 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7041 If there's already an item for KEY, add this DEF to it. */
7043 Lisp_Object item_properties
;
7046 menu_bar_item (key
, item
, dummy1
, dummy2
)
7047 Lisp_Object key
, item
, dummy1
;
7050 struct gcpro gcpro1
;
7054 if (EQ (item
, Qundefined
))
7056 /* If a map has an explicit `undefined' as definition,
7057 discard any previously made menu bar item. */
7059 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7060 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7062 if (menu_bar_items_index
> i
+ 4)
7063 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7064 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7065 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7066 menu_bar_items_index
-= 4;
7070 /* If this keymap has already contributed to this KEY,
7071 don't contribute to it a second time. */
7072 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7073 if (!NILP (tem
) || NILP (item
))
7076 menu_bar_one_keymap_changed_items
7077 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7079 /* We add to menu_bar_one_keymap_changed_items before doing the
7080 parse_menu_item, so that if it turns out it wasn't a menu item,
7081 it still correctly hides any further menu item. */
7083 i
= parse_menu_item (item
, 0, 1);
7088 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7090 /* Find any existing item for this KEY. */
7091 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7092 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7095 /* If we did not find this KEY, add it at the end. */
7096 if (i
== menu_bar_items_index
)
7098 /* If vector is too small, get a bigger one. */
7099 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7102 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7103 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7104 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7105 menu_bar_items_vector
= tem
;
7108 /* Add this item. */
7109 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7110 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7111 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7112 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7113 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7114 menu_bar_items_index
= i
;
7116 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7120 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7121 /* If the new and the old items are not both keymaps,
7122 the lookup will only find `item'. */
7123 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7124 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7128 /* This is used as the handler when calling menu_item_eval_property. */
7130 menu_item_eval_property_1 (arg
)
7133 /* If we got a quit from within the menu computation,
7134 quit all the way out of it. This takes care of C-] in the debugger. */
7135 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7136 Fsignal (Qquit
, Qnil
);
7141 /* Evaluate an expression and return the result (or nil if something
7142 went wrong). Used to evaluate dynamic parts of menu items. */
7144 menu_item_eval_property (sexpr
)
7147 int count
= SPECPDL_INDEX ();
7149 specbind (Qinhibit_redisplay
, Qt
);
7150 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7151 menu_item_eval_property_1
);
7152 return unbind_to (count
, val
);
7155 /* This function parses a menu item and leaves the result in the
7156 vector item_properties.
7157 ITEM is a key binding, a possible menu item.
7158 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7159 evaluate dynamic expressions in the menu item.
7160 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7162 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7163 parse_menu_item returns true if the item is a menu item and false
7167 parse_menu_item (item
, notreal
, inmenubar
)
7169 int notreal
, inmenubar
;
7171 Lisp_Object def
, tem
, item_string
, start
;
7172 Lisp_Object cachelist
;
7174 Lisp_Object keyhint
;
7185 /* Create item_properties vector if necessary. */
7186 if (NILP (item_properties
))
7188 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7190 /* Initialize optional entries. */
7191 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7192 AREF (item_properties
, i
) = Qnil
;
7193 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7195 /* Save the item here to protect it from GC. */
7196 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7198 item_string
= XCAR (item
);
7202 if (STRINGP (item_string
))
7204 /* Old format menu item. */
7205 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7207 /* Maybe help string. */
7208 if (CONSP (item
) && STRINGP (XCAR (item
)))
7210 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7215 /* Maybe key binding cache. */
7216 if (CONSP (item
) && CONSP (XCAR (item
))
7217 && (NILP (XCAR (XCAR (item
)))
7218 || VECTORP (XCAR (XCAR (item
)))))
7220 cachelist
= XCAR (item
);
7224 /* This is the real definition--the function to run. */
7225 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7227 /* Get enable property, if any. */
7230 tem
= Fget (item
, Qmenu_enable
);
7232 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7235 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7237 /* New format menu item. */
7238 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7239 start
= XCDR (item
);
7242 /* We have a real binding. */
7243 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7245 item
= XCDR (start
);
7246 /* Is there a cache list with key equivalences. */
7247 if (CONSP (item
) && CONSP (XCAR (item
)))
7249 cachelist
= XCAR (item
);
7253 /* Parse properties. */
7254 while (CONSP (item
) && CONSP (XCDR (item
)))
7259 if (EQ (tem
, QCenable
))
7260 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7261 else if (EQ (tem
, QCvisible
) && !notreal
)
7263 /* If got a visible property and that evaluates to nil
7264 then ignore this item. */
7265 tem
= menu_item_eval_property (XCAR (item
));
7269 else if (EQ (tem
, QChelp
))
7270 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7271 else if (EQ (tem
, QCfilter
))
7273 else if (EQ (tem
, QCkey_sequence
))
7276 if (NILP (cachelist
)
7277 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7278 /* Be GC protected. Set keyhint to item instead of tem. */
7281 else if (EQ (tem
, QCkeys
))
7284 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7285 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7287 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7292 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7294 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7296 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7303 else if (inmenubar
|| !NILP (start
))
7307 return 0; /* not a menu item */
7309 /* If item string is not a string, evaluate it to get string.
7310 If we don't get a string, skip this item. */
7311 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7312 if (!(STRINGP (item_string
) || notreal
))
7314 item_string
= menu_item_eval_property (item_string
);
7315 if (!STRINGP (item_string
))
7317 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7320 /* If got a filter apply it on definition. */
7321 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7324 def
= menu_item_eval_property (list2 (XCAR (filter
),
7325 list2 (Qquote
, def
)));
7327 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7330 /* Enable or disable selection of item. */
7331 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7337 tem
= menu_item_eval_property (tem
);
7338 if (inmenubar
&& NILP (tem
))
7339 return 0; /* Ignore disabled items in menu bar. */
7340 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7343 /* If we got no definition, this item is just unselectable text which
7344 is OK in a submenu but not in the menubar. */
7346 return (inmenubar
? 0 : 1);
7348 /* See if this is a separate pane or a submenu. */
7349 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7350 tem
= get_keymap (def
, 0, 1);
7351 /* For a subkeymap, just record its details and exit. */
7354 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7355 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7359 /* At the top level in the menu bar, do likewise for commands also.
7360 The menu bar does not display equivalent key bindings anyway.
7361 ITEM_PROPERTY_DEF is already set up properly. */
7365 /* This is a command. See if there is an equivalent key binding. */
7366 if (NILP (cachelist
))
7368 /* We have to create a cachelist. */
7369 CHECK_IMPURE (start
);
7370 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7371 cachelist
= XCAR (XCDR (start
));
7373 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7374 if (!NILP (keyhint
))
7376 XSETCAR (cachelist
, XCAR (keyhint
));
7379 else if (STRINGP (tem
))
7381 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7382 XSETCAR (cachelist
, Qt
);
7386 tem
= XCAR (cachelist
);
7393 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7395 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7398 def
= XCAR (prefix
);
7399 prefix
= XCDR (prefix
);
7402 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7404 if (!update_menu_bindings
)
7406 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7408 if (newcache
/* Always check first time. */
7409 /* Should we check everything when precomputing key
7411 /* If something had no key binding before, don't recheck it
7412 because that is too slow--except if we have a list of
7413 rebound commands in Vdefine_key_rebound_commands, do
7414 recheck any command that appears in that list. */
7415 || (CONSP (Vdefine_key_rebound_commands
)
7416 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7419 /* We had a saved key. Is it still bound to the command? */
7422 /* If the command is an alias for another
7423 (such as lmenu.el set it up), check if the
7424 original command matches the cached command. */
7425 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7426 chkcache
= 1; /* Need to recompute key binding. */
7430 /* Recompute equivalent key binding. If the command is an alias
7431 for another (such as lmenu.el set it up), see if the original
7432 command name has equivalent keys. Otherwise look up the
7433 specified command itself. We don't try both, because that
7434 makes lmenu menus slow. */
7436 && SYMBOLP (XSYMBOL (def
)->function
)
7437 && ! NILP (Fget (def
, Qmenu_alias
)))
7438 def
= XSYMBOL (def
)->function
;
7439 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7440 XSETCAR (cachelist
, tem
);
7443 XSETCDR (cachelist
, Qnil
);
7447 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7449 tem
= XCAR (cachelist
);
7453 newcache
= chkcache
;
7456 tem
= Fkey_description (tem
, Qnil
);
7459 if (STRINGP (XCAR (prefix
)))
7460 tem
= concat2 (XCAR (prefix
), tem
);
7461 if (STRINGP (XCDR (prefix
)))
7462 tem
= concat2 (tem
, XCDR (prefix
));
7464 XSETCDR (cachelist
, tem
);
7468 tem
= XCDR (cachelist
);
7469 if (newcache
&& !NILP (tem
))
7471 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7472 XSETCDR (cachelist
, tem
);
7475 /* If we only want to precompute equivalent key bindings, stop here. */
7479 /* If we have an equivalent key binding, use that. */
7480 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7482 /* Include this when menu help is implemented.
7483 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7484 if (!(NILP (tem) || STRINGP (tem)))
7486 tem = menu_item_eval_property (tem);
7489 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7493 /* Handle radio buttons or toggle boxes. */
7494 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7496 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7497 = menu_item_eval_property (tem
);
7504 /***********************************************************************
7506 ***********************************************************************/
7508 /* A vector holding tool bar items while they are parsed in function
7509 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7512 static Lisp_Object tool_bar_items_vector
;
7514 /* A vector holding the result of parse_tool_bar_item. Layout is like
7515 the one for a single item in tool_bar_items_vector. */
7517 static Lisp_Object tool_bar_item_properties
;
7519 /* Next free index in tool_bar_items_vector. */
7521 static int ntool_bar_items
;
7523 /* The symbols `tool-bar', and `:image'. */
7525 extern Lisp_Object Qtool_bar
;
7526 Lisp_Object QCimage
;
7528 /* Function prototypes. */
7530 static void init_tool_bar_items
P_ ((Lisp_Object
));
7531 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7532 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7533 static void append_tool_bar_item
P_ ((void));
7536 /* Return a vector of tool bar items for keymaps currently in effect.
7537 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7538 tool bar items found. */
7541 tool_bar_items (reuse
, nitems
)
7552 /* In order to build the menus, we need to call the keymap
7553 accessors. They all call QUIT. But this function is called
7554 during redisplay, during which a quit is fatal. So inhibit
7555 quitting while building the menus. We do this instead of
7556 specbind because (1) errors will clear it anyway and (2) this
7557 avoids risk of specpdl overflow. */
7558 oquit
= Vinhibit_quit
;
7561 /* Initialize tool_bar_items_vector and protect it from GC. */
7562 init_tool_bar_items (reuse
);
7564 /* Build list of keymaps in maps. Set nmaps to the number of maps
7567 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7568 if (!NILP (Voverriding_local_map_menu_flag
))
7570 /* Yes, use them (if non-nil) as well as the global map. */
7571 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7573 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7574 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7575 if (!NILP (Voverriding_local_map
))
7576 maps
[nmaps
++] = Voverriding_local_map
;
7580 /* No, so use major and minor mode keymaps and keymap property.
7581 Note that tool-bar bindings in the local-map and keymap
7582 properties may not work reliable, as they are only
7583 recognized when the tool-bar (or mode-line) is updated,
7584 which does not normally happen after every command. */
7587 nminor
= current_minor_maps (NULL
, &tmaps
);
7588 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7590 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7591 maps
[nmaps
++] = tem
;
7592 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7594 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7597 /* Add global keymap at the end. */
7598 maps
[nmaps
++] = current_global_map
;
7600 /* Process maps in reverse order and look up in each map the prefix
7602 for (i
= nmaps
- 1; i
>= 0; --i
)
7603 if (!NILP (maps
[i
]))
7607 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7612 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7613 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7615 Lisp_Object keydef
= XCAR (tail
);
7617 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7622 Vinhibit_quit
= oquit
;
7623 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7624 return tool_bar_items_vector
;
7628 /* Process the definition of KEY which is DEF. */
7631 process_tool_bar_item (key
, def
)
7632 Lisp_Object key
, def
;
7635 extern Lisp_Object Qundefined
;
7636 struct gcpro gcpro1
, gcpro2
;
7638 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7642 if (EQ (def
, Qundefined
))
7644 /* If a map has an explicit `undefined' as definition,
7645 discard any previously made item. */
7646 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7648 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7650 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7652 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7653 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7654 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7655 * sizeof (Lisp_Object
)));
7656 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7661 else if (parse_tool_bar_item (key
, def
))
7662 /* Append a new tool bar item to tool_bar_items_vector. Accept
7663 more than one definition for the same key. */
7664 append_tool_bar_item ();
7670 /* Parse a tool bar item specification ITEM for key KEY and return the
7671 result in tool_bar_item_properties. Value is zero if ITEM is
7674 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7676 CAPTION is the caption of the item, If it's not a string, it is
7677 evaluated to get a string.
7679 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7680 as binding are currently ignored.
7682 The following properties are recognized:
7686 FORM is evaluated and specifies whether the tool bar item is
7687 enabled or disabled.
7691 FORM is evaluated and specifies whether the tool bar item is visible.
7693 - `:filter FUNCTION'
7695 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7696 result is stored as the new binding.
7698 - `:button (TYPE SELECTED)'
7700 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7701 and specifies whether the button is selected (pressed) or not.
7705 IMAGES is either a single image specification or a vector of four
7706 image specifications. See enum tool_bar_item_images.
7708 - `:help HELP-STRING'.
7710 Gives a help string to display for the tool bar item. */
7713 parse_tool_bar_item (key
, item
)
7714 Lisp_Object key
, item
;
7716 /* Access slot with index IDX of vector tool_bar_item_properties. */
7717 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7719 Lisp_Object filter
= Qnil
;
7720 Lisp_Object caption
;
7723 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7724 Rule out items that aren't lists, don't start with
7725 `menu-item' or whose rest following `tool-bar-item' is not a
7728 || !EQ (XCAR (item
), Qmenu_item
)
7729 || (item
= XCDR (item
),
7733 /* Create tool_bar_item_properties vector if necessary. Reset it to
7735 if (VECTORP (tool_bar_item_properties
))
7737 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7741 tool_bar_item_properties
7742 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7745 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7746 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7748 /* Get the caption of the item. If the caption is not a string,
7749 evaluate it to get a string. If we don't get a string, skip this
7751 caption
= XCAR (item
);
7752 if (!STRINGP (caption
))
7754 caption
= menu_item_eval_property (caption
);
7755 if (!STRINGP (caption
))
7758 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7760 /* Give up if rest following the caption is not a list. */
7765 /* Store the binding. */
7766 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7769 /* Ignore cached key binding, if any. */
7770 if (CONSP (item
) && CONSP (XCAR (item
)))
7773 /* Process the rest of the properties. */
7774 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7776 Lisp_Object key
, value
;
7779 value
= XCAR (XCDR (item
));
7781 if (EQ (key
, QCenable
))
7782 /* `:enable FORM'. */
7783 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7784 else if (EQ (key
, QCvisible
))
7786 /* `:visible FORM'. If got a visible property and that
7787 evaluates to nil then ignore this item. */
7788 if (NILP (menu_item_eval_property (value
)))
7791 else if (EQ (key
, QChelp
))
7792 /* `:help HELP-STRING'. */
7793 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7794 else if (EQ (key
, QCfilter
))
7795 /* ':filter FORM'. */
7797 else if (EQ (key
, QCbutton
) && CONSP (value
))
7799 /* `:button (TYPE . SELECTED)'. */
7800 Lisp_Object type
, selected
;
7802 type
= XCAR (value
);
7803 selected
= XCDR (value
);
7804 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7806 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7807 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7810 else if (EQ (key
, QCimage
)
7812 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7813 /* Value is either a single image specification or a vector
7814 of 4 such specifications for the different button states. */
7815 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7818 /* If got a filter apply it on binding. */
7820 PROP (TOOL_BAR_ITEM_BINDING
)
7821 = menu_item_eval_property (list2 (filter
,
7823 PROP (TOOL_BAR_ITEM_BINDING
))));
7825 /* See if the binding is a keymap. Give up if it is. */
7826 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7829 /* Enable or disable selection of item. */
7830 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7831 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7832 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7834 /* Handle radio buttons or toggle boxes. */
7835 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7836 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7837 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7845 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7846 that can be reused. */
7849 init_tool_bar_items (reuse
)
7852 if (VECTORP (reuse
))
7853 tool_bar_items_vector
= reuse
;
7855 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7856 ntool_bar_items
= 0;
7860 /* Append parsed tool bar item properties from
7861 tool_bar_item_properties */
7864 append_tool_bar_item ()
7866 Lisp_Object
*to
, *from
;
7868 /* Enlarge tool_bar_items_vector if necessary. */
7869 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7870 >= XVECTOR (tool_bar_items_vector
)->size
)
7872 Lisp_Object new_vector
;
7873 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7875 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7876 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7877 XVECTOR (new_vector
)->contents
,
7878 old_size
* sizeof (Lisp_Object
));
7879 tool_bar_items_vector
= new_vector
;
7882 /* Append entries from tool_bar_item_properties to the end of
7883 tool_bar_items_vector. */
7884 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7885 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7886 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7887 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7894 /* Read a character using menus based on maps in the array MAPS.
7895 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7896 Return t if we displayed a menu but the user rejected it.
7898 PREV_EVENT is the previous input event, or nil if we are reading
7899 the first event of a key sequence.
7901 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7902 if we used a mouse menu to read the input, or zero otherwise. If
7903 USED_MOUSE_MENU is null, we don't dereference it.
7905 The prompting is done based on the prompt-string of the map
7906 and the strings associated with various map elements.
7908 This can be done with X menus or with menus put in the minibuf.
7909 These are done in different ways, depending on how the input will be read.
7910 Menus using X are done after auto-saving in read-char, getting the input
7911 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7912 and do auto-saving in the inner call of read_char. */
7915 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7918 Lisp_Object prev_event
;
7919 int *used_mouse_menu
;
7922 register Lisp_Object name
= Qnil
;
7924 if (used_mouse_menu
)
7925 *used_mouse_menu
= 0;
7927 /* Use local over global Menu maps */
7929 if (! menu_prompting
)
7932 /* Optionally disregard all but the global map. */
7933 if (inhibit_local_menu_bar_menus
)
7935 maps
+= (nmaps
- 1);
7939 /* Get the menu name from the first map that has one (a prompt string). */
7940 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7942 name
= Fkeymap_prompt (maps
[mapno
]);
7947 /* If we don't have any menus, just read a character normally. */
7948 if (!STRINGP (name
))
7952 /* If we got to this point via a mouse click,
7953 use a real menu for mouse selection. */
7954 if (EVENT_HAS_PARAMETERS (prev_event
)
7955 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7956 && !EQ (XCAR (prev_event
), Qtool_bar
))
7958 /* Display the menu and get the selection. */
7959 Lisp_Object
*realmaps
7960 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7964 /* Use the maps that are not nil. */
7965 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7966 if (!NILP (maps
[mapno
]))
7967 realmaps
[nmaps1
++] = maps
[mapno
];
7969 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7974 record_menu_key (XCAR (value
));
7976 /* If we got multiple events, unread all but
7978 There is no way to prevent those unread events
7979 from showing up later in last_nonmenu_event.
7980 So turn symbol and integer events into lists,
7981 to indicate that they came from a mouse menu,
7982 so that when present in last_nonmenu_event
7983 they won't confuse things. */
7984 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7986 record_menu_key (XCAR (tem
));
7987 if (SYMBOLP (XCAR (tem
))
7988 || INTEGERP (XCAR (tem
)))
7989 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7992 /* If we got more than one event, put all but the first
7993 onto this list to be read later.
7994 Return just the first event now. */
7995 Vunread_command_events
7996 = nconc2 (XCDR (value
), Vunread_command_events
);
7997 value
= XCAR (value
);
7999 else if (NILP (value
))
8001 if (used_mouse_menu
)
8002 *used_mouse_menu
= 1;
8005 #endif /* HAVE_MENUS */
8009 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8010 We make this bigger when necessary, and never free it. */
8011 static char *read_char_minibuf_menu_text
;
8012 /* Size of that buffer. */
8013 static int read_char_minibuf_menu_width
;
8016 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8022 register Lisp_Object name
;
8024 /* FIXME: Use the minibuffer's frame width. */
8025 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8028 Lisp_Object rest
, vector
;
8034 if (! menu_prompting
)
8037 /* Make sure we have a big enough buffer for the menu text. */
8038 if (read_char_minibuf_menu_text
== 0)
8040 read_char_minibuf_menu_width
= width
+ 4;
8041 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8043 else if (width
+ 4 > read_char_minibuf_menu_width
)
8045 read_char_minibuf_menu_width
= width
+ 4;
8046 read_char_minibuf_menu_text
8047 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8049 menu
= read_char_minibuf_menu_text
;
8051 /* Get the menu name from the first map that has one (a prompt string). */
8052 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8054 name
= Fkeymap_prompt (maps
[mapno
]);
8059 /* If we don't have any menus, just read a character normally. */
8060 if (!STRINGP (name
))
8063 /* Prompt string always starts with map's prompt, and a space. */
8064 strcpy (menu
, SDATA (name
));
8065 nlength
= SBYTES (name
);
8066 menu
[nlength
++] = ':';
8067 menu
[nlength
++] = ' ';
8070 /* Start prompting at start of first map. */
8074 /* Present the documented bindings, a line at a time. */
8081 Lisp_Object orig_defn_macro
;
8083 /* Loop over elements of map. */
8088 /* If reached end of map, start at beginning of next map. */
8092 /* At end of last map, wrap around to first map if just starting,
8093 or end this line if already have something on it. */
8097 if (notfirst
|| nobindings
) break;
8102 /* Look at the next element of the map. */
8104 elt
= XVECTOR (vector
)->contents
[idx
];
8106 elt
= Fcar_safe (rest
);
8108 if (idx
< 0 && VECTORP (elt
))
8110 /* If we found a dense table in the keymap,
8111 advanced past it, but start scanning its contents. */
8112 rest
= Fcdr_safe (rest
);
8118 /* An ordinary element. */
8119 Lisp_Object event
, tem
;
8123 event
= Fcar_safe (elt
); /* alist */
8124 elt
= Fcdr_safe (elt
);
8128 XSETINT (event
, idx
); /* vector */
8131 /* Ignore the element if it has no prompt string. */
8132 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8134 /* 1 if the char to type matches the string. */
8136 Lisp_Object upcased_event
, downcased_event
;
8137 Lisp_Object desc
= Qnil
;
8139 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8141 upcased_event
= Fupcase (event
);
8142 downcased_event
= Fdowncase (event
);
8143 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8144 || XINT (downcased_event
) == SREF (s
, 0));
8146 desc
= Fsingle_key_description (event
, Qnil
);
8148 #if 0 /* It is redundant to list the equivalent key bindings because
8149 the prefix is what the user has already typed. */
8151 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8153 /* Insert equivalent keybinding. */
8154 s
= concat2 (s
, tem
);
8157 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8158 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8160 /* Insert button prefix. */
8161 Lisp_Object selected
8162 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8163 if (EQ (tem
, QCradio
))
8164 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8166 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8167 s
= concat2 (tem
, s
);
8171 /* If we have room for the prompt string, add it to this line.
8172 If this is the first on the line, always add it. */
8173 if ((SCHARS (s
) + i
+ 2
8174 + (char_matches
? 0 : SCHARS (desc
) + 3))
8180 /* Punctuate between strings. */
8183 strcpy (menu
+ i
, ", ");
8189 /* If the char to type doesn't match the string's
8190 first char, explicitly show what char to type. */
8193 /* Add as much of string as fits. */
8194 thiswidth
= SCHARS (desc
);
8195 if (thiswidth
+ i
> width
)
8196 thiswidth
= width
- i
;
8197 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8199 strcpy (menu
+ i
, " = ");
8203 /* Add as much of string as fits. */
8204 thiswidth
= SCHARS (s
);
8205 if (thiswidth
+ i
> width
)
8206 thiswidth
= width
- i
;
8207 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8213 /* If this element does not fit, end the line now,
8214 and save the element for the next line. */
8215 strcpy (menu
+ i
, "...");
8220 /* Move past this element. */
8221 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8222 /* Handle reaching end of dense table. */
8227 rest
= Fcdr_safe (rest
);
8231 /* Prompt with that and read response. */
8232 message2_nolog (menu
, strlen (menu
),
8233 ! NILP (current_buffer
->enable_multibyte_characters
));
8235 /* Make believe its not a keyboard macro in case the help char
8236 is pressed. Help characters are not recorded because menu prompting
8237 is not used on replay.
8239 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8240 current_kboard
->defining_kbd_macro
= Qnil
;
8242 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8243 while (BUFFERP (obj
));
8244 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8246 if (!INTEGERP (obj
))
8251 if (! EQ (obj
, menu_prompt_more_char
)
8252 && (!INTEGERP (menu_prompt_more_char
)
8253 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8255 if (!NILP (current_kboard
->defining_kbd_macro
))
8256 store_kbd_macro_char (obj
);
8259 /* Help char - go round again */
8263 /* Reading key sequences. */
8265 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8266 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8267 keymap, or nil otherwise. Return the index of the first keymap in
8268 which KEY has any binding, or NMAPS if no map has a binding.
8270 If KEY is a meta ASCII character, treat it like meta-prefix-char
8271 followed by the corresponding non-meta character. Keymaps in
8272 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8275 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8278 NEXT may be the same array as CURRENT. */
8281 follow_key (key
, nmaps
, current
, defs
, next
)
8283 Lisp_Object
*current
, *defs
, *next
;
8286 int i
, first_binding
;
8288 first_binding
= nmaps
;
8289 for (i
= nmaps
- 1; i
>= 0; i
--)
8291 if (! NILP (current
[i
]))
8293 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8294 if (! NILP (defs
[i
]))
8301 /* Given the set of bindings we've found, produce the next set of maps. */
8302 if (first_binding
< nmaps
)
8303 for (i
= 0; i
< nmaps
; i
++)
8304 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8306 return first_binding
;
8309 /* Structure used to keep track of partial application of key remapping
8310 such as Vfunction_key_map and Vkey_translation_map. */
8311 typedef struct keyremap
8313 Lisp_Object map
, parent
;
8317 /* Lookup KEY in MAP.
8318 MAP is a keymap mapping keys to key vectors or functions.
8319 If the mapping is a function and DO_FUNCTION is non-zero, then
8320 the function is called with PROMPT as parameter and its return
8321 value is used as the return value of this function (after checking
8322 that it is indeed a vector). */
8325 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8326 Lisp_Object map
, key
, prompt
;
8331 next
= access_keymap (map
, key
, 1, 0, 1);
8333 /* Handle symbol with autoload definition. */
8334 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8335 && CONSP (XSYMBOL (next
)->function
)
8336 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8337 do_autoload (XSYMBOL (next
)->function
, next
);
8339 /* Handle a symbol whose function definition is a keymap
8341 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8342 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8343 || KEYMAPP (XSYMBOL (next
)->function
)))
8344 next
= XSYMBOL (next
)->function
;
8346 /* If the keymap gives a function, not an
8347 array, then call the function with one arg and use
8348 its value instead. */
8349 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8354 next
= call1 (next
, prompt
);
8355 /* If the function returned something invalid,
8356 barf--don't ignore it.
8357 (To ignore it safely, we would need to gcpro a bunch of
8358 other variables.) */
8359 if (! (VECTORP (next
) || STRINGP (next
)))
8360 error ("Function %s returns invalid key sequence", tem
);
8365 /* Do one step of the key remapping used for function-key-map and
8366 key-translation-map:
8367 KEYBUF is the buffer holding the input events.
8368 BUFSIZE is its maximum size.
8369 FKEY is a pointer to the keyremap structure to use.
8370 INPUT is the index of the last element in KEYBUF.
8371 DOIT if non-zero says that the remapping can actually take place.
8372 DIFF is used to return the number of keys added/removed by the remapping.
8373 PARENT is the root of the keymap.
8374 PROMPT is the prompt to use if the remapping happens through a function.
8375 The return value is non-zero if the remapping actually took place. */
8378 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8379 Lisp_Object
*keybuf
, prompt
;
8381 int input
, doit
, *diff
, bufsize
;
8383 Lisp_Object next
, key
;
8385 key
= keybuf
[fkey
->end
++];
8386 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8388 /* If keybuf[fkey->start..fkey->end] is bound in the
8389 map and we're in a position to do the key remapping, replace it with
8390 the binding and restart with fkey->start at the end. */
8391 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8393 int len
= XFASTINT (Flength (next
));
8396 *diff
= len
- (fkey
->end
- fkey
->start
);
8398 if (input
+ *diff
>= bufsize
)
8399 error ("Key sequence too long");
8401 /* Shift the keys that follow fkey->end. */
8403 for (i
= fkey
->end
; i
< input
; i
++)
8404 keybuf
[i
+ *diff
] = keybuf
[i
];
8406 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8407 keybuf
[i
+ *diff
] = keybuf
[i
];
8408 /* Overwrite the old keys with the new ones. */
8409 for (i
= 0; i
< len
; i
++)
8410 keybuf
[fkey
->start
+ i
]
8411 = Faref (next
, make_number (i
));
8413 fkey
->start
= fkey
->end
+= *diff
;
8414 fkey
->map
= fkey
->parent
;
8419 fkey
->map
= get_keymap (next
, 0, 1);
8421 /* If we no longer have a bound suffix, try a new position for
8423 if (!CONSP (fkey
->map
))
8425 fkey
->end
= ++fkey
->start
;
8426 fkey
->map
= fkey
->parent
;
8431 /* Read a sequence of keys that ends with a non prefix character,
8432 storing it in KEYBUF, a buffer of size BUFSIZE.
8434 Return the length of the key sequence stored.
8435 Return -1 if the user rejected a command menu.
8437 Echo starting immediately unless `prompt' is 0.
8439 Where a key sequence ends depends on the currently active keymaps.
8440 These include any minor mode keymaps active in the current buffer,
8441 the current buffer's local map, and the global map.
8443 If a key sequence has no other bindings, we check Vfunction_key_map
8444 to see if some trailing subsequence might be the beginning of a
8445 function key's sequence. If so, we try to read the whole function
8446 key, and substitute its symbolic name into the key sequence.
8448 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8449 `double-' events into similar click events, if that would make them
8450 bound. We try to turn `triple-' events first into `double-' events,
8453 If we get a mouse click in a mode line, vertical divider, or other
8454 non-text area, we treat the click as if it were prefixed by the
8455 symbol denoting that area - `mode-line', `vertical-line', or
8458 If the sequence starts with a mouse click, we read the key sequence
8459 with respect to the buffer clicked on, not the current buffer.
8461 If the user switches frames in the midst of a key sequence, we put
8462 off the switch-frame event until later; the next call to
8463 read_char will return it.
8465 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8466 from the selected window's buffer. */
8469 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8470 can_return_switch_frame
, fix_current_buffer
)
8471 Lisp_Object
*keybuf
;
8474 int dont_downcase_last
;
8475 int can_return_switch_frame
;
8476 int fix_current_buffer
;
8478 volatile Lisp_Object from_string
;
8479 volatile int count
= SPECPDL_INDEX ();
8481 /* How many keys there are in the current key sequence. */
8484 /* The length of the echo buffer when we started reading, and
8485 the length of this_command_keys when we started reading. */
8486 volatile int echo_start
;
8487 volatile int keys_start
;
8489 /* The number of keymaps we're scanning right now, and the number of
8490 keymaps we have allocated space for. */
8492 volatile int nmaps_allocated
= 0;
8494 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8495 the current keymaps. */
8496 Lisp_Object
*volatile defs
= NULL
;
8498 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8499 in the current keymaps, or nil where it is not a prefix. */
8500 Lisp_Object
*volatile submaps
= NULL
;
8502 /* The local map to start out with at start of key sequence. */
8503 volatile Lisp_Object orig_local_map
;
8505 /* The map from the `keymap' property to start out with at start of
8507 volatile Lisp_Object orig_keymap
;
8509 /* 1 if we have already considered switching to the local-map property
8510 of the place where a mouse click occurred. */
8511 volatile int localized_local_map
= 0;
8513 /* The index in defs[] of the first keymap that has a binding for
8514 this key sequence. In other words, the lowest i such that
8515 defs[i] is non-nil. */
8516 volatile int first_binding
;
8517 /* Index of the first key that has no binding.
8518 It is useless to try fkey.start larger than that. */
8519 volatile int first_unbound
;
8521 /* If t < mock_input, then KEYBUF[t] should be read as the next
8524 We use this to recover after recognizing a function key. Once we
8525 realize that a suffix of the current key sequence is actually a
8526 function key's escape sequence, we replace the suffix with the
8527 function key's binding from Vfunction_key_map. Now keybuf
8528 contains a new and different key sequence, so the echo area,
8529 this_command_keys, and the submaps and defs arrays are wrong. In
8530 this situation, we set mock_input to t, set t to 0, and jump to
8531 restart_sequence; the loop will read keys from keybuf up until
8532 mock_input, thus rebuilding the state; and then it will resume
8533 reading characters from the keyboard. */
8534 volatile int mock_input
= 0;
8536 /* If the sequence is unbound in submaps[], then
8537 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8538 and fkey.map is its binding.
8540 These might be > t, indicating that all function key scanning
8541 should hold off until t reaches them. We do this when we've just
8542 recognized a function key, to avoid searching for the function
8543 key's again in Vfunction_key_map. */
8544 volatile keyremap fkey
;
8546 /* Likewise, for key_translation_map. */
8547 volatile keyremap keytran
;
8549 /* If we receive a `switch-frame' or `select-window' event in the middle of
8550 a key sequence, we put it off for later.
8551 While we're reading, we keep the event here. */
8552 volatile Lisp_Object delayed_switch_frame
;
8554 /* See the comment below... */
8555 #if defined (GOBBLE_FIRST_EVENT)
8556 Lisp_Object first_event
;
8559 volatile Lisp_Object original_uppercase
;
8560 volatile int original_uppercase_position
= -1;
8562 /* Gets around Microsoft compiler limitations. */
8565 struct buffer
*starting_buffer
;
8567 /* List of events for which a fake prefix key has been generated. */
8568 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8570 #if defined (GOBBLE_FIRST_EVENT)
8574 struct gcpro gcpro1
;
8576 GCPRO1 (fake_prefixed_keys
);
8577 raw_keybuf_count
= 0;
8579 last_nonmenu_event
= Qnil
;
8581 delayed_switch_frame
= Qnil
;
8582 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8583 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8584 /* If there is no translation-map, turn off scanning. */
8585 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8586 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8591 echo_prompt (prompt
);
8592 else if (cursor_in_echo_area
8593 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8594 && NILP (Fzerop (Vecho_keystrokes
)))
8595 /* This doesn't put in a dash if the echo buffer is empty, so
8596 you don't always see a dash hanging out in the minibuffer. */
8600 /* Record the initial state of the echo area and this_command_keys;
8601 we will need to restore them if we replay a key sequence. */
8603 echo_start
= echo_length ();
8604 keys_start
= this_command_key_count
;
8605 this_single_command_key_start
= keys_start
;
8607 #if defined (GOBBLE_FIRST_EVENT)
8608 /* This doesn't quite work, because some of the things that read_char
8609 does cannot safely be bypassed. It seems too risky to try to make
8612 /* Read the first char of the sequence specially, before setting
8613 up any keymaps, in case a filter runs and switches buffers on us. */
8614 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8616 #endif /* GOBBLE_FIRST_EVENT */
8618 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8619 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8622 /* We jump here when the key sequence has been thoroughly changed, and
8623 we need to rescan it starting from the beginning. When we jump here,
8624 keybuf[0..mock_input] holds the sequence we should reread. */
8627 starting_buffer
= current_buffer
;
8628 first_unbound
= bufsize
+ 1;
8630 /* Build our list of keymaps.
8631 If we recognize a function key and replace its escape sequence in
8632 keybuf with its symbol, or if the sequence starts with a mouse
8633 click and we need to switch buffers, we jump back here to rebuild
8634 the initial keymaps from the current buffer. */
8637 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8638 || !NILP (Voverriding_local_map
))
8640 if (3 > nmaps_allocated
)
8642 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8643 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8644 nmaps_allocated
= 3;
8646 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8647 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8648 if (!NILP (Voverriding_local_map
))
8649 submaps
[nmaps
++] = Voverriding_local_map
;
8657 nminor
= current_minor_maps (0, &maps
);
8658 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8660 if (total
> nmaps_allocated
)
8662 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8663 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8664 nmaps_allocated
= total
;
8667 if (!NILP (orig_keymap
))
8668 submaps
[nmaps
++] = orig_keymap
;
8670 bcopy (maps
, (void *) (submaps
+ nmaps
),
8671 nminor
* sizeof (submaps
[0]));
8675 submaps
[nmaps
++] = orig_local_map
;
8677 submaps
[nmaps
++] = current_global_map
;
8679 /* Find an accurate initial value for first_binding. */
8680 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8681 if (! NILP (submaps
[first_binding
]))
8684 /* Start from the beginning in keybuf. */
8687 /* These are no-ops the first time through, but if we restart, they
8688 revert the echo area and this_command_keys to their original state. */
8689 this_command_key_count
= keys_start
;
8690 if (INTERACTIVE
&& t
< mock_input
)
8691 echo_truncate (echo_start
);
8693 /* If the best binding for the current key sequence is a keymap, or
8694 we may be looking at a function key's escape sequence, keep on
8696 while (first_binding
< nmaps
8697 /* Keep reading as long as there's a prefix binding. */
8698 ? !NILP (submaps
[first_binding
])
8699 /* Don't return in the middle of a possible function key sequence,
8700 if the only bindings we found were via case conversion.
8701 Thus, if ESC O a has a function-key-map translation
8702 and ESC o has a binding, don't return after ESC O,
8703 so that we can translate ESC O plus the next character. */
8704 : (fkey
.start
< t
|| keytran
.start
< t
))
8707 int used_mouse_menu
= 0;
8709 /* Where the last real key started. If we need to throw away a
8710 key that has expanded into more than one element of keybuf
8711 (say, a mouse click on the mode line which is being treated
8712 as [mode-line (mouse-...)], then we backtrack to this point
8714 volatile int last_real_key_start
;
8716 /* These variables are analogous to echo_start and keys_start;
8717 while those allow us to restart the entire key sequence,
8718 echo_local_start and keys_local_start allow us to throw away
8720 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8722 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8723 eassert (fkey
.start
<= fkey
.end
);
8724 eassert (keytran
.start
<= keytran
.end
);
8725 /* key-translation-map is applied *after* function-key-map. */
8726 eassert (keytran
.end
<= fkey
.start
);
8728 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8729 { /* The prefix upto first_unbound has no binding and has
8730 no translation left to do either, so we know it's unbound.
8731 If we don't stop now, we risk staying here indefinitely
8732 (if the user keeps entering fkey or keytran prefixes
8733 like C-c ESC ESC ESC ESC ...) */
8735 for (i
= first_unbound
+ 1; i
< t
; i
++)
8736 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8737 mock_input
= t
- first_unbound
- 1;
8738 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8739 fkey
.map
= fkey
.parent
;
8740 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8741 keytran
.map
= keytran
.parent
;
8742 goto replay_sequence
;
8746 error ("Key sequence too long");
8749 echo_local_start
= echo_length ();
8750 keys_local_start
= this_command_key_count
;
8751 local_first_binding
= first_binding
;
8754 /* These are no-ops, unless we throw away a keystroke below and
8755 jumped back up to replay_key; in that case, these restore the
8756 variables to their original state, allowing us to replay the
8758 if (INTERACTIVE
&& t
< mock_input
)
8759 echo_truncate (echo_local_start
);
8760 this_command_key_count
= keys_local_start
;
8761 first_binding
= local_first_binding
;
8763 /* By default, assume each event is "real". */
8764 last_real_key_start
= t
;
8766 /* Does mock_input indicate that we are re-reading a key sequence? */
8770 add_command_key (key
);
8771 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8772 && NILP (Fzerop (Vecho_keystrokes
)))
8776 /* If not, we should actually read a character. */
8781 KBOARD
*interrupted_kboard
= current_kboard
;
8782 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8783 if (setjmp (wrong_kboard_jmpbuf
))
8785 if (!NILP (delayed_switch_frame
))
8787 interrupted_kboard
->kbd_queue
8788 = Fcons (delayed_switch_frame
,
8789 interrupted_kboard
->kbd_queue
);
8790 delayed_switch_frame
= Qnil
;
8793 interrupted_kboard
->kbd_queue
8794 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8796 /* If the side queue is non-empty, ensure it begins with a
8797 switch-frame, so we'll replay it in the right context. */
8798 if (CONSP (interrupted_kboard
->kbd_queue
)
8799 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8800 !(EVENT_HAS_PARAMETERS (key
)
8801 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8805 XSETFRAME (frame
, interrupted_frame
);
8806 interrupted_kboard
->kbd_queue
8807 = Fcons (make_lispy_switch_frame (frame
),
8808 interrupted_kboard
->kbd_queue
);
8811 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8812 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8813 goto replay_sequence
;
8816 key
= read_char (NILP (prompt
), nmaps
,
8817 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8821 /* read_char returns t when it shows a menu and the user rejects it.
8825 unbind_to (count
, Qnil
);
8830 /* read_char returns -1 at the end of a macro.
8831 Emacs 18 handles this by returning immediately with a
8832 zero, so that's what we'll do. */
8833 if (INTEGERP (key
) && XINT (key
) == -1)
8836 /* The Microsoft C compiler can't handle the goto that
8842 /* If the current buffer has been changed from under us, the
8843 keymap may have changed, so replay the sequence. */
8846 timer_resume_idle ();
8849 /* Reset the current buffer from the selected window
8850 in case something changed the former and not the latter.
8851 This is to be more consistent with the behavior
8852 of the command_loop_1. */
8853 if (fix_current_buffer
)
8855 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8857 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8858 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8861 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8862 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8863 goto replay_sequence
;
8866 /* If we have a quit that was typed in another frame, and
8867 quit_throw_to_read_char switched buffers,
8868 replay to get the right keymap. */
8870 && XINT (key
) == quit_char
8871 && current_buffer
!= starting_buffer
)
8874 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8878 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8879 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8880 goto replay_sequence
;
8885 if (EVENT_HAS_PARAMETERS (key
)
8886 /* Either a `switch-frame' or a `select-window' event. */
8887 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8889 /* If we're at the beginning of a key sequence, and the caller
8890 says it's okay, go ahead and return this event. If we're
8891 in the midst of a key sequence, delay it until the end. */
8892 if (t
> 0 || !can_return_switch_frame
)
8894 delayed_switch_frame
= key
;
8900 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8903 /* Clicks in non-text areas get prefixed by the symbol
8904 in their CHAR-ADDRESS field. For example, a click on
8905 the mode line is prefixed by the symbol `mode-line'.
8907 Furthermore, key sequences beginning with mouse clicks
8908 are read using the keymaps of the buffer clicked on, not
8909 the current buffer. So we may have to switch the buffer
8912 When we turn one event into two events, we must make sure
8913 that neither of the two looks like the original--so that,
8914 if we replay the events, they won't be expanded again.
8915 If not for this, such reexpansion could happen either here
8916 or when user programs play with this-command-keys. */
8917 if (EVENT_HAS_PARAMETERS (key
))
8922 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8923 if (EQ (kind
, Qmouse_click
))
8925 Lisp_Object window
, posn
;
8927 window
= POSN_WINDOW (EVENT_START (key
));
8928 posn
= POSN_POSN (EVENT_START (key
));
8931 || (!NILP (fake_prefixed_keys
)
8932 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8934 /* We're looking a second time at an event for which
8935 we generated a fake prefix key. Set
8936 last_real_key_start appropriately. */
8938 last_real_key_start
= t
- 1;
8941 /* Key sequences beginning with mouse clicks are
8942 read using the keymaps in the buffer clicked on,
8943 not the current buffer. If we're at the
8944 beginning of a key sequence, switch buffers. */
8945 if (last_real_key_start
== 0
8947 && BUFFERP (XWINDOW (window
)->buffer
)
8948 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8950 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8954 /* Arrange to go back to the original buffer once we're
8955 done reading the key sequence. Note that we can't
8956 use save_excursion_{save,restore} here, because they
8957 save point as well as the current buffer; we don't
8958 want to save point, because redisplay may change it,
8959 to accommodate a Fset_window_start or something. We
8960 don't want to do this at the top of the function,
8961 because we may get input from a subprocess which
8962 wants to change the selected window and stuff (say,
8964 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8966 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8968 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8969 orig_local_map
= get_local_map (PT
, current_buffer
,
8971 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8972 goto replay_sequence
;
8975 /* For a mouse click, get the local text-property keymap
8976 of the place clicked on, rather than point. */
8977 if (last_real_key_start
== 0
8978 && CONSP (XCDR (key
))
8979 && ! localized_local_map
)
8981 Lisp_Object map_here
, start
, pos
;
8983 localized_local_map
= 1;
8984 start
= EVENT_START (key
);
8986 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8988 pos
= POSN_BUFFER_POSN (start
);
8990 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8992 map_here
= get_local_map (XINT (pos
),
8993 current_buffer
, Qlocal_map
);
8994 if (!EQ (map_here
, orig_local_map
))
8996 orig_local_map
= map_here
;
9000 goto replay_sequence
;
9002 map_here
= get_local_map (XINT (pos
),
9003 current_buffer
, Qkeymap
);
9004 if (!EQ (map_here
, orig_keymap
))
9006 orig_keymap
= map_here
;
9010 goto replay_sequence
;
9016 /* Expand mode-line and scroll-bar events into two events:
9017 use posn as a fake prefix key. */
9019 && (NILP (fake_prefixed_keys
)
9020 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9022 if (t
+ 1 >= bufsize
)
9023 error ("Key sequence too long");
9026 keybuf
[t
+ 1] = key
;
9029 /* Record that a fake prefix key has been generated
9030 for KEY. Don't modify the event; this would
9031 prevent proper action when the event is pushed
9032 back into unread-command-events. */
9033 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9035 /* If on a mode line string with a local keymap,
9036 reconsider the key sequence with that keymap. */
9037 if (string
= POSN_STRING (EVENT_START (key
)),
9038 (CONSP (string
) && STRINGP (XCAR (string
))))
9040 Lisp_Object pos
, map
, map2
;
9042 pos
= XCDR (string
);
9043 string
= XCAR (string
);
9045 && XINT (pos
) < SCHARS (string
))
9047 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9049 orig_local_map
= map
;
9050 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9053 if (!NILP (map
) || !NILP (map2
))
9054 goto replay_sequence
;
9060 else if (NILP (from_string
)
9061 && (string
= POSN_STRING (EVENT_START (key
)),
9062 (CONSP (string
) && STRINGP (XCAR (string
)))))
9064 /* For a click on a string, i.e. overlay string or a
9065 string displayed via the `display' property,
9066 consider `local-map' and `keymap' properties of
9068 Lisp_Object pos
, map
, map2
;
9070 pos
= XCDR (string
);
9071 string
= XCAR (string
);
9073 && XINT (pos
) < SCHARS (string
))
9075 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9077 orig_local_map
= map
;
9078 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9082 if (!NILP (map
) || !NILP (map2
))
9084 from_string
= string
;
9085 goto replay_sequence
;
9090 else if (CONSP (XCDR (key
))
9091 && CONSP (EVENT_START (key
))
9092 && CONSP (XCDR (EVENT_START (key
))))
9096 posn
= POSN_POSN (EVENT_START (key
));
9097 /* Handle menu-bar events:
9098 insert the dummy prefix event `menu-bar'. */
9099 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9101 if (t
+ 1 >= bufsize
)
9102 error ("Key sequence too long");
9106 /* Zap the position in key, so we know that we've
9107 expanded it, and don't try to do so again. */
9108 POSN_SET_POSN (EVENT_START (key
),
9109 Fcons (posn
, Qnil
));
9112 goto replay_sequence
;
9114 else if (CONSP (posn
))
9116 /* We're looking at the second event of a
9117 sequence which we expanded before. Set
9118 last_real_key_start appropriately. */
9119 if (last_real_key_start
== t
&& t
> 0)
9120 last_real_key_start
= t
- 1;
9125 /* We have finally decided that KEY is something we might want
9127 first_binding
= (follow_key (key
,
9128 nmaps
- first_binding
,
9129 submaps
+ first_binding
,
9130 defs
+ first_binding
,
9131 submaps
+ first_binding
)
9134 /* If KEY wasn't bound, we'll try some fallbacks. */
9135 if (first_binding
< nmaps
)
9136 /* This is needed for the following scenario:
9137 event 0: a down-event that gets dropped by calling replay_key.
9138 event 1: some normal prefix like C-h.
9139 After event 0, first_unbound is 0, after event 1 fkey.start
9140 and keytran.start are both 1, so when we see that C-h is bound,
9141 we need to update first_unbound. */
9142 first_unbound
= max (t
+ 1, first_unbound
);
9147 /* Remember the position to put an upper bound on fkey.start. */
9148 first_unbound
= min (t
, first_unbound
);
9150 head
= EVENT_HEAD (key
);
9151 if (help_char_p (head
) && t
> 0)
9153 read_key_sequence_cmd
= Vprefix_help_command
;
9155 last_nonmenu_event
= key
;
9156 /* The Microsoft C compiler can't handle the goto that
9164 Lisp_Object breakdown
;
9167 breakdown
= parse_modifiers (head
);
9168 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9169 /* Attempt to reduce an unbound mouse event to a simpler
9170 event that is bound:
9171 Drags reduce to clicks.
9172 Double-clicks reduce to clicks.
9173 Triple-clicks reduce to double-clicks, then to clicks.
9174 Down-clicks are eliminated.
9175 Double-downs reduce to downs, then are eliminated.
9176 Triple-downs reduce to double-downs, then to downs,
9177 then are eliminated. */
9178 if (modifiers
& (down_modifier
| drag_modifier
9179 | double_modifier
| triple_modifier
))
9181 while (modifiers
& (down_modifier
| drag_modifier
9182 | double_modifier
| triple_modifier
))
9184 Lisp_Object new_head
, new_click
;
9185 if (modifiers
& triple_modifier
)
9186 modifiers
^= (double_modifier
| triple_modifier
);
9187 else if (modifiers
& double_modifier
)
9188 modifiers
&= ~double_modifier
;
9189 else if (modifiers
& drag_modifier
)
9190 modifiers
&= ~drag_modifier
;
9193 /* Dispose of this `down' event by simply jumping
9194 back to replay_key, to get another event.
9196 Note that if this event came from mock input,
9197 then just jumping back to replay_key will just
9198 hand it to us again. So we have to wipe out any
9201 We could delete keybuf[t] and shift everything
9202 after that to the left by one spot, but we'd also
9203 have to fix up any variable that points into
9204 keybuf, and shifting isn't really necessary
9207 Adding prefixes for non-textual mouse clicks
9208 creates two characters of mock input, and both
9209 must be thrown away. If we're only looking at
9210 the prefix now, we can just jump back to
9211 replay_key. On the other hand, if we've already
9212 processed the prefix, and now the actual click
9213 itself is giving us trouble, then we've lost the
9214 state of the keymaps we want to backtrack to, and
9215 we need to replay the whole sequence to rebuild
9218 Beyond that, only function key expansion could
9219 create more than two keys, but that should never
9220 generate mouse events, so it's okay to zero
9221 mock_input in that case too.
9223 FIXME: The above paragraph seems just plain
9224 wrong, if you consider things like
9225 xterm-mouse-mode. -stef
9227 Isn't this just the most wonderful code ever? */
9229 /* If mock_input > t + 1, the above simplification
9230 will actually end up dropping keys on the floor.
9231 This is probably OK for now, but even
9232 if mock_input <= t + 1, we need to adjust fkey
9234 Typical case [header-line down-mouse-N]:
9235 mock_input = 2, t = 1, fkey.end = 1,
9236 last_real_key_start = 0. */
9237 if (fkey
.end
> last_real_key_start
)
9239 fkey
.end
= fkey
.start
9240 = min (last_real_key_start
, fkey
.start
);
9241 fkey
.map
= fkey
.parent
;
9242 if (keytran
.end
> last_real_key_start
)
9244 keytran
.end
= keytran
.start
9245 = min (last_real_key_start
, keytran
.start
);
9246 keytran
.map
= keytran
.parent
;
9249 if (t
== last_real_key_start
)
9256 mock_input
= last_real_key_start
;
9257 goto replay_sequence
;
9262 = apply_modifiers (modifiers
, XCAR (breakdown
));
9264 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9266 /* Look for a binding for this new key. follow_key
9267 promises that it didn't munge submaps the
9268 last time we called it, since key was unbound. */
9270 = (follow_key (new_click
,
9271 nmaps
- local_first_binding
,
9272 submaps
+ local_first_binding
,
9273 defs
+ local_first_binding
,
9274 submaps
+ local_first_binding
)
9275 + local_first_binding
);
9277 /* If that click is bound, go for it. */
9278 if (first_binding
< nmaps
)
9283 /* Otherwise, we'll leave key set to the drag event. */
9290 /* Normally, last_nonmenu_event gets the previous key we read.
9291 But when a mouse popup menu is being used,
9292 we don't update last_nonmenu_event; it continues to hold the mouse
9293 event that preceded the first level of menu. */
9294 if (!used_mouse_menu
)
9295 last_nonmenu_event
= key
;
9297 /* Record what part of this_command_keys is the current key sequence. */
9298 this_single_command_key_start
= this_command_key_count
- t
;
9300 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9301 /* There is a binding and it's not a prefix.
9302 There is thus no function-key in this sequence.
9303 Moving fkey.start is important in this case to allow keytran.start
9304 to go over the sequence before we return (since we keep the
9305 invariant that keytran.end <= fkey.start). */
9308 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9311 /* If the sequence is unbound, see if we can hang a function key
9312 off the end of it. */
9313 /* Continue scan from fkey.end until we find a bound suffix. */
9314 while (fkey
.end
< t
)
9316 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9319 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9320 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9321 max (t
, mock_input
),
9322 /* If there's a binding (i.e.
9323 first_binding >= nmaps) we don't want
9324 to apply this function-key-mapping. */
9325 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9330 mock_input
= diff
+ max (t
, mock_input
);
9331 goto replay_sequence
;
9335 /* Look for this sequence in key-translation-map.
9336 Scan from keytran.end until we find a bound suffix. */
9337 while (keytran
.end
< fkey
.start
)
9339 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9342 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9343 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9348 mock_input
= diff
+ max (t
, mock_input
);
9349 /* Adjust the function-key-map counters. */
9353 goto replay_sequence
;
9357 /* If KEY is not defined in any of the keymaps,
9358 and cannot be part of a function key or translation,
9359 and is an upper case letter
9360 use the corresponding lower-case letter instead. */
9361 if (first_binding
>= nmaps
9362 && fkey
.start
>= t
&& keytran
.start
>= t
9364 && ((((XINT (key
) & 0x3ffff)
9365 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9366 && UPPERCASEP (XINT (key
) & 0x3ffff))
9367 || (XINT (key
) & shift_modifier
)))
9369 Lisp_Object new_key
;
9371 original_uppercase
= key
;
9372 original_uppercase_position
= t
- 1;
9374 if (XINT (key
) & shift_modifier
)
9375 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9377 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9378 | (XINT (key
) & ~0x3ffff)));
9380 /* We have to do this unconditionally, regardless of whether
9381 the lower-case char is defined in the keymaps, because they
9382 might get translated through function-key-map. */
9383 keybuf
[t
- 1] = new_key
;
9384 mock_input
= max (t
, mock_input
);
9386 goto replay_sequence
;
9388 /* If KEY is not defined in any of the keymaps,
9389 and cannot be part of a function key or translation,
9390 and is a shifted function key,
9391 use the corresponding unshifted function key instead. */
9392 if (first_binding
>= nmaps
9393 && fkey
.start
>= t
&& keytran
.start
>= t
9396 Lisp_Object breakdown
;
9399 breakdown
= parse_modifiers (key
);
9400 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9401 if (modifiers
& shift_modifier
)
9403 Lisp_Object new_key
;
9405 original_uppercase
= key
;
9406 original_uppercase_position
= t
- 1;
9408 modifiers
&= ~shift_modifier
;
9409 new_key
= apply_modifiers (modifiers
,
9412 keybuf
[t
- 1] = new_key
;
9413 mock_input
= max (t
, mock_input
);
9414 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9415 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9417 goto replay_sequence
;
9423 read_key_sequence_cmd
= (first_binding
< nmaps
9424 ? defs
[first_binding
]
9427 unread_switch_frame
= delayed_switch_frame
;
9428 unbind_to (count
, Qnil
);
9430 /* Don't downcase the last character if the caller says don't.
9431 Don't downcase it if the result is undefined, either. */
9432 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9433 && t
- 1 == original_uppercase_position
)
9434 keybuf
[t
- 1] = original_uppercase
;
9436 /* Occasionally we fabricate events, perhaps by expanding something
9437 according to function-key-map, or by adding a prefix symbol to a
9438 mouse click in the scroll bar or modeline. In this cases, return
9439 the entire generated key sequence, even if we hit an unbound
9440 prefix or a definition before the end. This means that you will
9441 be able to push back the event properly, and also means that
9442 read-key-sequence will always return a logical unit.
9445 for (; t
< mock_input
; t
++)
9447 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9448 && NILP (Fzerop (Vecho_keystrokes
)))
9449 echo_char (keybuf
[t
]);
9450 add_command_key (keybuf
[t
]);
9459 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9460 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9461 The sequence is sufficient to specify a non-prefix command in the
9462 current local and global maps.
9464 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9465 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9466 as a continuation of the previous key.
9468 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9469 convert the last event to lower case. (Normally any upper case event
9470 is converted to lower case if the original event is undefined and the lower
9471 case equivalent is defined.) A non-nil value is appropriate for reading
9472 a key sequence to be defined.
9474 A C-g typed while in this function is treated like any other character,
9475 and `quit-flag' is not set.
9477 If the key sequence starts with a mouse click, then the sequence is read
9478 using the keymaps of the buffer of the window clicked in, not the buffer
9479 of the selected window as normal.
9481 `read-key-sequence' drops unbound button-down events, since you normally
9482 only care about the click or drag events which follow them. If a drag
9483 or multi-click event is unbound, but the corresponding click event would
9484 be bound, `read-key-sequence' turns the event into a click event at the
9485 drag's starting position. This means that you don't have to distinguish
9486 between click and drag, double, or triple events unless you want to.
9488 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9489 lines separating windows, and scroll bars with imaginary keys
9490 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9492 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9493 function will process a switch-frame event if the user switches frames
9494 before typing anything. If the user switches frames in the middle of a
9495 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9496 is nil, then the event will be put off until after the current key sequence.
9498 `read-key-sequence' checks `function-key-map' for function key
9499 sequences, where they wouldn't conflict with ordinary bindings. See
9500 `function-key-map' for more details.
9502 The optional fifth argument COMMAND-LOOP, if non-nil, means
9503 that this key sequence is being read by something that will
9504 read commands one after another. It should be nil if the caller
9505 will read just one key sequence. */)
9506 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9508 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9509 Lisp_Object can_return_switch_frame
, command_loop
;
9511 Lisp_Object keybuf
[30];
9513 struct gcpro gcpro1
;
9514 int count
= SPECPDL_INDEX ();
9517 CHECK_STRING (prompt
);
9520 specbind (Qinput_method_exit_on_first_char
,
9521 (NILP (command_loop
) ? Qt
: Qnil
));
9522 specbind (Qinput_method_use_echo_area
,
9523 (NILP (command_loop
) ? Qt
: Qnil
));
9525 bzero (keybuf
, sizeof keybuf
);
9527 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9529 if (NILP (continue_echo
))
9531 this_command_key_count
= 0;
9532 this_command_key_count_reset
= 0;
9533 this_single_command_key_start
= 0;
9536 #ifdef HAVE_X_WINDOWS
9537 if (display_hourglass_p
)
9538 cancel_hourglass ();
9541 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9542 prompt
, ! NILP (dont_downcase_last
),
9543 ! NILP (can_return_switch_frame
), 0);
9545 #if 0 /* The following is fine for code reading a key sequence and
9546 then proceeding with a lenghty computation, but it's not good
9547 for code reading keys in a loop, like an input method. */
9548 #ifdef HAVE_X_WINDOWS
9549 if (display_hourglass_p
)
9560 return unbind_to (count
, make_event_array (i
, keybuf
));
9563 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9564 Sread_key_sequence_vector
, 1, 5, 0,
9565 doc
: /* Like `read-key-sequence' but always return a vector. */)
9566 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9568 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9569 Lisp_Object can_return_switch_frame
, command_loop
;
9571 Lisp_Object keybuf
[30];
9573 struct gcpro gcpro1
;
9574 int count
= SPECPDL_INDEX ();
9577 CHECK_STRING (prompt
);
9580 specbind (Qinput_method_exit_on_first_char
,
9581 (NILP (command_loop
) ? Qt
: Qnil
));
9582 specbind (Qinput_method_use_echo_area
,
9583 (NILP (command_loop
) ? Qt
: Qnil
));
9585 bzero (keybuf
, sizeof keybuf
);
9587 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9589 if (NILP (continue_echo
))
9591 this_command_key_count
= 0;
9592 this_command_key_count_reset
= 0;
9593 this_single_command_key_start
= 0;
9596 #ifdef HAVE_X_WINDOWS
9597 if (display_hourglass_p
)
9598 cancel_hourglass ();
9601 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9602 prompt
, ! NILP (dont_downcase_last
),
9603 ! NILP (can_return_switch_frame
), 0);
9605 #ifdef HAVE_X_WINDOWS
9606 if (display_hourglass_p
)
9616 return unbind_to (count
, Fvector (i
, keybuf
));
9619 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9620 doc
: /* Execute CMD as an editor command.
9621 CMD must be a symbol that satisfies the `commandp' predicate.
9622 Optional second arg RECORD-FLAG non-nil
9623 means unconditionally put this command in `command-history'.
9624 Otherwise, that is done only if an arg is read using the minibuffer.
9625 The argument KEYS specifies the value to use instead of (this-command-keys)
9626 when reading the arguments; if it is nil, (this-command-keys) is used.
9627 The argument SPECIAL, if non-nil, means that this command is executing
9628 a special event, so ignore the prefix argument and don't clear it. */)
9629 (cmd
, record_flag
, keys
, special
)
9630 Lisp_Object cmd
, record_flag
, keys
, special
;
9632 register Lisp_Object final
;
9633 register Lisp_Object tem
;
9634 Lisp_Object prefixarg
;
9635 struct backtrace backtrace
;
9636 extern int debug_on_next_call
;
9638 debug_on_next_call
= 0;
9642 prefixarg
= current_kboard
->Vprefix_arg
;
9643 Vcurrent_prefix_arg
= prefixarg
;
9644 current_kboard
->Vprefix_arg
= Qnil
;
9651 tem
= Fget (cmd
, Qdisabled
);
9652 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9654 tem
= Fsymbol_value (Qdisabled_command_function
);
9656 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9662 final
= Findirect_function (cmd
);
9664 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9666 struct gcpro gcpro1
, gcpro2
;
9668 GCPRO2 (cmd
, prefixarg
);
9669 do_autoload (final
, cmd
);
9676 if (STRINGP (final
) || VECTORP (final
))
9678 /* If requested, place the macro in the command history. For
9679 other sorts of commands, call-interactively takes care of
9681 if (!NILP (record_flag
))
9684 = Fcons (Fcons (Qexecute_kbd_macro
,
9685 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9688 /* Don't keep command history around forever. */
9689 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9691 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9693 XSETCDR (tem
, Qnil
);
9697 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9700 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9702 backtrace
.next
= backtrace_list
;
9703 backtrace_list
= &backtrace
;
9704 backtrace
.function
= &Qcall_interactively
;
9705 backtrace
.args
= &cmd
;
9706 backtrace
.nargs
= 1;
9707 backtrace
.evalargs
= 0;
9708 backtrace
.debug_on_exit
= 0;
9710 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9712 backtrace_list
= backtrace
.next
;
9720 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9722 doc
: /* Read function name, then read its arguments and call it. */)
9724 Lisp_Object prefixarg
;
9726 Lisp_Object function
;
9728 int saved_last_point_position
;
9729 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9730 Lisp_Object bindings
, value
;
9731 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9733 saved_keys
= Fvector (this_command_key_count
,
9734 XVECTOR (this_command_keys
)->contents
);
9735 saved_last_point_position_buffer
= last_point_position_buffer
;
9736 saved_last_point_position
= last_point_position
;
9738 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9740 if (EQ (prefixarg
, Qminus
))
9742 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9743 strcpy (buf
, "C-u ");
9744 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9745 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9746 else if (INTEGERP (prefixarg
))
9747 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9749 /* This isn't strictly correct if execute-extended-command
9750 is bound to anything else. Perhaps it should use
9751 this_command_keys? */
9752 strcat (buf
, "M-x ");
9754 /* Prompt with buf, and then read a string, completing from and
9755 restricting to the set of all defined commands. Don't provide
9756 any initial input. Save the command read on the extended-command
9758 function
= Fcompleting_read (build_string (buf
),
9759 Vobarray
, Qcommandp
,
9760 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9763 if (STRINGP (function
) && SCHARS (function
) == 0)
9764 error ("No command name given");
9766 /* Set this_command_keys to the concatenation of saved_keys and
9767 function, followed by a RET. */
9772 this_command_key_count
= 0;
9773 this_command_key_count_reset
= 0;
9774 this_single_command_key_start
= 0;
9776 keys
= XVECTOR (saved_keys
)->contents
;
9777 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9778 add_command_key (keys
[i
]);
9780 for (i
= 0; i
< SCHARS (function
); i
++)
9781 add_command_key (Faref (function
, make_number (i
)));
9783 add_command_key (make_number ('\015'));
9786 last_point_position
= saved_last_point_position
;
9787 last_point_position_buffer
= saved_last_point_position_buffer
;
9791 function
= Fintern (function
, Qnil
);
9792 current_kboard
->Vprefix_arg
= prefixarg
;
9793 Vthis_command
= function
;
9794 real_this_command
= function
;
9796 /* If enabled, show which key runs this command. */
9797 if (!NILP (Vsuggest_key_bindings
)
9798 && NILP (Vexecuting_macro
)
9799 && SYMBOLP (function
))
9800 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9806 GCPRO2 (bindings
, value
);
9807 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9809 /* If the command has a key binding, print it now. */
9810 if (!NILP (bindings
)
9811 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9814 /* But first wait, and skip the message if there is input. */
9816 if (!NILP (echo_area_buffer
[0]))
9817 /* This command displayed something in the echo area;
9818 so wait a few seconds, then display our suggestion message. */
9819 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9820 ? XINT (Vsuggest_key_bindings
) : 2);
9822 /* This command left the echo area empty,
9823 so display our message immediately. */
9826 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9827 && ! CONSP (Vunread_command_events
))
9829 Lisp_Object binding
;
9831 int message_p
= push_message ();
9832 int count
= SPECPDL_INDEX ();
9834 record_unwind_protect (pop_message_unwind
, Qnil
);
9835 binding
= Fkey_description (bindings
, Qnil
);
9838 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9841 sprintf (newmessage
, "You can run the command `%s' with %s",
9842 SDATA (SYMBOL_NAME (function
)),
9844 message2_nolog (newmessage
,
9845 strlen (newmessage
),
9846 STRING_MULTIBYTE (binding
));
9847 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9848 ? Vsuggest_key_bindings
: make_number (2)),
9853 unbind_to (count
, Qnil
);
9857 RETURN_UNGCPRO (value
);
9861 /* Return nonzero if input events are pending. */
9864 detect_input_pending ()
9867 get_input_pending (&input_pending
, 0);
9869 return input_pending
;
9872 /* Return nonzero if input events are pending, and run any pending timers. */
9875 detect_input_pending_run_timers (do_display
)
9878 int old_timers_run
= timers_run
;
9881 get_input_pending (&input_pending
, 1);
9883 if (old_timers_run
!= timers_run
&& do_display
)
9885 redisplay_preserve_echo_area (8);
9886 /* The following fixes a bug when using lazy-lock with
9887 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9888 from an idle timer function. The symptom of the bug is that
9889 the cursor sometimes doesn't become visible until the next X
9890 event is processed. --gerd. */
9892 rif
->flush_display (NULL
);
9895 return input_pending
;
9898 /* This is called in some cases before a possible quit.
9899 It cases the next call to detect_input_pending to recompute input_pending.
9900 So calling this function unnecessarily can't do any harm. */
9903 clear_input_pending ()
9908 /* Return nonzero if there are pending requeued events.
9909 This isn't used yet. The hope is to make wait_reading_process_output
9910 call it, and return if it runs Lisp code that unreads something.
9911 The problem is, kbd_buffer_get_event needs to be fixed to know what
9912 to do in that case. It isn't trivial. */
9915 requeued_events_pending_p ()
9917 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9921 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9922 doc
: /* Return t if command input is currently available with no wait.
9923 Actually, the value is nil only if we can be sure that no input is available;
9924 if there is a doubt, the value is t. */)
9927 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9930 get_filtered_input_pending (&input_pending
, 1, 1);
9931 return input_pending
> 0 ? Qt
: Qnil
;
9934 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9935 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9938 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9941 if (total_keys
< NUM_RECENT_KEYS
)
9942 return Fvector (total_keys
, keys
);
9945 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9946 bcopy (keys
+ recent_keys_index
,
9947 XVECTOR (val
)->contents
,
9948 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9950 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9951 recent_keys_index
* sizeof (Lisp_Object
));
9956 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9957 doc
: /* Return the key sequence that invoked this command.
9958 However, if the command has called `read-key-sequence', it returns
9959 the last key sequence that has been read.
9960 The value is a string or a vector. */)
9963 return make_event_array (this_command_key_count
,
9964 XVECTOR (this_command_keys
)->contents
);
9967 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9968 doc
: /* Return the key sequence that invoked this command, as a vector.
9969 However, if the command has called `read-key-sequence', it returns
9970 the last key sequence that has been read. */)
9973 return Fvector (this_command_key_count
,
9974 XVECTOR (this_command_keys
)->contents
);
9977 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9978 Sthis_single_command_keys
, 0, 0, 0,
9979 doc
: /* Return the key sequence that invoked this command.
9980 More generally, it returns the last key sequence read, either by
9981 the command loop or by `read-key-sequence'.
9982 Unlike `this-command-keys', this function's value
9983 does not include prefix arguments.
9984 The value is always a vector. */)
9987 return Fvector (this_command_key_count
9988 - this_single_command_key_start
,
9989 (XVECTOR (this_command_keys
)->contents
9990 + this_single_command_key_start
));
9993 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9994 Sthis_single_command_raw_keys
, 0, 0, 0,
9995 doc
: /* Return the raw events that were read for this command.
9996 More generally, it returns the last key sequence read, either by
9997 the command loop or by `read-key-sequence'.
9998 Unlike `this-single-command-keys', this function's value
9999 shows the events before all translations (except for input methods).
10000 The value is always a vector. */)
10003 return Fvector (raw_keybuf_count
,
10004 (XVECTOR (raw_keybuf
)->contents
));
10007 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10008 Sreset_this_command_lengths
, 0, 0, 0,
10009 doc
: /* Make the unread events replace the last command and echo.
10010 Used in `universal-argument-other-key'.
10012 `universal-argument-other-key' rereads the event just typed.
10013 It then gets translated through `function-key-map'.
10014 The translated event has to replace the real events,
10015 both in the value of (this-command-keys) and in echoing.
10016 To achieve this, `universal-argument-other-key' calls
10017 `reset-this-command-lengths', which discards the record of reading
10018 these events the first time. */)
10021 this_command_key_count
= before_command_key_count
;
10022 if (this_command_key_count
< this_single_command_key_start
)
10023 this_single_command_key_start
= this_command_key_count
;
10025 echo_truncate (before_command_echo_length
);
10027 /* Cause whatever we put into unread-command-events
10028 to echo as if it were being freshly read from the keyboard. */
10029 this_command_key_count_reset
= 1;
10034 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10035 Sclear_this_command_keys
, 0, 1, 0,
10036 doc
: /* Clear out the vector that `this-command-keys' returns.
10037 Also clear the record of the last 100 events, unless optional arg
10038 KEEP-RECORD is non-nil. */)
10040 Lisp_Object keep_record
;
10044 this_command_key_count
= 0;
10045 this_command_key_count_reset
= 0;
10047 if (NILP (keep_record
))
10049 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10050 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10052 recent_keys_index
= 0;
10057 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10058 doc
: /* Return the current depth in recursive edits. */)
10062 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10066 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10067 "FOpen dribble file: ",
10068 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10069 If FILE is nil, close any open dribble file. */)
10080 file
= Fexpand_file_name (file
, Qnil
);
10081 dribble
= fopen (SDATA (file
), "w");
10083 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10088 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10089 doc
: /* Discard the contents of the terminal input buffer.
10090 Also end any kbd macro being defined. */)
10093 if (!NILP (current_kboard
->defining_kbd_macro
))
10095 /* Discard the last command from the macro. */
10096 Fcancel_kbd_macro_events ();
10100 update_mode_lines
++;
10102 Vunread_command_events
= Qnil
;
10103 unread_command_char
= -1;
10105 discard_tty_input ();
10107 kbd_fetch_ptr
= kbd_store_ptr
;
10113 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10114 doc
: /* Stop Emacs and return to superior process. You can resume later.
10115 If `cannot-suspend' is non-nil, or if the system doesn't support job
10116 control, run a subshell instead.
10118 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10119 to be read as terminal input by Emacs's parent, after suspension.
10121 Before suspending, run the normal hook `suspend-hook'.
10122 After resumption run the normal hook `suspend-resume-hook'.
10124 Some operating systems cannot stop the Emacs process and resume it later.
10125 On such systems, Emacs starts a subshell instead of suspending. */)
10127 Lisp_Object stuffstring
;
10129 int count
= SPECPDL_INDEX ();
10130 int old_height
, old_width
;
10132 struct gcpro gcpro1
;
10134 if (!NILP (stuffstring
))
10135 CHECK_STRING (stuffstring
);
10137 /* Run the functions in suspend-hook. */
10138 if (!NILP (Vrun_hooks
))
10139 call1 (Vrun_hooks
, intern ("suspend-hook"));
10141 GCPRO1 (stuffstring
);
10142 get_frame_size (&old_width
, &old_height
);
10143 reset_sys_modes ();
10144 /* sys_suspend can get an error if it tries to fork a subshell
10145 and the system resources aren't available for that. */
10146 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10148 stuff_buffered_input (stuffstring
);
10149 if (cannot_suspend
)
10153 unbind_to (count
, Qnil
);
10155 /* Check if terminal/window size has changed.
10156 Note that this is not useful when we are running directly
10157 with a window system; but suspend should be disabled in that case. */
10158 get_frame_size (&width
, &height
);
10159 if (width
!= old_width
|| height
!= old_height
)
10160 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10162 /* Run suspend-resume-hook. */
10163 if (!NILP (Vrun_hooks
))
10164 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10170 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10171 Then in any case stuff anything Emacs has read ahead and not used. */
10174 stuff_buffered_input (stuffstring
)
10175 Lisp_Object stuffstring
;
10177 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10178 register unsigned char *p
;
10180 if (STRINGP (stuffstring
))
10182 register int count
;
10184 p
= SDATA (stuffstring
);
10185 count
= SBYTES (stuffstring
);
10186 while (count
-- > 0)
10191 /* Anything we have read ahead, put back for the shell to read. */
10192 /* ?? What should this do when we have multiple keyboards??
10193 Should we ignore anything that was typed in at the "wrong" kboard?
10195 rms: we should stuff everything back into the kboard
10197 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10200 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10201 kbd_fetch_ptr
= kbd_buffer
;
10202 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10203 stuff_char (kbd_fetch_ptr
->code
);
10205 clear_event (kbd_fetch_ptr
);
10209 #endif /* SIGTSTP */
10213 set_waiting_for_input (time_to_clear
)
10214 EMACS_TIME
*time_to_clear
;
10216 input_available_clear_time
= time_to_clear
;
10218 /* Tell interrupt_signal to throw back to read_char, */
10219 waiting_for_input
= 1;
10221 /* If interrupt_signal was called before and buffered a C-g,
10222 make it run again now, to avoid timing error. */
10223 if (!NILP (Vquit_flag
))
10224 quit_throw_to_read_char ();
10228 clear_waiting_for_input ()
10230 /* Tell interrupt_signal not to throw back to read_char, */
10231 waiting_for_input
= 0;
10232 input_available_clear_time
= 0;
10235 /* This routine is called at interrupt level in response to C-g.
10237 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10238 is called from kbd_buffer_store_event, in handling SIGIO or
10241 If `waiting_for_input' is non zero, then unless `echoing' is
10242 nonzero, immediately throw back to read_char.
10244 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10245 eval to throw, when it gets a chance. If quit-flag is already
10246 non-nil, it stops the job right away. */
10249 interrupt_signal (signalnum
) /* If we don't have an argument, */
10250 int signalnum
; /* some compilers complain in signal calls. */
10253 /* Must preserve main program's value of errno. */
10254 int old_errno
= errno
;
10255 struct frame
*sf
= SELECTED_FRAME ();
10257 #if defined (USG) && !defined (POSIX_SIGNALS)
10258 if (!read_socket_hook
&& NILP (Vwindow_system
))
10260 /* USG systems forget handlers when they are used;
10261 must reestablish each time */
10262 signal (SIGINT
, interrupt_signal
);
10263 signal (SIGQUIT
, interrupt_signal
);
10267 SIGNAL_THREAD_CHECK (signalnum
);
10270 if (!NILP (Vquit_flag
)
10271 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10273 /* If SIGINT isn't blocked, don't let us be interrupted by
10274 another SIGINT, it might be harmful due to non-reentrancy
10275 in I/O functions. */
10276 sigblock (sigmask (SIGINT
));
10279 reset_sys_modes ();
10281 #ifdef SIGTSTP /* Support possible in later USG versions */
10283 * On systems which can suspend the current process and return to the original
10284 * shell, this command causes the user to end up back at the shell.
10285 * The "Auto-save" and "Abort" questions are not asked until
10286 * the user elects to return to emacs, at which point he can save the current
10287 * job and either dump core or continue.
10292 if (sys_suspend () == -1)
10294 printf ("Not running as a subprocess;\n");
10295 printf ("you can continue or abort.\n");
10297 #else /* not VMS */
10298 /* Perhaps should really fork an inferior shell?
10299 But that would not provide any way to get back
10300 to the original shell, ever. */
10301 printf ("No support for stopping a process on this operating system;\n");
10302 printf ("you can continue or abort.\n");
10303 #endif /* not VMS */
10304 #endif /* not SIGTSTP */
10306 /* We must remain inside the screen area when the internal terminal
10307 is used. Note that [Enter] is not echoed by dos. */
10310 /* It doesn't work to autosave while GC is in progress;
10311 the code used for auto-saving doesn't cope with the mark bit. */
10312 if (!gc_in_progress
)
10314 printf ("Auto-save? (y or n) ");
10316 if (((c
= getchar ()) & ~040) == 'Y')
10318 Fdo_auto_save (Qt
, Qnil
);
10320 printf ("\r\nAuto-save done");
10321 #else /* not MSDOS */
10322 printf ("Auto-save done\n");
10323 #endif /* not MSDOS */
10325 while (c
!= '\n') c
= getchar ();
10329 /* During GC, it must be safe to reenable quitting again. */
10330 Vinhibit_quit
= Qnil
;
10333 #endif /* not MSDOS */
10334 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10335 printf ("but will instead do a real quit after garbage collection ends\r\n");
10340 printf ("\r\nAbort? (y or n) ");
10341 #else /* not MSDOS */
10343 printf ("Abort (and enter debugger)? (y or n) ");
10344 #else /* not VMS */
10345 printf ("Abort (and dump core)? (y or n) ");
10346 #endif /* not VMS */
10347 #endif /* not MSDOS */
10349 if (((c
= getchar ()) & ~040) == 'Y')
10351 while (c
!= '\n') c
= getchar ();
10353 printf ("\r\nContinuing...\r\n");
10354 #else /* not MSDOS */
10355 printf ("Continuing...\n");
10356 #endif /* not MSDOS */
10363 /* If executing a function that wants to be interrupted out of
10364 and the user has not deferred quitting by binding `inhibit-quit'
10365 then quit right away. */
10366 if (immediate_quit
&& NILP (Vinhibit_quit
))
10368 struct gl_state_s saved
;
10369 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10371 immediate_quit
= 0;
10374 GCPRO4 (saved
.object
, saved
.global_code
,
10375 saved
.current_syntax_table
, saved
.old_prop
);
10376 Fsignal (Qquit
, Qnil
);
10381 /* Else request quit when it's safe */
10385 if (waiting_for_input
&& !echoing
)
10386 quit_throw_to_read_char ();
10391 /* Handle a C-g by making read_char return C-g. */
10394 quit_throw_to_read_char ()
10397 /* Prevent another signal from doing this before we finish. */
10398 clear_waiting_for_input ();
10401 Vunread_command_events
= Qnil
;
10402 unread_command_char
= -1;
10404 #if 0 /* Currently, sit_for is called from read_char without turning
10405 off polling. And that can call set_waiting_for_input.
10406 It seems to be harmless. */
10407 #ifdef POLL_FOR_INPUT
10408 /* May be > 1 if in recursive minibuffer. */
10409 if (poll_suppress_count
== 0)
10413 if (FRAMEP (internal_last_event_frame
)
10414 && !EQ (internal_last_event_frame
, selected_frame
))
10415 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10418 _longjmp (getcjmp
, 1);
10421 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10422 doc
: /* Set mode of reading keyboard input.
10423 First arg INTERRUPT non-nil means use input interrupts;
10424 nil means use CBREAK mode.
10425 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10426 (no effect except in CBREAK mode).
10427 Third arg META t means accept 8-bit input (for a Meta key).
10428 META nil means ignore the top bit, on the assumption it is parity.
10429 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10430 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10431 See also `current-input-mode'. */)
10432 (interrupt
, flow
, meta
, quit
)
10433 Lisp_Object interrupt
, flow
, meta
, quit
;
10436 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10437 error ("set-input-mode: QUIT must be an ASCII character");
10439 #ifdef POLL_FOR_INPUT
10444 /* this causes startup screen to be restored and messes with the mouse */
10445 reset_sys_modes ();
10449 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10450 if (read_socket_hook
)
10452 /* When using X, don't give the user a real choice,
10453 because we haven't implemented the mechanisms to support it. */
10454 #ifdef NO_SOCK_SIGIO
10455 interrupt_input
= 0;
10456 #else /* not NO_SOCK_SIGIO */
10457 interrupt_input
= 1;
10458 #endif /* NO_SOCK_SIGIO */
10461 interrupt_input
= !NILP (interrupt
);
10462 #else /* not SIGIO */
10463 interrupt_input
= 0;
10464 #endif /* not SIGIO */
10466 /* Our VMS input only works by interrupts, as of now. */
10468 interrupt_input
= 1;
10471 flow_control
= !NILP (flow
);
10474 else if (EQ (meta
, Qt
))
10479 /* Don't let this value be out of range. */
10480 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10486 #ifdef POLL_FOR_INPUT
10487 poll_suppress_count
= 1;
10493 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10494 doc
: /* Return information about the way Emacs currently reads keyboard input.
10495 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10496 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10497 nil, Emacs is using CBREAK mode.
10498 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10499 terminal; this does not apply if Emacs uses interrupt-driven input.
10500 META is t if accepting 8-bit input with 8th bit as Meta flag.
10501 META nil means ignoring the top bit, on the assumption it is parity.
10502 META is neither t nor nil if accepting 8-bit input and using
10503 all 8 bits as the character code.
10504 QUIT is the character Emacs currently uses to quit.
10505 The elements of this list correspond to the arguments of
10506 `set-input-mode'. */)
10509 Lisp_Object val
[4];
10511 val
[0] = interrupt_input
? Qt
: Qnil
;
10512 val
[1] = flow_control
? Qt
: Qnil
;
10513 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10514 XSETFASTINT (val
[3], quit_char
);
10516 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10519 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 3, 0,
10520 doc
: /* Return position information for pixel coordinates X and Y.
10521 By default, X and Y are relative to text area of the selected window.
10522 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10524 The return value is similar to a mouse click position:
10525 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10526 IMAGE (DX . DY) (WIDTH . HEIGHT))
10527 The `posn-' functions access elements of such lists. */)
10528 (x
, y
, frame_or_window
)
10529 Lisp_Object x
, y
, frame_or_window
;
10531 if (NILP (frame_or_window
))
10532 frame_or_window
= selected_window
;
10534 if (WINDOWP (frame_or_window
))
10538 CHECK_LIVE_WINDOW (frame_or_window
);
10540 w
= XWINDOW (frame_or_window
);
10541 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10542 + window_box_left_offset (w
, TEXT_AREA
)));
10543 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10544 frame_or_window
= w
->frame
;
10547 CHECK_LIVE_FRAME (frame_or_window
);
10549 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10552 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10553 doc
: /* Return position information for buffer POS in WINDOW.
10554 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10556 Return nil if position is not visible in window. Otherwise,
10557 the return value is similar to that returned by `event-start' for
10558 a mouse click at the upper left corner of the glyph corresponding
10559 to the given buffer position:
10560 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10561 IMAGE (DX . DY) (WIDTH . HEIGHT))
10562 The `posn-' functions access elements of such lists. */)
10564 Lisp_Object pos
, window
;
10568 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10570 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
);
10576 * Set up a new kboard object with reasonable initial values.
10582 kb
->Voverriding_terminal_local_map
= Qnil
;
10583 kb
->Vlast_command
= Qnil
;
10584 kb
->Vreal_last_command
= Qnil
;
10585 kb
->Vprefix_arg
= Qnil
;
10586 kb
->Vlast_prefix_arg
= Qnil
;
10587 kb
->kbd_queue
= Qnil
;
10588 kb
->kbd_queue_has_data
= 0;
10589 kb
->immediate_echo
= 0;
10590 kb
->echo_string
= Qnil
;
10591 kb
->echo_after_prompt
= -1;
10592 kb
->kbd_macro_buffer
= 0;
10593 kb
->kbd_macro_bufsize
= 0;
10594 kb
->defining_kbd_macro
= Qnil
;
10595 kb
->Vlast_kbd_macro
= Qnil
;
10596 kb
->reference_count
= 0;
10597 kb
->Vsystem_key_alist
= Qnil
;
10598 kb
->system_key_syms
= Qnil
;
10599 kb
->Vdefault_minibuffer_frame
= Qnil
;
10603 * Destroy the contents of a kboard object, but not the object itself.
10604 * We use this just before deleting it, or if we're going to initialize
10605 * it a second time.
10611 if (kb
->kbd_macro_buffer
)
10612 xfree (kb
->kbd_macro_buffer
);
10615 #ifdef MULTI_KBOARD
10617 /* Free KB and memory referenced from it. */
10625 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10628 *kbp
= kb
->next_kboard
;
10630 /* Prevent a dangling reference to KB. */
10631 if (kb
== current_kboard
10632 && FRAMEP (selected_frame
)
10633 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10635 current_kboard
= XFRAME (selected_frame
)->kboard
;
10636 if (current_kboard
== kb
)
10644 #endif /* MULTI_KBOARD */
10649 /* This is correct before outermost invocation of the editor loop */
10650 command_loop_level
= -1;
10651 immediate_quit
= 0;
10652 quit_char
= Ctl ('g');
10653 Vunread_command_events
= Qnil
;
10654 unread_command_char
= -1;
10655 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10657 recent_keys_index
= 0;
10658 kbd_fetch_ptr
= kbd_buffer
;
10659 kbd_store_ptr
= kbd_buffer
;
10661 do_mouse_tracking
= Qnil
;
10665 /* This means that command_loop_1 won't try to select anything the first
10667 internal_last_event_frame
= Qnil
;
10668 Vlast_event_frame
= internal_last_event_frame
;
10670 #ifdef MULTI_KBOARD
10671 current_kboard
= initial_kboard
;
10673 wipe_kboard (current_kboard
);
10674 init_kboard (current_kboard
);
10676 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10678 signal (SIGINT
, interrupt_signal
);
10679 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10680 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10681 SIGQUIT and we can't tell which one it will give us. */
10682 signal (SIGQUIT
, interrupt_signal
);
10683 #endif /* HAVE_TERMIO */
10685 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10687 if (!noninteractive
)
10688 signal (SIGIO
, input_available_signal
);
10691 /* Use interrupt input by default, if it works and noninterrupt input
10692 has deficiencies. */
10694 #ifdef INTERRUPT_INPUT
10695 interrupt_input
= 1;
10697 interrupt_input
= 0;
10700 /* Our VMS input only works by interrupts, as of now. */
10702 interrupt_input
= 1;
10708 if (keyboard_init_hook
)
10709 (*keyboard_init_hook
) ();
10711 #ifdef POLL_FOR_INPUT
10712 poll_suppress_count
= 1;
10717 /* At least provide an escape route since C-g doesn't work. */
10718 signal (SIGINT
, interrupt_signal
);
10722 /* This type's only use is in syms_of_keyboard, to initialize the
10723 event header symbols and put properties on them. */
10724 struct event_head
{
10730 struct event_head head_table
[] = {
10731 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10732 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10733 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10734 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10735 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10736 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10737 /* `select-window' should be handled just like `switch-frame'
10738 in read_key_sequence. */
10739 {&Qselect_window
, "select-window", &Qswitch_frame
}
10743 syms_of_keyboard ()
10745 Vpre_help_message
= Qnil
;
10746 staticpro (&Vpre_help_message
);
10748 Vlispy_mouse_stem
= build_string ("mouse");
10749 staticpro (&Vlispy_mouse_stem
);
10752 QCimage
= intern (":image");
10753 staticpro (&QCimage
);
10755 staticpro (&Qhelp_echo
);
10756 Qhelp_echo
= intern ("help-echo");
10758 staticpro (&item_properties
);
10759 item_properties
= Qnil
;
10761 staticpro (&tool_bar_item_properties
);
10762 tool_bar_item_properties
= Qnil
;
10763 staticpro (&tool_bar_items_vector
);
10764 tool_bar_items_vector
= Qnil
;
10766 staticpro (&real_this_command
);
10767 real_this_command
= Qnil
;
10769 Qtimer_event_handler
= intern ("timer-event-handler");
10770 staticpro (&Qtimer_event_handler
);
10772 Qdisabled_command_function
= intern ("disabled-command-function");
10773 staticpro (&Qdisabled_command_function
);
10775 Qself_insert_command
= intern ("self-insert-command");
10776 staticpro (&Qself_insert_command
);
10778 Qforward_char
= intern ("forward-char");
10779 staticpro (&Qforward_char
);
10781 Qbackward_char
= intern ("backward-char");
10782 staticpro (&Qbackward_char
);
10784 Qdisabled
= intern ("disabled");
10785 staticpro (&Qdisabled
);
10787 Qundefined
= intern ("undefined");
10788 staticpro (&Qundefined
);
10790 Qpre_command_hook
= intern ("pre-command-hook");
10791 staticpro (&Qpre_command_hook
);
10793 Qpost_command_hook
= intern ("post-command-hook");
10794 staticpro (&Qpost_command_hook
);
10796 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10797 staticpro (&Qpost_command_idle_hook
);
10799 Qdeferred_action_function
= intern ("deferred-action-function");
10800 staticpro (&Qdeferred_action_function
);
10802 Qcommand_hook_internal
= intern ("command-hook-internal");
10803 staticpro (&Qcommand_hook_internal
);
10805 Qfunction_key
= intern ("function-key");
10806 staticpro (&Qfunction_key
);
10807 Qmouse_click
= intern ("mouse-click");
10808 staticpro (&Qmouse_click
);
10810 Qlanguage_change
= intern ("language-change");
10811 staticpro (&Qlanguage_change
);
10813 Qdrag_n_drop
= intern ("drag-n-drop");
10814 staticpro (&Qdrag_n_drop
);
10816 Qsave_session
= intern ("save-session");
10817 staticpro(&Qsave_session
);
10819 Qusr1_signal
= intern ("usr1-signal");
10820 staticpro (&Qusr1_signal
);
10821 Qusr2_signal
= intern ("usr2-signal");
10822 staticpro (&Qusr2_signal
);
10824 Qmenu_enable
= intern ("menu-enable");
10825 staticpro (&Qmenu_enable
);
10826 Qmenu_alias
= intern ("menu-alias");
10827 staticpro (&Qmenu_alias
);
10828 QCenable
= intern (":enable");
10829 staticpro (&QCenable
);
10830 QCvisible
= intern (":visible");
10831 staticpro (&QCvisible
);
10832 QChelp
= intern (":help");
10833 staticpro (&QChelp
);
10834 QCfilter
= intern (":filter");
10835 staticpro (&QCfilter
);
10836 QCbutton
= intern (":button");
10837 staticpro (&QCbutton
);
10838 QCkeys
= intern (":keys");
10839 staticpro (&QCkeys
);
10840 QCkey_sequence
= intern (":key-sequence");
10841 staticpro (&QCkey_sequence
);
10842 QCtoggle
= intern (":toggle");
10843 staticpro (&QCtoggle
);
10844 QCradio
= intern (":radio");
10845 staticpro (&QCradio
);
10847 Qmode_line
= intern ("mode-line");
10848 staticpro (&Qmode_line
);
10849 Qvertical_line
= intern ("vertical-line");
10850 staticpro (&Qvertical_line
);
10851 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10852 staticpro (&Qvertical_scroll_bar
);
10853 Qmenu_bar
= intern ("menu-bar");
10854 staticpro (&Qmenu_bar
);
10856 Qabove_handle
= intern ("above-handle");
10857 staticpro (&Qabove_handle
);
10858 Qhandle
= intern ("handle");
10859 staticpro (&Qhandle
);
10860 Qbelow_handle
= intern ("below-handle");
10861 staticpro (&Qbelow_handle
);
10862 Qup
= intern ("up");
10864 Qdown
= intern ("down");
10865 staticpro (&Qdown
);
10866 Qtop
= intern ("top");
10868 Qbottom
= intern ("bottom");
10869 staticpro (&Qbottom
);
10870 Qend_scroll
= intern ("end-scroll");
10871 staticpro (&Qend_scroll
);
10872 Qratio
= intern ("ratio");
10873 staticpro (&Qratio
);
10875 Qevent_kind
= intern ("event-kind");
10876 staticpro (&Qevent_kind
);
10877 Qevent_symbol_elements
= intern ("event-symbol-elements");
10878 staticpro (&Qevent_symbol_elements
);
10879 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10880 staticpro (&Qevent_symbol_element_mask
);
10881 Qmodifier_cache
= intern ("modifier-cache");
10882 staticpro (&Qmodifier_cache
);
10884 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10885 staticpro (&Qrecompute_lucid_menubar
);
10886 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10887 staticpro (&Qactivate_menubar_hook
);
10889 Qpolling_period
= intern ("polling-period");
10890 staticpro (&Qpolling_period
);
10892 Qinput_method_function
= intern ("input-method-function");
10893 staticpro (&Qinput_method_function
);
10895 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10896 staticpro (&Qinput_method_exit_on_first_char
);
10897 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10898 staticpro (&Qinput_method_use_echo_area
);
10900 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10901 Fset (Qinput_method_use_echo_area
, Qnil
);
10903 last_point_position_buffer
= Qnil
;
10906 struct event_head
*p
;
10908 for (p
= head_table
;
10909 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10912 *p
->var
= intern (p
->name
);
10913 staticpro (p
->var
);
10914 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10915 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10919 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10920 staticpro (&button_down_location
);
10921 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10922 staticpro (&mouse_syms
);
10923 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10924 staticpro (&wheel_syms
);
10928 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10930 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10931 for (i
= 0; i
< len
; i
++)
10932 if (modifier_names
[i
])
10933 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10934 staticpro (&modifier_symbols
);
10937 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10938 staticpro (&recent_keys
);
10940 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10941 staticpro (&this_command_keys
);
10943 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10944 staticpro (&raw_keybuf
);
10946 Qextended_command_history
= intern ("extended-command-history");
10947 Fset (Qextended_command_history
, Qnil
);
10948 staticpro (&Qextended_command_history
);
10950 accent_key_syms
= Qnil
;
10951 staticpro (&accent_key_syms
);
10953 func_key_syms
= Qnil
;
10954 staticpro (&func_key_syms
);
10956 drag_n_drop_syms
= Qnil
;
10957 staticpro (&drag_n_drop_syms
);
10959 unread_switch_frame
= Qnil
;
10960 staticpro (&unread_switch_frame
);
10962 internal_last_event_frame
= Qnil
;
10963 staticpro (&internal_last_event_frame
);
10965 read_key_sequence_cmd
= Qnil
;
10966 staticpro (&read_key_sequence_cmd
);
10968 menu_bar_one_keymap_changed_items
= Qnil
;
10969 staticpro (&menu_bar_one_keymap_changed_items
);
10971 defsubr (&Sevent_convert_list
);
10972 defsubr (&Sread_key_sequence
);
10973 defsubr (&Sread_key_sequence_vector
);
10974 defsubr (&Srecursive_edit
);
10976 defsubr (&Strack_mouse
);
10978 defsubr (&Sinput_pending_p
);
10979 defsubr (&Scommand_execute
);
10980 defsubr (&Srecent_keys
);
10981 defsubr (&Sthis_command_keys
);
10982 defsubr (&Sthis_command_keys_vector
);
10983 defsubr (&Sthis_single_command_keys
);
10984 defsubr (&Sthis_single_command_raw_keys
);
10985 defsubr (&Sreset_this_command_lengths
);
10986 defsubr (&Sclear_this_command_keys
);
10987 defsubr (&Ssuspend_emacs
);
10988 defsubr (&Sabort_recursive_edit
);
10989 defsubr (&Sexit_recursive_edit
);
10990 defsubr (&Srecursion_depth
);
10991 defsubr (&Stop_level
);
10992 defsubr (&Sdiscard_input
);
10993 defsubr (&Sopen_dribble_file
);
10994 defsubr (&Sset_input_mode
);
10995 defsubr (&Scurrent_input_mode
);
10996 defsubr (&Sexecute_extended_command
);
10997 defsubr (&Sposn_at_point
);
10998 defsubr (&Sposn_at_x_y
);
11000 DEFVAR_LISP ("last-command-char", &last_command_char
,
11001 doc
: /* Last input event that was part of a command. */);
11003 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11004 doc
: /* Last input event that was part of a command. */);
11006 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11007 doc
: /* Last input event in a command, except for mouse menu events.
11008 Mouse menus give back keys that don't look like mouse events;
11009 this variable holds the actual mouse event that led to the menu,
11010 so that you can determine whether the command was run by mouse or not. */);
11012 DEFVAR_LISP ("last-input-char", &last_input_char
,
11013 doc
: /* Last input event. */);
11015 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11016 doc
: /* Last input event. */);
11018 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11019 doc
: /* List of events to be read as the command input.
11020 These events are processed first, before actual keyboard input. */);
11021 Vunread_command_events
= Qnil
;
11023 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11024 doc
: /* If not -1, an object to be read as next command input event. */);
11026 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11027 doc
: /* List of events to be processed as input by input methods.
11028 These events are processed after `unread-command-events', but
11029 before actual keyboard input. */);
11030 Vunread_post_input_method_events
= Qnil
;
11032 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11033 doc
: /* List of events to be processed as input by input methods.
11034 These events are processed after `unread-command-events', but
11035 before actual keyboard input. */);
11036 Vunread_input_method_events
= Qnil
;
11038 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11039 doc
: /* Meta-prefix character code.
11040 Meta-foo as command input turns into this character followed by foo. */);
11041 XSETINT (meta_prefix_char
, 033);
11043 DEFVAR_KBOARD ("last-command", Vlast_command
,
11044 doc
: /* The last command executed.
11045 Normally a symbol with a function definition, but can be whatever was found
11046 in the keymap, or whatever the variable `this-command' was set to by that
11049 The value `mode-exit' is special; it means that the previous command
11050 read an event that told it to exit, and it did so and unread that event.
11051 In other words, the present command is the event that made the previous
11054 The value `kill-region' is special; it means that the previous command
11055 was a kill command. */);
11057 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11058 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11060 DEFVAR_LISP ("this-command", &Vthis_command
,
11061 doc
: /* The command now being executed.
11062 The command can set this variable; whatever is put here
11063 will be in `last-command' during the following command. */);
11064 Vthis_command
= Qnil
;
11066 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11067 doc
: /* The command bound to the current key sequence before remapping.
11068 It equals `this-command' if the original command was not remapped through
11069 any of the active keymaps. Otherwise, the value of `this-command' is the
11070 result of looking up the original command in the active keymaps. */);
11071 Vthis_original_command
= Qnil
;
11073 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11074 doc
: /* *Number of input events between auto-saves.
11075 Zero means disable autosaving due to number of characters typed. */);
11076 auto_save_interval
= 300;
11078 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11079 doc
: /* *Number of seconds idle time before auto-save.
11080 Zero or nil means disable auto-saving due to idleness.
11081 After auto-saving due to this many seconds of idle time,
11082 Emacs also does a garbage collection if that seems to be warranted. */);
11083 XSETFASTINT (Vauto_save_timeout
, 30);
11085 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11086 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11087 The value may be integer or floating point. */);
11088 Vecho_keystrokes
= make_number (1);
11090 DEFVAR_INT ("polling-period", &polling_period
,
11091 doc
: /* *Interval between polling for input during Lisp execution.
11092 The reason for polling is to make C-g work to stop a running program.
11093 Polling is needed only when using X windows and SIGIO does not work.
11094 Polling is automatically disabled in all other cases. */);
11095 polling_period
= 2;
11097 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11098 doc
: /* *Maximum time between mouse clicks to make a double-click.
11099 Measured in milliseconds. nil means disable double-click recognition;
11100 t means double-clicks have no time limit and are detected
11101 by position only. */);
11102 Vdouble_click_time
= make_number (500);
11104 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11105 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11106 On window-system frames, value is the number of pixels the mouse may have
11107 moved horizontally or vertically between two clicks to make a double-click.
11108 On non window-system frames, value is interpreted in units of 1/8 characters
11111 This variable is also the threshold for motion of the mouse
11112 to count as a drag. */);
11113 double_click_fuzz
= 3;
11115 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11116 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11117 inhibit_local_menu_bar_menus
= 0;
11119 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11120 doc
: /* Number of complete key sequences read as input so far.
11121 This includes key sequences read from keyboard macros.
11122 The number is effectively the number of interactive command invocations. */);
11123 num_input_keys
= 0;
11125 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11126 doc
: /* Number of input events read from the keyboard so far.
11127 This does not include events generated by keyboard macros. */);
11128 num_nonmacro_input_events
= 0;
11130 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11131 doc
: /* The frame in which the most recently read event occurred.
11132 If the last event came from a keyboard macro, this is set to `macro'. */);
11133 Vlast_event_frame
= Qnil
;
11135 /* This variable is set up in sysdep.c. */
11136 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11137 doc
: /* The ERASE character as set by the user with stty. */);
11139 DEFVAR_LISP ("help-char", &Vhelp_char
,
11140 doc
: /* Character to recognize as meaning Help.
11141 When it is read, do `(eval help-form)', and display result if it's a string.
11142 If the value of `help-form' is nil, this char can be read normally. */);
11143 XSETINT (Vhelp_char
, Ctl ('H'));
11145 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11146 doc
: /* List of input events to recognize as meaning Help.
11147 These work just like the value of `help-char' (see that). */);
11148 Vhelp_event_list
= Qnil
;
11150 DEFVAR_LISP ("help-form", &Vhelp_form
,
11151 doc
: /* Form to execute when character `help-char' is read.
11152 If the form returns a string, that string is displayed.
11153 If `help-form' is nil, the help char is not recognized. */);
11156 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11157 doc
: /* Command to run when `help-char' character follows a prefix key.
11158 This command is used only when there is no actual binding
11159 for that character after that prefix key. */);
11160 Vprefix_help_command
= Qnil
;
11162 DEFVAR_LISP ("top-level", &Vtop_level
,
11163 doc
: /* Form to evaluate when Emacs starts up.
11164 Useful to set before you dump a modified Emacs. */);
11167 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11168 doc
: /* Translate table for keyboard input, or nil.
11169 If non-nil, the value should be a char-table. Each character read
11170 from the keyboard is looked up in this char-table. If the value found
11171 there is non-nil, then it is used instead of the actual input character.
11173 The value can also be a string or vector, but this is considered obsolete.
11174 If it is a string or vector of length N, character codes N and up are left
11175 untranslated. In a vector, an element which is nil means "no translation".
11177 This is applied to the characters supplied to input methods, not their
11178 output. See also `translation-table-for-input'. */);
11179 Vkeyboard_translate_table
= Qnil
;
11181 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11182 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11183 \(Even if the operating system has support for stopping a process.\) */);
11184 cannot_suspend
= 0;
11186 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11187 doc
: /* Non-nil means prompt with menus when appropriate.
11188 This is done when reading from a keymap that has a prompt string,
11189 for elements that have prompt strings.
11190 The menu is displayed on the screen
11191 if X menus were enabled at configuration
11192 time and the previous event was a mouse click prefix key.
11193 Otherwise, menu prompting uses the echo area. */);
11194 menu_prompting
= 1;
11196 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11197 doc
: /* Character to see next line of menu prompt.
11198 Type this character while in a menu prompt to rotate around the lines of it. */);
11199 XSETINT (menu_prompt_more_char
, ' ');
11201 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11202 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11203 Emacs applies the modifiers of the character stored here to each keyboard
11204 character it reads. For example, after evaluating the expression
11205 (setq extra-keyboard-modifiers ?\\C-x)
11206 all input characters will have the control modifier applied to them.
11208 Note that the character ?\\C-@, equivalent to the integer zero, does
11209 not count as a control character; rather, it counts as a character
11210 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11211 cancels any modification. */);
11212 extra_keyboard_modifiers
= 0;
11214 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11215 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11216 The command loop sets this to nil before each command,
11217 and tests the value when the command returns.
11218 Buffer modification stores t in this variable. */);
11219 Vdeactivate_mark
= Qnil
;
11221 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11222 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11223 Vcommand_hook_internal
= Qnil
;
11225 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11226 doc
: /* Normal hook run before each command is executed.
11227 If an unhandled error happens in running this hook,
11228 the hook value is set to nil, since otherwise the error
11229 might happen repeatedly and make Emacs nonfunctional. */);
11230 Vpre_command_hook
= Qnil
;
11232 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11233 doc
: /* Normal hook run after each command is executed.
11234 If an unhandled error happens in running this hook,
11235 the hook value is set to nil, since otherwise the error
11236 might happen repeatedly and make Emacs nonfunctional. */);
11237 Vpost_command_hook
= Qnil
;
11239 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11240 doc
: /* Normal hook run after each command is executed, if idle.
11241 Errors running the hook are caught and ignored. */);
11242 Vpost_command_idle_hook
= Qnil
;
11244 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11245 doc
: /* Delay time before running `post-command-idle-hook'.
11246 This is measured in microseconds. */);
11247 post_command_idle_delay
= 100000;
11250 DEFVAR_LISP ("echo-area-clear-hook", ...,
11251 doc
: /* Normal hook run when clearing the echo area. */);
11253 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11254 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11256 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11257 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11258 Vlucid_menu_bar_dirty_flag
= Qnil
;
11260 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11261 doc
: /* List of menu bar items to move to the end of the menu bar.
11262 The elements of the list are event types that may have menu bar bindings. */);
11263 Vmenu_bar_final_items
= Qnil
;
11265 DEFVAR_KBOARD ("overriding-terminal-local-map",
11266 Voverriding_terminal_local_map
,
11267 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11268 If this variable is non-nil, it is used as a keymap instead of the
11269 buffer's local map, and the minor mode keymaps and text property keymaps.
11270 It also overrides `overriding-local-map'.
11271 This variable is intended to let commands such as `universal-argument'
11272 set up a different keymap for reading the next command. */);
11274 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11275 doc
: /* 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 Voverriding_local_map
= Qnil
;
11280 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11281 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11282 Otherwise, the menu bar continues to reflect the buffer's local map
11283 and the minor mode maps regardless of `overriding-local-map'. */);
11284 Voverriding_local_map_menu_flag
= Qnil
;
11286 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11287 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11288 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11290 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11291 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11293 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11294 doc
: /* Alist of system-specific X windows key symbols.
11295 Each element should have the form (N . SYMBOL) where N is the
11296 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11297 and SYMBOL is its name. */);
11299 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11300 doc
: /* List of deferred actions to be performed at a later time.
11301 The precise format isn't relevant here; we just check whether it is nil. */);
11302 Vdeferred_action_list
= Qnil
;
11304 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11305 doc
: /* Function to call to handle deferred actions, after each command.
11306 This function is called with no arguments after each command
11307 whenever `deferred-action-list' is non-nil. */);
11308 Vdeferred_action_function
= Qnil
;
11310 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11311 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11312 The value can be a length of time to show the message for.
11313 If the value is non-nil and not a number, we wait 2 seconds. */);
11314 Vsuggest_key_bindings
= Qt
;
11316 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11317 doc
: /* List of active absolute time timers in order of increasing time. */);
11318 Vtimer_list
= Qnil
;
11320 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11321 doc
: /* List of active idle-time timers in order of increasing time. */);
11322 Vtimer_idle_list
= Qnil
;
11324 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11325 doc
: /* If non-nil, the function that implements the current input method.
11326 It's called with one argument, a printing character that was just read.
11327 \(That means a character with code 040...0176.)
11328 Typically this function uses `read-event' to read additional events.
11329 When it does so, it should first bind `input-method-function' to nil
11330 so it will not be called recursively.
11332 The function should return a list of zero or more events
11333 to be used as input. If it wants to put back some events
11334 to be reconsidered, separately, by the input method,
11335 it can add them to the beginning of `unread-command-events'.
11337 The input method function can find in `input-method-previous-method'
11338 the previous echo area message.
11340 The input method function should refer to the variables
11341 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11342 for guidance on what to do. */);
11343 Vinput_method_function
= Qnil
;
11345 DEFVAR_LISP ("input-method-previous-message",
11346 &Vinput_method_previous_message
,
11347 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11348 This variable exists because `read-event' clears the echo area
11349 before running the input method. It is nil if there was no message. */);
11350 Vinput_method_previous_message
= Qnil
;
11352 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11353 doc
: /* If non-nil, the function that implements the display of help.
11354 It's called with one argument, the help string to display. */);
11355 Vshow_help_function
= Qnil
;
11357 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11358 doc
: /* If non-nil, suppress point adjustment after executing a command.
11360 After a command is executed, if point is moved into a region that has
11361 special properties (e.g. composition, display), we adjust point to
11362 the boundary of the region. But, when a command sets this variable to
11363 non-nil, we suppress the point adjustment.
11365 This variable is set to nil before reading a command, and is checked
11366 just after executing the command. */);
11367 Vdisable_point_adjustment
= Qnil
;
11369 DEFVAR_LISP ("global-disable-point-adjustment",
11370 &Vglobal_disable_point_adjustment
,
11371 doc
: /* *If non-nil, always suppress point adjustment.
11373 The default value is nil, in which case, point adjustment are
11374 suppressed only after special commands that set
11375 `disable-point-adjustment' (which see) to non-nil. */);
11376 Vglobal_disable_point_adjustment
= Qnil
;
11378 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11379 doc
: /* Non-nil means updating menu bindings is allowed.
11380 A value of nil means menu bindings should not be updated.
11381 Used during Emacs' startup. */);
11382 update_menu_bindings
= 1;
11384 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11385 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11386 If the value is not a number, such messages don't time out. */);
11387 Vminibuffer_message_timeout
= make_number (2);
11389 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11390 doc
: /* If non-nil, any keyboard input throws to this symbol.
11391 The value of that variable is passed to `quit-flag' and later causes a
11392 peculiar kind of quitting. */);
11393 Vthrow_on_input
= Qnil
;
11397 keys_of_keyboard ()
11399 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11400 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11401 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11402 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11403 initial_define_key (meta_map
, 'x', "execute-extended-command");
11405 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11406 "handle-delete-frame");
11407 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11409 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11411 /* Handling it at such a low-level causes read_key_sequence to get
11412 * confused because it doesn't realize that the current_buffer was
11413 * changed by read_char.
11415 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11416 * "handle-select-window"); */
11417 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11418 "handle-save-session");
11421 /* Mark the pointers in the kboard objects.
11422 Called by the Fgarbage_collector. */
11428 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11430 if (kb
->kbd_macro_buffer
)
11431 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11433 mark_object (kb
->Voverriding_terminal_local_map
);
11434 mark_object (kb
->Vlast_command
);
11435 mark_object (kb
->Vreal_last_command
);
11436 mark_object (kb
->Vprefix_arg
);
11437 mark_object (kb
->Vlast_prefix_arg
);
11438 mark_object (kb
->kbd_queue
);
11439 mark_object (kb
->defining_kbd_macro
);
11440 mark_object (kb
->Vlast_kbd_macro
);
11441 mark_object (kb
->Vsystem_key_alist
);
11442 mark_object (kb
->system_key_syms
);
11443 mark_object (kb
->Vdefault_minibuffer_frame
);
11444 mark_object (kb
->echo_string
);
11447 struct input_event
*event
;
11448 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11450 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11451 event
= kbd_buffer
;
11452 if (event
->kind
!= SELECTION_REQUEST_EVENT
11453 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11455 mark_object (event
->x
);
11456 mark_object (event
->y
);
11458 mark_object (event
->frame_or_window
);
11459 mark_object (event
->arg
);
11464 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11465 (do not change this comment) */