1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995, 1996, 1997,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
29 #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"
62 #include <sys/types.h>
71 /* This is to get the definitions of the XK_ symbols. */
78 #endif /* HAVE_NTGUI */
88 /* Variables for blockinput.h: */
90 /* Non-zero if interrupt input is blocked right now. */
91 int interrupt_input_blocked
;
93 /* Nonzero means an input interrupt has arrived
94 during the current critical section. */
95 int interrupt_input_pending
;
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 /* Non-zero means force key bindings update in parse_menu_item. */
474 int update_menu_bindings
;
476 extern char *pending_malloc_warning
;
478 /* Circular buffer for pre-read keyboard input. */
480 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
482 /* Pointer to next available character in kbd_buffer.
483 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
484 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
485 next available char is in kbd_buffer[0]. */
486 static struct input_event
*kbd_fetch_ptr
;
488 /* Pointer to next place to store character in kbd_buffer. This
489 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
490 character should go in kbd_buffer[0]. */
491 static struct input_event
* volatile kbd_store_ptr
;
493 /* The above pair of variables forms a "queue empty" flag. When we
494 enqueue a non-hook event, we increment kbd_store_ptr. When we
495 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
496 there is input available iff the two pointers are not equal.
498 Why not just have a flag set and cleared by the enqueuing and
499 dequeuing functions? Such a flag could be screwed up by interrupts
500 at inopportune times. */
502 /* If this flag is non-nil, we check mouse_moved to see when the
503 mouse moves, and motion events will appear in the input stream.
504 Otherwise, mouse motion is ignored. */
505 Lisp_Object do_mouse_tracking
;
507 /* Symbols to head events. */
508 Lisp_Object Qmouse_movement
;
509 Lisp_Object Qscroll_bar_movement
;
510 Lisp_Object Qswitch_frame
;
511 Lisp_Object Qdelete_frame
;
512 Lisp_Object Qiconify_frame
;
513 Lisp_Object Qmake_frame_visible
;
514 Lisp_Object Qselect_window
;
515 Lisp_Object Qhelp_echo
;
518 Lisp_Object Qmouse_fixup_help_message
;
521 /* Symbols to denote kinds of events. */
522 Lisp_Object Qfunction_key
;
523 Lisp_Object Qmouse_click
;
524 #if defined (WINDOWSNT) || defined (MAC_OS)
525 Lisp_Object Qlanguage_change
;
527 Lisp_Object Qdrag_n_drop
;
528 Lisp_Object Qsave_session
;
530 /* Lisp_Object Qmouse_movement; - also an event header */
532 /* Properties of event headers. */
533 Lisp_Object Qevent_kind
;
534 Lisp_Object Qevent_symbol_elements
;
536 /* menu item parts */
537 Lisp_Object Qmenu_alias
;
538 Lisp_Object Qmenu_enable
;
539 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
540 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
541 extern Lisp_Object Vdefine_key_rebound_commands
;
542 extern Lisp_Object Qmenu_item
;
544 /* An event header symbol HEAD may have a property named
545 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
546 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
547 mask of modifiers applied to it. If present, this is used to help
548 speed up parse_modifiers. */
549 Lisp_Object Qevent_symbol_element_mask
;
551 /* An unmodified event header BASE may have a property named
552 Qmodifier_cache, which is an alist mapping modifier masks onto
553 modified versions of BASE. If present, this helps speed up
555 Lisp_Object Qmodifier_cache
;
557 /* Symbols to use for parts of windows. */
558 Lisp_Object Qmode_line
;
559 Lisp_Object Qvertical_line
;
560 Lisp_Object Qvertical_scroll_bar
;
561 Lisp_Object Qmenu_bar
;
562 extern Lisp_Object Qleft_margin
, Qright_margin
;
563 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
564 extern Lisp_Object QCmap
;
566 Lisp_Object
recursive_edit_unwind (), command_loop ();
567 Lisp_Object
Fthis_command_keys ();
568 Lisp_Object Qextended_command_history
;
569 EMACS_TIME
timer_check ();
571 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
573 extern char *x_get_keysym_name ();
575 static void record_menu_key ();
576 static int echo_length ();
578 Lisp_Object Qpolling_period
;
580 /* List of absolute timers. Appears in order of next scheduled event. */
581 Lisp_Object Vtimer_list
;
583 /* List of idle time timers. Appears in order of next scheduled event. */
584 Lisp_Object Vtimer_idle_list
;
586 /* Incremented whenever a timer is run. */
589 extern Lisp_Object Vprint_level
, Vprint_length
;
591 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
593 EMACS_TIME
*input_available_clear_time
;
595 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
596 Default is 1 if INTERRUPT_INPUT is defined. */
599 /* Nonzero while interrupts are temporarily deferred during redisplay. */
600 int interrupts_deferred
;
602 /* Allow m- file to inhibit use of FIONREAD. */
603 #ifdef BROKEN_FIONREAD
607 /* We are unable to use interrupts if FIONREAD is not available,
608 so flush SIGIO so we won't try. */
609 #if !defined (FIONREAD)
615 /* If we support a window system, turn on the code to poll periodically
616 to detect C-g. It isn't actually used when doing interrupt input. */
617 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
618 #define POLL_FOR_INPUT
621 /* After a command is executed, if point is moved into a region that
622 has specific properties (e.g. composition, display), we adjust
623 point to the boundary of the region. But, if a command sets this
624 variable to non-nil, we suppress this point adjustment. This
625 variable is set to nil before reading a command. */
627 Lisp_Object Vdisable_point_adjustment
;
629 /* If non-nil, always disable point adjustment. */
631 Lisp_Object Vglobal_disable_point_adjustment
;
633 /* The time when Emacs started being idle. */
635 static EMACS_TIME timer_idleness_start_time
;
637 /* After Emacs stops being idle, this saves the last value
638 of timer_idleness_start_time from when it was idle. */
640 static EMACS_TIME timer_last_idleness_start_time
;
643 /* Global variable declarations. */
645 /* Flags for readable_events. */
646 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
647 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
648 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
650 /* Function for init_keyboard to call with no args (if nonzero). */
651 void (*keyboard_init_hook
) ();
653 static int read_avail_input
P_ ((int));
654 static void get_input_pending
P_ ((int *, int));
655 static int readable_events
P_ ((int));
656 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
657 Lisp_Object
, int *));
658 static Lisp_Object
read_char_x_menu_prompt ();
659 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
661 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
663 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
664 enum scroll_bar_part
,
665 Lisp_Object
, Lisp_Object
,
668 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
669 Lisp_Object
, char **,
670 Lisp_Object
*, unsigned));
671 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
672 static int parse_solitary_modifier
P_ ((Lisp_Object
));
673 static int parse_solitary_modifier ();
674 static void save_getcjmp
P_ ((jmp_buf));
675 static void save_getcjmp ();
676 static void restore_getcjmp
P_ ((jmp_buf));
677 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
678 static void clear_event
P_ ((struct input_event
*));
679 static void any_kboard_state
P_ ((void));
680 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
681 static void handle_interrupt
P_ ((void));
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_kbd_macro
))
1167 if (executing_kbd_macro_iterations
== 1)
1168 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1170 sprintf (macroerror
, "After %d kbd macro iterations: ",
1171 executing_kbd_macro_iterations
);
1176 Vstandard_output
= Qt
;
1177 Vstandard_input
= Qt
;
1178 Vexecuting_kbd_macro
= Qnil
;
1179 executing_kbd_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 || FRAME_INITIAL_P (sf
)
1232 stream
= Qexternal_debugging_output
;
1238 message_log_maybe_newline ();
1243 /* The immediate context is not interesting for Quits,
1244 since they are asyncronous. */
1245 if (EQ (XCAR (data
), Qquit
))
1246 Vsignaling_function
= Qnil
;
1248 print_error_message (data
, stream
, context
, Vsignaling_function
);
1250 Vsignaling_function
= Qnil
;
1252 /* If the window system or terminal frame hasn't been initialized
1253 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1257 Fkill_emacs (make_number (-1));
1261 Lisp_Object
command_loop_1 ();
1262 Lisp_Object
command_loop_2 ();
1263 Lisp_Object
top_level_1 ();
1265 /* Entry to editor-command-loop.
1266 This level has the catches for exiting/returning to editor command loop.
1267 It returns nil to exit recursive edit, t to abort it. */
1272 if (command_loop_level
> 0 || minibuf_level
> 0)
1275 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1276 executing_kbd_macro
= Qnil
;
1282 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1283 /* Reset single_kboard in case top-level set it while
1284 evaluating an -f option, or we are stuck there for some
1286 any_kboard_state ();
1287 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1288 executing_kbd_macro
= Qnil
;
1290 /* End of file in -batch run causes exit here. */
1296 /* Here we catch errors in execution of commands within the
1297 editing loop, and reenter the editing loop.
1298 When there is an error, cmd_error runs and returns a non-nil
1299 value to us. A value of nil means that command_loop_1 itself
1300 returned due to end of file (or end of kbd macro). */
1305 register Lisp_Object val
;
1308 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1309 while (!NILP (val
));
1317 return Feval (Vtop_level
);
1323 /* On entry to the outer level, run the startup file */
1324 if (!NILP (Vtop_level
))
1325 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1326 else if (!NILP (Vpurify_flag
))
1327 message ("Bare impure Emacs (standard Lisp code not loaded)");
1329 message ("Bare Emacs (standard Lisp code not loaded)");
1333 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1334 doc
: /* Exit all recursive editing levels. */)
1337 #ifdef HAVE_X_WINDOWS
1338 if (display_hourglass_p
)
1339 cancel_hourglass ();
1342 /* Unblock input if we enter with input blocked. This may happen if
1343 redisplay traps e.g. during tool-bar update with input blocked. */
1344 while (INPUT_BLOCKED_P
)
1347 return Fthrow (Qtop_level
, Qnil
);
1350 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1351 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1354 if (command_loop_level
> 0 || minibuf_level
> 0)
1355 Fthrow (Qexit
, Qnil
);
1357 error ("No recursive edit is in progress");
1361 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1362 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1365 if (command_loop_level
> 0 || minibuf_level
> 0)
1368 error ("No recursive edit is in progress");
1372 /* This is the actual command reading loop,
1373 sans error-handling encapsulation. */
1375 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1377 void safe_run_hooks
P_ ((Lisp_Object
));
1378 static void adjust_point_for_property
P_ ((int, int));
1380 /* Cancel hourglass from protect_unwind.
1382 #ifdef HAVE_X_WINDOWS
1384 cancel_hourglass_unwind (arg
)
1387 cancel_hourglass ();
1398 Lisp_Object keybuf
[30];
1401 int prev_modiff
= 0;
1402 struct buffer
*prev_buffer
= NULL
;
1404 int was_locked
= single_kboard
;
1406 int already_adjusted
= 0;
1408 current_kboard
->Vprefix_arg
= Qnil
;
1409 current_kboard
->Vlast_prefix_arg
= Qnil
;
1410 Vdeactivate_mark
= Qnil
;
1411 waiting_for_input
= 0;
1415 this_command_key_count
= 0;
1416 this_command_key_count_reset
= 0;
1417 this_single_command_key_start
= 0;
1419 if (NILP (Vmemory_full
))
1421 /* Make sure this hook runs after commands that get errors and
1422 throw to top level. */
1423 /* Note that the value cell will never directly contain nil
1424 if the symbol is a local variable. */
1425 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1426 safe_run_hooks (Qpost_command_hook
);
1428 /* If displaying a message, resize the echo area window to fit
1429 that message's size exactly. */
1430 if (!NILP (echo_area_buffer
[0]))
1431 resize_echo_area_exactly ();
1433 if (!NILP (Vdeferred_action_list
))
1434 safe_run_hooks (Qdeferred_action_function
);
1436 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1438 if (NILP (Vunread_command_events
)
1439 && NILP (Vunread_input_method_events
)
1440 && NILP (Vunread_post_input_method_events
)
1441 && NILP (Vexecuting_kbd_macro
)
1442 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1443 safe_run_hooks (Qpost_command_idle_hook
);
1447 Vmemory_full
= Qnil
;
1449 /* Do this after running Vpost_command_hook, for consistency. */
1450 current_kboard
->Vlast_command
= Vthis_command
;
1451 current_kboard
->Vreal_last_command
= real_this_command
;
1455 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1458 /* Make sure the current window's buffer is selected. */
1459 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1460 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1462 /* Display any malloc warning that just came out. Use while because
1463 displaying one warning can cause another. */
1465 while (pending_malloc_warning
)
1466 display_malloc_warning ();
1470 Vdeactivate_mark
= Qnil
;
1472 /* If minibuffer on and echo area in use,
1473 wait a short time and redraw minibuffer. */
1476 && !NILP (echo_area_buffer
[0])
1477 && EQ (minibuf_window
, echo_area_window
)
1478 && NUMBERP (Vminibuffer_message_timeout
))
1480 /* Bind inhibit-quit to t so that C-g gets read in
1481 rather than quitting back to the minibuffer. */
1482 int count
= SPECPDL_INDEX ();
1483 specbind (Qinhibit_quit
, Qt
);
1485 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1486 /* Clear the echo area. */
1488 safe_run_hooks (Qecho_area_clear_hook
);
1490 unbind_to (count
, Qnil
);
1492 /* If a C-g came in before, treat it as input now. */
1493 if (!NILP (Vquit_flag
))
1496 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1501 alloca (0); /* Cause a garbage collection now */
1502 /* Since we can free the most stuff here. */
1503 #endif /* C_ALLOCA */
1506 /* Select the frame that the last event came from. Usually,
1507 switch-frame events will take care of this, but if some lisp
1508 code swallows a switch-frame event, we'll fix things up here.
1509 Is this a good idea? */
1510 if (FRAMEP (internal_last_event_frame
)
1511 && !EQ (internal_last_event_frame
, selected_frame
))
1512 Fselect_frame (internal_last_event_frame
, Qnil
);
1514 /* If it has changed current-menubar from previous value,
1515 really recompute the menubar from the value. */
1516 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1517 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1518 call0 (Qrecompute_lucid_menubar
);
1520 before_command_key_count
= this_command_key_count
;
1521 before_command_echo_length
= echo_length ();
1523 Vthis_command
= Qnil
;
1524 real_this_command
= Qnil
;
1526 /* Read next key sequence; i gets its length. */
1527 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1530 /* A filter may have run while we were reading the input. */
1531 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1533 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1534 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1538 /* Now we have read a key sequence of length I,
1539 or else I is 0 and we found end of file. */
1541 if (i
== 0) /* End of file -- happens only in */
1542 return Qnil
; /* a kbd macro, at the end. */
1543 /* -1 means read_key_sequence got a menu that was rejected.
1544 Just loop around and read another command. */
1548 this_command_key_count
= 0;
1549 this_command_key_count_reset
= 0;
1550 this_single_command_key_start
= 0;
1554 last_command_char
= keybuf
[i
- 1];
1556 /* If the previous command tried to force a specific window-start,
1557 forget about that, in case this command moves point far away
1558 from that position. But also throw away beg_unchanged and
1559 end_unchanged information in that case, so that redisplay will
1560 update the whole window properly. */
1561 if (!NILP (XWINDOW (selected_window
)->force_start
))
1564 XWINDOW (selected_window
)->force_start
= Qnil
;
1565 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1566 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1569 cmd
= read_key_sequence_cmd
;
1570 if (!NILP (Vexecuting_kbd_macro
))
1572 if (!NILP (Vquit_flag
))
1574 Vexecuting_kbd_macro
= Qt
;
1575 QUIT
; /* Make some noise. */
1576 /* Will return since macro now empty. */
1580 /* Do redisplay processing after this command except in special
1581 cases identified below. */
1582 prev_buffer
= current_buffer
;
1583 prev_modiff
= MODIFF
;
1584 last_point_position
= PT
;
1585 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1587 /* By default, we adjust point to a boundary of a region that
1588 has such a property that should be treated intangible
1589 (e.g. composition, display). But, some commands will set
1590 this variable differently. */
1591 Vdisable_point_adjustment
= Qnil
;
1593 /* Process filters and timers may have messed with deactivate-mark.
1594 reset it before we execute the command. */
1595 Vdeactivate_mark
= Qnil
;
1597 /* Remap command through active keymaps */
1598 Vthis_original_command
= cmd
;
1602 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1606 /* Execute the command. */
1608 Vthis_command
= cmd
;
1609 real_this_command
= cmd
;
1610 /* Note that the value cell will never directly contain nil
1611 if the symbol is a local variable. */
1612 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1613 safe_run_hooks (Qpre_command_hook
);
1615 already_adjusted
= 0;
1617 if (NILP (Vthis_command
))
1619 /* nil means key is undefined. */
1620 Lisp_Object keys
= Fvector (i
, keybuf
);
1621 keys
= Fkey_description (keys
, Qnil
);
1623 message_with_string ("%s is undefined", keys
, 0);
1624 current_kboard
->defining_kbd_macro
= Qnil
;
1625 update_mode_lines
= 1;
1626 current_kboard
->Vprefix_arg
= Qnil
;
1630 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1632 /* In case we jump to directly_done. */
1633 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1635 /* Recognize some common commands in common situations and
1636 do them directly. */
1637 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1639 struct Lisp_Char_Table
*dp
1640 = window_display_table (XWINDOW (selected_window
));
1641 lose
= FETCH_CHAR (PT_BYTE
);
1643 if (! NILP (Vpost_command_hook
))
1644 /* Put this before calling adjust_point_for_property
1645 so it will only get called once in any case. */
1647 if (current_buffer
== prev_buffer
1648 && last_point_position
!= PT
1649 && NILP (Vdisable_point_adjustment
)
1650 && NILP (Vglobal_disable_point_adjustment
))
1651 adjust_point_for_property (last_point_position
, 0);
1652 already_adjusted
= 1;
1653 if (PT
== last_point_position
+ 1
1655 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1656 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1657 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1658 && (lose
>= 0x20 && lose
< 0x7f)))
1659 : (lose
>= 0x20 && lose
< 0x7f))
1660 /* To extract the case of continuation on
1661 wide-column characters. */
1662 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1663 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1665 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1667 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1669 && !windows_or_buffers_changed
1670 && EQ (current_buffer
->selective_display
, Qnil
)
1671 && !detect_input_pending ()
1672 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1673 && NILP (Vexecuting_kbd_macro
))
1674 direct_output_forward_char (1);
1677 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1679 struct Lisp_Char_Table
*dp
1680 = window_display_table (XWINDOW (selected_window
));
1682 lose
= FETCH_CHAR (PT_BYTE
);
1683 if (! NILP (Vpost_command_hook
))
1685 if (current_buffer
== prev_buffer
1686 && last_point_position
!= PT
1687 && NILP (Vdisable_point_adjustment
)
1688 && NILP (Vglobal_disable_point_adjustment
))
1689 adjust_point_for_property (last_point_position
, 0);
1690 already_adjusted
= 1;
1691 if (PT
== last_point_position
- 1
1693 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1694 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1695 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1696 && (lose
>= 0x20 && lose
< 0x7f)))
1697 : (lose
>= 0x20 && lose
< 0x7f))
1698 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1700 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1702 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1704 && !windows_or_buffers_changed
1705 && EQ (current_buffer
->selective_display
, Qnil
)
1706 && !detect_input_pending ()
1707 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1708 && NILP (Vexecuting_kbd_macro
))
1709 direct_output_forward_char (-1);
1712 else if (EQ (Vthis_command
, Qself_insert_command
)
1713 /* Try this optimization only on char keystrokes. */
1714 && NATNUMP (last_command_char
)
1715 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1718 = translate_char (Vtranslation_table_for_input
,
1719 XFASTINT (last_command_char
), 0, 0, 0);
1721 if (NILP (Vexecuting_kbd_macro
)
1722 && !EQ (minibuf_window
, selected_window
))
1724 if (!nonundocount
|| nonundocount
>= 20)
1732 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1734 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1736 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1738 || MODIFF
<= SAVE_MODIFF
1739 || windows_or_buffers_changed
1740 || !EQ (current_buffer
->selective_display
, Qnil
)
1741 || detect_input_pending ()
1742 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1743 || !NILP (Vexecuting_kbd_macro
));
1745 value
= internal_self_insert (c
, 0);
1750 if (! NILP (Vpost_command_hook
))
1751 /* Put this before calling adjust_point_for_property
1752 so it will only get called once in any case. */
1755 /* VALUE == 1 when AFTER-CHANGE functions are
1756 installed which is the case most of the time
1757 because FONT-LOCK installs one. */
1758 if (!lose
&& !value
)
1759 direct_output_for_insert (c
);
1764 /* Here for a command that isn't executed directly */
1767 #ifdef HAVE_X_WINDOWS
1768 int scount
= SPECPDL_INDEX ();
1770 if (display_hourglass_p
1771 && NILP (Vexecuting_kbd_macro
))
1773 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1779 if (NILP (current_kboard
->Vprefix_arg
))
1781 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1783 #ifdef HAVE_X_WINDOWS
1784 /* Do not check display_hourglass_p here, because
1785 Fcommand_execute could change it, but we should cancel
1786 hourglass cursor anyway.
1787 But don't cancel the hourglass within a macro
1788 just because a command in the macro finishes. */
1789 if (NILP (Vexecuting_kbd_macro
))
1790 unbind_to (scount
, Qnil
);
1795 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1797 /* Note that the value cell will never directly contain nil
1798 if the symbol is a local variable. */
1799 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1800 safe_run_hooks (Qpost_command_hook
);
1802 /* If displaying a message, resize the echo area window to fit
1803 that message's size exactly. */
1804 if (!NILP (echo_area_buffer
[0]))
1805 resize_echo_area_exactly ();
1807 if (!NILP (Vdeferred_action_list
))
1808 safe_run_hooks (Qdeferred_action_function
);
1810 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1812 if (NILP (Vunread_command_events
)
1813 && NILP (Vunread_input_method_events
)
1814 && NILP (Vunread_post_input_method_events
)
1815 && NILP (Vexecuting_kbd_macro
)
1816 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1817 safe_run_hooks (Qpost_command_idle_hook
);
1820 /* If there is a prefix argument,
1821 1) We don't want Vlast_command to be ``universal-argument''
1822 (that would be dumb), so don't set Vlast_command,
1823 2) we want to leave echoing on so that the prefix will be
1824 echoed as part of this key sequence, so don't call
1826 3) we want to leave this_command_key_count non-zero, so that
1827 read_char will realize that it is re-reading a character, and
1828 not echo it a second time.
1830 If the command didn't actually create a prefix arg,
1831 but is merely a frame event that is transparent to prefix args,
1832 then the above doesn't apply. */
1833 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1835 current_kboard
->Vlast_command
= Vthis_command
;
1836 current_kboard
->Vreal_last_command
= real_this_command
;
1838 this_command_key_count
= 0;
1839 this_command_key_count_reset
= 0;
1840 this_single_command_key_start
= 0;
1843 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1845 /* Setting transient-mark-mode to `only' is a way of
1846 turning it on for just one command. */
1848 if (EQ (Vtransient_mark_mode
, Qidentity
))
1849 Vtransient_mark_mode
= Qnil
;
1850 if (EQ (Vtransient_mark_mode
, Qonly
))
1851 Vtransient_mark_mode
= Qidentity
;
1853 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1855 /* We could also call `deactivate'mark'. */
1856 if (EQ (Vtransient_mark_mode
, Qlambda
))
1857 Vtransient_mark_mode
= Qnil
;
1860 current_buffer
->mark_active
= Qnil
;
1861 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1864 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1865 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1870 if (current_buffer
== prev_buffer
1871 && last_point_position
!= PT
1872 && NILP (Vdisable_point_adjustment
)
1873 && NILP (Vglobal_disable_point_adjustment
)
1874 && !already_adjusted
)
1875 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1877 /* Install chars successfully executed in kbd macro. */
1879 if (!NILP (current_kboard
->defining_kbd_macro
)
1880 && NILP (current_kboard
->Vprefix_arg
))
1881 finalize_kbd_macro_chars ();
1885 any_kboard_state ();
1890 extern Lisp_Object Qcomposition
, Qdisplay
;
1892 /* Adjust point to a boundary of a region that has such a property
1893 that should be treated intangible. For the moment, we check
1894 `composition', `display' and `invisible' properties.
1895 LAST_PT is the last position of point. */
1897 extern Lisp_Object Qafter_string
, Qbefore_string
;
1898 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1901 adjust_point_for_property (last_pt
, modified
)
1906 Lisp_Object val
, overlay
, tmp
;
1907 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1910 /* FIXME: cycling is probably not necessary because these properties
1911 can't be usefully combined anyway. */
1912 while (check_composition
|| check_display
|| check_invisible
)
1914 if (check_composition
1915 && PT
> BEGV
&& PT
< ZV
1916 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1917 && COMPOSITION_VALID_P (beg
, end
, val
)
1918 && beg
< PT
/* && end > PT <- It's always the case. */
1919 && (last_pt
<= beg
|| last_pt
>= end
))
1922 SET_PT (PT
< last_pt
? beg
: end
);
1923 check_display
= check_invisible
= 1;
1925 check_composition
= 0;
1927 && PT
> BEGV
&& PT
< ZV
1928 && !NILP (val
= get_char_property_and_overlay
1929 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1930 && display_prop_intangible_p (val
)
1931 && (!OVERLAYP (overlay
)
1932 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1933 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1934 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1935 && beg
< PT
) /* && end > PT <- It's always the case. */
1938 SET_PT (PT
< last_pt
? beg
: end
);
1939 check_composition
= check_invisible
= 1;
1942 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1944 int inv
, ellipsis
= 0;
1947 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1949 && !NILP (val
= get_char_property_and_overlay
1950 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1951 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1953 ellipsis
= ellipsis
|| inv
> 1
1954 || (OVERLAYP (overlay
)
1955 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1956 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1957 tmp
= Fnext_single_char_property_change
1958 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1959 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1962 && !NILP (val
= get_char_property_and_overlay
1963 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1964 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1966 ellipsis
= ellipsis
|| inv
> 1
1967 || (OVERLAYP (overlay
)
1968 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1969 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1970 tmp
= Fprevious_single_char_property_change
1971 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1972 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1975 /* Move away from the inside area. */
1976 if (beg
< PT
&& end
> PT
)
1978 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1979 /* We haven't moved yet (so we don't need to fear
1980 infinite-looping) and we were outside the range
1981 before (so either end of the range still corresponds
1982 to a move in the right direction): pretend we moved
1983 less than we actually did, so that we still have
1984 more freedom below in choosing which end of the range
1986 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1987 /* We either have moved already or the last point
1988 was already in the range: we don't get to choose
1989 which end of the range we have to go to. */
1990 : (PT
< last_pt
? beg
: end
));
1991 check_composition
= check_display
= 1;
1993 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1994 the point to something other than its argument, due to
1995 point-motion hooks, intangibility, etc. */
1996 xassert (PT
== beg
|| PT
== end
);
1999 /* Pretend the area doesn't exist if the buffer is not
2001 if (!modified
&& !ellipsis
&& beg
< end
)
2003 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2004 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2005 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2006 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2007 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2008 /* We've already moved as far as we can. Trying to go
2009 to the other end would mean moving backwards and thus
2010 could lead to an infinite loop. */
2012 else if (val
= get_pos_property (make_number (PT
),
2014 TEXT_PROP_MEANS_INVISIBLE (val
)
2015 && (val
= get_pos_property
2016 (make_number (PT
== beg
? end
: beg
),
2018 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2019 (check_composition
= check_display
= 1,
2020 SET_PT (PT
== beg
? end
: beg
));
2023 check_invisible
= 0;
2027 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2030 safe_run_hooks_1 (hook
)
2033 return call1 (Vrun_hooks
, Vinhibit_quit
);
2036 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2039 safe_run_hooks_error (data
)
2042 Lisp_Object args
[3];
2043 args
[0] = build_string ("Error in %s: %s");
2044 args
[1] = Vinhibit_quit
;
2047 return Fset (Vinhibit_quit
, Qnil
);
2050 /* If we get an error while running the hook, cause the hook variable
2051 to be nil. Also inhibit quits, so that C-g won't cause the hook
2052 to mysteriously evaporate. */
2055 safe_run_hooks (hook
)
2058 int count
= SPECPDL_INDEX ();
2059 specbind (Qinhibit_quit
, hook
);
2061 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2063 unbind_to (count
, Qnil
);
2067 /* Number of seconds between polling for input. This is a Lisp
2068 variable that can be bound. */
2070 EMACS_INT polling_period
;
2072 /* Nonzero means polling for input is temporarily suppressed. */
2074 int poll_suppress_count
;
2076 /* Asynchronous timer for polling. */
2078 struct atimer
*poll_timer
;
2081 #ifdef POLL_FOR_INPUT
2083 /* Poll for input, so what we catch a C-g if it comes in. This
2084 function is called from x_make_frame_visible, see comment
2090 if (interrupt_input_blocked
== 0
2091 && !waiting_for_input
)
2092 read_avail_input (0);
2095 /* Timer callback function for poll_timer. TIMER is equal to
2099 poll_for_input (timer
)
2100 struct atimer
*timer
;
2102 if (poll_suppress_count
== 0)
2104 interrupt_input_pending
= 1;
2106 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 /* XXX This condition was (read_socket_hook && !interrupt_input),
2120 but read_socket_hook is not global anymore. Let's pretend that
2122 if (!interrupt_input
)
2124 /* Turn alarm handling on unconditionally. It might have
2125 been turned off in process.c. */
2126 turn_on_atimers (1);
2128 /* If poll timer doesn't exist, are we need one with
2129 a different interval, start a new one. */
2130 if (poll_timer
== NULL
2131 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2133 EMACS_TIME interval
;
2136 cancel_atimer (poll_timer
);
2138 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2139 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2140 poll_for_input
, NULL
);
2143 /* Let the timer's callback function poll for input
2144 if this becomes zero. */
2145 --poll_suppress_count
;
2150 /* Nonzero if we are using polling to handle input asynchronously. */
2153 input_polling_used ()
2155 #ifdef POLL_FOR_INPUT
2156 /* XXX This condition was (read_socket_hook && !interrupt_input),
2157 but read_socket_hook is not global anymore. Let's pretend that
2159 return !interrupt_input
;
2165 /* Turn off polling. */
2170 #ifdef POLL_FOR_INPUT
2171 /* XXX This condition was (read_socket_hook && !interrupt_input),
2172 but read_socket_hook is not global anymore. Let's pretend that
2174 if (!interrupt_input
)
2175 ++poll_suppress_count
;
2179 /* Set the value of poll_suppress_count to COUNT
2180 and start or stop polling accordingly. */
2183 set_poll_suppress_count (count
)
2186 #ifdef POLL_FOR_INPUT
2187 if (count
== 0 && poll_suppress_count
!= 0)
2189 poll_suppress_count
= 1;
2192 else if (count
!= 0 && poll_suppress_count
== 0)
2196 poll_suppress_count
= count
;
2200 /* Bind polling_period to a value at least N.
2201 But don't decrease it. */
2204 bind_polling_period (n
)
2207 #ifdef POLL_FOR_INPUT
2208 int new = polling_period
;
2213 stop_other_atimers (poll_timer
);
2215 specbind (Qpolling_period
, make_number (new));
2216 /* Start a new alarm with the new period. */
2221 /* Apply the control modifier to CHARACTER. */
2227 /* Save the upper bits here. */
2228 int upper
= c
& ~0177;
2232 /* Everything in the columns containing the upper-case letters
2233 denotes a control character. */
2234 if (c
>= 0100 && c
< 0140)
2238 /* Set the shift modifier for a control char
2239 made from a shifted letter. But only for letters! */
2240 if (oc
>= 'A' && oc
<= 'Z')
2241 c
|= shift_modifier
;
2244 /* The lower-case letters denote control characters too. */
2245 else if (c
>= 'a' && c
<= 'z')
2248 /* Include the bits for control and shift
2249 only if the basic ASCII code can't indicate them. */
2253 /* Replace the high bits. */
2254 c
|= (upper
& ~ctrl_modifier
);
2259 /* Display the help-echo property of the character after the mouse pointer.
2260 Either show it in the echo area, or call show-help-function to display
2261 it by other means (maybe in a tooltip).
2263 If HELP is nil, that means clear the previous help echo.
2265 If HELP is a string, display that string. If HELP is a function,
2266 call it with OBJECT and POS as arguments; the function should
2267 return a help string or nil for none. For all other types of HELP,
2268 evaluate it to obtain a string.
2270 WINDOW is the window in which the help was generated, if any.
2271 It is nil if not in a window.
2273 If OBJECT is a buffer, POS is the position in the buffer where the
2274 `help-echo' text property was found.
2276 If OBJECT is an overlay, that overlay has a `help-echo' property,
2277 and POS is the position in the overlay's buffer under the mouse.
2279 If OBJECT is a string (an overlay string or a string displayed with
2280 the `display' property). POS is the position in that string under
2283 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2284 echo overwrites a keystroke echo currently displayed in the echo
2287 Note: this function may only be called with HELP nil or a string
2288 from X code running asynchronously. */
2291 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2292 Lisp_Object help
, window
, object
, pos
;
2293 int ok_to_overwrite_keystroke_echo
;
2295 if (!NILP (help
) && !STRINGP (help
))
2297 if (FUNCTIONP (help
))
2299 Lisp_Object args
[4];
2304 help
= safe_call (4, args
);
2307 help
= safe_eval (help
);
2309 if (!STRINGP (help
))
2314 if (!noninteractive
&& STRINGP (help
))
2315 help
= call1 (Qmouse_fixup_help_message
, help
);
2318 if (STRINGP (help
) || NILP (help
))
2320 if (!NILP (Vshow_help_function
))
2321 call1 (Vshow_help_function
, help
);
2322 else if (/* Don't overwrite minibuffer contents. */
2323 !MINI_WINDOW_P (XWINDOW (selected_window
))
2324 /* Don't overwrite a keystroke echo. */
2325 && (NILP (echo_message_buffer
)
2326 || ok_to_overwrite_keystroke_echo
)
2327 /* Don't overwrite a prompt. */
2328 && !cursor_in_echo_area
)
2332 int count
= SPECPDL_INDEX ();
2334 if (!help_echo_showing_p
)
2335 Vpre_help_message
= current_message ();
2337 specbind (Qmessage_truncate_lines
, Qt
);
2338 message3_nolog (help
, SBYTES (help
),
2339 STRING_MULTIBYTE (help
));
2340 unbind_to (count
, Qnil
);
2342 else if (STRINGP (Vpre_help_message
))
2344 message3_nolog (Vpre_help_message
,
2345 SBYTES (Vpre_help_message
),
2346 STRING_MULTIBYTE (Vpre_help_message
));
2347 Vpre_help_message
= Qnil
;
2353 help_echo_showing_p
= STRINGP (help
);
2359 /* Input of single characters from keyboard */
2361 Lisp_Object
print_help ();
2362 static Lisp_Object
kbd_buffer_get_event ();
2363 static void record_char ();
2366 static jmp_buf wrong_kboard_jmpbuf
;
2369 #define STOP_POLLING \
2370 do { if (! polling_stopped_here) stop_polling (); \
2371 polling_stopped_here = 1; } while (0)
2373 #define RESUME_POLLING \
2374 do { if (polling_stopped_here) start_polling (); \
2375 polling_stopped_here = 0; } while (0)
2377 /* read a character from the keyboard; call the redisplay if needed */
2378 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2379 -1 means do not do redisplay, but do do autosaving.
2382 /* The arguments MAPS and NMAPS are for menu prompting.
2383 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2385 PREV_EVENT is the previous input event, or nil if we are reading
2386 the first event of a key sequence (or not reading a key sequence).
2387 If PREV_EVENT is t, that is a "magic" value that says
2388 not to run input methods, but in other respects to act as if
2389 not reading a key sequence.
2391 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2392 if we used a mouse menu to read the input, or zero otherwise. If
2393 USED_MOUSE_MENU is null, we don't dereference it.
2395 Value is t if we showed a menu and the user rejected it. */
2398 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2402 Lisp_Object prev_event
;
2403 int *used_mouse_menu
;
2405 volatile Lisp_Object c
;
2407 jmp_buf local_getcjmp
;
2409 volatile int key_already_recorded
= 0;
2410 Lisp_Object tem
, save
;
2411 volatile Lisp_Object previous_echo_area_message
;
2412 volatile Lisp_Object also_record
;
2413 volatile int reread
;
2414 struct gcpro gcpro1
, gcpro2
;
2415 int polling_stopped_here
= 0;
2419 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2420 before_command_key_count
= this_command_key_count
;
2421 before_command_echo_length
= echo_length ();
2424 previous_echo_area_message
= Qnil
;
2426 GCPRO2 (c
, previous_echo_area_message
);
2431 if (CONSP (Vunread_post_input_method_events
))
2433 c
= XCAR (Vunread_post_input_method_events
);
2434 Vunread_post_input_method_events
2435 = XCDR (Vunread_post_input_method_events
);
2437 /* Undo what read_char_x_menu_prompt did when it unread
2438 additional keys returned by Fx_popup_menu. */
2440 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2448 if (unread_command_char
!= -1)
2450 XSETINT (c
, unread_command_char
);
2451 unread_command_char
= -1;
2457 if (CONSP (Vunread_command_events
))
2459 c
= XCAR (Vunread_command_events
);
2460 Vunread_command_events
= XCDR (Vunread_command_events
);
2462 /* Undo what read_char_x_menu_prompt did when it unread
2463 additional keys returned by Fx_popup_menu. */
2465 && EQ (XCDR (c
), Qdisabled
)
2466 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2469 /* If the queued event is something that used the mouse,
2470 set used_mouse_menu accordingly. */
2472 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2473 *used_mouse_menu
= 1;
2476 goto reread_for_input_method
;
2479 if (CONSP (Vunread_input_method_events
))
2481 c
= XCAR (Vunread_input_method_events
);
2482 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2484 /* Undo what read_char_x_menu_prompt did when it unread
2485 additional keys returned by Fx_popup_menu. */
2487 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2491 goto reread_for_input_method
;
2494 this_command_key_count_reset
= 0;
2496 if (!NILP (Vexecuting_kbd_macro
))
2498 /* We set this to Qmacro; since that's not a frame, nobody will
2499 try to switch frames on us, and the selected window will
2502 Since this event came from a macro, it would be misleading to
2503 leave internal_last_event_frame set to wherever the last
2504 real event came from. Normally, a switch-frame event selects
2505 internal_last_event_frame after each command is read, but
2506 events read from a macro should never cause a new frame to be
2508 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2510 /* Exit the macro if we are at the end.
2511 Also, some things replace the macro with t
2512 to force an early exit. */
2513 if (EQ (Vexecuting_kbd_macro
, Qt
)
2514 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2520 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2521 if (STRINGP (Vexecuting_kbd_macro
)
2522 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2523 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2525 executing_kbd_macro_index
++;
2530 if (!NILP (unread_switch_frame
))
2532 c
= unread_switch_frame
;
2533 unread_switch_frame
= Qnil
;
2535 /* This event should make it into this_command_keys, and get echoed
2536 again, so we do not set `reread'. */
2540 /* if redisplay was requested */
2541 if (commandflag
>= 0)
2543 /* If there is pending input, process any events which are not
2544 user-visible, such as X selection_request events. */
2546 || detect_input_pending_run_timers (0))
2547 swallow_events (0); /* may clear input_pending */
2549 /* Redisplay if no pending input. */
2550 while (!input_pending
)
2552 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2553 redisplay_preserve_echo_area (5);
2558 /* Normal case: no input arrived during redisplay. */
2561 /* Input arrived and pre-empted redisplay.
2562 Process any events which are not user-visible. */
2564 /* If that cleared input_pending, try again to redisplay. */
2568 /* Message turns off echoing unless more keystrokes turn it on again.
2570 The code in 20.x for the condition was
2572 1. echo_area_glyphs && *echo_area_glyphs
2573 2. && echo_area_glyphs != current_kboard->echobuf
2574 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2576 (1) means there's a current message displayed
2578 (2) means it's not the message from echoing from the current
2581 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2582 is set to a non-null value. This is done in read_char and it is
2583 set to echo_area_glyphs after a call to echo_char. That means
2584 ok_to_echo_at_next_pause is either null or
2585 current_kboard->echobuf with the appropriate current_kboard at
2588 So, condition (3) means in clear text ok_to_echo_at_next_pause
2589 must be either null, or the current message isn't from echoing at
2590 all, or it's from echoing from a different kboard than the
2593 if (/* There currently is something in the echo area. */
2594 !NILP (echo_area_buffer
[0])
2595 && (/* And it's either not from echoing. */
2596 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2597 /* Or it's an echo from a different kboard. */
2598 || echo_kboard
!= current_kboard
2599 /* Or we explicitly allow overwriting whatever there is. */
2600 || ok_to_echo_at_next_pause
== NULL
))
2605 /* Try reading a character via menu prompting in the minibuf.
2606 Try this before the sit-for, because the sit-for
2607 would do the wrong thing if we are supposed to do
2608 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2609 after a mouse event so don't try a minibuf menu. */
2611 if (nmaps
> 0 && INTERACTIVE
2612 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2613 /* Don't bring up a menu if we already have another event. */
2614 && NILP (Vunread_command_events
)
2615 && unread_command_char
< 0
2616 && !detect_input_pending_run_timers (0))
2618 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2621 key_already_recorded
= 1;
2626 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2627 We will do that below, temporarily for short sections of code,
2628 when appropriate. local_getcjmp must be in effect
2629 around any call to sit_for or kbd_buffer_get_event;
2630 it *must not* be in effect when we call redisplay. */
2632 if (_setjmp (local_getcjmp
))
2634 XSETINT (c
, quit_char
);
2635 internal_last_event_frame
= selected_frame
;
2636 Vlast_event_frame
= internal_last_event_frame
;
2637 /* If we report the quit char as an event,
2638 don't do so more than once. */
2639 if (!NILP (Vinhibit_quit
))
2644 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2645 if (kb
!= current_kboard
)
2647 Lisp_Object link
= kb
->kbd_queue
;
2648 /* We shouldn't get here if we were in single-kboard mode! */
2653 while (CONSP (XCDR (link
)))
2655 if (!NILP (XCDR (link
)))
2659 kb
->kbd_queue
= Fcons (c
, Qnil
);
2661 XSETCDR (link
, Fcons (c
, Qnil
));
2662 kb
->kbd_queue_has_data
= 1;
2663 current_kboard
= kb
;
2664 /* This is going to exit from read_char
2665 so we had better get rid of this frame's stuff. */
2667 longjmp (wrong_kboard_jmpbuf
, 1);
2674 timer_start_idle ();
2676 /* If in middle of key sequence and minibuffer not active,
2677 start echoing if enough time elapses. */
2679 if (minibuf_level
== 0
2680 && !current_kboard
->immediate_echo
2681 && this_command_key_count
> 0
2683 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2684 && NILP (Fzerop (Vecho_keystrokes
))
2685 && (/* No message. */
2686 NILP (echo_area_buffer
[0])
2687 /* Or empty message. */
2688 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2689 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2690 /* Or already echoing from same kboard. */
2691 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2692 /* Or not echoing before and echoing allowed. */
2693 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2697 /* After a mouse event, start echoing right away.
2698 This is because we are probably about to display a menu,
2699 and we don't want to delay before doing so. */
2700 if (EVENT_HAS_PARAMETERS (prev_event
))
2705 double duration
= extract_float (Vecho_keystrokes
);
2706 sec
= (int) duration
;
2707 usec
= (duration
- sec
) * 1000000;
2708 save_getcjmp (save_jump
);
2709 restore_getcjmp (local_getcjmp
);
2710 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2711 restore_getcjmp (save_jump
);
2713 && ! CONSP (Vunread_command_events
))
2718 /* Maybe auto save due to number of keystrokes. */
2720 if (commandflag
!= 0
2721 && auto_save_interval
> 0
2722 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2723 && !detect_input_pending_run_timers (0))
2725 Fdo_auto_save (Qnil
, Qnil
);
2726 /* Hooks can actually change some buffers in auto save. */
2730 /* Try reading using an X menu.
2731 This is never confused with reading using the minibuf
2732 because the recursive call of read_char in read_char_minibuf_menu_prompt
2733 does not pass on any keymaps. */
2735 if (nmaps
> 0 && INTERACTIVE
2736 && !NILP (prev_event
)
2737 && EVENT_HAS_PARAMETERS (prev_event
)
2738 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2739 && !EQ (XCAR (prev_event
), Qtool_bar
)
2740 /* Don't bring up a menu if we already have another event. */
2741 && NILP (Vunread_command_events
)
2742 && unread_command_char
< 0)
2744 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2746 /* Now that we have read an event, Emacs is not idle. */
2752 /* Maybe autosave and/or garbage collect due to idleness. */
2754 if (INTERACTIVE
&& NILP (c
))
2756 int delay_level
, buffer_size
;
2758 /* Slow down auto saves logarithmically in size of current buffer,
2759 and garbage collect while we're at it. */
2760 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2761 last_non_minibuf_size
= Z
- BEG
;
2762 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2764 while (buffer_size
> 64)
2765 delay_level
++, buffer_size
-= buffer_size
>> 2;
2766 if (delay_level
< 4) delay_level
= 4;
2767 /* delay_level is 4 for files under around 50k, 7 at 100k,
2768 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2770 /* Auto save if enough time goes by without input. */
2771 if (commandflag
!= 0
2772 && num_nonmacro_input_events
> last_auto_save
2773 && INTEGERP (Vauto_save_timeout
)
2774 && XINT (Vauto_save_timeout
) > 0)
2778 save_getcjmp (save_jump
);
2779 restore_getcjmp (local_getcjmp
);
2780 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2782 restore_getcjmp (save_jump
);
2785 && ! CONSP (Vunread_command_events
))
2787 Fdo_auto_save (Qnil
, Qnil
);
2789 /* If we have auto-saved and there is still no input
2790 available, garbage collect if there has been enough
2791 consing going on to make it worthwhile. */
2792 if (!detect_input_pending_run_timers (0)
2793 && consing_since_gc
> gc_cons_threshold
/ 2)
2794 Fgarbage_collect ();
2801 /* If this has become non-nil here, it has been set by a timer
2802 or sentinel or filter. */
2803 if (CONSP (Vunread_command_events
))
2805 c
= XCAR (Vunread_command_events
);
2806 Vunread_command_events
= XCDR (Vunread_command_events
);
2809 /* Read something from current KBOARD's side queue, if possible. */
2813 if (current_kboard
->kbd_queue_has_data
)
2815 if (!CONSP (current_kboard
->kbd_queue
))
2817 c
= XCAR (current_kboard
->kbd_queue
);
2818 current_kboard
->kbd_queue
2819 = XCDR (current_kboard
->kbd_queue
);
2820 if (NILP (current_kboard
->kbd_queue
))
2821 current_kboard
->kbd_queue_has_data
= 0;
2822 input_pending
= readable_events (0);
2823 if (EVENT_HAS_PARAMETERS (c
)
2824 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2825 internal_last_event_frame
= XCAR (XCDR (c
));
2826 Vlast_event_frame
= internal_last_event_frame
;
2831 /* If current_kboard's side queue is empty check the other kboards.
2832 If one of them has data that we have not yet seen here,
2833 switch to it and process the data waiting for it.
2835 Note: if the events queued up for another kboard
2836 have already been seen here, and therefore are not a complete command,
2837 the kbd_queue_has_data field is 0, so we skip that kboard here.
2838 That's to avoid an infinite loop switching between kboards here. */
2839 if (NILP (c
) && !single_kboard
)
2842 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2843 if (kb
->kbd_queue_has_data
)
2845 current_kboard
= kb
;
2846 /* This is going to exit from read_char
2847 so we had better get rid of this frame's stuff. */
2849 longjmp (wrong_kboard_jmpbuf
, 1);
2858 /* Finally, we read from the main queue,
2859 and if that gives us something we can't use yet, we put it on the
2860 appropriate side queue and try again. */
2866 /* Actually read a character, waiting if necessary. */
2867 save_getcjmp (save_jump
);
2868 restore_getcjmp (local_getcjmp
);
2869 timer_start_idle ();
2870 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2871 restore_getcjmp (save_jump
);
2874 if (! NILP (c
) && (kb
!= current_kboard
))
2876 Lisp_Object link
= kb
->kbd_queue
;
2879 while (CONSP (XCDR (link
)))
2881 if (!NILP (XCDR (link
)))
2885 kb
->kbd_queue
= Fcons (c
, Qnil
);
2887 XSETCDR (link
, Fcons (c
, Qnil
));
2888 kb
->kbd_queue_has_data
= 1;
2892 current_kboard
= kb
;
2893 /* This is going to exit from read_char
2894 so we had better get rid of this frame's stuff. */
2896 longjmp (wrong_kboard_jmpbuf
, 1);
2901 /* Terminate Emacs in batch mode if at eof. */
2902 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2903 Fkill_emacs (make_number (1));
2907 /* Add in any extra modifiers, where appropriate. */
2908 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2909 || ((extra_keyboard_modifiers
& 0177) < ' '
2910 && (extra_keyboard_modifiers
& 0177) != 0))
2911 XSETINT (c
, make_ctrl_char (XINT (c
)));
2913 /* Transfer any other modifier bits directly from
2914 extra_keyboard_modifiers to c. Ignore the actual character code
2915 in the low 16 bits of extra_keyboard_modifiers. */
2916 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2926 if (commandflag
>= 0
2927 && !input_pending
&& !detect_input_pending_run_timers (0))
2935 /* Buffer switch events are only for internal wakeups
2936 so don't show them to the user.
2937 Also, don't record a key if we already did. */
2938 if (BUFFERP (c
) || key_already_recorded
)
2941 /* Process special events within read_char
2942 and loop around to read another event. */
2945 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2950 int was_locked
= single_kboard
;
2952 last_input_char
= c
;
2953 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2955 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2956 /* We stopped being idle for this event; undo that. This
2957 prevents automatic window selection (under
2958 mouse_autoselect_window from acting as a real input event, for
2959 example banishing the mouse under mouse-avoidance-mode. */
2960 timer_resume_idle ();
2962 /* Resume allowing input from any kboard, if that was true before. */
2964 any_kboard_state ();
2969 /* Handle things that only apply to characters. */
2972 /* If kbd_buffer_get_event gave us an EOF, return that. */
2976 if ((STRINGP (Vkeyboard_translate_table
)
2977 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2978 || (VECTORP (Vkeyboard_translate_table
)
2979 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2980 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2981 && CHAR_VALID_P (XINT (c
), 0)))
2984 d
= Faref (Vkeyboard_translate_table
, c
);
2985 /* nil in keyboard-translate-table means no translation. */
2991 /* If this event is a mouse click in the menu bar,
2992 return just menu-bar for now. Modify the mouse click event
2993 so we won't do this twice, then queue it up. */
2994 if (EVENT_HAS_PARAMETERS (c
)
2996 && CONSP (EVENT_START (c
))
2997 && CONSP (XCDR (EVENT_START (c
))))
3001 posn
= POSN_POSN (EVENT_START (c
));
3002 /* Handle menu-bar events:
3003 insert the dummy prefix event `menu-bar'. */
3004 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3006 /* Change menu-bar to (menu-bar) as the event "position". */
3007 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3010 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3015 /* Store these characters into recent_keys, the dribble file if any,
3016 and the keyboard macro being defined, if any. */
3018 if (! NILP (also_record
))
3019 record_char (also_record
);
3021 /* Wipe the echo area.
3022 But first, if we are about to use an input method,
3023 save the echo area contents for it to refer to. */
3025 && ! NILP (Vinput_method_function
)
3026 && (unsigned) XINT (c
) >= ' '
3027 && (unsigned) XINT (c
) != 127
3028 && (unsigned) XINT (c
) < 256)
3030 previous_echo_area_message
= Fcurrent_message ();
3031 Vinput_method_previous_message
= previous_echo_area_message
;
3034 /* Now wipe the echo area, except for help events which do their
3035 own stuff with the echo area. */
3037 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3038 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3040 if (!NILP (echo_area_buffer
[0]))
3041 safe_run_hooks (Qecho_area_clear_hook
);
3042 clear_message (1, 0);
3045 reread_for_input_method
:
3047 /* Pass this to the input method, if appropriate. */
3049 && ! NILP (Vinput_method_function
)
3050 /* Don't run the input method within a key sequence,
3051 after the first event of the key sequence. */
3052 && NILP (prev_event
)
3053 && (unsigned) XINT (c
) >= ' '
3054 && (unsigned) XINT (c
) != 127
3055 && (unsigned) XINT (c
) < 256)
3058 int key_count
, key_count_reset
;
3059 struct gcpro gcpro1
;
3060 int count
= SPECPDL_INDEX ();
3062 /* Save the echo status. */
3063 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3064 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3065 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3066 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3069 if (before_command_restore_flag
)
3071 this_command_key_count
= before_command_key_count_1
;
3072 if (this_command_key_count
< this_single_command_key_start
)
3073 this_single_command_key_start
= this_command_key_count
;
3074 echo_truncate (before_command_echo_length_1
);
3075 before_command_restore_flag
= 0;
3079 /* Save the this_command_keys status. */
3080 key_count
= this_command_key_count
;
3081 key_count_reset
= this_command_key_count_reset
;
3084 keys
= Fcopy_sequence (this_command_keys
);
3089 /* Clear out this_command_keys. */
3090 this_command_key_count
= 0;
3091 this_command_key_count_reset
= 0;
3093 /* Now wipe the echo area. */
3094 if (!NILP (echo_area_buffer
[0]))
3095 safe_run_hooks (Qecho_area_clear_hook
);
3096 clear_message (1, 0);
3099 /* If we are not reading a key sequence,
3100 never use the echo area. */
3103 specbind (Qinput_method_use_echo_area
, Qt
);
3106 /* Call the input method. */
3107 tem
= call1 (Vinput_method_function
, c
);
3109 tem
= unbind_to (count
, tem
);
3111 /* Restore the saved echoing state
3112 and this_command_keys state. */
3113 this_command_key_count
= key_count
;
3114 this_command_key_count_reset
= key_count_reset
;
3116 this_command_keys
= keys
;
3119 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3120 current_kboard
->echo_string
= saved_echo_string
;
3121 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3122 if (saved_immediate_echo
)
3127 /* The input method can return no events. */
3130 /* Bring back the previous message, if any. */
3131 if (! NILP (previous_echo_area_message
))
3132 message_with_string ("%s", previous_echo_area_message
, 0);
3135 /* It returned one event or more. */
3137 Vunread_post_input_method_events
3138 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3143 /* Display help if not echoing. */
3144 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3146 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3147 Lisp_Object help
, object
, position
, window
, tem
;
3149 tem
= Fcdr (XCDR (c
));
3152 window
= Fcar (tem
);
3154 object
= Fcar (tem
);
3156 position
= Fcar (tem
);
3158 show_help_echo (help
, window
, object
, position
, 0);
3160 /* We stopped being idle for this event; undo that. */
3161 timer_resume_idle ();
3165 if (! reread
|| this_command_key_count
== 0
3166 || this_command_key_count_reset
)
3169 /* Don't echo mouse motion events. */
3170 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3171 && NILP (Fzerop (Vecho_keystrokes
))
3172 && ! (EVENT_HAS_PARAMETERS (c
)
3173 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3176 if (! NILP (also_record
))
3177 echo_char (also_record
);
3178 /* Once we reread a character, echoing can happen
3179 the next time we pause to read a new one. */
3180 ok_to_echo_at_next_pause
= current_kboard
;
3183 /* Record this character as part of the current key. */
3184 add_command_key (c
);
3185 if (! NILP (also_record
))
3186 add_command_key (also_record
);
3189 last_input_char
= c
;
3192 /* Process the help character specially if enabled */
3193 if (!NILP (Vhelp_form
) && help_char_p (c
))
3196 count
= SPECPDL_INDEX ();
3198 record_unwind_protect (Fset_window_configuration
,
3199 Fcurrent_window_configuration (Qnil
));
3201 tem0
= Feval (Vhelp_form
);
3203 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3207 c
= read_char (0, 0, 0, Qnil
, 0);
3208 while (BUFFERP (c
));
3209 /* Remove the help from the frame */
3210 unbind_to (count
, Qnil
);
3213 if (EQ (c
, make_number (040)))
3217 c
= read_char (0, 0, 0, Qnil
, 0);
3218 while (BUFFERP (c
));
3227 /* Record a key that came from a mouse menu.
3228 Record it for echoing, for this-command-keys, and so on. */
3234 /* Wipe the echo area. */
3235 clear_message (1, 0);
3240 before_command_key_count
= this_command_key_count
;
3241 before_command_echo_length
= echo_length ();
3244 /* Don't echo mouse motion events. */
3245 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3246 && NILP (Fzerop (Vecho_keystrokes
)))
3250 /* Once we reread a character, echoing can happen
3251 the next time we pause to read a new one. */
3252 ok_to_echo_at_next_pause
= 0;
3255 /* Record this character as part of the current key. */
3256 add_command_key (c
);
3258 /* Re-reading in the middle of a command */
3259 last_input_char
= c
;
3263 /* Return 1 if should recognize C as "the help character". */
3271 if (EQ (c
, Vhelp_char
))
3273 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3274 if (EQ (c
, XCAR (tail
)))
3279 /* Record the input event C in various ways. */
3287 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3289 /* To avoid filling recent_keys with help-echo and mouse-movement
3290 events, we filter out repeated help-echo events, only store the
3291 first and last in a series of mouse-movement events, and don't
3292 store repeated help-echo events which are only separated by
3293 mouse-movement events. */
3295 Lisp_Object ev1
, ev2
, ev3
;
3298 if ((ix1
= recent_keys_index
- 1) < 0)
3299 ix1
= NUM_RECENT_KEYS
- 1;
3300 ev1
= AREF (recent_keys
, ix1
);
3302 if ((ix2
= ix1
- 1) < 0)
3303 ix2
= NUM_RECENT_KEYS
- 1;
3304 ev2
= AREF (recent_keys
, ix2
);
3306 if ((ix3
= ix2
- 1) < 0)
3307 ix3
= NUM_RECENT_KEYS
- 1;
3308 ev3
= AREF (recent_keys
, ix3
);
3310 if (EQ (XCAR (c
), Qhelp_echo
))
3312 /* Don't record `help-echo' in recent_keys unless it shows some help
3313 message, and a different help than the previously recorded
3315 Lisp_Object help
, last_help
;
3317 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3318 if (!STRINGP (help
))
3320 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3321 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3323 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3324 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3325 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3327 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3328 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3329 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3330 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3333 else if (EQ (XCAR (c
), Qmouse_movement
))
3335 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3336 So additional mouse movement events replace the last element. */
3337 Lisp_Object last_window
, window
;
3339 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3340 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3341 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3342 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3343 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3345 ASET (recent_keys
, ix1
, c
);
3351 store_kbd_macro_char (c
);
3356 ASET (recent_keys
, recent_keys_index
, c
);
3357 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3358 recent_keys_index
= 0;
3360 else if (recorded
< 0)
3362 /* We need to remove one or two events from recent_keys.
3363 To do this, we simply put nil at those events and move the
3364 recent_keys_index backwards over those events. Usually,
3365 users will never see those nil events, as they will be
3366 overwritten by the command keys entered to see recent_keys
3369 while (recorded
++ < 0 && total_keys
> 0)
3371 if (total_keys
< NUM_RECENT_KEYS
)
3373 if (--recent_keys_index
< 0)
3374 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3375 ASET (recent_keys
, recent_keys_index
, Qnil
);
3379 num_nonmacro_input_events
++;
3381 /* Write c to the dribble file. If c is a lispy event, write
3382 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3383 If you, dear reader, have a better idea, you've got the source. :-) */
3388 if (XUINT (c
) < 0x100)
3389 putc (XINT (c
), dribble
);
3391 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3395 Lisp_Object dribblee
;
3397 /* If it's a structured event, take the event header. */
3398 dribblee
= EVENT_HEAD (c
);
3400 if (SYMBOLP (dribblee
))
3402 putc ('<', dribble
);
3403 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3404 SBYTES (SYMBOL_NAME (dribblee
)),
3406 putc ('>', dribble
);
3418 struct buffer
*old
= current_buffer
;
3419 Fprinc (object
, Qnil
);
3420 set_buffer_internal (XBUFFER (Vstandard_output
));
3421 call0 (intern ("help-mode"));
3422 set_buffer_internal (old
);
3426 /* Copy out or in the info on where C-g should throw to.
3427 This is used when running Lisp code from within get_char,
3428 in case get_char is called recursively.
3429 See read_process_output. */
3435 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3439 restore_getcjmp (temp
)
3442 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3447 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3448 of this function. */
3451 tracking_off (old_value
)
3452 Lisp_Object old_value
;
3454 do_mouse_tracking
= old_value
;
3455 if (NILP (old_value
))
3457 /* Redisplay may have been preempted because there was input
3458 available, and it assumes it will be called again after the
3459 input has been processed. If the only input available was
3460 the sort that we have just disabled, then we need to call
3462 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3464 redisplay_preserve_echo_area (6);
3465 get_input_pending (&input_pending
,
3466 READABLE_EVENTS_DO_TIMERS_NOW
);
3472 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3473 doc
: /* Evaluate BODY with mouse movement events enabled.
3474 Within a `track-mouse' form, mouse motion generates input events that
3475 you can read with `read-event'.
3476 Normally, mouse motion is ignored.
3477 usage: (track-mouse BODY ...) */)
3481 int count
= SPECPDL_INDEX ();
3484 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3486 do_mouse_tracking
= Qt
;
3488 val
= Fprogn (args
);
3489 return unbind_to (count
, val
);
3492 /* If mouse has moved on some frame, return one of those frames.
3493 Return 0 otherwise. */
3498 Lisp_Object tail
, frame
;
3500 FOR_EACH_FRAME (tail
, frame
)
3502 if (XFRAME (frame
)->mouse_moved
)
3503 return XFRAME (frame
);
3509 #endif /* HAVE_MOUSE */
3511 /* Low level keyboard/mouse input.
3512 kbd_buffer_store_event places events in kbd_buffer, and
3513 kbd_buffer_get_event retrieves them. */
3515 /* Return true iff there are any events in the queue that read-char
3516 would return. If this returns false, a read-char would block. */
3518 readable_events (flags
)
3521 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3524 /* If the buffer contains only FOCUS_IN_EVENT events, and
3525 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3526 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3528 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3529 #ifdef USE_TOOLKIT_SCROLL_BARS
3530 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3534 struct input_event
*event
;
3536 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3543 #ifdef USE_TOOLKIT_SCROLL_BARS
3544 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3546 event
->kind
== FOCUS_IN_EVENT
)
3547 #ifdef USE_TOOLKIT_SCROLL_BARS
3548 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3549 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3550 && event
->part
== scroll_bar_handle
3551 && event
->modifiers
== 0)
3556 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3559 while (event
!= kbd_store_ptr
);
3566 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3567 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3572 if (current_kboard
->kbd_queue_has_data
)
3578 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3579 if (kb
->kbd_queue_has_data
)
3585 /* Set this for debugging, to have a way to get out */
3590 event_to_kboard (event
)
3591 struct input_event
*event
;
3594 frame
= event
->frame_or_window
;
3596 frame
= XCAR (frame
);
3597 else if (WINDOWP (frame
))
3598 frame
= WINDOW_FRAME (XWINDOW (frame
));
3600 /* There are still some events that don't set this field.
3601 For now, just ignore the problem.
3602 Also ignore dead frames here. */
3603 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3606 return FRAME_KBOARD (XFRAME (frame
));
3611 Lisp_Object Vthrow_on_input
;
3613 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3616 kbd_buffer_store_event (event
)
3617 register struct input_event
*event
;
3619 kbd_buffer_store_event_hold (event
, 0);
3622 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3624 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3625 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3626 Else, if EVENT is a quit event, store the quit event
3627 in HOLD_QUIT, and return (thus ignoring further events).
3629 This is used in read_avail_input to postpone the processing
3630 of the quit event until all subsequent input events have been
3631 parsed (and discarded).
3635 kbd_buffer_store_event_hold (event
, hold_quit
)
3636 register struct input_event
*event
;
3637 struct input_event
*hold_quit
;
3639 if (event
->kind
== NO_EVENT
)
3642 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3645 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3647 register int c
= event
->code
& 0377;
3649 if (event
->modifiers
& ctrl_modifier
)
3650 c
= make_ctrl_char (c
);
3652 c
|= (event
->modifiers
3653 & (meta_modifier
| alt_modifier
3654 | hyper_modifier
| super_modifier
));
3660 struct input_event
*sp
;
3663 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3664 kb
!= current_kboard
))
3667 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3668 Fcons (make_number (c
), Qnil
));
3669 kb
->kbd_queue_has_data
= 1;
3670 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3672 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3675 if (event_to_kboard (sp
) == kb
)
3677 sp
->kind
= NO_EVENT
;
3678 sp
->frame_or_window
= Qnil
;
3688 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3692 /* If this results in a quit_char being returned to Emacs as
3693 input, set Vlast_event_frame properly. If this doesn't
3694 get returned to Emacs as an event, the next event read
3695 will set Vlast_event_frame again, so this is safe to do. */
3699 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3701 focus
= event
->frame_or_window
;
3702 internal_last_event_frame
= focus
;
3703 Vlast_event_frame
= focus
;
3706 last_event_timestamp
= event
->timestamp
;
3707 handle_interrupt ();
3711 if (c
&& c
== stop_character
)
3717 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3718 Just ignore the second one. */
3719 else if (event
->kind
== BUFFER_SWITCH_EVENT
3720 && kbd_fetch_ptr
!= kbd_store_ptr
3721 && ((kbd_store_ptr
== kbd_buffer
3722 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3723 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3726 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3727 kbd_store_ptr
= kbd_buffer
;
3729 /* Don't let the very last slot in the buffer become full,
3730 since that would make the two pointers equal,
3731 and that is indistinguishable from an empty buffer.
3732 Discard the event if it would fill the last slot. */
3733 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3735 *kbd_store_ptr
= *event
;
3739 /* If we're inside while-no-input, and this event qualifies
3740 as input, set quit-flag to cause an interrupt. */
3741 if (!NILP (Vthrow_on_input
)
3742 && event
->kind
!= FOCUS_IN_EVENT
3743 && event
->kind
!= HELP_EVENT
3744 && event
->kind
!= DEICONIFY_EVENT
)
3746 Vquit_flag
= Vthrow_on_input
;
3747 /* If we're inside a function that wants immediate quits,
3749 if (immediate_quit
&& NILP (Vinhibit_quit
))
3759 /* Put an input event back in the head of the event queue. */
3762 kbd_buffer_unget_event (event
)
3763 register struct input_event
*event
;
3765 if (kbd_fetch_ptr
== kbd_buffer
)
3766 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3768 /* Don't let the very last slot in the buffer become full, */
3769 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3772 *kbd_fetch_ptr
= *event
;
3777 /* Generate HELP_EVENT input_events in BUFP which has room for
3778 SIZE events. If there's not enough room in BUFP, ignore this
3781 HELP is the help form.
3783 FRAME is the frame on which the help is generated. OBJECT is the
3784 Lisp object where the help was found (a buffer, a string, an
3785 overlay, or nil if neither from a string nor from a buffer. POS is
3786 the position within OBJECT where the help was found.
3788 Value is the number of input_events generated. */
3791 gen_help_event (help
, frame
, window
, object
, pos
)
3792 Lisp_Object help
, frame
, object
, window
;
3795 struct input_event event
;
3799 event
.kind
= HELP_EVENT
;
3800 event
.frame_or_window
= frame
;
3802 event
.x
= WINDOWP (window
) ? window
: frame
;
3805 kbd_buffer_store_event (&event
);
3809 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3812 kbd_buffer_store_help_event (frame
, help
)
3813 Lisp_Object frame
, help
;
3815 struct input_event event
;
3817 event
.kind
= HELP_EVENT
;
3818 event
.frame_or_window
= frame
;
3823 kbd_buffer_store_event (&event
);
3827 /* Discard any mouse events in the event buffer by setting them to
3830 discard_mouse_events ()
3832 struct input_event
*sp
;
3833 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3835 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3838 if (sp
->kind
== MOUSE_CLICK_EVENT
3839 || sp
->kind
== WHEEL_EVENT
3841 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3843 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3845 sp
->kind
= NO_EVENT
;
3851 /* Return non-zero if there are any real events waiting in the event
3852 buffer, not counting `NO_EVENT's.
3854 If DISCARD is non-zero, discard NO_EVENT events at the front of
3855 the input queue, possibly leaving the input queue empty if there
3856 are no real input events. */
3859 kbd_buffer_events_waiting (discard
)
3862 struct input_event
*sp
;
3864 for (sp
= kbd_fetch_ptr
;
3865 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3868 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3875 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3879 /* Clear input event EVENT. */
3883 struct input_event
*event
;
3885 event
->kind
= NO_EVENT
;
3889 /* Read one event from the event buffer, waiting if necessary.
3890 The value is a Lisp object representing the event.
3891 The value is nil for an event that should be ignored,
3892 or that was handled here.
3893 We always read and discard one event. */
3896 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3898 int *used_mouse_menu
;
3907 *kbp
= current_kboard
;
3911 /* Wait until there is input available. */
3914 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3917 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3921 /* If the quit flag is set, then read_char will return
3922 quit_char, so that counts as "available input." */
3923 if (!NILP (Vquit_flag
))
3924 quit_throw_to_read_char ();
3926 /* One way or another, wait until input is available; then, if
3927 interrupt handlers have not read it, read it now. */
3930 wait_for_kbd_input ();
3932 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3936 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3939 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3943 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3945 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3946 /* Pass 1 for EXPECT since we just waited to have input. */
3947 read_avail_input (1);
3949 #endif /* not VMS */
3952 if (CONSP (Vunread_command_events
))
3955 first
= XCAR (Vunread_command_events
);
3956 Vunread_command_events
= XCDR (Vunread_command_events
);
3957 *kbp
= current_kboard
;
3961 /* At this point, we know that there is a readable event available
3962 somewhere. If the event queue is empty, then there must be a
3963 mouse movement enabled and available. */
3964 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3966 struct input_event
*event
;
3968 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3972 last_event_timestamp
= event
->timestamp
;
3975 *kbp
= event_to_kboard (event
);
3977 *kbp
= current_kboard
; /* Better than returning null ptr? */
3979 *kbp
= &the_only_kboard
;
3984 /* These two kinds of events get special handling
3985 and don't actually appear to the command loop.
3986 We return nil for them. */
3987 if (event
->kind
== SELECTION_REQUEST_EVENT
3988 || event
->kind
== SELECTION_CLEAR_EVENT
)
3991 struct input_event copy
;
3993 /* Remove it from the buffer before processing it,
3994 since otherwise swallow_events will see it
3995 and process it again. */
3997 kbd_fetch_ptr
= event
+ 1;
3998 input_pending
= readable_events (0);
3999 x_handle_selection_event (©
);
4001 /* We're getting selection request events, but we don't have
4007 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4008 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4010 /* Make an event (delete-frame (FRAME)). */
4011 obj
= Fcons (event
->frame_or_window
, Qnil
);
4012 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4013 kbd_fetch_ptr
= event
+ 1;
4016 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
4017 else if (event
->kind
== ICONIFY_EVENT
)
4019 /* Make an event (iconify-frame (FRAME)). */
4020 obj
= Fcons (event
->frame_or_window
, Qnil
);
4021 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4022 kbd_fetch_ptr
= event
+ 1;
4024 else if (event
->kind
== DEICONIFY_EVENT
)
4026 /* Make an event (make-frame-visible (FRAME)). */
4027 obj
= Fcons (event
->frame_or_window
, Qnil
);
4028 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4029 kbd_fetch_ptr
= event
+ 1;
4032 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4034 /* The value doesn't matter here; only the type is tested. */
4035 XSETBUFFER (obj
, current_buffer
);
4036 kbd_fetch_ptr
= event
+ 1;
4038 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4039 || defined (USE_GTK)
4040 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4042 kbd_fetch_ptr
= event
+ 1;
4043 input_pending
= readable_events (0);
4044 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4045 x_activate_menubar (XFRAME (event
->frame_or_window
));
4048 #if defined (WINDOWSNT) || defined (MAC_OS)
4049 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4052 /* Make an event (language-change (KEY_SCRIPT)). */
4053 obj
= Fcons (make_number (event
->code
), Qnil
);
4055 /* Make an event (language-change (FRAME CHARSET LCID)). */
4056 obj
= Fcons (event
->frame_or_window
, Qnil
);
4058 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4059 kbd_fetch_ptr
= event
+ 1;
4062 else if (event
->kind
== SAVE_SESSION_EVENT
)
4064 obj
= Fcons (Qsave_session
, Qnil
);
4065 kbd_fetch_ptr
= event
+ 1;
4067 /* Just discard these, by returning nil.
4068 With MULTI_KBOARD, these events are used as placeholders
4069 when we need to randomly delete events from the queue.
4070 (They shouldn't otherwise be found in the buffer,
4071 but on some machines it appears they do show up
4072 even without MULTI_KBOARD.) */
4073 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4074 mouse events during a popup-menu call. */
4075 else if (event
->kind
== NO_EVENT
)
4076 kbd_fetch_ptr
= event
+ 1;
4077 else if (event
->kind
== HELP_EVENT
)
4079 Lisp_Object object
, position
, help
, frame
, window
;
4081 frame
= event
->frame_or_window
;
4082 object
= event
->arg
;
4083 position
= make_number (event
->code
);
4086 clear_event (event
);
4088 kbd_fetch_ptr
= event
+ 1;
4089 if (!WINDOWP (window
))
4091 obj
= Fcons (Qhelp_echo
,
4092 list5 (frame
, help
, window
, object
, position
));
4094 else if (event
->kind
== FOCUS_IN_EVENT
)
4096 /* Notification of a FocusIn event. The frame receiving the
4097 focus is in event->frame_or_window. Generate a
4098 switch-frame event if necessary. */
4099 Lisp_Object frame
, focus
;
4101 frame
= event
->frame_or_window
;
4102 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4106 if (!EQ (frame
, internal_last_event_frame
)
4107 && !EQ (frame
, selected_frame
))
4108 obj
= make_lispy_switch_frame (frame
);
4109 internal_last_event_frame
= frame
;
4110 kbd_fetch_ptr
= event
+ 1;
4114 /* If this event is on a different frame, return a switch-frame this
4115 time, and leave the event in the queue for next time. */
4119 frame
= event
->frame_or_window
;
4121 frame
= XCAR (frame
);
4122 else if (WINDOWP (frame
))
4123 frame
= WINDOW_FRAME (XWINDOW (frame
));
4125 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4129 if (! EQ (frame
, internal_last_event_frame
)
4130 && !EQ (frame
, selected_frame
))
4131 obj
= make_lispy_switch_frame (frame
);
4132 internal_last_event_frame
= frame
;
4134 /* If we didn't decide to make a switch-frame event, go ahead
4135 and build a real event from the queue entry. */
4139 obj
= make_lispy_event (event
);
4141 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4142 || defined (USE_GTK)
4143 /* If this was a menu selection, then set the flag to inhibit
4144 writing to last_nonmenu_event. Don't do this if the event
4145 we're returning is (menu-bar), though; that indicates the
4146 beginning of the menu sequence, and we might as well leave
4147 that as the `event with parameters' for this selection. */
4149 && !EQ (event
->frame_or_window
, event
->arg
)
4150 && (event
->kind
== MENU_BAR_EVENT
4151 || event
->kind
== TOOL_BAR_EVENT
))
4152 *used_mouse_menu
= 1;
4155 /* Wipe out this event, to catch bugs. */
4156 clear_event (event
);
4157 kbd_fetch_ptr
= event
+ 1;
4162 /* Try generating a mouse motion event. */
4163 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4165 FRAME_PTR f
= some_mouse_moved ();
4166 Lisp_Object bar_window
;
4167 enum scroll_bar_part part
;
4171 *kbp
= current_kboard
;
4172 /* Note that this uses F to determine which display to look at.
4173 If there is no valid info, it does not store anything
4174 so x remains nil. */
4177 /* XXX Can f or mouse_position_hook be NULL here? */
4178 if (f
&& FRAME_DISPLAY (f
)->mouse_position_hook
)
4179 (*FRAME_DISPLAY (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4180 &part
, &x
, &y
, &time
);
4184 /* Decide if we should generate a switch-frame event. Don't
4185 generate switch-frame events for motion outside of all Emacs
4191 frame
= FRAME_FOCUS_FRAME (f
);
4193 XSETFRAME (frame
, f
);
4195 if (! EQ (frame
, internal_last_event_frame
)
4196 && !EQ (frame
, selected_frame
))
4197 obj
= make_lispy_switch_frame (frame
);
4198 internal_last_event_frame
= frame
;
4201 /* If we didn't decide to make a switch-frame event, go ahead and
4202 return a mouse-motion event. */
4203 if (!NILP (x
) && NILP (obj
))
4204 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4206 #endif /* HAVE_MOUSE */
4208 /* We were promised by the above while loop that there was
4209 something for us to read! */
4212 input_pending
= readable_events (0);
4214 Vlast_event_frame
= internal_last_event_frame
;
4219 /* Process any events that are not user-visible,
4220 then return, without reading any user-visible events. */
4223 swallow_events (do_display
)
4228 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4230 struct input_event
*event
;
4232 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4236 last_event_timestamp
= event
->timestamp
;
4238 /* These two kinds of events get special handling
4239 and don't actually appear to the command loop. */
4240 if (event
->kind
== SELECTION_REQUEST_EVENT
4241 || event
->kind
== SELECTION_CLEAR_EVENT
)
4244 struct input_event copy
;
4246 /* Remove it from the buffer before processing it,
4247 since otherwise swallow_events called recursively could see it
4248 and process it again. */
4250 kbd_fetch_ptr
= event
+ 1;
4251 input_pending
= readable_events (0);
4252 x_handle_selection_event (©
);
4254 /* We're getting selection request events, but we don't have
4263 old_timers_run
= timers_run
;
4264 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4266 if (timers_run
!= old_timers_run
&& do_display
)
4267 redisplay_preserve_echo_area (7);
4270 /* Record the start of when Emacs is idle,
4271 for the sake of running idle-time timers. */
4278 /* If we are already in the idle state, do nothing. */
4279 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4282 EMACS_GET_TIME (timer_idleness_start_time
);
4284 timer_last_idleness_start_time
= timer_idleness_start_time
;
4286 /* Mark all idle-time timers as once again candidates for running. */
4287 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4291 timer
= XCAR (timers
);
4293 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4295 XVECTOR (timer
)->contents
[0] = Qnil
;
4299 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4304 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4307 /* Resume idle timer from last idle start time. */
4310 timer_resume_idle ()
4312 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4315 timer_idleness_start_time
= timer_last_idleness_start_time
;
4318 /* This is only for debugging. */
4319 struct input_event last_timer_event
;
4321 /* Check whether a timer has fired. To prevent larger problems we simply
4322 disregard elements that are not proper timers. Do not make a circular
4323 timer list for the time being.
4325 Returns the number of seconds to wait until the next timer fires. If a
4326 timer is triggering now, return zero seconds.
4327 If no timer is active, return -1 seconds.
4329 If a timer is ripe, we run it, with quitting turned off.
4331 DO_IT_NOW is now ignored. It used to mean that we should
4332 run the timer directly instead of queueing a timer-event.
4333 Now we always run timers directly. */
4336 timer_check (do_it_now
)
4339 EMACS_TIME nexttime
;
4340 EMACS_TIME now
, idleness_now
;
4341 Lisp_Object timers
, idle_timers
, chosen_timer
;
4342 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4344 EMACS_SET_SECS (nexttime
, -1);
4345 EMACS_SET_USECS (nexttime
, -1);
4347 /* Always consider the ordinary timers. */
4348 timers
= Vtimer_list
;
4349 /* Consider the idle timers only if Emacs is idle. */
4350 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4351 idle_timers
= Vtimer_idle_list
;
4354 chosen_timer
= Qnil
;
4355 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4357 if (CONSP (timers
) || CONSP (idle_timers
))
4359 EMACS_GET_TIME (now
);
4360 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4361 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4364 while (CONSP (timers
) || CONSP (idle_timers
))
4366 Lisp_Object
*vector
;
4367 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4368 EMACS_TIME timer_time
, idle_timer_time
;
4369 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4371 /* Skip past invalid timers and timers already handled. */
4374 timer
= XCAR (timers
);
4375 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4377 timers
= XCDR (timers
);
4380 vector
= XVECTOR (timer
)->contents
;
4382 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4383 || !INTEGERP (vector
[3])
4384 || ! NILP (vector
[0]))
4386 timers
= XCDR (timers
);
4390 if (!NILP (idle_timers
))
4392 timer
= XCAR (idle_timers
);
4393 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4395 idle_timers
= XCDR (idle_timers
);
4398 vector
= XVECTOR (timer
)->contents
;
4400 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4401 || !INTEGERP (vector
[3])
4402 || ! NILP (vector
[0]))
4404 idle_timers
= XCDR (idle_timers
);
4409 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4410 based on the next ordinary timer.
4411 TIMER_DIFFERENCE is the distance in time from NOW to when
4412 this timer becomes ripe (negative if it's already ripe). */
4415 timer
= XCAR (timers
);
4416 vector
= XVECTOR (timer
)->contents
;
4417 EMACS_SET_SECS (timer_time
,
4418 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4419 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4420 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4423 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4424 based on the next idle timer. */
4425 if (!NILP (idle_timers
))
4427 idle_timer
= XCAR (idle_timers
);
4428 vector
= XVECTOR (idle_timer
)->contents
;
4429 EMACS_SET_SECS (idle_timer_time
,
4430 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4431 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4432 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4435 /* Decide which timer is the next timer,
4436 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4437 Also step down the list where we found that timer. */
4439 if (! NILP (timers
) && ! NILP (idle_timers
))
4442 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4443 if (EMACS_TIME_NEG_P (temp
))
4445 chosen_timer
= timer
;
4446 timers
= XCDR (timers
);
4447 difference
= timer_difference
;
4451 chosen_timer
= idle_timer
;
4452 idle_timers
= XCDR (idle_timers
);
4453 difference
= idle_timer_difference
;
4456 else if (! NILP (timers
))
4458 chosen_timer
= timer
;
4459 timers
= XCDR (timers
);
4460 difference
= timer_difference
;
4464 chosen_timer
= idle_timer
;
4465 idle_timers
= XCDR (idle_timers
);
4466 difference
= idle_timer_difference
;
4468 vector
= XVECTOR (chosen_timer
)->contents
;
4470 /* If timer is ripe, run it if it hasn't been run. */
4471 if (EMACS_TIME_NEG_P (difference
)
4472 || (EMACS_SECS (difference
) == 0
4473 && EMACS_USECS (difference
) == 0))
4475 if (NILP (vector
[0]))
4477 int was_locked
= single_kboard
;
4478 int count
= SPECPDL_INDEX ();
4479 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4481 /* Mark the timer as triggered to prevent problems if the lisp
4482 code fails to reschedule it right. */
4485 specbind (Qinhibit_quit
, Qt
);
4487 call1 (Qtimer_event_handler
, chosen_timer
);
4488 Vdeactivate_mark
= old_deactivate_mark
;
4490 unbind_to (count
, Qnil
);
4492 /* Resume allowing input from any kboard, if that was true before. */
4494 any_kboard_state ();
4496 /* Since we have handled the event,
4497 we don't need to tell the caller to wake up and do it. */
4501 /* When we encounter a timer that is still waiting,
4502 return the amount of time to wait before it is ripe. */
4509 /* No timers are pending in the future. */
4510 /* Return 0 if we generated an event, and -1 if not. */
4515 /* Caches for modify_event_symbol. */
4516 static Lisp_Object accent_key_syms
;
4517 static Lisp_Object func_key_syms
;
4518 static Lisp_Object mouse_syms
;
4519 static Lisp_Object wheel_syms
;
4520 static Lisp_Object drag_n_drop_syms
;
4522 /* This is a list of keysym codes for special "accent" characters.
4523 It parallels lispy_accent_keys. */
4525 static int lispy_accent_codes
[] =
4527 #ifdef XK_dead_circumflex
4532 #ifdef XK_dead_grave
4537 #ifdef XK_dead_tilde
4542 #ifdef XK_dead_diaeresis
4547 #ifdef XK_dead_macron
4552 #ifdef XK_dead_degree
4557 #ifdef XK_dead_acute
4562 #ifdef XK_dead_cedilla
4567 #ifdef XK_dead_breve
4572 #ifdef XK_dead_ogonek
4577 #ifdef XK_dead_caron
4582 #ifdef XK_dead_doubleacute
4583 XK_dead_doubleacute
,
4587 #ifdef XK_dead_abovedot
4592 #ifdef XK_dead_abovering
4602 #ifdef XK_dead_belowdot
4607 #ifdef XK_dead_voiced_sound
4608 XK_dead_voiced_sound
,
4612 #ifdef XK_dead_semivoiced_sound
4613 XK_dead_semivoiced_sound
,
4629 /* This is a list of Lisp names for special "accent" characters.
4630 It parallels lispy_accent_codes. */
4632 static char *lispy_accent_keys
[] =
4650 "dead-voiced-sound",
4651 "dead-semivoiced-sound",
4657 #define FUNCTION_KEY_OFFSET 0x0
4659 char *lispy_function_keys
[] =
4663 0, /* VK_LBUTTON 0x01 */
4664 0, /* VK_RBUTTON 0x02 */
4665 "cancel", /* VK_CANCEL 0x03 */
4666 0, /* VK_MBUTTON 0x04 */
4668 0, 0, 0, /* 0x05 .. 0x07 */
4670 "backspace", /* VK_BACK 0x08 */
4671 "tab", /* VK_TAB 0x09 */
4673 0, 0, /* 0x0A .. 0x0B */
4675 "clear", /* VK_CLEAR 0x0C */
4676 "return", /* VK_RETURN 0x0D */
4678 0, 0, /* 0x0E .. 0x0F */
4680 0, /* VK_SHIFT 0x10 */
4681 0, /* VK_CONTROL 0x11 */
4682 0, /* VK_MENU 0x12 */
4683 "pause", /* VK_PAUSE 0x13 */
4684 "capslock", /* VK_CAPITAL 0x14 */
4686 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4688 "escape", /* VK_ESCAPE 0x1B */
4690 0, 0, 0, 0, /* 0x1C .. 0x1F */
4692 0, /* VK_SPACE 0x20 */
4693 "prior", /* VK_PRIOR 0x21 */
4694 "next", /* VK_NEXT 0x22 */
4695 "end", /* VK_END 0x23 */
4696 "home", /* VK_HOME 0x24 */
4697 "left", /* VK_LEFT 0x25 */
4698 "up", /* VK_UP 0x26 */
4699 "right", /* VK_RIGHT 0x27 */
4700 "down", /* VK_DOWN 0x28 */
4701 "select", /* VK_SELECT 0x29 */
4702 "print", /* VK_PRINT 0x2A */
4703 "execute", /* VK_EXECUTE 0x2B */
4704 "snapshot", /* VK_SNAPSHOT 0x2C */
4705 "insert", /* VK_INSERT 0x2D */
4706 "delete", /* VK_DELETE 0x2E */
4707 "help", /* VK_HELP 0x2F */
4709 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4711 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4713 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4715 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4717 0, 0, 0, 0, 0, 0, 0, 0, 0,
4718 0, 0, 0, 0, 0, 0, 0, 0, 0,
4719 0, 0, 0, 0, 0, 0, 0, 0,
4721 "lwindow", /* VK_LWIN 0x5B */
4722 "rwindow", /* VK_RWIN 0x5C */
4723 "apps", /* VK_APPS 0x5D */
4725 0, 0, /* 0x5E .. 0x5F */
4727 "kp-0", /* VK_NUMPAD0 0x60 */
4728 "kp-1", /* VK_NUMPAD1 0x61 */
4729 "kp-2", /* VK_NUMPAD2 0x62 */
4730 "kp-3", /* VK_NUMPAD3 0x63 */
4731 "kp-4", /* VK_NUMPAD4 0x64 */
4732 "kp-5", /* VK_NUMPAD5 0x65 */
4733 "kp-6", /* VK_NUMPAD6 0x66 */
4734 "kp-7", /* VK_NUMPAD7 0x67 */
4735 "kp-8", /* VK_NUMPAD8 0x68 */
4736 "kp-9", /* VK_NUMPAD9 0x69 */
4737 "kp-multiply", /* VK_MULTIPLY 0x6A */
4738 "kp-add", /* VK_ADD 0x6B */
4739 "kp-separator", /* VK_SEPARATOR 0x6C */
4740 "kp-subtract", /* VK_SUBTRACT 0x6D */
4741 "kp-decimal", /* VK_DECIMAL 0x6E */
4742 "kp-divide", /* VK_DIVIDE 0x6F */
4743 "f1", /* VK_F1 0x70 */
4744 "f2", /* VK_F2 0x71 */
4745 "f3", /* VK_F3 0x72 */
4746 "f4", /* VK_F4 0x73 */
4747 "f5", /* VK_F5 0x74 */
4748 "f6", /* VK_F6 0x75 */
4749 "f7", /* VK_F7 0x76 */
4750 "f8", /* VK_F8 0x77 */
4751 "f9", /* VK_F9 0x78 */
4752 "f10", /* VK_F10 0x79 */
4753 "f11", /* VK_F11 0x7A */
4754 "f12", /* VK_F12 0x7B */
4755 "f13", /* VK_F13 0x7C */
4756 "f14", /* VK_F14 0x7D */
4757 "f15", /* VK_F15 0x7E */
4758 "f16", /* VK_F16 0x7F */
4759 "f17", /* VK_F17 0x80 */
4760 "f18", /* VK_F18 0x81 */
4761 "f19", /* VK_F19 0x82 */
4762 "f20", /* VK_F20 0x83 */
4763 "f21", /* VK_F21 0x84 */
4764 "f22", /* VK_F22 0x85 */
4765 "f23", /* VK_F23 0x86 */
4766 "f24", /* VK_F24 0x87 */
4768 0, 0, 0, 0, /* 0x88 .. 0x8B */
4769 0, 0, 0, 0, /* 0x8C .. 0x8F */
4771 "kp-numlock", /* VK_NUMLOCK 0x90 */
4772 "scroll", /* VK_SCROLL 0x91 */
4774 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4775 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4776 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4777 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4778 "kp-end", /* VK_NUMPAD_END 0x96 */
4779 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4780 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4781 "kp-up", /* VK_NUMPAD_UP 0x99 */
4782 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4783 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4784 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4785 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4787 0, 0, /* 0x9E .. 0x9F */
4790 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4791 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4792 * No other API or message will distinguish left and right keys this way.
4796 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4797 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4798 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4799 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4800 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4806 "attn", /* VK_ATTN 0xF6 */
4807 "crsel", /* VK_CRSEL 0xF7 */
4808 "exsel", /* VK_EXSEL 0xF8 */
4809 "ereof", /* VK_EREOF 0xF9 */
4810 "play", /* VK_PLAY 0xFA */
4811 "zoom", /* VK_ZOOM 0xFB */
4812 "noname", /* VK_NONAME 0xFC */
4813 "pa1", /* VK_PA1 0xFD */
4814 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4818 #else /* not HAVE_NTGUI */
4820 /* This should be dealt with in XTread_socket now, and that doesn't
4821 depend on the client system having the Kana syms defined. See also
4822 the XK_kana_A case below. */
4825 static char *lispy_kana_keys
[] =
4827 /* X Keysym value */
4828 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4829 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4830 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4831 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4832 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4833 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4834 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4835 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4836 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4837 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4838 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4839 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4840 "kana-i", "kana-u", "kana-e", "kana-o",
4841 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4842 "prolongedsound", "kana-A", "kana-I", "kana-U",
4843 "kana-E", "kana-O", "kana-KA", "kana-KI",
4844 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4845 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4846 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4847 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4848 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4849 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4850 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4851 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4852 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4853 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4854 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4855 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4857 #endif /* XK_kana_A */
4860 #define FUNCTION_KEY_OFFSET 0xff00
4862 /* You'll notice that this table is arranged to be conveniently
4863 indexed by X Windows keysym values. */
4864 static char *lispy_function_keys
[] =
4866 /* X Keysym value */
4868 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4869 "backspace", "tab", "linefeed", "clear",
4871 0, 0, 0, "pause", /* 0xff10...1f */
4872 0, 0, 0, 0, 0, 0, 0, "escape",
4874 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4875 "romaji", "hiragana", "katakana", "hiragana-katakana",
4876 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4877 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4878 "eisu-toggle", /* 0xff30...3f */
4879 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4880 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4882 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4883 "down", "prior", "next", "end",
4884 "begin", 0, 0, 0, 0, 0, 0, 0,
4885 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4896 "break", /* 0xff6b */
4899 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4900 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4901 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4902 0, 0, 0, 0, 0, 0, 0, 0,
4903 "kp-tab", /* 0xff89 */
4905 "kp-enter", /* 0xff8d */
4907 "kp-f1", /* 0xff91 */
4911 "kp-home", /* 0xff95 */
4916 "kp-prior", /* kp-page-up */
4917 "kp-next", /* kp-page-down */
4923 0, 0, 0, 0, 0, 0, 0, 0, 0,
4924 "kp-multiply", /* 0xffaa */
4929 "kp-divide", /* 0xffaf */
4930 "kp-0", /* 0xffb0 */
4931 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4934 "kp-equal", /* 0xffbd */
4935 "f1", /* 0xffbe */ /* IsFunctionKey */
4937 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4938 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4939 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4940 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4941 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4942 0, 0, 0, 0, 0, 0, 0, 0,
4943 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4944 0, 0, 0, 0, 0, 0, 0, "delete"
4947 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4948 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4950 static char *iso_lispy_function_keys
[] =
4952 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4953 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4954 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4955 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4956 "iso-lefttab", /* 0xfe20 */
4957 "iso-move-line-up", "iso-move-line-down",
4958 "iso-partial-line-up", "iso-partial-line-down",
4959 "iso-partial-space-left", "iso-partial-space-right",
4960 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4961 "iso-release-margin-left", "iso-release-margin-right",
4962 "iso-release-both-margins",
4963 "iso-fast-cursor-left", "iso-fast-cursor-right",
4964 "iso-fast-cursor-up", "iso-fast-cursor-down",
4965 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4966 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4969 #endif /* not HAVE_NTGUI */
4971 Lisp_Object Vlispy_mouse_stem
;
4973 static char *lispy_wheel_names
[] =
4975 "wheel-up", "wheel-down"
4978 /* drag-n-drop events are generated when a set of selected files are
4979 dragged from another application and dropped onto an Emacs window. */
4980 static char *lispy_drag_n_drop_names
[] =
4985 /* Scroll bar parts. */
4986 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4987 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4988 Lisp_Object Qtop
, Qratio
;
4990 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4991 Lisp_Object
*scroll_bar_parts
[] = {
4992 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4993 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4996 /* User signal events. */
4997 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4999 Lisp_Object
*lispy_user_signals
[] =
5001 &Qusr1_signal
, &Qusr2_signal
5005 /* A vector, indexed by button number, giving the down-going location
5006 of currently depressed buttons, both scroll bar and non-scroll bar.
5008 The elements have the form
5009 (BUTTON-NUMBER MODIFIER-MASK . REST)
5010 where REST is the cdr of a position as it would be reported in the event.
5012 The make_lispy_event function stores positions here to tell the
5013 difference between click and drag events, and to store the starting
5014 location to be included in drag events. */
5016 static Lisp_Object button_down_location
;
5018 /* Information about the most recent up-going button event: Which
5019 button, what location, and what time. */
5021 static int last_mouse_button
;
5022 static int last_mouse_x
;
5023 static int last_mouse_y
;
5024 static unsigned long button_down_time
;
5026 /* The maximum time between clicks to make a double-click, or Qnil to
5027 disable double-click detection, or Qt for no time limit. */
5029 Lisp_Object Vdouble_click_time
;
5031 /* Maximum number of pixels the mouse may be moved between clicks
5032 to make a double-click. */
5034 EMACS_INT double_click_fuzz
;
5036 /* The number of clicks in this multiple-click. */
5038 int double_click_count
;
5040 /* Return position of a mouse click or wheel event */
5043 make_lispy_position (f
, x
, y
, time
)
5049 enum window_part part
;
5050 Lisp_Object posn
= Qnil
;
5051 Lisp_Object extra_info
= Qnil
;
5054 /* Set `window' to the window under frame pixel coordinates (x,y) */
5056 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5057 &part
, &wx
, &wy
, 0);
5061 if (WINDOWP (window
))
5063 /* It's a click in window window at frame coordinates (x,y) */
5064 struct window
*w
= XWINDOW (window
);
5065 Lisp_Object string_info
= Qnil
;
5066 int textpos
= -1, rx
= -1, ry
= -1;
5067 int dx
= -1, dy
= -1;
5068 int width
= -1, height
= -1;
5069 Lisp_Object object
= Qnil
;
5071 /* Set event coordinates to window-relative coordinates
5072 for constructing the Lisp event below. */
5076 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5078 /* Mode line or header line. Look for a string under
5079 the mouse that may have a `local-map' property. */
5083 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5085 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5086 &object
, &dx
, &dy
, &width
, &height
);
5087 if (STRINGP (string
))
5088 string_info
= Fcons (string
, make_number (charpos
));
5089 if (w
== XWINDOW (selected_window
))
5092 textpos
= XMARKER (w
->pointm
)->charpos
;
5094 else if (part
== ON_VERTICAL_BORDER
)
5096 posn
= Qvertical_line
;
5101 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5106 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5108 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5109 &object
, &dx
, &dy
, &width
, &height
);
5110 if (STRINGP (string
))
5111 string_info
= Fcons (string
, make_number (charpos
));
5113 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5115 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5118 if (part
== ON_RIGHT_FRINGE
)
5119 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5120 + window_box_width (w
, TEXT_AREA
)
5121 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5122 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5124 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5125 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5130 Lisp_Object string2
, object2
= Qnil
;
5131 struct display_pos p
;
5133 int width2
, height2
;
5134 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5135 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5136 &object2
, &dx2
, &dy2
,
5138 textpos
= CHARPOS (p
.pos
);
5139 if (rx
< 0) rx
= wx
;
5140 if (ry
< 0) ry
= wy
;
5141 if (dx
< 0) dx
= dx2
;
5142 if (dy
< 0) dy
= dy2
;
5143 if (width
< 0) width
= width2
;
5144 if (height
< 0) height
= height2
;
5148 posn
= make_number (textpos
);
5149 if (STRINGP (string2
))
5150 string_info
= Fcons (string2
,
5151 make_number (CHARPOS (p
.string_pos
)));
5157 #ifdef HAVE_WINDOW_SYSTEM
5158 if (IMAGEP (object
))
5160 Lisp_Object image_map
, hotspot
;
5161 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5163 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5165 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5166 posn
= XCAR (hotspot
);
5171 extra_info
= Fcons (object
,
5172 Fcons (Fcons (make_number (dx
),
5174 Fcons (Fcons (make_number (width
),
5175 make_number (height
)),
5179 extra_info
= Fcons (string_info
,
5180 Fcons (make_number (textpos
),
5181 Fcons (Fcons (make_number (rx
),
5187 XSETFRAME (window
, f
);
5192 XSETFASTINT (*x
, 0);
5193 XSETFASTINT (*y
, 0);
5196 return Fcons (window
,
5198 Fcons (Fcons (*x
, *y
),
5199 Fcons (make_number (time
),
5203 /* Given a struct input_event, build the lisp event which represents
5204 it. If EVENT is 0, build a mouse movement event from the mouse
5205 movement buffer, which should have a movement event in it.
5207 Note that events must be passed to this function in the order they
5208 are received; this function stores the location of button presses
5209 in order to build drag events when the button is released. */
5212 make_lispy_event (event
)
5213 struct input_event
*event
;
5217 switch (SWITCH_ENUM_CAST (event
->kind
))
5219 /* A simple keystroke. */
5220 case ASCII_KEYSTROKE_EVENT
:
5222 Lisp_Object lispy_c
;
5223 int c
= event
->code
& 0377;
5224 /* Turn ASCII characters into control characters
5226 if (event
->modifiers
& ctrl_modifier
)
5227 c
= make_ctrl_char (c
);
5229 /* Add in the other modifier bits. We took care of ctrl_modifier
5230 just above, and the shift key was taken care of by the X code,
5231 and applied to control characters by make_ctrl_char. */
5232 c
|= (event
->modifiers
5233 & (meta_modifier
| alt_modifier
5234 | hyper_modifier
| super_modifier
));
5235 /* Distinguish Shift-SPC from SPC. */
5236 if ((event
->code
& 0377) == 040
5237 && event
->modifiers
& shift_modifier
)
5238 c
|= shift_modifier
;
5239 button_down_time
= 0;
5240 XSETFASTINT (lispy_c
, c
);
5244 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5246 Lisp_Object lispy_c
;
5247 int c
= event
->code
;
5249 /* Add in the other modifier bits. We took care of ctrl_modifier
5250 just above, and the shift key was taken care of by the X code,
5251 and applied to control characters by make_ctrl_char. */
5252 c
|= (event
->modifiers
5253 & (meta_modifier
| alt_modifier
5254 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5255 /* What about the `shift' modifier ? */
5256 button_down_time
= 0;
5257 XSETFASTINT (lispy_c
, c
);
5261 /* A function key. The symbol may need to have modifier prefixes
5263 case NON_ASCII_KEYSTROKE_EVENT
:
5264 button_down_time
= 0;
5266 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5267 if (event
->code
== lispy_accent_codes
[i
])
5268 return modify_event_symbol (i
,
5270 Qfunction_key
, Qnil
,
5271 lispy_accent_keys
, &accent_key_syms
,
5272 (sizeof (lispy_accent_keys
)
5273 / sizeof (lispy_accent_keys
[0])));
5277 if (event
->code
>= 0x400 && event
->code
< 0x500)
5278 return modify_event_symbol (event
->code
- 0x400,
5279 event
->modifiers
& ~shift_modifier
,
5280 Qfunction_key
, Qnil
,
5281 lispy_kana_keys
, &func_key_syms
,
5282 (sizeof (lispy_kana_keys
)
5283 / sizeof (lispy_kana_keys
[0])));
5284 #endif /* XK_kana_A */
5287 #ifdef ISO_FUNCTION_KEY_OFFSET
5288 if (event
->code
< FUNCTION_KEY_OFFSET
5289 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5290 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5292 Qfunction_key
, Qnil
,
5293 iso_lispy_function_keys
, &func_key_syms
,
5294 (sizeof (iso_lispy_function_keys
)
5295 / sizeof (iso_lispy_function_keys
[0])));
5298 /* Handle system-specific or unknown keysyms. */
5299 if (event
->code
& (1 << 28)
5300 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5301 || (event
->code
- FUNCTION_KEY_OFFSET
5302 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5303 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5305 /* We need to use an alist rather than a vector as the cache
5306 since we can't make a vector long enuf. */
5307 if (NILP (current_kboard
->system_key_syms
))
5308 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5309 return modify_event_symbol (event
->code
,
5312 current_kboard
->Vsystem_key_alist
,
5313 0, ¤t_kboard
->system_key_syms
,
5317 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5319 Qfunction_key
, Qnil
,
5320 lispy_function_keys
, &func_key_syms
,
5321 (sizeof (lispy_function_keys
)
5322 / sizeof (lispy_function_keys
[0])));
5325 /* A mouse click. Figure out where it is, decide whether it's
5326 a press, click or drag, and build the appropriate structure. */
5327 case MOUSE_CLICK_EVENT
:
5328 #ifndef USE_TOOLKIT_SCROLL_BARS
5329 case SCROLL_BAR_CLICK_EVENT
:
5332 int button
= event
->code
;
5334 Lisp_Object position
;
5335 Lisp_Object
*start_pos_ptr
;
5336 Lisp_Object start_pos
;
5340 /* Build the position as appropriate for this mouse click. */
5341 if (event
->kind
== MOUSE_CLICK_EVENT
)
5343 struct frame
*f
= XFRAME (event
->frame_or_window
);
5344 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5348 /* Ignore mouse events that were made on frame that
5349 have been deleted. */
5350 if (! FRAME_LIVE_P (f
))
5353 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5354 /* EVENT->x and EVENT->y are frame-relative pixel
5355 coordinates at this place. Under old redisplay, COLUMN
5356 and ROW are set to frame relative glyph coordinates
5357 which are then used to determine whether this click is
5358 in a menu (non-toolkit version). */
5359 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5360 &column
, &row
, NULL
, 1);
5362 /* In the non-toolkit version, clicks on the menu bar
5363 are ordinary button events in the event buffer.
5364 Distinguish them, and invoke the menu.
5366 (In the toolkit version, the toolkit handles the menu bar
5367 and Emacs doesn't know about it until after the user
5368 makes a selection.) */
5369 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5370 && (event
->modifiers
& down_modifier
))
5372 Lisp_Object items
, item
;
5377 /* Activate the menu bar on the down event. If the
5378 up event comes in before the menu code can deal with it,
5380 if (! (event
->modifiers
& down_modifier
))
5384 /* Find the menu bar item under `column'. */
5386 items
= FRAME_MENU_BAR_ITEMS (f
);
5387 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5389 Lisp_Object pos
, string
;
5390 string
= AREF (items
, i
+ 1);
5391 pos
= AREF (items
, i
+ 3);
5394 if (column
>= XINT (pos
)
5395 && column
< XINT (pos
) + SCHARS (string
))
5397 item
= AREF (items
, i
);
5402 /* ELisp manual 2.4b says (x y) are window relative but
5403 code says they are frame-relative. */
5405 = Fcons (event
->frame_or_window
,
5407 Fcons (Fcons (event
->x
, event
->y
),
5408 Fcons (make_number (event
->timestamp
),
5411 return Fcons (item
, Fcons (position
, Qnil
));
5413 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5415 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5418 #ifndef USE_TOOLKIT_SCROLL_BARS
5421 /* It's a scrollbar click. */
5423 Lisp_Object portion_whole
;
5426 window
= event
->frame_or_window
;
5427 portion_whole
= Fcons (event
->x
, event
->y
);
5428 part
= *scroll_bar_parts
[(int) event
->part
];
5432 Fcons (Qvertical_scroll_bar
,
5433 Fcons (portion_whole
,
5434 Fcons (make_number (event
->timestamp
),
5435 Fcons (part
, Qnil
)))));
5437 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5439 if (button
>= ASIZE (button_down_location
))
5441 button_down_location
= larger_vector (button_down_location
,
5443 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5446 start_pos_ptr
= &AREF (button_down_location
, button
);
5447 start_pos
= *start_pos_ptr
;
5448 *start_pos_ptr
= Qnil
;
5451 /* On window-system frames, use the value of
5452 double-click-fuzz as is. On other frames, interpret it
5453 as a multiple of 1/8 characters. */
5457 if (WINDOWP (event
->frame_or_window
))
5458 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5459 else if (FRAMEP (event
->frame_or_window
))
5460 f
= XFRAME (event
->frame_or_window
);
5464 if (FRAME_WINDOW_P (f
))
5465 fuzz
= double_click_fuzz
;
5467 fuzz
= double_click_fuzz
/ 8;
5469 is_double
= (button
== last_mouse_button
5470 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5471 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5472 && button_down_time
!= 0
5473 && (EQ (Vdouble_click_time
, Qt
)
5474 || (INTEGERP (Vdouble_click_time
)
5475 && ((int)(event
->timestamp
- button_down_time
)
5476 < XINT (Vdouble_click_time
)))));
5479 last_mouse_button
= button
;
5480 last_mouse_x
= XINT (event
->x
);
5481 last_mouse_y
= XINT (event
->y
);
5483 /* If this is a button press, squirrel away the location, so
5484 we can decide later whether it was a click or a drag. */
5485 if (event
->modifiers
& down_modifier
)
5489 double_click_count
++;
5490 event
->modifiers
|= ((double_click_count
> 2)
5495 double_click_count
= 1;
5496 button_down_time
= event
->timestamp
;
5497 *start_pos_ptr
= Fcopy_alist (position
);
5500 /* Now we're releasing a button - check the co-ordinates to
5501 see if this was a click or a drag. */
5502 else if (event
->modifiers
& up_modifier
)
5504 /* If we did not see a down before this up, ignore the up.
5505 Probably this happened because the down event chose a
5506 menu item. It would be an annoyance to treat the
5507 release of the button that chose the menu item as a
5510 if (!CONSP (start_pos
))
5513 event
->modifiers
&= ~up_modifier
;
5514 #if 0 /* Formerly we treated an up with no down as a click event. */
5515 if (!CONSP (start_pos
))
5516 event
->modifiers
|= click_modifier
;
5521 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5523 /* The third element of every position
5524 should be the (x,y) pair. */
5525 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5527 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5529 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5530 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5533 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5534 && ydiff
< double_click_fuzz
5535 && ydiff
> - double_click_fuzz
)
5536 /* Mouse hasn't moved (much). */
5537 event
->modifiers
|= click_modifier
;
5540 button_down_time
= 0;
5541 event
->modifiers
|= drag_modifier
;
5544 /* Don't check is_double; treat this as multiple
5545 if the down-event was multiple. */
5546 if (double_click_count
> 1)
5547 event
->modifiers
|= ((double_click_count
> 2)
5553 /* Every mouse event should either have the down_modifier or
5554 the up_modifier set. */
5558 /* Get the symbol we should use for the mouse click. */
5561 head
= modify_event_symbol (button
,
5563 Qmouse_click
, Vlispy_mouse_stem
,
5566 XVECTOR (mouse_syms
)->size
);
5567 if (event
->modifiers
& drag_modifier
)
5572 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5575 Fcons (make_number (double_click_count
),
5586 Lisp_Object position
;
5589 /* Build the position as appropriate for this mouse click. */
5590 struct frame
*f
= XFRAME (event
->frame_or_window
);
5592 /* Ignore wheel events that were made on frame that have been
5594 if (! FRAME_LIVE_P (f
))
5597 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5600 /* Set double or triple modifiers to indicate the wheel speed. */
5602 /* On window-system frames, use the value of
5603 double-click-fuzz as is. On other frames, interpret it
5604 as a multiple of 1/8 characters. */
5609 if (WINDOWP (event
->frame_or_window
))
5610 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5611 else if (FRAMEP (event
->frame_or_window
))
5612 f
= XFRAME (event
->frame_or_window
);
5616 if (FRAME_WINDOW_P (f
))
5617 fuzz
= double_click_fuzz
;
5619 fuzz
= double_click_fuzz
/ 8;
5621 is_double
= (last_mouse_button
< 0
5622 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5623 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5624 && button_down_time
!= 0
5625 && (EQ (Vdouble_click_time
, Qt
)
5626 || (INTEGERP (Vdouble_click_time
)
5627 && ((int)(event
->timestamp
- button_down_time
)
5628 < XINT (Vdouble_click_time
)))));
5631 double_click_count
++;
5632 event
->modifiers
|= ((double_click_count
> 2)
5638 double_click_count
= 1;
5639 event
->modifiers
|= click_modifier
;
5642 button_down_time
= event
->timestamp
;
5643 /* Use a negative value to distinguish wheel from mouse button. */
5644 last_mouse_button
= -1;
5645 last_mouse_x
= XINT (event
->x
);
5646 last_mouse_y
= XINT (event
->y
);
5652 if (event
->modifiers
& up_modifier
)
5654 /* Emit a wheel-up event. */
5655 event
->modifiers
&= ~up_modifier
;
5658 else if (event
->modifiers
& down_modifier
)
5660 /* Emit a wheel-down event. */
5661 event
->modifiers
&= ~down_modifier
;
5665 /* Every wheel event should either have the down_modifier or
5666 the up_modifier set. */
5669 /* Get the symbol we should use for the wheel event. */
5670 head
= modify_event_symbol (symbol_num
,
5676 ASIZE (wheel_syms
));
5679 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5682 Fcons (make_number (double_click_count
),
5691 #ifdef USE_TOOLKIT_SCROLL_BARS
5693 /* We don't have down and up events if using toolkit scroll bars,
5694 so make this always a click event. Store in the `part' of
5695 the Lisp event a symbol which maps to the following actions:
5697 `above_handle' page up
5698 `below_handle' page down
5702 `bottom' bottom of buffer
5703 `handle' thumb has been dragged.
5704 `end-scroll' end of interaction with scroll bar
5706 The incoming input_event contains in its `part' member an
5707 index of type `enum scroll_bar_part' which we can use as an
5708 index in scroll_bar_parts to get the appropriate symbol. */
5710 case SCROLL_BAR_CLICK_EVENT
:
5712 Lisp_Object position
, head
, window
, portion_whole
, part
;
5714 window
= event
->frame_or_window
;
5715 portion_whole
= Fcons (event
->x
, event
->y
);
5716 part
= *scroll_bar_parts
[(int) event
->part
];
5720 Fcons (Qvertical_scroll_bar
,
5721 Fcons (portion_whole
,
5722 Fcons (make_number (event
->timestamp
),
5723 Fcons (part
, Qnil
)))));
5725 /* Always treat scroll bar events as clicks. */
5726 event
->modifiers
|= click_modifier
;
5727 event
->modifiers
&= ~up_modifier
;
5729 if (event
->code
>= ASIZE (mouse_syms
))
5730 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5732 /* Get the symbol we should use for the mouse click. */
5733 head
= modify_event_symbol (event
->code
,
5738 XVECTOR (mouse_syms
)->size
);
5739 return Fcons (head
, Fcons (position
, Qnil
));
5742 #endif /* USE_TOOLKIT_SCROLL_BARS */
5745 case W32_SCROLL_BAR_CLICK_EVENT
:
5747 int button
= event
->code
;
5749 Lisp_Object position
;
5750 Lisp_Object
*start_pos_ptr
;
5751 Lisp_Object start_pos
;
5755 Lisp_Object portion_whole
;
5758 window
= event
->frame_or_window
;
5759 portion_whole
= Fcons (event
->x
, event
->y
);
5760 part
= *scroll_bar_parts
[(int) event
->part
];
5764 Fcons (Qvertical_scroll_bar
,
5765 Fcons (portion_whole
,
5766 Fcons (make_number (event
->timestamp
),
5767 Fcons (part
, Qnil
)))));
5770 /* Always treat W32 scroll bar events as clicks. */
5771 event
->modifiers
|= click_modifier
;
5774 /* Get the symbol we should use for the mouse click. */
5777 head
= modify_event_symbol (button
,
5782 XVECTOR (mouse_syms
)->size
);
5788 #endif /* WINDOWSNT */
5790 case DRAG_N_DROP_EVENT
:
5793 Lisp_Object head
, position
;
5796 /* The frame_or_window field should be a cons of the frame in
5797 which the event occurred and a list of the filenames
5799 if (! CONSP (event
->frame_or_window
))
5802 f
= XFRAME (XCAR (event
->frame_or_window
));
5803 files
= XCDR (event
->frame_or_window
);
5805 /* Ignore mouse events that were made on frames that
5806 have been deleted. */
5807 if (! FRAME_LIVE_P (f
))
5810 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5813 head
= modify_event_symbol (0, event
->modifiers
,
5815 lispy_drag_n_drop_names
,
5816 &drag_n_drop_syms
, 1);
5822 #endif /* HAVE_MOUSE */
5824 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5825 || defined (USE_GTK)
5826 case MENU_BAR_EVENT
:
5827 if (EQ (event
->arg
, event
->frame_or_window
))
5828 /* This is the prefix key. We translate this to
5829 `(menu_bar)' because the code in keyboard.c for menu
5830 events, which we use, relies on this. */
5831 return Fcons (Qmenu_bar
, Qnil
);
5835 case SELECT_WINDOW_EVENT
:
5836 /* Make an event (select-window (WINDOW)). */
5837 return Fcons (Qselect_window
,
5838 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5841 case TOOL_BAR_EVENT
:
5842 if (EQ (event
->arg
, event
->frame_or_window
))
5843 /* This is the prefix key. We translate this to
5844 `(tool_bar)' because the code in keyboard.c for tool bar
5845 events, which we use, relies on this. */
5846 return Fcons (Qtool_bar
, Qnil
);
5847 else if (SYMBOLP (event
->arg
))
5848 return apply_modifiers (event
->modifiers
, event
->arg
);
5851 case USER_SIGNAL_EVENT
:
5852 /* A user signal. */
5853 return *lispy_user_signals
[event
->code
];
5855 case SAVE_SESSION_EVENT
:
5856 return Qsave_session
;
5858 /* The 'kind' field of the event is something we don't recognize. */
5867 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5869 Lisp_Object bar_window
;
5870 enum scroll_bar_part part
;
5874 /* Is it a scroll bar movement? */
5875 if (frame
&& ! NILP (bar_window
))
5877 Lisp_Object part_sym
;
5879 part_sym
= *scroll_bar_parts
[(int) part
];
5880 return Fcons (Qscroll_bar_movement
,
5881 (Fcons (Fcons (bar_window
,
5882 Fcons (Qvertical_scroll_bar
,
5883 Fcons (Fcons (x
, y
),
5884 Fcons (make_number (time
),
5890 /* Or is it an ordinary mouse movement? */
5893 Lisp_Object position
;
5895 position
= make_lispy_position (frame
, &x
, &y
, time
);
5897 return Fcons (Qmouse_movement
,
5903 #endif /* HAVE_MOUSE */
5905 /* Construct a switch frame event. */
5907 make_lispy_switch_frame (frame
)
5910 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5913 /* Manipulating modifiers. */
5915 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5917 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5918 SYMBOL's name of the end of the modifiers; the string from this
5919 position is the unmodified symbol name.
5921 This doesn't use any caches. */
5924 parse_modifiers_uncached (symbol
, modifier_end
)
5932 CHECK_SYMBOL (symbol
);
5935 name
= SYMBOL_NAME (symbol
);
5937 for (i
= 0; i
+2 <= SBYTES (name
); )
5939 int this_mod_end
= 0;
5942 /* See if the name continues with a modifier word.
5943 Check that the word appears, but don't check what follows it.
5944 Set this_mod and this_mod_end to record what we find. */
5946 switch (SREF (name
, i
))
5948 #define SINGLE_LETTER_MOD(BIT) \
5949 (this_mod_end = i + 1, this_mod = BIT)
5952 SINGLE_LETTER_MOD (alt_modifier
);
5956 SINGLE_LETTER_MOD (ctrl_modifier
);
5960 SINGLE_LETTER_MOD (hyper_modifier
);
5964 SINGLE_LETTER_MOD (meta_modifier
);
5968 SINGLE_LETTER_MOD (shift_modifier
);
5972 SINGLE_LETTER_MOD (super_modifier
);
5975 #undef SINGLE_LETTER_MOD
5977 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5978 if (i + LEN + 1 <= SBYTES (name) \
5979 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5981 this_mod_end = i + LEN; \
5986 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5987 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5988 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5992 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5994 #undef MULTI_LETTER_MOD
5998 /* If we found no modifier, stop looking for them. */
5999 if (this_mod_end
== 0)
6002 /* Check there is a dash after the modifier, so that it
6003 really is a modifier. */
6004 if (this_mod_end
>= SBYTES (name
)
6005 || SREF (name
, this_mod_end
) != '-')
6008 /* This modifier is real; look for another. */
6009 modifiers
|= this_mod
;
6010 i
= this_mod_end
+ 1;
6013 /* Should we include the `click' modifier? */
6014 if (! (modifiers
& (down_modifier
| drag_modifier
6015 | double_modifier
| triple_modifier
))
6016 && i
+ 7 == SBYTES (name
)
6017 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6018 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6019 modifiers
|= click_modifier
;
6027 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6028 prepended to the string BASE[0..BASE_LEN-1].
6029 This doesn't use any caches. */
6031 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6034 int base_len
, base_len_byte
;
6036 /* Since BASE could contain nulls, we can't use intern here; we have
6037 to use Fintern, which expects a genuine Lisp_String, and keeps a
6040 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6046 /* Only the event queue may use the `up' modifier; it should always
6047 be turned into a click or drag event before presented to lisp code. */
6048 if (modifiers
& up_modifier
)
6051 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6052 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6053 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6054 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6055 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6056 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6057 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6058 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6059 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6060 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6061 /* The click modifier is denoted by the absence of other modifiers. */
6065 mod_len
= p
- new_mods
;
6069 Lisp_Object new_name
;
6071 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6072 mod_len
+ base_len_byte
);
6073 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6074 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6076 return Fintern (new_name
, Qnil
);
6081 static char *modifier_names
[] =
6083 "up", "down", "drag", "click", "double", "triple", 0, 0,
6084 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6085 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6087 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6089 static Lisp_Object modifier_symbols
;
6091 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6093 lispy_modifier_list (modifiers
)
6096 Lisp_Object modifier_list
;
6099 modifier_list
= Qnil
;
6100 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6101 if (modifiers
& (1<<i
))
6102 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6105 return modifier_list
;
6109 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6110 where UNMODIFIED is the unmodified form of SYMBOL,
6111 MASK is the set of modifiers present in SYMBOL's name.
6112 This is similar to parse_modifiers_uncached, but uses the cache in
6113 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6114 Qevent_symbol_elements property. */
6117 parse_modifiers (symbol
)
6120 Lisp_Object elements
;
6122 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6123 if (CONSP (elements
))
6128 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6129 Lisp_Object unmodified
;
6132 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6133 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6136 if (modifiers
& ~INTMASK
)
6138 XSETFASTINT (mask
, modifiers
);
6139 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6141 /* Cache the parsing results on SYMBOL. */
6142 Fput (symbol
, Qevent_symbol_element_mask
,
6144 Fput (symbol
, Qevent_symbol_elements
,
6145 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6147 /* Since we know that SYMBOL is modifiers applied to unmodified,
6148 it would be nice to put that in unmodified's cache.
6149 But we can't, since we're not sure that parse_modifiers is
6156 /* Apply the modifiers MODIFIERS to the symbol BASE.
6157 BASE must be unmodified.
6159 This is like apply_modifiers_uncached, but uses BASE's
6160 Qmodifier_cache property, if present. It also builds
6161 Qevent_symbol_elements properties, since it has that info anyway.
6163 apply_modifiers copies the value of BASE's Qevent_kind property to
6164 the modified symbol. */
6166 apply_modifiers (modifiers
, base
)
6170 Lisp_Object cache
, index
, entry
, new_symbol
;
6172 /* Mask out upper bits. We don't know where this value's been. */
6173 modifiers
&= INTMASK
;
6175 /* The click modifier never figures into cache indices. */
6176 cache
= Fget (base
, Qmodifier_cache
);
6177 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6178 entry
= assq_no_quit (index
, cache
);
6181 new_symbol
= XCDR (entry
);
6184 /* We have to create the symbol ourselves. */
6185 new_symbol
= apply_modifiers_uncached (modifiers
,
6186 SDATA (SYMBOL_NAME (base
)),
6187 SCHARS (SYMBOL_NAME (base
)),
6188 SBYTES (SYMBOL_NAME (base
)));
6190 /* Add the new symbol to the base's cache. */
6191 entry
= Fcons (index
, new_symbol
);
6192 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6194 /* We have the parsing info now for free, so we could add it to
6196 XSETFASTINT (index, modifiers);
6197 Fput (new_symbol, Qevent_symbol_element_mask,
6198 Fcons (base, Fcons (index, Qnil)));
6199 Fput (new_symbol, Qevent_symbol_elements,
6200 Fcons (base, lispy_modifier_list (modifiers)));
6201 Sadly, this is only correct if `base' is indeed a base event,
6202 which is not necessarily the case. -stef */
6205 /* Make sure this symbol is of the same kind as BASE.
6207 You'd think we could just set this once and for all when we
6208 intern the symbol above, but reorder_modifiers may call us when
6209 BASE's property isn't set right; we can't assume that just
6210 because it has a Qmodifier_cache property it must have its
6211 Qevent_kind set right as well. */
6212 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6216 kind
= Fget (base
, Qevent_kind
);
6218 Fput (new_symbol
, Qevent_kind
, kind
);
6225 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6226 return a symbol with the modifiers placed in the canonical order.
6227 Canonical order is alphabetical, except for down and drag, which
6228 always come last. The 'click' modifier is never written out.
6230 Fdefine_key calls this to make sure that (for example) C-M-foo
6231 and M-C-foo end up being equivalent in the keymap. */
6234 reorder_modifiers (symbol
)
6237 /* It's hopefully okay to write the code this way, since everything
6238 will soon be in caches, and no consing will be done at all. */
6241 parsed
= parse_modifiers (symbol
);
6242 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6247 /* For handling events, we often want to produce a symbol whose name
6248 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6249 to some base, like the name of a function key or mouse button.
6250 modify_event_symbol produces symbols of this sort.
6252 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6253 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6256 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6257 into symbol names, or a string specifying a name stem used to
6258 construct a symbol name or the form `STEM-N', where N is the decimal
6259 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6260 non-nil; otherwise NAME_TABLE is used.
6262 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6263 persist between calls to modify_event_symbol that it can use to
6264 store a cache of the symbols it's generated for this NAME_TABLE
6265 before. The object stored there may be a vector or an alist.
6267 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6269 MODIFIERS is a set of modifier bits (as given in struct input_events)
6270 whose prefixes should be applied to the symbol name.
6272 SYMBOL_KIND is the value to be placed in the event_kind property of
6273 the returned symbol.
6275 The symbols we create are supposed to have an
6276 `event-symbol-elements' property, which lists the modifiers present
6277 in the symbol's name. */
6280 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6281 name_table
, symbol_table
, table_size
)
6284 Lisp_Object symbol_kind
;
6285 Lisp_Object name_alist_or_stem
;
6287 Lisp_Object
*symbol_table
;
6288 unsigned int table_size
;
6291 Lisp_Object symbol_int
;
6293 /* Get rid of the "vendor-specific" bit here. */
6294 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6296 /* Is this a request for a valid symbol? */
6297 if (symbol_num
< 0 || symbol_num
>= table_size
)
6300 if (CONSP (*symbol_table
))
6301 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6303 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6304 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6305 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6306 we've never used that symbol before. */
6309 if (! VECTORP (*symbol_table
)
6310 || XVECTOR (*symbol_table
)->size
!= table_size
)
6314 XSETFASTINT (size
, table_size
);
6315 *symbol_table
= Fmake_vector (size
, Qnil
);
6318 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6321 /* Have we already used this symbol before? */
6324 /* No; let's create it. */
6325 if (CONSP (name_alist_or_stem
))
6326 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6327 else if (STRINGP (name_alist_or_stem
))
6329 int len
= SBYTES (name_alist_or_stem
);
6330 char *buf
= (char *) alloca (len
+ 50);
6331 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6332 (long) XINT (symbol_int
) + 1);
6333 value
= intern (buf
);
6335 else if (name_table
!= 0 && name_table
[symbol_num
])
6336 value
= intern (name_table
[symbol_num
]);
6338 #ifdef HAVE_WINDOW_SYSTEM
6341 char *name
= x_get_keysym_name (symbol_num
);
6343 value
= intern (name
);
6350 sprintf (buf
, "key-%d", symbol_num
);
6351 value
= intern (buf
);
6354 if (CONSP (*symbol_table
))
6355 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6357 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6359 /* Fill in the cache entries for this symbol; this also
6360 builds the Qevent_symbol_elements property, which the user
6362 apply_modifiers (modifiers
& click_modifier
, value
);
6363 Fput (value
, Qevent_kind
, symbol_kind
);
6366 /* Apply modifiers to that symbol. */
6367 return apply_modifiers (modifiers
, value
);
6370 /* Convert a list that represents an event type,
6371 such as (ctrl meta backspace), into the usual representation of that
6372 event type as a number or a symbol. */
6374 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6375 doc
: /* Convert the event description list EVENT-DESC to an event type.
6376 EVENT-DESC should contain one base event type (a character or symbol)
6377 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6378 drag, down, double or triple). The base must be last.
6379 The return value is an event type (a character or symbol) which
6380 has the same base event type and all the specified modifiers. */)
6382 Lisp_Object event_desc
;
6390 while (CONSP (rest
))
6398 /* Given a symbol, see if it is a modifier name. */
6399 if (SYMBOLP (elt
) && CONSP (rest
))
6400 this = parse_solitary_modifier (elt
);
6404 else if (!NILP (base
))
6405 error ("Two bases given in one event");
6411 /* Let the symbol A refer to the character A. */
6412 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6413 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6415 if (INTEGERP (base
))
6417 /* Turn (shift a) into A. */
6418 if ((modifiers
& shift_modifier
) != 0
6419 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6421 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6422 modifiers
&= ~shift_modifier
;
6425 /* Turn (control a) into C-a. */
6426 if (modifiers
& ctrl_modifier
)
6427 return make_number ((modifiers
& ~ctrl_modifier
)
6428 | make_ctrl_char (XINT (base
)));
6430 return make_number (modifiers
| XINT (base
));
6432 else if (SYMBOLP (base
))
6433 return apply_modifiers (modifiers
, base
);
6436 error ("Invalid base event");
6441 /* Try to recognize SYMBOL as a modifier name.
6442 Return the modifier flag bit, or 0 if not recognized. */
6445 parse_solitary_modifier (symbol
)
6448 Lisp_Object name
= SYMBOL_NAME (symbol
);
6450 switch (SREF (name
, 0))
6452 #define SINGLE_LETTER_MOD(BIT) \
6453 if (SBYTES (name) == 1) \
6456 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6457 if (LEN == SBYTES (name) \
6458 && ! strncmp (SDATA (name), NAME, LEN)) \
6462 SINGLE_LETTER_MOD (alt_modifier
);
6466 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6470 SINGLE_LETTER_MOD (ctrl_modifier
);
6474 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6475 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6479 SINGLE_LETTER_MOD (hyper_modifier
);
6483 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6487 SINGLE_LETTER_MOD (meta_modifier
);
6491 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6495 SINGLE_LETTER_MOD (shift_modifier
);
6499 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6500 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6501 SINGLE_LETTER_MOD (super_modifier
);
6505 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6506 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6507 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6511 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6514 #undef SINGLE_LETTER_MOD
6515 #undef MULTI_LETTER_MOD
6521 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6522 Such a list is not valid as an event,
6523 but it can be a Lucid-style event type list. */
6526 lucid_event_type_list_p (object
)
6531 if (! CONSP (object
))
6534 if (EQ (XCAR (object
), Qhelp_echo
)
6535 || EQ (XCAR (object
), Qvertical_line
)
6536 || EQ (XCAR (object
), Qmode_line
)
6537 || EQ (XCAR (object
), Qheader_line
))
6540 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6544 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6551 /* Store into *addr a value nonzero if terminal input chars are available.
6552 Serves the purpose of ioctl (0, FIONREAD, addr)
6553 but works even if FIONREAD does not exist.
6554 (In fact, this may actually read some input.)
6556 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6557 timer events that are ripe.
6558 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6559 events (FOCUS_IN_EVENT).
6560 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6561 movements and toolkit scroll bar thumb drags. */
6564 get_input_pending (addr
, flags
)
6568 /* First of all, have we already counted some input? */
6569 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6571 /* If input is being read as it arrives, and we have none, there is none. */
6572 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6575 /* Try to read some input and see how much we get. */
6577 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6580 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6583 gobble_input (expected
)
6588 if (interrupt_input
)
6591 mask
= sigblock (sigmask (SIGIO
));
6592 read_avail_input (expected
);
6596 #ifdef POLL_FOR_INPUT
6597 /* XXX This condition was (read_socket_hook && !interrupt_input),
6598 but read_socket_hook is not global anymore. Let's pretend that
6600 if (!interrupt_input
&& poll_suppress_count
== 0)
6603 mask
= sigblock (sigmask (SIGALRM
));
6604 read_avail_input (expected
);
6610 read_avail_input (expected
);
6614 /* Put a BUFFER_SWITCH_EVENT in the buffer
6615 so that read_key_sequence will notice the new current buffer. */
6618 record_asynch_buffer_change ()
6620 struct input_event event
;
6624 event
.kind
= BUFFER_SWITCH_EVENT
;
6625 event
.frame_or_window
= Qnil
;
6629 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6630 The purpose of the event is to make read_key_sequence look up the
6631 keymaps again. If we aren't in read_key_sequence, we don't need one,
6632 and the event could cause trouble by messing up (input-pending-p). */
6633 tem
= Fwaiting_for_user_input_p ();
6637 /* We never need these events if we have no asynchronous subprocesses. */
6641 /* Make sure no interrupt happens while storing the event. */
6643 if (interrupt_input
)
6646 mask
= sigblock (sigmask (SIGIO
));
6647 kbd_buffer_store_event (&event
);
6654 kbd_buffer_store_event (&event
);
6661 /* Read any terminal input already buffered up by the system
6662 into the kbd_buffer, but do not wait.
6664 EXPECTED should be nonzero if the caller knows there is some input.
6666 Except on VMS, all input is read by this function.
6667 If interrupt_input is nonzero, this function MUST be called
6668 only when SIGIO is blocked.
6670 Returns the number of keyboard chars read, or -1 meaning
6671 this is a bad time to try to read input. */
6674 read_avail_input (expected
)
6681 /* Loop through the available displays, and call their input hooks. */
6685 struct display
*next
= d
->next_display
;
6687 if (d
->read_socket_hook
)
6690 struct input_event hold_quit
;
6692 EVENT_INIT (hold_quit
);
6693 hold_quit
.kind
= NO_EVENT
;
6695 /* No need for FIONREAD or fcntl; just say don't wait. */
6696 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6702 if (nr
== -1) /* Not OK to read input now. */
6706 else if (nr
== -2) /* Non-transient error. */
6708 /* The display device terminated; it should be closed. */
6710 /* Kill Emacs if this was our last display. */
6711 if (! display_list
->next_display
)
6712 /* Formerly simply reported no input, but that
6713 sometimes led to a failure of Emacs to terminate.
6714 SIGHUP seems appropriate if we can't reach the
6716 /* ??? Is it really right to send the signal just to
6717 this process rather than to the whole process
6718 group? Perhaps on systems with FIONREAD Emacs is
6719 alone in its group. */
6720 kill (getpid (), SIGHUP
);
6722 /* XXX Is calling delete_display safe here? It calls Fdelete_frame. */
6723 if (d
->delete_display_hook
)
6724 (*d
->delete_display_hook
) (d
);
6729 if (hold_quit
.kind
!= NO_EVENT
)
6730 kbd_buffer_store_event (&hold_quit
);
6742 /* This is the tty way of reading available input.
6744 Note that each terminal device has its own `struct display' object,
6745 and so this function is called once for each individual termcap
6746 display. The first parameter indicates which device to read from. */
6749 tty_read_avail_input (struct display
*display
,
6751 struct input_event
*hold_quit
)
6753 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6754 the kbd_buffer can really hold. That may prevent loss
6755 of characters on some systems when input is stuffed at us. */
6756 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6758 struct tty_display_info
*tty
= display
->display_info
.tty
;
6761 if (display
->type
!= output_termcap
)
6764 /* XXX I think the following code should be moved to separate hook
6765 functions in system-dependent files. */
6768 #else /* not WINDOWSNT */
6770 n_to_read
= dos_keysns ();
6774 cbuf
[0] = dos_keyread ();
6777 #else /* not MSDOS */
6779 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6783 return 0; /* The terminal is suspended. */
6785 /* Determine how many characters we should *try* to read. */
6787 /* Find out how much input is available. */
6788 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6790 if (! noninteractive
)
6791 return -2; /* Close this display. */
6797 if (n_to_read
> sizeof cbuf
)
6798 n_to_read
= sizeof cbuf
;
6799 #else /* no FIONREAD */
6800 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6801 /* Read some input if available, but don't wait. */
6802 n_to_read
= sizeof cbuf
;
6803 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6809 /* Now read; for one reason or another, this will not block.
6810 NREAD is set to the number of chars read. */
6813 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6814 /* POSIX infers that processes which are not in the session leader's
6815 process group won't get SIGHUP's at logout time. BSDI adheres to
6816 this part standard and returns -1 from read (0) with errno==EIO
6817 when the control tty is taken away.
6818 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6819 if (nread
== -1 && errno
== EIO
)
6820 return -2; /* Close this display. */
6821 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6822 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6823 This looks incorrect, but it isn't, because _BSD causes
6824 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6825 and that causes a value other than 0 when there is no input. */
6827 return -2; /* Close this display. */
6831 /* We used to retry the read if it was interrupted.
6832 But this does the wrong thing when O_NDELAY causes
6833 an EAGAIN error. Does anybody know of a situation
6834 where a retry is actually needed? */
6836 nread
< 0 && (errno
== EAGAIN
6850 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6851 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6852 #endif /* USG or DGUX or CYGWIN */
6853 #endif /* no FIONREAD */
6858 #endif /* not MSDOS */
6859 #endif /* not WINDOWSNT */
6861 for (i
= 0; i
< nread
; i
++)
6863 struct input_event buf
;
6865 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6867 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6868 buf
.modifiers
= meta_modifier
;
6869 if (tty
->meta_key
!= 2)
6873 /* Set the frame corresponding to the active tty. Note that the
6874 value of selected_frame is not reliable here, redisplay tends
6875 to temporarily change it. */
6876 buf
.frame_or_window
= tty
->top_frame
;
6879 kbd_buffer_store_event (&buf
);
6880 /* Don't look at input that follows a C-g too closely.
6881 This reduces lossage due to autorepeat on C-g. */
6882 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6883 && buf
.code
== quit_char
)
6889 #endif /* not VMS */
6892 handle_async_input ()
6895 extern int select_alarmed
;
6898 interrupt_input_pending
= 0;
6903 nread
= read_avail_input (1);
6904 /* -1 means it's not ok to read the input now.
6905 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6906 0 means there was no keyboard input available. */
6911 select_alarmed
= 1; /* Force the select emulator back to life */
6916 #ifdef SIGIO /* for entire page */
6917 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6920 input_available_signal (signo
)
6923 /* Must preserve main program's value of errno. */
6924 int old_errno
= errno
;
6925 #if defined (USG) && !defined (POSIX_SIGNALS)
6926 /* USG systems forget handlers when they are used;
6927 must reestablish each time */
6928 signal (signo
, input_available_signal
);
6936 interrupt_input_pending
= 1;
6938 SIGNAL_THREAD_CHECK (signo
);
6941 if (input_available_clear_time
)
6942 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6945 handle_async_input ();
6955 /* Send ourselves a SIGIO.
6957 This function exists so that the UNBLOCK_INPUT macro in
6958 blockinput.h can have some way to take care of input we put off
6959 dealing with, without assuming that every file which uses
6960 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6962 reinvoke_input_signal ()
6965 handle_async_input ();
6971 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6972 static Lisp_Object menu_bar_one_keymap_changed_items
;
6974 /* These variables hold the vector under construction within
6975 menu_bar_items and its subroutines, and the current index
6976 for storing into that vector. */
6977 static Lisp_Object menu_bar_items_vector
;
6978 static int menu_bar_items_index
;
6980 /* Return a vector of menu items for a menu bar, appropriate
6981 to the current buffer. Each item has three elements in the vector:
6984 OLD is an old vector we can optionally reuse, or nil. */
6987 menu_bar_items (old
)
6990 /* The number of keymaps we're scanning right now, and the number of
6991 keymaps we have allocated space for. */
6994 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6995 in the current keymaps, or nil where it is not a prefix. */
6998 Lisp_Object def
, tail
;
7007 struct gcpro gcpro1
;
7009 /* In order to build the menus, we need to call the keymap
7010 accessors. They all call QUIT. But this function is called
7011 during redisplay, during which a quit is fatal. So inhibit
7012 quitting while building the menus.
7013 We do this instead of specbind because (1) errors will clear it anyway
7014 and (2) this avoids risk of specpdl overflow. */
7015 oquit
= Vinhibit_quit
;
7019 menu_bar_items_vector
= old
;
7021 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7022 menu_bar_items_index
= 0;
7024 GCPRO1 (menu_bar_items_vector
);
7026 /* Build our list of keymaps.
7027 If we recognize a function key and replace its escape sequence in
7028 keybuf with its symbol, or if the sequence starts with a mouse
7029 click and we need to switch buffers, we jump back here to rebuild
7030 the initial keymaps from the current buffer. */
7034 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7035 if (!NILP (Voverriding_local_map_menu_flag
))
7037 /* Yes, use them (if non-nil) as well as the global map. */
7038 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7040 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7041 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7042 if (!NILP (Voverriding_local_map
))
7043 maps
[nmaps
++] = Voverriding_local_map
;
7047 /* No, so use major and minor mode keymaps and keymap property.
7048 Note that menu-bar bindings in the local-map and keymap
7049 properties may not work reliable, as they are only
7050 recognized when the menu-bar (or mode-line) is updated,
7051 which does not normally happen after every command. */
7054 nminor
= current_minor_maps (NULL
, &tmaps
);
7055 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7057 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7058 maps
[nmaps
++] = tem
;
7059 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7061 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7063 maps
[nmaps
++] = current_global_map
;
7066 /* Look up in each map the dummy prefix key `menu-bar'. */
7070 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7071 if (!NILP (maps
[mapno
]))
7073 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7077 menu_bar_one_keymap_changed_items
= Qnil
;
7078 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7082 /* Move to the end those items that should be at the end. */
7084 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7087 int end
= menu_bar_items_index
;
7089 for (i
= 0; i
< end
; i
+= 4)
7090 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7092 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7093 /* Move the item at index I to the end,
7094 shifting all the others forward. */
7095 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7096 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7097 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7098 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7100 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7101 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7102 (end
- i
- 4) * sizeof (Lisp_Object
));
7103 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7104 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7105 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7106 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7111 /* Add nil, nil, nil, nil at the end. */
7112 i
= menu_bar_items_index
;
7113 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7116 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7117 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7118 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7119 menu_bar_items_vector
= tem
;
7121 /* Add this item. */
7122 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7123 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7124 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7125 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7126 menu_bar_items_index
= i
;
7128 Vinhibit_quit
= oquit
;
7130 return menu_bar_items_vector
;
7133 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7134 If there's already an item for KEY, add this DEF to it. */
7136 Lisp_Object item_properties
;
7139 menu_bar_item (key
, item
, dummy1
, dummy2
)
7140 Lisp_Object key
, item
, dummy1
;
7143 struct gcpro gcpro1
;
7147 if (EQ (item
, Qundefined
))
7149 /* If a map has an explicit `undefined' as definition,
7150 discard any previously made menu bar item. */
7152 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7153 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7155 if (menu_bar_items_index
> i
+ 4)
7156 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7157 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7158 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7159 menu_bar_items_index
-= 4;
7163 /* If this keymap has already contributed to this KEY,
7164 don't contribute to it a second time. */
7165 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7166 if (!NILP (tem
) || NILP (item
))
7169 menu_bar_one_keymap_changed_items
7170 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7172 /* We add to menu_bar_one_keymap_changed_items before doing the
7173 parse_menu_item, so that if it turns out it wasn't a menu item,
7174 it still correctly hides any further menu item. */
7176 i
= parse_menu_item (item
, 0, 1);
7181 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7183 /* Find any existing item for this KEY. */
7184 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7185 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7188 /* If we did not find this KEY, add it at the end. */
7189 if (i
== menu_bar_items_index
)
7191 /* If vector is too small, get a bigger one. */
7192 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7195 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7196 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7197 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7198 menu_bar_items_vector
= tem
;
7201 /* Add this item. */
7202 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7203 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7204 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7205 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7206 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7207 menu_bar_items_index
= i
;
7209 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7213 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7214 /* If the new and the old items are not both keymaps,
7215 the lookup will only find `item'. */
7216 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7217 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7221 /* This is used as the handler when calling menu_item_eval_property. */
7223 menu_item_eval_property_1 (arg
)
7226 /* If we got a quit from within the menu computation,
7227 quit all the way out of it. This takes care of C-] in the debugger. */
7228 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7229 Fsignal (Qquit
, Qnil
);
7234 /* Evaluate an expression and return the result (or nil if something
7235 went wrong). Used to evaluate dynamic parts of menu items. */
7237 menu_item_eval_property (sexpr
)
7240 int count
= SPECPDL_INDEX ();
7242 specbind (Qinhibit_redisplay
, Qt
);
7243 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7244 menu_item_eval_property_1
);
7245 return unbind_to (count
, val
);
7248 /* This function parses a menu item and leaves the result in the
7249 vector item_properties.
7250 ITEM is a key binding, a possible menu item.
7251 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7252 evaluate dynamic expressions in the menu item.
7253 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7255 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7256 parse_menu_item returns true if the item is a menu item and false
7260 parse_menu_item (item
, notreal
, inmenubar
)
7262 int notreal
, inmenubar
;
7264 Lisp_Object def
, tem
, item_string
, start
;
7265 Lisp_Object cachelist
;
7267 Lisp_Object keyhint
;
7278 /* Create item_properties vector if necessary. */
7279 if (NILP (item_properties
))
7281 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7283 /* Initialize optional entries. */
7284 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7285 AREF (item_properties
, i
) = Qnil
;
7286 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7288 /* Save the item here to protect it from GC. */
7289 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7291 item_string
= XCAR (item
);
7295 if (STRINGP (item_string
))
7297 /* Old format menu item. */
7298 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7300 /* Maybe help string. */
7301 if (CONSP (item
) && STRINGP (XCAR (item
)))
7303 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7308 /* Maybe key binding cache. */
7309 if (CONSP (item
) && CONSP (XCAR (item
))
7310 && (NILP (XCAR (XCAR (item
)))
7311 || VECTORP (XCAR (XCAR (item
)))))
7313 cachelist
= XCAR (item
);
7317 /* This is the real definition--the function to run. */
7318 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7320 /* Get enable property, if any. */
7323 tem
= Fget (item
, Qmenu_enable
);
7325 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7328 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7330 /* New format menu item. */
7331 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7332 start
= XCDR (item
);
7335 /* We have a real binding. */
7336 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7338 item
= XCDR (start
);
7339 /* Is there a cache list with key equivalences. */
7340 if (CONSP (item
) && CONSP (XCAR (item
)))
7342 cachelist
= XCAR (item
);
7346 /* Parse properties. */
7347 while (CONSP (item
) && CONSP (XCDR (item
)))
7352 if (EQ (tem
, QCenable
))
7353 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7354 else if (EQ (tem
, QCvisible
) && !notreal
)
7356 /* If got a visible property and that evaluates to nil
7357 then ignore this item. */
7358 tem
= menu_item_eval_property (XCAR (item
));
7362 else if (EQ (tem
, QChelp
))
7363 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7364 else if (EQ (tem
, QCfilter
))
7366 else if (EQ (tem
, QCkey_sequence
))
7369 if (NILP (cachelist
)
7370 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7371 /* Be GC protected. Set keyhint to item instead of tem. */
7374 else if (EQ (tem
, QCkeys
))
7377 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7378 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7380 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7385 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7387 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7389 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7396 else if (inmenubar
|| !NILP (start
))
7400 return 0; /* not a menu item */
7402 /* If item string is not a string, evaluate it to get string.
7403 If we don't get a string, skip this item. */
7404 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7405 if (!(STRINGP (item_string
) || notreal
))
7407 item_string
= menu_item_eval_property (item_string
);
7408 if (!STRINGP (item_string
))
7410 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7413 /* If got a filter apply it on definition. */
7414 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7417 def
= menu_item_eval_property (list2 (XCAR (filter
),
7418 list2 (Qquote
, def
)));
7420 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7423 /* Enable or disable selection of item. */
7424 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7430 tem
= menu_item_eval_property (tem
);
7431 if (inmenubar
&& NILP (tem
))
7432 return 0; /* Ignore disabled items in menu bar. */
7433 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7436 /* If we got no definition, this item is just unselectable text which
7437 is OK in a submenu but not in the menubar. */
7439 return (inmenubar
? 0 : 1);
7441 /* See if this is a separate pane or a submenu. */
7442 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7443 tem
= get_keymap (def
, 0, 1);
7444 /* For a subkeymap, just record its details and exit. */
7447 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7448 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7452 /* At the top level in the menu bar, do likewise for commands also.
7453 The menu bar does not display equivalent key bindings anyway.
7454 ITEM_PROPERTY_DEF is already set up properly. */
7458 /* This is a command. See if there is an equivalent key binding. */
7459 if (NILP (cachelist
))
7461 /* We have to create a cachelist. */
7462 CHECK_IMPURE (start
);
7463 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7464 cachelist
= XCAR (XCDR (start
));
7466 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7467 if (!NILP (keyhint
))
7469 XSETCAR (cachelist
, XCAR (keyhint
));
7472 else if (STRINGP (tem
))
7474 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7475 XSETCAR (cachelist
, Qt
);
7479 tem
= XCAR (cachelist
);
7486 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7488 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7491 def
= XCAR (prefix
);
7492 prefix
= XCDR (prefix
);
7495 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7497 if (!update_menu_bindings
)
7499 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7501 if (newcache
/* Always check first time. */
7502 /* Should we check everything when precomputing key
7504 /* If something had no key binding before, don't recheck it
7505 because that is too slow--except if we have a list of
7506 rebound commands in Vdefine_key_rebound_commands, do
7507 recheck any command that appears in that list. */
7508 || (CONSP (Vdefine_key_rebound_commands
)
7509 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7512 /* We had a saved key. Is it still bound to the command? */
7515 /* If the command is an alias for another
7516 (such as lmenu.el set it up), check if the
7517 original command matches the cached command. */
7518 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7519 chkcache
= 1; /* Need to recompute key binding. */
7523 /* Recompute equivalent key binding. If the command is an alias
7524 for another (such as lmenu.el set it up), see if the original
7525 command name has equivalent keys. Otherwise look up the
7526 specified command itself. We don't try both, because that
7527 makes lmenu menus slow. */
7529 && SYMBOLP (XSYMBOL (def
)->function
)
7530 && ! NILP (Fget (def
, Qmenu_alias
)))
7531 def
= XSYMBOL (def
)->function
;
7532 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7533 XSETCAR (cachelist
, tem
);
7536 XSETCDR (cachelist
, Qnil
);
7540 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7542 tem
= XCAR (cachelist
);
7546 newcache
= chkcache
;
7549 tem
= Fkey_description (tem
, Qnil
);
7552 if (STRINGP (XCAR (prefix
)))
7553 tem
= concat2 (XCAR (prefix
), tem
);
7554 if (STRINGP (XCDR (prefix
)))
7555 tem
= concat2 (tem
, XCDR (prefix
));
7557 XSETCDR (cachelist
, tem
);
7561 tem
= XCDR (cachelist
);
7562 if (newcache
&& !NILP (tem
))
7564 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7565 XSETCDR (cachelist
, tem
);
7568 /* If we only want to precompute equivalent key bindings, stop here. */
7572 /* If we have an equivalent key binding, use that. */
7573 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7575 /* Include this when menu help is implemented.
7576 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7577 if (!(NILP (tem) || STRINGP (tem)))
7579 tem = menu_item_eval_property (tem);
7582 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7586 /* Handle radio buttons or toggle boxes. */
7587 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7589 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7590 = menu_item_eval_property (tem
);
7597 /***********************************************************************
7599 ***********************************************************************/
7601 /* A vector holding tool bar items while they are parsed in function
7602 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7605 static Lisp_Object tool_bar_items_vector
;
7607 /* A vector holding the result of parse_tool_bar_item. Layout is like
7608 the one for a single item in tool_bar_items_vector. */
7610 static Lisp_Object tool_bar_item_properties
;
7612 /* Next free index in tool_bar_items_vector. */
7614 static int ntool_bar_items
;
7616 /* The symbols `tool-bar', and `:image'. */
7618 extern Lisp_Object Qtool_bar
;
7619 Lisp_Object QCimage
;
7621 /* Function prototypes. */
7623 static void init_tool_bar_items
P_ ((Lisp_Object
));
7624 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7625 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7626 static void append_tool_bar_item
P_ ((void));
7629 /* Return a vector of tool bar items for keymaps currently in effect.
7630 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7631 tool bar items found. */
7634 tool_bar_items (reuse
, nitems
)
7645 /* In order to build the menus, we need to call the keymap
7646 accessors. They all call QUIT. But this function is called
7647 during redisplay, during which a quit is fatal. So inhibit
7648 quitting while building the menus. We do this instead of
7649 specbind because (1) errors will clear it anyway and (2) this
7650 avoids risk of specpdl overflow. */
7651 oquit
= Vinhibit_quit
;
7654 /* Initialize tool_bar_items_vector and protect it from GC. */
7655 init_tool_bar_items (reuse
);
7657 /* Build list of keymaps in maps. Set nmaps to the number of maps
7660 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7661 if (!NILP (Voverriding_local_map_menu_flag
))
7663 /* Yes, use them (if non-nil) as well as the global map. */
7664 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7666 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7667 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7668 if (!NILP (Voverriding_local_map
))
7669 maps
[nmaps
++] = Voverriding_local_map
;
7673 /* No, so use major and minor mode keymaps and keymap property.
7674 Note that tool-bar bindings in the local-map and keymap
7675 properties may not work reliable, as they are only
7676 recognized when the tool-bar (or mode-line) is updated,
7677 which does not normally happen after every command. */
7680 nminor
= current_minor_maps (NULL
, &tmaps
);
7681 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7683 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7684 maps
[nmaps
++] = tem
;
7685 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7687 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7690 /* Add global keymap at the end. */
7691 maps
[nmaps
++] = current_global_map
;
7693 /* Process maps in reverse order and look up in each map the prefix
7695 for (i
= nmaps
- 1; i
>= 0; --i
)
7696 if (!NILP (maps
[i
]))
7700 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7705 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7706 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7708 Lisp_Object keydef
= XCAR (tail
);
7710 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7715 Vinhibit_quit
= oquit
;
7716 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7717 return tool_bar_items_vector
;
7721 /* Process the definition of KEY which is DEF. */
7724 process_tool_bar_item (key
, def
)
7725 Lisp_Object key
, def
;
7728 extern Lisp_Object Qundefined
;
7729 struct gcpro gcpro1
, gcpro2
;
7731 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7735 if (EQ (def
, Qundefined
))
7737 /* If a map has an explicit `undefined' as definition,
7738 discard any previously made item. */
7739 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7741 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7743 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7745 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7746 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7747 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7748 * sizeof (Lisp_Object
)));
7749 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7754 else if (parse_tool_bar_item (key
, def
))
7755 /* Append a new tool bar item to tool_bar_items_vector. Accept
7756 more than one definition for the same key. */
7757 append_tool_bar_item ();
7763 /* Parse a tool bar item specification ITEM for key KEY and return the
7764 result in tool_bar_item_properties. Value is zero if ITEM is
7767 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7769 CAPTION is the caption of the item, If it's not a string, it is
7770 evaluated to get a string.
7772 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7773 as binding are currently ignored.
7775 The following properties are recognized:
7779 FORM is evaluated and specifies whether the tool bar item is
7780 enabled or disabled.
7784 FORM is evaluated and specifies whether the tool bar item is visible.
7786 - `:filter FUNCTION'
7788 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7789 result is stored as the new binding.
7791 - `:button (TYPE SELECTED)'
7793 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7794 and specifies whether the button is selected (pressed) or not.
7798 IMAGES is either a single image specification or a vector of four
7799 image specifications. See enum tool_bar_item_images.
7801 - `:help HELP-STRING'.
7803 Gives a help string to display for the tool bar item. */
7806 parse_tool_bar_item (key
, item
)
7807 Lisp_Object key
, item
;
7809 /* Access slot with index IDX of vector tool_bar_item_properties. */
7810 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7812 Lisp_Object filter
= Qnil
;
7813 Lisp_Object caption
;
7816 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7817 Rule out items that aren't lists, don't start with
7818 `menu-item' or whose rest following `tool-bar-item' is not a
7821 || !EQ (XCAR (item
), Qmenu_item
)
7822 || (item
= XCDR (item
),
7826 /* Create tool_bar_item_properties vector if necessary. Reset it to
7828 if (VECTORP (tool_bar_item_properties
))
7830 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7834 tool_bar_item_properties
7835 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7838 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7839 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7841 /* Get the caption of the item. If the caption is not a string,
7842 evaluate it to get a string. If we don't get a string, skip this
7844 caption
= XCAR (item
);
7845 if (!STRINGP (caption
))
7847 caption
= menu_item_eval_property (caption
);
7848 if (!STRINGP (caption
))
7851 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7853 /* Give up if rest following the caption is not a list. */
7858 /* Store the binding. */
7859 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7862 /* Ignore cached key binding, if any. */
7863 if (CONSP (item
) && CONSP (XCAR (item
)))
7866 /* Process the rest of the properties. */
7867 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7869 Lisp_Object key
, value
;
7872 value
= XCAR (XCDR (item
));
7874 if (EQ (key
, QCenable
))
7875 /* `:enable FORM'. */
7876 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7877 else if (EQ (key
, QCvisible
))
7879 /* `:visible FORM'. If got a visible property and that
7880 evaluates to nil then ignore this item. */
7881 if (NILP (menu_item_eval_property (value
)))
7884 else if (EQ (key
, QChelp
))
7885 /* `:help HELP-STRING'. */
7886 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7887 else if (EQ (key
, QCfilter
))
7888 /* ':filter FORM'. */
7890 else if (EQ (key
, QCbutton
) && CONSP (value
))
7892 /* `:button (TYPE . SELECTED)'. */
7893 Lisp_Object type
, selected
;
7895 type
= XCAR (value
);
7896 selected
= XCDR (value
);
7897 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7899 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7900 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7903 else if (EQ (key
, QCimage
)
7905 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7906 /* Value is either a single image specification or a vector
7907 of 4 such specifications for the different button states. */
7908 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7911 /* If got a filter apply it on binding. */
7913 PROP (TOOL_BAR_ITEM_BINDING
)
7914 = menu_item_eval_property (list2 (filter
,
7916 PROP (TOOL_BAR_ITEM_BINDING
))));
7918 /* See if the binding is a keymap. Give up if it is. */
7919 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7922 /* Enable or disable selection of item. */
7923 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7924 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7925 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7927 /* Handle radio buttons or toggle boxes. */
7928 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7929 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7930 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7938 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7939 that can be reused. */
7942 init_tool_bar_items (reuse
)
7945 if (VECTORP (reuse
))
7946 tool_bar_items_vector
= reuse
;
7948 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7949 ntool_bar_items
= 0;
7953 /* Append parsed tool bar item properties from
7954 tool_bar_item_properties */
7957 append_tool_bar_item ()
7959 Lisp_Object
*to
, *from
;
7961 /* Enlarge tool_bar_items_vector if necessary. */
7962 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7963 >= XVECTOR (tool_bar_items_vector
)->size
)
7965 Lisp_Object new_vector
;
7966 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7968 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7969 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7970 XVECTOR (new_vector
)->contents
,
7971 old_size
* sizeof (Lisp_Object
));
7972 tool_bar_items_vector
= new_vector
;
7975 /* Append entries from tool_bar_item_properties to the end of
7976 tool_bar_items_vector. */
7977 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7978 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7979 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7980 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7987 /* Read a character using menus based on maps in the array MAPS.
7988 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7989 Return t if we displayed a menu but the user rejected it.
7991 PREV_EVENT is the previous input event, or nil if we are reading
7992 the first event of a key sequence.
7994 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7995 if we used a mouse menu to read the input, or zero otherwise. If
7996 USED_MOUSE_MENU is null, we don't dereference it.
7998 The prompting is done based on the prompt-string of the map
7999 and the strings associated with various map elements.
8001 This can be done with X menus or with menus put in the minibuf.
8002 These are done in different ways, depending on how the input will be read.
8003 Menus using X are done after auto-saving in read-char, getting the input
8004 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8005 and do auto-saving in the inner call of read_char. */
8008 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8011 Lisp_Object prev_event
;
8012 int *used_mouse_menu
;
8015 register Lisp_Object name
= Qnil
;
8017 if (used_mouse_menu
)
8018 *used_mouse_menu
= 0;
8020 /* Use local over global Menu maps */
8022 if (! menu_prompting
)
8025 /* Optionally disregard all but the global map. */
8026 if (inhibit_local_menu_bar_menus
)
8028 maps
+= (nmaps
- 1);
8032 /* Get the menu name from the first map that has one (a prompt string). */
8033 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8035 name
= Fkeymap_prompt (maps
[mapno
]);
8040 /* If we don't have any menus, just read a character normally. */
8041 if (!STRINGP (name
))
8045 /* If we got to this point via a mouse click,
8046 use a real menu for mouse selection. */
8047 if (EVENT_HAS_PARAMETERS (prev_event
)
8048 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8049 && !EQ (XCAR (prev_event
), Qtool_bar
))
8051 /* Display the menu and get the selection. */
8052 Lisp_Object
*realmaps
8053 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8057 /* Use the maps that are not nil. */
8058 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8059 if (!NILP (maps
[mapno
]))
8060 realmaps
[nmaps1
++] = maps
[mapno
];
8062 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8067 record_menu_key (XCAR (value
));
8069 /* If we got multiple events, unread all but
8071 There is no way to prevent those unread events
8072 from showing up later in last_nonmenu_event.
8073 So turn symbol and integer events into lists,
8074 to indicate that they came from a mouse menu,
8075 so that when present in last_nonmenu_event
8076 they won't confuse things. */
8077 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8079 record_menu_key (XCAR (tem
));
8080 if (SYMBOLP (XCAR (tem
))
8081 || INTEGERP (XCAR (tem
)))
8082 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8085 /* If we got more than one event, put all but the first
8086 onto this list to be read later.
8087 Return just the first event now. */
8088 Vunread_command_events
8089 = nconc2 (XCDR (value
), Vunread_command_events
);
8090 value
= XCAR (value
);
8092 else if (NILP (value
))
8094 if (used_mouse_menu
)
8095 *used_mouse_menu
= 1;
8098 #endif /* HAVE_MENUS */
8102 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8103 We make this bigger when necessary, and never free it. */
8104 static char *read_char_minibuf_menu_text
;
8105 /* Size of that buffer. */
8106 static int read_char_minibuf_menu_width
;
8109 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8115 register Lisp_Object name
;
8117 /* FIXME: Use the minibuffer's frame width. */
8118 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8121 Lisp_Object rest
, vector
;
8127 if (! menu_prompting
)
8130 /* Make sure we have a big enough buffer for the menu text. */
8131 if (read_char_minibuf_menu_text
== 0)
8133 read_char_minibuf_menu_width
= width
+ 4;
8134 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8136 else if (width
+ 4 > read_char_minibuf_menu_width
)
8138 read_char_minibuf_menu_width
= width
+ 4;
8139 read_char_minibuf_menu_text
8140 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8142 menu
= read_char_minibuf_menu_text
;
8144 /* Get the menu name from the first map that has one (a prompt string). */
8145 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8147 name
= Fkeymap_prompt (maps
[mapno
]);
8152 /* If we don't have any menus, just read a character normally. */
8153 if (!STRINGP (name
))
8156 /* Prompt string always starts with map's prompt, and a space. */
8157 strcpy (menu
, SDATA (name
));
8158 nlength
= SBYTES (name
);
8159 menu
[nlength
++] = ':';
8160 menu
[nlength
++] = ' ';
8163 /* Start prompting at start of first map. */
8167 /* Present the documented bindings, a line at a time. */
8174 Lisp_Object orig_defn_macro
;
8176 /* Loop over elements of map. */
8181 /* If reached end of map, start at beginning of next map. */
8185 /* At end of last map, wrap around to first map if just starting,
8186 or end this line if already have something on it. */
8190 if (notfirst
|| nobindings
) break;
8195 /* Look at the next element of the map. */
8197 elt
= XVECTOR (vector
)->contents
[idx
];
8199 elt
= Fcar_safe (rest
);
8201 if (idx
< 0 && VECTORP (elt
))
8203 /* If we found a dense table in the keymap,
8204 advanced past it, but start scanning its contents. */
8205 rest
= Fcdr_safe (rest
);
8211 /* An ordinary element. */
8212 Lisp_Object event
, tem
;
8216 event
= Fcar_safe (elt
); /* alist */
8217 elt
= Fcdr_safe (elt
);
8221 XSETINT (event
, idx
); /* vector */
8224 /* Ignore the element if it has no prompt string. */
8225 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8227 /* 1 if the char to type matches the string. */
8229 Lisp_Object upcased_event
, downcased_event
;
8230 Lisp_Object desc
= Qnil
;
8232 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8234 upcased_event
= Fupcase (event
);
8235 downcased_event
= Fdowncase (event
);
8236 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8237 || XINT (downcased_event
) == SREF (s
, 0));
8239 desc
= Fsingle_key_description (event
, Qnil
);
8241 #if 0 /* It is redundant to list the equivalent key bindings because
8242 the prefix is what the user has already typed. */
8244 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8246 /* Insert equivalent keybinding. */
8247 s
= concat2 (s
, tem
);
8250 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8251 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8253 /* Insert button prefix. */
8254 Lisp_Object selected
8255 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8256 if (EQ (tem
, QCradio
))
8257 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8259 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8260 s
= concat2 (tem
, s
);
8264 /* If we have room for the prompt string, add it to this line.
8265 If this is the first on the line, always add it. */
8266 if ((SCHARS (s
) + i
+ 2
8267 + (char_matches
? 0 : SCHARS (desc
) + 3))
8273 /* Punctuate between strings. */
8276 strcpy (menu
+ i
, ", ");
8282 /* If the char to type doesn't match the string's
8283 first char, explicitly show what char to type. */
8286 /* Add as much of string as fits. */
8287 thiswidth
= SCHARS (desc
);
8288 if (thiswidth
+ i
> width
)
8289 thiswidth
= width
- i
;
8290 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8292 strcpy (menu
+ i
, " = ");
8296 /* Add as much of string as fits. */
8297 thiswidth
= SCHARS (s
);
8298 if (thiswidth
+ i
> width
)
8299 thiswidth
= width
- i
;
8300 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8306 /* If this element does not fit, end the line now,
8307 and save the element for the next line. */
8308 strcpy (menu
+ i
, "...");
8313 /* Move past this element. */
8314 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8315 /* Handle reaching end of dense table. */
8320 rest
= Fcdr_safe (rest
);
8324 /* Prompt with that and read response. */
8325 message2_nolog (menu
, strlen (menu
),
8326 ! NILP (current_buffer
->enable_multibyte_characters
));
8328 /* Make believe its not a keyboard macro in case the help char
8329 is pressed. Help characters are not recorded because menu prompting
8330 is not used on replay.
8332 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8333 current_kboard
->defining_kbd_macro
= Qnil
;
8335 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8336 while (BUFFERP (obj
));
8337 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8339 if (!INTEGERP (obj
))
8344 if (! EQ (obj
, menu_prompt_more_char
)
8345 && (!INTEGERP (menu_prompt_more_char
)
8346 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8348 if (!NILP (current_kboard
->defining_kbd_macro
))
8349 store_kbd_macro_char (obj
);
8352 /* Help char - go round again */
8356 /* Reading key sequences. */
8358 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8359 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8360 keymap, or nil otherwise. Return the index of the first keymap in
8361 which KEY has any binding, or NMAPS if no map has a binding.
8363 If KEY is a meta ASCII character, treat it like meta-prefix-char
8364 followed by the corresponding non-meta character. Keymaps in
8365 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8368 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8371 NEXT may be the same array as CURRENT. */
8374 follow_key (key
, nmaps
, current
, defs
, next
)
8376 Lisp_Object
*current
, *defs
, *next
;
8379 int i
, first_binding
;
8381 first_binding
= nmaps
;
8382 for (i
= nmaps
- 1; i
>= 0; i
--)
8384 if (! NILP (current
[i
]))
8386 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8387 if (! NILP (defs
[i
]))
8394 /* Given the set of bindings we've found, produce the next set of maps. */
8395 if (first_binding
< nmaps
)
8396 for (i
= 0; i
< nmaps
; i
++)
8397 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8399 return first_binding
;
8402 /* Structure used to keep track of partial application of key remapping
8403 such as Vfunction_key_map and Vkey_translation_map. */
8404 typedef struct keyremap
8406 Lisp_Object map
, parent
;
8410 /* Lookup KEY in MAP.
8411 MAP is a keymap mapping keys to key vectors or functions.
8412 If the mapping is a function and DO_FUNCTION is non-zero, then
8413 the function is called with PROMPT as parameter and its return
8414 value is used as the return value of this function (after checking
8415 that it is indeed a vector). */
8418 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8419 Lisp_Object map
, key
, prompt
;
8424 next
= access_keymap (map
, key
, 1, 0, 1);
8426 /* Handle symbol with autoload definition. */
8427 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8428 && CONSP (XSYMBOL (next
)->function
)
8429 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8430 do_autoload (XSYMBOL (next
)->function
, next
);
8432 /* Handle a symbol whose function definition is a keymap
8434 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8435 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8436 || KEYMAPP (XSYMBOL (next
)->function
)))
8437 next
= XSYMBOL (next
)->function
;
8439 /* If the keymap gives a function, not an
8440 array, then call the function with one arg and use
8441 its value instead. */
8442 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8447 next
= call1 (next
, prompt
);
8448 /* If the function returned something invalid,
8449 barf--don't ignore it.
8450 (To ignore it safely, we would need to gcpro a bunch of
8451 other variables.) */
8452 if (! (VECTORP (next
) || STRINGP (next
)))
8453 error ("Function %s returns invalid key sequence", tem
);
8458 /* Do one step of the key remapping used for function-key-map and
8459 key-translation-map:
8460 KEYBUF is the buffer holding the input events.
8461 BUFSIZE is its maximum size.
8462 FKEY is a pointer to the keyremap structure to use.
8463 INPUT is the index of the last element in KEYBUF.
8464 DOIT if non-zero says that the remapping can actually take place.
8465 DIFF is used to return the number of keys added/removed by the remapping.
8466 PARENT is the root of the keymap.
8467 PROMPT is the prompt to use if the remapping happens through a function.
8468 The return value is non-zero if the remapping actually took place. */
8471 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8472 Lisp_Object
*keybuf
, prompt
;
8474 int input
, doit
, *diff
, bufsize
;
8476 Lisp_Object next
, key
;
8478 key
= keybuf
[fkey
->end
++];
8479 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8481 /* If keybuf[fkey->start..fkey->end] is bound in the
8482 map and we're in a position to do the key remapping, replace it with
8483 the binding and restart with fkey->start at the end. */
8484 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8486 int len
= XFASTINT (Flength (next
));
8489 *diff
= len
- (fkey
->end
- fkey
->start
);
8491 if (input
+ *diff
>= bufsize
)
8492 error ("Key sequence too long");
8494 /* Shift the keys that follow fkey->end. */
8496 for (i
= fkey
->end
; i
< input
; i
++)
8497 keybuf
[i
+ *diff
] = keybuf
[i
];
8499 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8500 keybuf
[i
+ *diff
] = keybuf
[i
];
8501 /* Overwrite the old keys with the new ones. */
8502 for (i
= 0; i
< len
; i
++)
8503 keybuf
[fkey
->start
+ i
]
8504 = Faref (next
, make_number (i
));
8506 fkey
->start
= fkey
->end
+= *diff
;
8507 fkey
->map
= fkey
->parent
;
8512 fkey
->map
= get_keymap (next
, 0, 1);
8514 /* If we no longer have a bound suffix, try a new position for
8516 if (!CONSP (fkey
->map
))
8518 fkey
->end
= ++fkey
->start
;
8519 fkey
->map
= fkey
->parent
;
8524 /* Read a sequence of keys that ends with a non prefix character,
8525 storing it in KEYBUF, a buffer of size BUFSIZE.
8527 Return the length of the key sequence stored.
8528 Return -1 if the user rejected a command menu.
8530 Echo starting immediately unless `prompt' is 0.
8532 Where a key sequence ends depends on the currently active keymaps.
8533 These include any minor mode keymaps active in the current buffer,
8534 the current buffer's local map, and the global map.
8536 If a key sequence has no other bindings, we check Vfunction_key_map
8537 to see if some trailing subsequence might be the beginning of a
8538 function key's sequence. If so, we try to read the whole function
8539 key, and substitute its symbolic name into the key sequence.
8541 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8542 `double-' events into similar click events, if that would make them
8543 bound. We try to turn `triple-' events first into `double-' events,
8546 If we get a mouse click in a mode line, vertical divider, or other
8547 non-text area, we treat the click as if it were prefixed by the
8548 symbol denoting that area - `mode-line', `vertical-line', or
8551 If the sequence starts with a mouse click, we read the key sequence
8552 with respect to the buffer clicked on, not the current buffer.
8554 If the user switches frames in the midst of a key sequence, we put
8555 off the switch-frame event until later; the next call to
8556 read_char will return it.
8558 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8559 from the selected window's buffer. */
8562 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8563 can_return_switch_frame
, fix_current_buffer
)
8564 Lisp_Object
*keybuf
;
8567 int dont_downcase_last
;
8568 int can_return_switch_frame
;
8569 int fix_current_buffer
;
8571 volatile Lisp_Object from_string
;
8572 volatile int count
= SPECPDL_INDEX ();
8574 /* How many keys there are in the current key sequence. */
8577 /* The length of the echo buffer when we started reading, and
8578 the length of this_command_keys when we started reading. */
8579 volatile int echo_start
;
8580 volatile int keys_start
;
8582 /* The number of keymaps we're scanning right now, and the number of
8583 keymaps we have allocated space for. */
8585 volatile int nmaps_allocated
= 0;
8587 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8588 the current keymaps. */
8589 Lisp_Object
*volatile defs
= NULL
;
8591 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8592 in the current keymaps, or nil where it is not a prefix. */
8593 Lisp_Object
*volatile submaps
= NULL
;
8595 /* The local map to start out with at start of key sequence. */
8596 volatile Lisp_Object orig_local_map
;
8598 /* The map from the `keymap' property to start out with at start of
8600 volatile Lisp_Object orig_keymap
;
8602 /* 1 if we have already considered switching to the local-map property
8603 of the place where a mouse click occurred. */
8604 volatile int localized_local_map
= 0;
8606 /* The index in defs[] of the first keymap that has a binding for
8607 this key sequence. In other words, the lowest i such that
8608 defs[i] is non-nil. */
8609 volatile int first_binding
;
8610 /* Index of the first key that has no binding.
8611 It is useless to try fkey.start larger than that. */
8612 volatile int first_unbound
;
8614 /* If t < mock_input, then KEYBUF[t] should be read as the next
8617 We use this to recover after recognizing a function key. Once we
8618 realize that a suffix of the current key sequence is actually a
8619 function key's escape sequence, we replace the suffix with the
8620 function key's binding from Vfunction_key_map. Now keybuf
8621 contains a new and different key sequence, so the echo area,
8622 this_command_keys, and the submaps and defs arrays are wrong. In
8623 this situation, we set mock_input to t, set t to 0, and jump to
8624 restart_sequence; the loop will read keys from keybuf up until
8625 mock_input, thus rebuilding the state; and then it will resume
8626 reading characters from the keyboard. */
8627 volatile int mock_input
= 0;
8629 /* If the sequence is unbound in submaps[], then
8630 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8631 and fkey.map is its binding.
8633 These might be > t, indicating that all function key scanning
8634 should hold off until t reaches them. We do this when we've just
8635 recognized a function key, to avoid searching for the function
8636 key's again in Vfunction_key_map. */
8637 volatile keyremap fkey
;
8639 /* Likewise, for key_translation_map. */
8640 volatile keyremap keytran
;
8642 /* If we receive a `switch-frame' or `select-window' event in the middle of
8643 a key sequence, we put it off for later.
8644 While we're reading, we keep the event here. */
8645 volatile Lisp_Object delayed_switch_frame
;
8647 /* See the comment below... */
8648 #if defined (GOBBLE_FIRST_EVENT)
8649 Lisp_Object first_event
;
8652 volatile Lisp_Object original_uppercase
;
8653 volatile int original_uppercase_position
= -1;
8655 /* Gets around Microsoft compiler limitations. */
8658 struct buffer
*starting_buffer
;
8660 /* List of events for which a fake prefix key has been generated. */
8661 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8663 #if defined (GOBBLE_FIRST_EVENT)
8667 struct gcpro gcpro1
;
8669 GCPRO1 (fake_prefixed_keys
);
8670 raw_keybuf_count
= 0;
8672 last_nonmenu_event
= Qnil
;
8674 delayed_switch_frame
= Qnil
;
8675 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8676 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8677 /* If there is no translation-map, turn off scanning. */
8678 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8679 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8684 echo_prompt (prompt
);
8685 else if (cursor_in_echo_area
8686 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8687 && NILP (Fzerop (Vecho_keystrokes
)))
8688 /* This doesn't put in a dash if the echo buffer is empty, so
8689 you don't always see a dash hanging out in the minibuffer. */
8693 /* Record the initial state of the echo area and this_command_keys;
8694 we will need to restore them if we replay a key sequence. */
8696 echo_start
= echo_length ();
8697 keys_start
= this_command_key_count
;
8698 this_single_command_key_start
= keys_start
;
8700 #if defined (GOBBLE_FIRST_EVENT)
8701 /* This doesn't quite work, because some of the things that read_char
8702 does cannot safely be bypassed. It seems too risky to try to make
8705 /* Read the first char of the sequence specially, before setting
8706 up any keymaps, in case a filter runs and switches buffers on us. */
8707 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8709 #endif /* GOBBLE_FIRST_EVENT */
8711 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8712 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8715 /* We jump here when the key sequence has been thoroughly changed, and
8716 we need to rescan it starting from the beginning. When we jump here,
8717 keybuf[0..mock_input] holds the sequence we should reread. */
8720 starting_buffer
= current_buffer
;
8721 first_unbound
= bufsize
+ 1;
8723 /* Build our list of keymaps.
8724 If we recognize a function key and replace its escape sequence in
8725 keybuf with its symbol, or if the sequence starts with a mouse
8726 click and we need to switch buffers, we jump back here to rebuild
8727 the initial keymaps from the current buffer. */
8730 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8731 || !NILP (Voverriding_local_map
))
8733 if (3 > nmaps_allocated
)
8735 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8736 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8737 nmaps_allocated
= 3;
8739 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8740 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8741 if (!NILP (Voverriding_local_map
))
8742 submaps
[nmaps
++] = Voverriding_local_map
;
8750 nminor
= current_minor_maps (0, &maps
);
8751 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8753 if (total
> nmaps_allocated
)
8755 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8756 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8757 nmaps_allocated
= total
;
8760 if (!NILP (orig_keymap
))
8761 submaps
[nmaps
++] = orig_keymap
;
8763 bcopy (maps
, (void *) (submaps
+ nmaps
),
8764 nminor
* sizeof (submaps
[0]));
8768 submaps
[nmaps
++] = orig_local_map
;
8770 submaps
[nmaps
++] = current_global_map
;
8772 /* Find an accurate initial value for first_binding. */
8773 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8774 if (! NILP (submaps
[first_binding
]))
8777 /* Start from the beginning in keybuf. */
8780 /* These are no-ops the first time through, but if we restart, they
8781 revert the echo area and this_command_keys to their original state. */
8782 this_command_key_count
= keys_start
;
8783 if (INTERACTIVE
&& t
< mock_input
)
8784 echo_truncate (echo_start
);
8786 /* If the best binding for the current key sequence is a keymap, or
8787 we may be looking at a function key's escape sequence, keep on
8789 while (first_binding
< nmaps
8790 /* Keep reading as long as there's a prefix binding. */
8791 ? !NILP (submaps
[first_binding
])
8792 /* Don't return in the middle of a possible function key sequence,
8793 if the only bindings we found were via case conversion.
8794 Thus, if ESC O a has a function-key-map translation
8795 and ESC o has a binding, don't return after ESC O,
8796 so that we can translate ESC O plus the next character. */
8797 : (fkey
.start
< t
|| keytran
.start
< t
))
8800 int used_mouse_menu
= 0;
8802 /* Where the last real key started. If we need to throw away a
8803 key that has expanded into more than one element of keybuf
8804 (say, a mouse click on the mode line which is being treated
8805 as [mode-line (mouse-...)], then we backtrack to this point
8807 volatile int last_real_key_start
;
8809 /* These variables are analogous to echo_start and keys_start;
8810 while those allow us to restart the entire key sequence,
8811 echo_local_start and keys_local_start allow us to throw away
8813 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8815 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8816 eassert (fkey
.start
<= fkey
.end
);
8817 eassert (keytran
.start
<= keytran
.end
);
8818 /* key-translation-map is applied *after* function-key-map. */
8819 eassert (keytran
.end
<= fkey
.start
);
8821 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8822 { /* The prefix upto first_unbound has no binding and has
8823 no translation left to do either, so we know it's unbound.
8824 If we don't stop now, we risk staying here indefinitely
8825 (if the user keeps entering fkey or keytran prefixes
8826 like C-c ESC ESC ESC ESC ...) */
8828 for (i
= first_unbound
+ 1; i
< t
; i
++)
8829 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8830 mock_input
= t
- first_unbound
- 1;
8831 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8832 fkey
.map
= fkey
.parent
;
8833 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8834 keytran
.map
= keytran
.parent
;
8835 goto replay_sequence
;
8839 error ("Key sequence too long");
8842 echo_local_start
= echo_length ();
8843 keys_local_start
= this_command_key_count
;
8844 local_first_binding
= first_binding
;
8847 /* These are no-ops, unless we throw away a keystroke below and
8848 jumped back up to replay_key; in that case, these restore the
8849 variables to their original state, allowing us to replay the
8851 if (INTERACTIVE
&& t
< mock_input
)
8852 echo_truncate (echo_local_start
);
8853 this_command_key_count
= keys_local_start
;
8854 first_binding
= local_first_binding
;
8856 /* By default, assume each event is "real". */
8857 last_real_key_start
= t
;
8859 /* Does mock_input indicate that we are re-reading a key sequence? */
8863 add_command_key (key
);
8864 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8865 && NILP (Fzerop (Vecho_keystrokes
)))
8869 /* If not, we should actually read a character. */
8874 KBOARD
*interrupted_kboard
= current_kboard
;
8875 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8876 if (setjmp (wrong_kboard_jmpbuf
))
8878 if (!NILP (delayed_switch_frame
))
8880 interrupted_kboard
->kbd_queue
8881 = Fcons (delayed_switch_frame
,
8882 interrupted_kboard
->kbd_queue
);
8883 delayed_switch_frame
= Qnil
;
8886 interrupted_kboard
->kbd_queue
8887 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8889 /* If the side queue is non-empty, ensure it begins with a
8890 switch-frame, so we'll replay it in the right context. */
8891 if (CONSP (interrupted_kboard
->kbd_queue
)
8892 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8893 !(EVENT_HAS_PARAMETERS (key
)
8894 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8898 XSETFRAME (frame
, interrupted_frame
);
8899 interrupted_kboard
->kbd_queue
8900 = Fcons (make_lispy_switch_frame (frame
),
8901 interrupted_kboard
->kbd_queue
);
8904 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8905 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8906 goto replay_sequence
;
8909 key
= read_char (NILP (prompt
), nmaps
,
8910 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8914 /* read_char returns t when it shows a menu and the user rejects it.
8918 unbind_to (count
, Qnil
);
8923 /* read_char returns -1 at the end of a macro.
8924 Emacs 18 handles this by returning immediately with a
8925 zero, so that's what we'll do. */
8926 if (INTEGERP (key
) && XINT (key
) == -1)
8929 /* The Microsoft C compiler can't handle the goto that
8935 /* If the current buffer has been changed from under us, the
8936 keymap may have changed, so replay the sequence. */
8939 timer_resume_idle ();
8942 /* Reset the current buffer from the selected window
8943 in case something changed the former and not the latter.
8944 This is to be more consistent with the behavior
8945 of the command_loop_1. */
8946 if (fix_current_buffer
)
8948 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8950 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8951 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8954 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8955 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8956 goto replay_sequence
;
8959 /* If we have a quit that was typed in another frame, and
8960 quit_throw_to_read_char switched buffers,
8961 replay to get the right keymap. */
8963 && XINT (key
) == quit_char
8964 && current_buffer
!= starting_buffer
)
8967 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8971 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8972 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8973 goto replay_sequence
;
8978 if (EVENT_HAS_PARAMETERS (key
)
8979 /* Either a `switch-frame' or a `select-window' event. */
8980 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8982 /* If we're at the beginning of a key sequence, and the caller
8983 says it's okay, go ahead and return this event. If we're
8984 in the midst of a key sequence, delay it until the end. */
8985 if (t
> 0 || !can_return_switch_frame
)
8987 delayed_switch_frame
= key
;
8993 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8996 /* Clicks in non-text areas get prefixed by the symbol
8997 in their CHAR-ADDRESS field. For example, a click on
8998 the mode line is prefixed by the symbol `mode-line'.
9000 Furthermore, key sequences beginning with mouse clicks
9001 are read using the keymaps of the buffer clicked on, not
9002 the current buffer. So we may have to switch the buffer
9005 When we turn one event into two events, we must make sure
9006 that neither of the two looks like the original--so that,
9007 if we replay the events, they won't be expanded again.
9008 If not for this, such reexpansion could happen either here
9009 or when user programs play with this-command-keys. */
9010 if (EVENT_HAS_PARAMETERS (key
))
9015 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9016 if (EQ (kind
, Qmouse_click
))
9018 Lisp_Object window
, posn
;
9020 window
= POSN_WINDOW (EVENT_START (key
));
9021 posn
= POSN_POSN (EVENT_START (key
));
9024 || (!NILP (fake_prefixed_keys
)
9025 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9027 /* We're looking a second time at an event for which
9028 we generated a fake prefix key. Set
9029 last_real_key_start appropriately. */
9031 last_real_key_start
= t
- 1;
9034 /* Key sequences beginning with mouse clicks are
9035 read using the keymaps in the buffer clicked on,
9036 not the current buffer. If we're at the
9037 beginning of a key sequence, switch buffers. */
9038 if (last_real_key_start
== 0
9040 && BUFFERP (XWINDOW (window
)->buffer
)
9041 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9043 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9047 /* Arrange to go back to the original buffer once we're
9048 done reading the key sequence. Note that we can't
9049 use save_excursion_{save,restore} here, because they
9050 save point as well as the current buffer; we don't
9051 want to save point, because redisplay may change it,
9052 to accommodate a Fset_window_start or something. We
9053 don't want to do this at the top of the function,
9054 because we may get input from a subprocess which
9055 wants to change the selected window and stuff (say,
9057 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9059 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9061 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9062 orig_local_map
= get_local_map (PT
, current_buffer
,
9064 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9065 goto replay_sequence
;
9068 /* For a mouse click, get the local text-property keymap
9069 of the place clicked on, rather than point. */
9070 if (last_real_key_start
== 0
9071 && CONSP (XCDR (key
))
9072 && ! localized_local_map
)
9074 Lisp_Object map_here
, start
, pos
;
9076 localized_local_map
= 1;
9077 start
= EVENT_START (key
);
9079 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9081 pos
= POSN_BUFFER_POSN (start
);
9083 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9085 map_here
= get_local_map (XINT (pos
),
9086 current_buffer
, Qlocal_map
);
9087 if (!EQ (map_here
, orig_local_map
))
9089 orig_local_map
= map_here
;
9093 goto replay_sequence
;
9095 map_here
= get_local_map (XINT (pos
),
9096 current_buffer
, Qkeymap
);
9097 if (!EQ (map_here
, orig_keymap
))
9099 orig_keymap
= map_here
;
9103 goto replay_sequence
;
9109 /* Expand mode-line and scroll-bar events into two events:
9110 use posn as a fake prefix key. */
9112 && (NILP (fake_prefixed_keys
)
9113 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9115 if (t
+ 1 >= bufsize
)
9116 error ("Key sequence too long");
9119 keybuf
[t
+ 1] = key
;
9122 /* Record that a fake prefix key has been generated
9123 for KEY. Don't modify the event; this would
9124 prevent proper action when the event is pushed
9125 back into unread-command-events. */
9126 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9128 /* If on a mode line string with a local keymap,
9129 reconsider the key sequence with that keymap. */
9130 if (string
= POSN_STRING (EVENT_START (key
)),
9131 (CONSP (string
) && STRINGP (XCAR (string
))))
9133 Lisp_Object pos
, map
, map2
;
9135 pos
= XCDR (string
);
9136 string
= XCAR (string
);
9138 && XINT (pos
) < SCHARS (string
))
9140 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9142 orig_local_map
= map
;
9143 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9146 if (!NILP (map
) || !NILP (map2
))
9147 goto replay_sequence
;
9153 else if (NILP (from_string
)
9154 && (string
= POSN_STRING (EVENT_START (key
)),
9155 (CONSP (string
) && STRINGP (XCAR (string
)))))
9157 /* For a click on a string, i.e. overlay string or a
9158 string displayed via the `display' property,
9159 consider `local-map' and `keymap' properties of
9161 Lisp_Object pos
, map
, map2
;
9163 pos
= XCDR (string
);
9164 string
= XCAR (string
);
9166 && XINT (pos
) < SCHARS (string
))
9168 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9170 orig_local_map
= map
;
9171 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9175 if (!NILP (map
) || !NILP (map2
))
9177 from_string
= string
;
9178 goto replay_sequence
;
9183 else if (CONSP (XCDR (key
))
9184 && CONSP (EVENT_START (key
))
9185 && CONSP (XCDR (EVENT_START (key
))))
9189 posn
= POSN_POSN (EVENT_START (key
));
9190 /* Handle menu-bar events:
9191 insert the dummy prefix event `menu-bar'. */
9192 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9194 if (t
+ 1 >= bufsize
)
9195 error ("Key sequence too long");
9199 /* Zap the position in key, so we know that we've
9200 expanded it, and don't try to do so again. */
9201 POSN_SET_POSN (EVENT_START (key
),
9202 Fcons (posn
, Qnil
));
9205 goto replay_sequence
;
9207 else if (CONSP (posn
))
9209 /* We're looking at the second event of a
9210 sequence which we expanded before. Set
9211 last_real_key_start appropriately. */
9212 if (last_real_key_start
== t
&& t
> 0)
9213 last_real_key_start
= t
- 1;
9218 /* We have finally decided that KEY is something we might want
9220 first_binding
= (follow_key (key
,
9221 nmaps
- first_binding
,
9222 submaps
+ first_binding
,
9223 defs
+ first_binding
,
9224 submaps
+ first_binding
)
9227 /* If KEY wasn't bound, we'll try some fallbacks. */
9228 if (first_binding
< nmaps
)
9229 /* This is needed for the following scenario:
9230 event 0: a down-event that gets dropped by calling replay_key.
9231 event 1: some normal prefix like C-h.
9232 After event 0, first_unbound is 0, after event 1 fkey.start
9233 and keytran.start are both 1, so when we see that C-h is bound,
9234 we need to update first_unbound. */
9235 first_unbound
= max (t
+ 1, first_unbound
);
9240 /* Remember the position to put an upper bound on fkey.start. */
9241 first_unbound
= min (t
, first_unbound
);
9243 head
= EVENT_HEAD (key
);
9244 if (help_char_p (head
) && t
> 0)
9246 read_key_sequence_cmd
= Vprefix_help_command
;
9248 last_nonmenu_event
= key
;
9249 /* The Microsoft C compiler can't handle the goto that
9257 Lisp_Object breakdown
;
9260 breakdown
= parse_modifiers (head
);
9261 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9262 /* Attempt to reduce an unbound mouse event to a simpler
9263 event that is bound:
9264 Drags reduce to clicks.
9265 Double-clicks reduce to clicks.
9266 Triple-clicks reduce to double-clicks, then to clicks.
9267 Down-clicks are eliminated.
9268 Double-downs reduce to downs, then are eliminated.
9269 Triple-downs reduce to double-downs, then to downs,
9270 then are eliminated. */
9271 if (modifiers
& (down_modifier
| drag_modifier
9272 | double_modifier
| triple_modifier
))
9274 while (modifiers
& (down_modifier
| drag_modifier
9275 | double_modifier
| triple_modifier
))
9277 Lisp_Object new_head
, new_click
;
9278 if (modifiers
& triple_modifier
)
9279 modifiers
^= (double_modifier
| triple_modifier
);
9280 else if (modifiers
& double_modifier
)
9281 modifiers
&= ~double_modifier
;
9282 else if (modifiers
& drag_modifier
)
9283 modifiers
&= ~drag_modifier
;
9286 /* Dispose of this `down' event by simply jumping
9287 back to replay_key, to get another event.
9289 Note that if this event came from mock input,
9290 then just jumping back to replay_key will just
9291 hand it to us again. So we have to wipe out any
9294 We could delete keybuf[t] and shift everything
9295 after that to the left by one spot, but we'd also
9296 have to fix up any variable that points into
9297 keybuf, and shifting isn't really necessary
9300 Adding prefixes for non-textual mouse clicks
9301 creates two characters of mock input, and both
9302 must be thrown away. If we're only looking at
9303 the prefix now, we can just jump back to
9304 replay_key. On the other hand, if we've already
9305 processed the prefix, and now the actual click
9306 itself is giving us trouble, then we've lost the
9307 state of the keymaps we want to backtrack to, and
9308 we need to replay the whole sequence to rebuild
9311 Beyond that, only function key expansion could
9312 create more than two keys, but that should never
9313 generate mouse events, so it's okay to zero
9314 mock_input in that case too.
9316 FIXME: The above paragraph seems just plain
9317 wrong, if you consider things like
9318 xterm-mouse-mode. -stef
9320 Isn't this just the most wonderful code ever? */
9322 /* If mock_input > t + 1, the above simplification
9323 will actually end up dropping keys on the floor.
9324 This is probably OK for now, but even
9325 if mock_input <= t + 1, we need to adjust fkey
9327 Typical case [header-line down-mouse-N]:
9328 mock_input = 2, t = 1, fkey.end = 1,
9329 last_real_key_start = 0. */
9330 if (fkey
.end
> last_real_key_start
)
9332 fkey
.end
= fkey
.start
9333 = min (last_real_key_start
, fkey
.start
);
9334 fkey
.map
= fkey
.parent
;
9335 if (keytran
.end
> last_real_key_start
)
9337 keytran
.end
= keytran
.start
9338 = min (last_real_key_start
, keytran
.start
);
9339 keytran
.map
= keytran
.parent
;
9342 if (t
== last_real_key_start
)
9349 mock_input
= last_real_key_start
;
9350 goto replay_sequence
;
9355 = apply_modifiers (modifiers
, XCAR (breakdown
));
9357 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9359 /* Look for a binding for this new key. follow_key
9360 promises that it didn't munge submaps the
9361 last time we called it, since key was unbound. */
9363 = (follow_key (new_click
,
9364 nmaps
- local_first_binding
,
9365 submaps
+ local_first_binding
,
9366 defs
+ local_first_binding
,
9367 submaps
+ local_first_binding
)
9368 + local_first_binding
);
9370 /* If that click is bound, go for it. */
9371 if (first_binding
< nmaps
)
9376 /* Otherwise, we'll leave key set to the drag event. */
9383 /* Normally, last_nonmenu_event gets the previous key we read.
9384 But when a mouse popup menu is being used,
9385 we don't update last_nonmenu_event; it continues to hold the mouse
9386 event that preceded the first level of menu. */
9387 if (!used_mouse_menu
)
9388 last_nonmenu_event
= key
;
9390 /* Record what part of this_command_keys is the current key sequence. */
9391 this_single_command_key_start
= this_command_key_count
- t
;
9393 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9394 /* There is a binding and it's not a prefix.
9395 There is thus no function-key in this sequence.
9396 Moving fkey.start is important in this case to allow keytran.start
9397 to go over the sequence before we return (since we keep the
9398 invariant that keytran.end <= fkey.start). */
9401 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9404 /* If the sequence is unbound, see if we can hang a function key
9405 off the end of it. */
9406 /* Continue scan from fkey.end until we find a bound suffix. */
9407 while (fkey
.end
< t
)
9409 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9412 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9413 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9414 max (t
, mock_input
),
9415 /* If there's a binding (i.e.
9416 first_binding >= nmaps) we don't want
9417 to apply this function-key-mapping. */
9418 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9423 mock_input
= diff
+ max (t
, mock_input
);
9424 goto replay_sequence
;
9428 /* Look for this sequence in key-translation-map.
9429 Scan from keytran.end until we find a bound suffix. */
9430 while (keytran
.end
< fkey
.start
)
9432 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9435 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9436 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9441 mock_input
= diff
+ max (t
, mock_input
);
9442 /* Adjust the function-key-map counters. */
9446 goto replay_sequence
;
9450 /* If KEY is not defined in any of the keymaps,
9451 and cannot be part of a function key or translation,
9452 and is an upper case letter
9453 use the corresponding lower-case letter instead. */
9454 if (first_binding
>= nmaps
9455 && fkey
.start
>= t
&& keytran
.start
>= t
9457 && ((((XINT (key
) & 0x3ffff)
9458 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9459 && UPPERCASEP (XINT (key
) & 0x3ffff))
9460 || (XINT (key
) & shift_modifier
)))
9462 Lisp_Object new_key
;
9464 original_uppercase
= key
;
9465 original_uppercase_position
= t
- 1;
9467 if (XINT (key
) & shift_modifier
)
9468 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9470 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9471 | (XINT (key
) & ~0x3ffff)));
9473 /* We have to do this unconditionally, regardless of whether
9474 the lower-case char is defined in the keymaps, because they
9475 might get translated through function-key-map. */
9476 keybuf
[t
- 1] = new_key
;
9477 mock_input
= max (t
, mock_input
);
9479 goto replay_sequence
;
9481 /* If KEY is not defined in any of the keymaps,
9482 and cannot be part of a function key or translation,
9483 and is a shifted function key,
9484 use the corresponding unshifted function key instead. */
9485 if (first_binding
>= nmaps
9486 && fkey
.start
>= t
&& keytran
.start
>= t
9489 Lisp_Object breakdown
;
9492 breakdown
= parse_modifiers (key
);
9493 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9494 if (modifiers
& shift_modifier
)
9496 Lisp_Object new_key
;
9498 original_uppercase
= key
;
9499 original_uppercase_position
= t
- 1;
9501 modifiers
&= ~shift_modifier
;
9502 new_key
= apply_modifiers (modifiers
,
9505 keybuf
[t
- 1] = new_key
;
9506 mock_input
= max (t
, mock_input
);
9507 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9508 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9510 goto replay_sequence
;
9516 read_key_sequence_cmd
= (first_binding
< nmaps
9517 ? defs
[first_binding
]
9520 unread_switch_frame
= delayed_switch_frame
;
9521 unbind_to (count
, Qnil
);
9523 /* Don't downcase the last character if the caller says don't.
9524 Don't downcase it if the result is undefined, either. */
9525 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9526 && t
- 1 == original_uppercase_position
)
9527 keybuf
[t
- 1] = original_uppercase
;
9529 /* Occasionally we fabricate events, perhaps by expanding something
9530 according to function-key-map, or by adding a prefix symbol to a
9531 mouse click in the scroll bar or modeline. In this cases, return
9532 the entire generated key sequence, even if we hit an unbound
9533 prefix or a definition before the end. This means that you will
9534 be able to push back the event properly, and also means that
9535 read-key-sequence will always return a logical unit.
9538 for (; t
< mock_input
; t
++)
9540 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9541 && NILP (Fzerop (Vecho_keystrokes
)))
9542 echo_char (keybuf
[t
]);
9543 add_command_key (keybuf
[t
]);
9552 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9553 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9554 The sequence is sufficient to specify a non-prefix command in the
9555 current local and global maps.
9557 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9558 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9559 as a continuation of the previous key.
9561 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9562 convert the last event to lower case. (Normally any upper case event
9563 is converted to lower case if the original event is undefined and the lower
9564 case equivalent is defined.) A non-nil value is appropriate for reading
9565 a key sequence to be defined.
9567 A C-g typed while in this function is treated like any other character,
9568 and `quit-flag' is not set.
9570 If the key sequence starts with a mouse click, then the sequence is read
9571 using the keymaps of the buffer of the window clicked in, not the buffer
9572 of the selected window as normal.
9574 `read-key-sequence' drops unbound button-down events, since you normally
9575 only care about the click or drag events which follow them. If a drag
9576 or multi-click event is unbound, but the corresponding click event would
9577 be bound, `read-key-sequence' turns the event into a click event at the
9578 drag's starting position. This means that you don't have to distinguish
9579 between click and drag, double, or triple events unless you want to.
9581 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9582 lines separating windows, and scroll bars with imaginary keys
9583 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9585 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9586 function will process a switch-frame event if the user switches frames
9587 before typing anything. If the user switches frames in the middle of a
9588 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9589 is nil, then the event will be put off until after the current key sequence.
9591 `read-key-sequence' checks `function-key-map' for function key
9592 sequences, where they wouldn't conflict with ordinary bindings. See
9593 `function-key-map' for more details.
9595 The optional fifth argument COMMAND-LOOP, if non-nil, means
9596 that this key sequence is being read by something that will
9597 read commands one after another. It should be nil if the caller
9598 will read just one key sequence. */)
9599 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9601 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9602 Lisp_Object can_return_switch_frame
, command_loop
;
9604 Lisp_Object keybuf
[30];
9606 struct gcpro gcpro1
;
9607 int count
= SPECPDL_INDEX ();
9610 CHECK_STRING (prompt
);
9613 specbind (Qinput_method_exit_on_first_char
,
9614 (NILP (command_loop
) ? Qt
: Qnil
));
9615 specbind (Qinput_method_use_echo_area
,
9616 (NILP (command_loop
) ? Qt
: Qnil
));
9618 bzero (keybuf
, sizeof keybuf
);
9620 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9622 if (NILP (continue_echo
))
9624 this_command_key_count
= 0;
9625 this_command_key_count_reset
= 0;
9626 this_single_command_key_start
= 0;
9629 #ifdef HAVE_X_WINDOWS
9630 if (display_hourglass_p
)
9631 cancel_hourglass ();
9634 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9635 prompt
, ! NILP (dont_downcase_last
),
9636 ! NILP (can_return_switch_frame
), 0);
9638 #if 0 /* The following is fine for code reading a key sequence and
9639 then proceeding with a lenghty computation, but it's not good
9640 for code reading keys in a loop, like an input method. */
9641 #ifdef HAVE_X_WINDOWS
9642 if (display_hourglass_p
)
9653 return unbind_to (count
, make_event_array (i
, keybuf
));
9656 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9657 Sread_key_sequence_vector
, 1, 5, 0,
9658 doc
: /* Like `read-key-sequence' but always return a vector. */)
9659 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9661 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9662 Lisp_Object can_return_switch_frame
, command_loop
;
9664 Lisp_Object keybuf
[30];
9666 struct gcpro gcpro1
;
9667 int count
= SPECPDL_INDEX ();
9670 CHECK_STRING (prompt
);
9673 specbind (Qinput_method_exit_on_first_char
,
9674 (NILP (command_loop
) ? Qt
: Qnil
));
9675 specbind (Qinput_method_use_echo_area
,
9676 (NILP (command_loop
) ? Qt
: Qnil
));
9678 bzero (keybuf
, sizeof keybuf
);
9680 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9682 if (NILP (continue_echo
))
9684 this_command_key_count
= 0;
9685 this_command_key_count_reset
= 0;
9686 this_single_command_key_start
= 0;
9689 #ifdef HAVE_X_WINDOWS
9690 if (display_hourglass_p
)
9691 cancel_hourglass ();
9694 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9695 prompt
, ! NILP (dont_downcase_last
),
9696 ! NILP (can_return_switch_frame
), 0);
9698 #ifdef HAVE_X_WINDOWS
9699 if (display_hourglass_p
)
9709 return unbind_to (count
, Fvector (i
, keybuf
));
9712 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9713 doc
: /* Execute CMD as an editor command.
9714 CMD must be a symbol that satisfies the `commandp' predicate.
9715 Optional second arg RECORD-FLAG non-nil
9716 means unconditionally put this command in `command-history'.
9717 Otherwise, that is done only if an arg is read using the minibuffer.
9718 The argument KEYS specifies the value to use instead of (this-command-keys)
9719 when reading the arguments; if it is nil, (this-command-keys) is used.
9720 The argument SPECIAL, if non-nil, means that this command is executing
9721 a special event, so ignore the prefix argument and don't clear it. */)
9722 (cmd
, record_flag
, keys
, special
)
9723 Lisp_Object cmd
, record_flag
, keys
, special
;
9725 register Lisp_Object final
;
9726 register Lisp_Object tem
;
9727 Lisp_Object prefixarg
;
9728 struct backtrace backtrace
;
9729 extern int debug_on_next_call
;
9731 debug_on_next_call
= 0;
9735 prefixarg
= current_kboard
->Vprefix_arg
;
9736 Vcurrent_prefix_arg
= prefixarg
;
9737 current_kboard
->Vprefix_arg
= Qnil
;
9744 tem
= Fget (cmd
, Qdisabled
);
9745 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9747 tem
= Fsymbol_value (Qdisabled_command_function
);
9749 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9755 final
= Findirect_function (cmd
);
9757 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9759 struct gcpro gcpro1
, gcpro2
;
9761 GCPRO2 (cmd
, prefixarg
);
9762 do_autoload (final
, cmd
);
9769 if (STRINGP (final
) || VECTORP (final
))
9771 /* If requested, place the macro in the command history. For
9772 other sorts of commands, call-interactively takes care of
9774 if (!NILP (record_flag
))
9777 = Fcons (Fcons (Qexecute_kbd_macro
,
9778 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9781 /* Don't keep command history around forever. */
9782 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9784 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9786 XSETCDR (tem
, Qnil
);
9790 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9793 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9795 backtrace
.next
= backtrace_list
;
9796 backtrace_list
= &backtrace
;
9797 backtrace
.function
= &Qcall_interactively
;
9798 backtrace
.args
= &cmd
;
9799 backtrace
.nargs
= 1;
9800 backtrace
.evalargs
= 0;
9801 backtrace
.debug_on_exit
= 0;
9803 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9805 backtrace_list
= backtrace
.next
;
9813 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9815 doc
: /* Read function name, then read its arguments and call it. */)
9817 Lisp_Object prefixarg
;
9819 Lisp_Object function
;
9821 int saved_last_point_position
;
9822 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9823 Lisp_Object bindings
, value
;
9824 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9825 #ifdef HAVE_X_WINDOWS
9826 /* The call to Fcompleting_read wil start and cancel the hourglass,
9827 but if the hourglass was already scheduled, this means that no
9828 hourglass will be shown for the actual M-x command itself.
9829 So we restart it if it is already scheduled. Note that checking
9830 hourglass_shown_p is not enough, normally the hourglass is not shown,
9831 just scheduled to be shown. */
9832 int hstarted
= hourglass_started ();
9835 saved_keys
= Fvector (this_command_key_count
,
9836 XVECTOR (this_command_keys
)->contents
);
9837 saved_last_point_position_buffer
= last_point_position_buffer
;
9838 saved_last_point_position
= last_point_position
;
9840 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9842 if (EQ (prefixarg
, Qminus
))
9844 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9845 strcpy (buf
, "C-u ");
9846 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9847 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9848 else if (INTEGERP (prefixarg
))
9849 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9851 /* This isn't strictly correct if execute-extended-command
9852 is bound to anything else. Perhaps it should use
9853 this_command_keys? */
9854 strcat (buf
, "M-x ");
9856 /* Prompt with buf, and then read a string, completing from and
9857 restricting to the set of all defined commands. Don't provide
9858 any initial input. Save the command read on the extended-command
9860 function
= Fcompleting_read (build_string (buf
),
9861 Vobarray
, Qcommandp
,
9862 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9865 #ifdef HAVE_X_WINDOWS
9866 if (hstarted
) start_hourglass ();
9869 if (STRINGP (function
) && SCHARS (function
) == 0)
9870 error ("No command name given");
9872 /* Set this_command_keys to the concatenation of saved_keys and
9873 function, followed by a RET. */
9878 this_command_key_count
= 0;
9879 this_command_key_count_reset
= 0;
9880 this_single_command_key_start
= 0;
9882 keys
= XVECTOR (saved_keys
)->contents
;
9883 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9884 add_command_key (keys
[i
]);
9886 for (i
= 0; i
< SCHARS (function
); i
++)
9887 add_command_key (Faref (function
, make_number (i
)));
9889 add_command_key (make_number ('\015'));
9892 last_point_position
= saved_last_point_position
;
9893 last_point_position_buffer
= saved_last_point_position_buffer
;
9897 function
= Fintern (function
, Qnil
);
9898 current_kboard
->Vprefix_arg
= prefixarg
;
9899 Vthis_command
= function
;
9900 real_this_command
= function
;
9902 /* If enabled, show which key runs this command. */
9903 if (!NILP (Vsuggest_key_bindings
)
9904 && NILP (Vexecuting_kbd_macro
)
9905 && SYMBOLP (function
))
9906 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9912 GCPRO2 (bindings
, value
);
9913 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9915 /* If the command has a key binding, print it now. */
9916 if (!NILP (bindings
)
9917 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9920 /* But first wait, and skip the message if there is input. */
9922 if (!NILP (echo_area_buffer
[0]))
9923 /* This command displayed something in the echo area;
9924 so wait a few seconds, then display our suggestion message. */
9925 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9926 ? XINT (Vsuggest_key_bindings
) : 2);
9928 /* This command left the echo area empty,
9929 so display our message immediately. */
9932 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9933 && ! CONSP (Vunread_command_events
))
9935 Lisp_Object binding
;
9937 int message_p
= push_message ();
9938 int count
= SPECPDL_INDEX ();
9940 record_unwind_protect (pop_message_unwind
, Qnil
);
9941 binding
= Fkey_description (bindings
, Qnil
);
9944 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9947 sprintf (newmessage
, "You can run the command `%s' with %s",
9948 SDATA (SYMBOL_NAME (function
)),
9950 message2_nolog (newmessage
,
9951 strlen (newmessage
),
9952 STRING_MULTIBYTE (binding
));
9953 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9954 ? Vsuggest_key_bindings
: make_number (2)),
9959 unbind_to (count
, Qnil
);
9963 RETURN_UNGCPRO (value
);
9967 /* Return nonzero if input events are pending. */
9970 detect_input_pending ()
9973 get_input_pending (&input_pending
, 0);
9975 return input_pending
;
9978 /* Return nonzero if input events other than mouse movements are
9982 detect_input_pending_ignore_squeezables ()
9985 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9987 return input_pending
;
9990 /* Return nonzero if input events are pending, and run any pending timers. */
9993 detect_input_pending_run_timers (do_display
)
9996 int old_timers_run
= timers_run
;
9999 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10001 if (old_timers_run
!= timers_run
&& do_display
)
10003 redisplay_preserve_echo_area (8);
10004 /* The following fixes a bug when using lazy-lock with
10005 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10006 from an idle timer function. The symptom of the bug is that
10007 the cursor sometimes doesn't become visible until the next X
10008 event is processed. --gerd. */
10010 Lisp_Object tail
, frame
;
10011 FOR_EACH_FRAME (tail
, frame
)
10012 if (FRAME_RIF (XFRAME (frame
)))
10013 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10017 return input_pending
;
10020 /* This is called in some cases before a possible quit.
10021 It cases the next call to detect_input_pending to recompute input_pending.
10022 So calling this function unnecessarily can't do any harm. */
10025 clear_input_pending ()
10030 /* Return nonzero if there are pending requeued events.
10031 This isn't used yet. The hope is to make wait_reading_process_output
10032 call it, and return if it runs Lisp code that unreads something.
10033 The problem is, kbd_buffer_get_event needs to be fixed to know what
10034 to do in that case. It isn't trivial. */
10037 requeued_events_pending_p ()
10039 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10043 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10044 doc
: /* Return t if command input is currently available with no wait.
10045 Actually, the value is nil only if we can be sure that no input is available;
10046 if there is a doubt, the value is t. */)
10049 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10052 get_input_pending (&input_pending
,
10053 READABLE_EVENTS_DO_TIMERS_NOW
10054 | READABLE_EVENTS_FILTER_EVENTS
);
10055 return input_pending
> 0 ? Qt
: Qnil
;
10058 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10059 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10062 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10065 if (total_keys
< NUM_RECENT_KEYS
)
10066 return Fvector (total_keys
, keys
);
10069 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10070 bcopy (keys
+ recent_keys_index
,
10071 XVECTOR (val
)->contents
,
10072 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10074 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10075 recent_keys_index
* sizeof (Lisp_Object
));
10080 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10081 doc
: /* Return the key sequence that invoked this command.
10082 However, if the command has called `read-key-sequence', it returns
10083 the last key sequence that has been read.
10084 The value is a string or a vector. */)
10087 return make_event_array (this_command_key_count
,
10088 XVECTOR (this_command_keys
)->contents
);
10091 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10092 doc
: /* Return the key sequence that invoked this command, as a vector.
10093 However, if the command has called `read-key-sequence', it returns
10094 the last key sequence that has been read. */)
10097 return Fvector (this_command_key_count
,
10098 XVECTOR (this_command_keys
)->contents
);
10101 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10102 Sthis_single_command_keys
, 0, 0, 0,
10103 doc
: /* Return the key sequence that invoked this command.
10104 More generally, it returns the last key sequence read, either by
10105 the command loop or by `read-key-sequence'.
10106 Unlike `this-command-keys', this function's value
10107 does not include prefix arguments.
10108 The value is always a vector. */)
10111 return Fvector (this_command_key_count
10112 - this_single_command_key_start
,
10113 (XVECTOR (this_command_keys
)->contents
10114 + this_single_command_key_start
));
10117 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10118 Sthis_single_command_raw_keys
, 0, 0, 0,
10119 doc
: /* Return the raw events that were read for this command.
10120 More generally, it returns the last key sequence read, either by
10121 the command loop or by `read-key-sequence'.
10122 Unlike `this-single-command-keys', this function's value
10123 shows the events before all translations (except for input methods).
10124 The value is always a vector. */)
10127 return Fvector (raw_keybuf_count
,
10128 (XVECTOR (raw_keybuf
)->contents
));
10131 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10132 Sreset_this_command_lengths
, 0, 0, 0,
10133 doc
: /* Make the unread events replace the last command and echo.
10134 Used in `universal-argument-other-key'.
10136 `universal-argument-other-key' rereads the event just typed.
10137 It then gets translated through `function-key-map'.
10138 The translated event has to replace the real events,
10139 both in the value of (this-command-keys) and in echoing.
10140 To achieve this, `universal-argument-other-key' calls
10141 `reset-this-command-lengths', which discards the record of reading
10142 these events the first time. */)
10145 this_command_key_count
= before_command_key_count
;
10146 if (this_command_key_count
< this_single_command_key_start
)
10147 this_single_command_key_start
= this_command_key_count
;
10149 echo_truncate (before_command_echo_length
);
10151 /* Cause whatever we put into unread-command-events
10152 to echo as if it were being freshly read from the keyboard. */
10153 this_command_key_count_reset
= 1;
10158 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10159 Sclear_this_command_keys
, 0, 1, 0,
10160 doc
: /* Clear out the vector that `this-command-keys' returns.
10161 Also clear the record of the last 100 events, unless optional arg
10162 KEEP-RECORD is non-nil. */)
10164 Lisp_Object keep_record
;
10168 this_command_key_count
= 0;
10169 this_command_key_count_reset
= 0;
10171 if (NILP (keep_record
))
10173 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10174 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10176 recent_keys_index
= 0;
10181 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10182 doc
: /* Return the current depth in recursive edits. */)
10186 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10190 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10191 "FOpen dribble file: ",
10192 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10193 If FILE is nil, close any open dribble file. */)
10204 file
= Fexpand_file_name (file
, Qnil
);
10205 dribble
= fopen (SDATA (file
), "w");
10207 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10212 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10213 doc
: /* Discard the contents of the terminal input buffer.
10214 Also end any kbd macro being defined. */)
10217 if (!NILP (current_kboard
->defining_kbd_macro
))
10219 /* Discard the last command from the macro. */
10220 Fcancel_kbd_macro_events ();
10224 update_mode_lines
++;
10226 Vunread_command_events
= Qnil
;
10227 unread_command_char
= -1;
10229 discard_tty_input ();
10231 kbd_fetch_ptr
= kbd_store_ptr
;
10237 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10238 doc
: /* Stop Emacs and return to superior process. You can resume later.
10239 If `cannot-suspend' is non-nil, or if the system doesn't support job
10240 control, run a subshell instead.
10242 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10243 to be read as terminal input by Emacs's parent, after suspension.
10245 Before suspending, run the normal hook `suspend-hook'.
10246 After resumption run the normal hook `suspend-resume-hook'.
10248 Some operating systems cannot stop the Emacs process and resume it later.
10249 On such systems, Emacs starts a subshell instead of suspending. */)
10251 Lisp_Object stuffstring
;
10253 int count
= SPECPDL_INDEX ();
10254 int old_height
, old_width
;
10256 struct gcpro gcpro1
;
10258 if (tty_list
&& tty_list
->next
)
10259 error ("There are other tty frames open; close them before suspending Emacs");
10261 if (!NILP (stuffstring
))
10262 CHECK_STRING (stuffstring
);
10264 /* Run the functions in suspend-hook. */
10265 if (!NILP (Vrun_hooks
))
10266 call1 (Vrun_hooks
, intern ("suspend-hook"));
10268 GCPRO1 (stuffstring
);
10269 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10270 reset_all_sys_modes ();
10271 /* sys_suspend can get an error if it tries to fork a subshell
10272 and the system resources aren't available for that. */
10273 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10275 stuff_buffered_input (stuffstring
);
10276 if (cannot_suspend
)
10280 unbind_to (count
, Qnil
);
10282 /* Check if terminal/window size has changed.
10283 Note that this is not useful when we are running directly
10284 with a window system; but suspend should be disabled in that case. */
10285 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10286 if (width
!= old_width
|| height
!= old_height
)
10287 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10289 /* Run suspend-resume-hook. */
10290 if (!NILP (Vrun_hooks
))
10291 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10297 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10298 Then in any case stuff anything Emacs has read ahead and not used. */
10301 stuff_buffered_input (stuffstring
)
10302 Lisp_Object stuffstring
;
10304 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10305 register unsigned char *p
;
10307 if (STRINGP (stuffstring
))
10309 register int count
;
10311 p
= SDATA (stuffstring
);
10312 count
= SBYTES (stuffstring
);
10313 while (count
-- > 0)
10318 /* Anything we have read ahead, put back for the shell to read. */
10319 /* ?? What should this do when we have multiple keyboards??
10320 Should we ignore anything that was typed in at the "wrong" kboard?
10322 rms: we should stuff everything back into the kboard
10324 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10327 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10328 kbd_fetch_ptr
= kbd_buffer
;
10329 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10330 stuff_char (kbd_fetch_ptr
->code
);
10332 clear_event (kbd_fetch_ptr
);
10336 #endif /* SIGTSTP */
10340 set_waiting_for_input (time_to_clear
)
10341 EMACS_TIME
*time_to_clear
;
10343 input_available_clear_time
= time_to_clear
;
10345 /* Tell handle_interrupt to throw back to read_char, */
10346 waiting_for_input
= 1;
10348 /* If handle_interrupt was called before and buffered a C-g,
10349 make it run again now, to avoid timing error. */
10350 if (!NILP (Vquit_flag
))
10351 quit_throw_to_read_char ();
10355 clear_waiting_for_input ()
10357 /* Tell handle_interrupt not to throw back to read_char, */
10358 waiting_for_input
= 0;
10359 input_available_clear_time
= 0;
10362 /* The SIGINT handler.
10364 If we have a frame on the controlling tty, we assume that the
10365 SIGINT was generated by C-g, so we call handle_interrupt.
10366 Otherwise, the handler kills Emacs. */
10369 interrupt_signal (signalnum
) /* If we don't have an argument, */
10370 int signalnum
; /* some compilers complain in signal calls. */
10372 /* Must preserve main program's value of errno. */
10373 int old_errno
= errno
;
10374 struct display
*display
;
10376 #if defined (USG) && !defined (POSIX_SIGNALS)
10377 /* USG systems forget handlers when they are used;
10378 must reestablish each time */
10379 signal (SIGINT
, interrupt_signal
);
10380 signal (SIGQUIT
, interrupt_signal
);
10383 SIGNAL_THREAD_CHECK (signalnum
);
10385 /* See if we have an active display on our controlling terminal. */
10386 display
= get_named_tty_display (NULL
);
10389 /* If there are no frames there, let's pretend that we are a
10390 well-behaving UN*X program and quit. */
10391 fatal_error_signal (SIGTERM
);
10395 /* Otherwise, the SIGINT was probably generated by C-g. */
10397 /* Set internal_last_event_frame to the top frame of the
10398 controlling tty, if we have a frame there. We disable the
10399 interrupt key on secondary ttys, so the SIGINT must have come
10400 from the controlling tty. */
10401 internal_last_event_frame
= display
->display_info
.tty
->top_frame
;
10403 handle_interrupt ();
10409 /* This routine is called at interrupt level in response to C-g.
10411 It is called from the SIGINT handler or kbd_buffer_store_event.
10413 If `waiting_for_input' is non zero, then unless `echoing' is
10414 nonzero, immediately throw back to read_char.
10416 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10417 eval to throw, when it gets a chance. If quit-flag is already
10418 non-nil, it stops the job right away. */
10421 handle_interrupt ()
10427 /* XXX This code needs to be revised for multi-tty support. */
10428 if (!NILP (Vquit_flag
)
10430 && get_named_tty_display (NULL
)
10434 /* If SIGINT isn't blocked, don't let us be interrupted by
10435 another SIGINT, it might be harmful due to non-reentrancy
10436 in I/O functions. */
10437 sigblock (sigmask (SIGINT
));
10440 reset_all_sys_modes ();
10442 #ifdef SIGTSTP /* Support possible in later USG versions */
10444 * On systems which can suspend the current process and return to the original
10445 * shell, this command causes the user to end up back at the shell.
10446 * The "Auto-save" and "Abort" questions are not asked until
10447 * the user elects to return to emacs, at which point he can save the current
10448 * job and either dump core or continue.
10453 if (sys_suspend () == -1)
10455 printf ("Not running as a subprocess;\n");
10456 printf ("you can continue or abort.\n");
10458 #else /* not VMS */
10459 /* Perhaps should really fork an inferior shell?
10460 But that would not provide any way to get back
10461 to the original shell, ever. */
10462 printf ("No support for stopping a process on this operating system;\n");
10463 printf ("you can continue or abort.\n");
10464 #endif /* not VMS */
10465 #endif /* not SIGTSTP */
10467 /* We must remain inside the screen area when the internal terminal
10468 is used. Note that [Enter] is not echoed by dos. */
10471 /* It doesn't work to autosave while GC is in progress;
10472 the code used for auto-saving doesn't cope with the mark bit. */
10473 if (!gc_in_progress
)
10475 printf ("Auto-save? (y or n) ");
10477 if (((c
= getchar ()) & ~040) == 'Y')
10479 Fdo_auto_save (Qt
, Qnil
);
10481 printf ("\r\nAuto-save done");
10482 #else /* not MSDOS */
10483 printf ("Auto-save done\n");
10484 #endif /* not MSDOS */
10486 while (c
!= '\n') c
= getchar ();
10490 /* During GC, it must be safe to reenable quitting again. */
10491 Vinhibit_quit
= Qnil
;
10494 #endif /* not MSDOS */
10495 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10496 printf ("but will instead do a real quit after garbage collection ends\r\n");
10501 printf ("\r\nAbort? (y or n) ");
10502 #else /* not MSDOS */
10504 printf ("Abort (and enter debugger)? (y or n) ");
10505 #else /* not VMS */
10506 printf ("Abort (and dump core)? (y or n) ");
10507 #endif /* not VMS */
10508 #endif /* not MSDOS */
10510 if (((c
= getchar ()) & ~040) == 'Y')
10512 while (c
!= '\n') c
= getchar ();
10514 printf ("\r\nContinuing...\r\n");
10515 #else /* not MSDOS */
10516 printf ("Continuing...\n");
10517 #endif /* not MSDOS */
10519 init_all_sys_modes ();
10524 /* If executing a function that wants to be interrupted out of
10525 and the user has not deferred quitting by binding `inhibit-quit'
10526 then quit right away. */
10527 if (immediate_quit
&& NILP (Vinhibit_quit
))
10529 struct gl_state_s saved
;
10530 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10532 immediate_quit
= 0;
10535 GCPRO4 (saved
.object
, saved
.global_code
,
10536 saved
.current_syntax_table
, saved
.old_prop
);
10537 Fsignal (Qquit
, Qnil
);
10542 /* Else request quit when it's safe */
10546 if (waiting_for_input
&& !echoing
)
10547 quit_throw_to_read_char ();
10550 /* Handle a C-g by making read_char return C-g. */
10553 quit_throw_to_read_char ()
10556 /* Prevent another signal from doing this before we finish. */
10557 clear_waiting_for_input ();
10560 Vunread_command_events
= Qnil
;
10561 unread_command_char
= -1;
10563 #if 0 /* Currently, sit_for is called from read_char without turning
10564 off polling. And that can call set_waiting_for_input.
10565 It seems to be harmless. */
10566 #ifdef POLL_FOR_INPUT
10567 /* May be > 1 if in recursive minibuffer. */
10568 if (poll_suppress_count
== 0)
10572 if (FRAMEP (internal_last_event_frame
)
10573 && !EQ (internal_last_event_frame
, selected_frame
))
10574 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10577 _longjmp (getcjmp
, 1);
10580 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10581 doc
: /* Set mode of reading keyboard input.
10582 First arg INTERRUPT non-nil means use input interrupts;
10583 nil means use CBREAK mode.
10584 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10585 (no effect except in CBREAK mode).
10586 Third arg META t means accept 8-bit input (for a Meta key).
10587 META nil means ignore the top bit, on the assumption it is parity.
10588 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10589 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10590 See also `current-input-mode'. */)
10591 (interrupt
, flow
, meta
, quit
)
10592 Lisp_Object interrupt
, flow
, meta
, quit
;
10594 /* XXX This function needs to be revised for multi-device support.
10595 Currently it compiles fine, but its semantics are wrong. It sets
10596 global parameters (e.g. interrupt_input) based on only the
10597 current frame's device. */
10600 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10601 error ("set-input-mode: QUIT must be an ASCII character");
10603 #ifdef POLL_FOR_INPUT
10608 /* this causes startup screen to be restored and messes with the mouse */
10609 reset_all_sys_modes ();
10613 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10614 if (FRAME_DISPLAY (SELECTED_FRAME ())->read_socket_hook
)
10616 /* When using X, don't give the user a real choice,
10617 because we haven't implemented the mechanisms to support it. */
10618 #ifdef NO_SOCK_SIGIO
10619 interrupt_input
= 0;
10620 #else /* not NO_SOCK_SIGIO */
10621 interrupt_input
= 1;
10622 #endif /* NO_SOCK_SIGIO */
10625 interrupt_input
= !NILP (interrupt
);
10626 #else /* not SIGIO */
10627 interrupt_input
= 0;
10628 #endif /* not SIGIO */
10630 /* Our VMS input only works by interrupts, as of now. */
10632 interrupt_input
= 1;
10635 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10637 struct tty_display_info
*tty
= CURTTY ();
10638 tty
->flow_control
= !NILP (flow
);
10641 else if (EQ (meta
, Qt
))
10648 /* Don't let this value be out of range. */
10649 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10652 init_all_sys_modes ();
10655 #ifdef POLL_FOR_INPUT
10656 poll_suppress_count
= 1;
10662 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10663 doc
: /* Return information about the way Emacs currently reads keyboard input.
10664 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10665 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10666 nil, Emacs is using CBREAK mode.
10667 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10668 terminal; this does not apply if Emacs uses interrupt-driven input.
10669 META is t if accepting 8-bit input with 8th bit as Meta flag.
10670 META nil means ignoring the top bit, on the assumption it is parity.
10671 META is neither t nor nil if accepting 8-bit input and using
10672 all 8 bits as the character code.
10673 QUIT is the character Emacs currently uses to quit.
10674 The elements of this list correspond to the arguments of
10675 `set-input-mode'. */)
10678 Lisp_Object val
[4];
10679 struct frame
*sf
= XFRAME (selected_frame
);
10681 val
[0] = interrupt_input
? Qt
: Qnil
;
10682 if (FRAME_TERMCAP_P (sf
))
10684 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10685 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10687 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10694 XSETFASTINT (val
[3], quit_char
);
10696 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10699 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10700 doc
: /* Return position information for pixel coordinates X and Y.
10701 By default, X and Y are relative to text area of the selected window.
10702 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10703 If optional fourth arg WHOLE is non-nil, X is relative to the left
10704 edge of the window.
10706 The return value is similar to a mouse click position:
10707 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10708 IMAGE (DX . DY) (WIDTH . HEIGHT))
10709 The `posn-' functions access elements of such lists. */)
10710 (x
, y
, frame_or_window
, whole
)
10711 Lisp_Object x
, y
, frame_or_window
, whole
;
10716 if (NILP (frame_or_window
))
10717 frame_or_window
= selected_window
;
10719 if (WINDOWP (frame_or_window
))
10723 CHECK_LIVE_WINDOW (frame_or_window
);
10725 w
= XWINDOW (frame_or_window
);
10726 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10728 ? window_box_left_offset (w
, TEXT_AREA
)
10729 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10730 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10731 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10732 frame_or_window
= w
->frame
;
10735 CHECK_LIVE_FRAME (frame_or_window
);
10737 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10740 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10741 doc
: /* Return position information for buffer POS in WINDOW.
10742 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10744 Return nil if position is not visible in window. Otherwise,
10745 the return value is similar to that returned by `event-start' for
10746 a mouse click at the upper left corner of the glyph corresponding
10747 to the given buffer position:
10748 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10749 IMAGE (DX . DY) (WIDTH . HEIGHT))
10750 The `posn-' functions access elements of such lists. */)
10752 Lisp_Object pos
, window
;
10756 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10758 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10764 * Set up a new kboard object with reasonable initial values.
10770 kb
->Voverriding_terminal_local_map
= Qnil
;
10771 kb
->Vlast_command
= Qnil
;
10772 kb
->Vreal_last_command
= Qnil
;
10773 kb
->Vprefix_arg
= Qnil
;
10774 kb
->Vlast_prefix_arg
= Qnil
;
10775 kb
->kbd_queue
= Qnil
;
10776 kb
->kbd_queue_has_data
= 0;
10777 kb
->immediate_echo
= 0;
10778 kb
->echo_string
= Qnil
;
10779 kb
->echo_after_prompt
= -1;
10780 kb
->kbd_macro_buffer
= 0;
10781 kb
->kbd_macro_bufsize
= 0;
10782 kb
->defining_kbd_macro
= Qnil
;
10783 kb
->Vlast_kbd_macro
= Qnil
;
10784 kb
->reference_count
= 0;
10785 kb
->Vsystem_key_alist
= Qnil
;
10786 kb
->system_key_syms
= Qnil
;
10787 kb
->Vdefault_minibuffer_frame
= Qnil
;
10791 * Destroy the contents of a kboard object, but not the object itself.
10792 * We use this just before deleting it, or if we're going to initialize
10793 * it a second time.
10799 if (kb
->kbd_macro_buffer
)
10800 xfree (kb
->kbd_macro_buffer
);
10803 #ifdef MULTI_KBOARD
10805 /* Free KB and memory referenced from it. */
10813 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10816 *kbp
= kb
->next_kboard
;
10818 /* Prevent a dangling reference to KB. */
10819 if (kb
== current_kboard
10820 && FRAMEP (selected_frame
)
10821 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10823 current_kboard
= XFRAME (selected_frame
)->kboard
;
10824 if (current_kboard
== kb
)
10832 #endif /* MULTI_KBOARD */
10837 /* This is correct before outermost invocation of the editor loop */
10838 command_loop_level
= -1;
10839 immediate_quit
= 0;
10840 quit_char
= Ctl ('g');
10841 Vunread_command_events
= Qnil
;
10842 unread_command_char
= -1;
10843 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10845 recent_keys_index
= 0;
10846 kbd_fetch_ptr
= kbd_buffer
;
10847 kbd_store_ptr
= kbd_buffer
;
10849 do_mouse_tracking
= Qnil
;
10853 /* This means that command_loop_1 won't try to select anything the first
10855 internal_last_event_frame
= Qnil
;
10856 Vlast_event_frame
= internal_last_event_frame
;
10858 #ifdef MULTI_KBOARD
10859 current_kboard
= initial_kboard
;
10861 wipe_kboard (current_kboard
);
10862 init_kboard (current_kboard
);
10864 if (!noninteractive
)
10866 /* Before multi-tty support, these handlers used to be installed
10867 only if the current session was a tty session. Now an Emacs
10868 session may have multiple display types, so we always handle
10869 SIGINT. There is special code in interrupt_signal to exit
10870 Emacs on SIGINT when there are no termcap frames on the
10871 controlling terminal. */
10872 signal (SIGINT
, interrupt_signal
);
10873 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10874 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10875 SIGQUIT and we can't tell which one it will give us. */
10876 signal (SIGQUIT
, interrupt_signal
);
10877 #endif /* HAVE_TERMIO */
10879 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10881 if (!noninteractive
)
10882 signal (SIGIO
, input_available_signal
);
10885 /* Use interrupt input by default, if it works and noninterrupt input
10886 has deficiencies. */
10888 #ifdef INTERRUPT_INPUT
10889 interrupt_input
= 1;
10891 interrupt_input
= 0;
10894 /* Our VMS input only works by interrupts, as of now. */
10896 interrupt_input
= 1;
10902 if (keyboard_init_hook
)
10903 (*keyboard_init_hook
) ();
10905 #ifdef POLL_FOR_INPUT
10906 poll_suppress_count
= 1;
10911 /* At least provide an escape route since C-g doesn't work. */
10912 signal (SIGINT
, interrupt_signal
);
10916 /* This type's only use is in syms_of_keyboard, to initialize the
10917 event header symbols and put properties on them. */
10918 struct event_head
{
10924 struct event_head head_table
[] = {
10925 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10926 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10927 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10928 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10929 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10930 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10931 /* `select-window' should be handled just like `switch-frame'
10932 in read_key_sequence. */
10933 {&Qselect_window
, "select-window", &Qswitch_frame
}
10937 syms_of_keyboard ()
10939 Vpre_help_message
= Qnil
;
10940 staticpro (&Vpre_help_message
);
10942 Vlispy_mouse_stem
= build_string ("mouse");
10943 staticpro (&Vlispy_mouse_stem
);
10946 QCimage
= intern (":image");
10947 staticpro (&QCimage
);
10949 staticpro (&Qhelp_echo
);
10950 Qhelp_echo
= intern ("help-echo");
10952 staticpro (&item_properties
);
10953 item_properties
= Qnil
;
10955 staticpro (&tool_bar_item_properties
);
10956 tool_bar_item_properties
= Qnil
;
10957 staticpro (&tool_bar_items_vector
);
10958 tool_bar_items_vector
= Qnil
;
10960 staticpro (&real_this_command
);
10961 real_this_command
= Qnil
;
10963 Qtimer_event_handler
= intern ("timer-event-handler");
10964 staticpro (&Qtimer_event_handler
);
10966 Qdisabled_command_function
= intern ("disabled-command-function");
10967 staticpro (&Qdisabled_command_function
);
10969 Qself_insert_command
= intern ("self-insert-command");
10970 staticpro (&Qself_insert_command
);
10972 Qforward_char
= intern ("forward-char");
10973 staticpro (&Qforward_char
);
10975 Qbackward_char
= intern ("backward-char");
10976 staticpro (&Qbackward_char
);
10978 Qdisabled
= intern ("disabled");
10979 staticpro (&Qdisabled
);
10981 Qundefined
= intern ("undefined");
10982 staticpro (&Qundefined
);
10984 Qpre_command_hook
= intern ("pre-command-hook");
10985 staticpro (&Qpre_command_hook
);
10987 Qpost_command_hook
= intern ("post-command-hook");
10988 staticpro (&Qpost_command_hook
);
10990 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10991 staticpro (&Qpost_command_idle_hook
);
10993 Qdeferred_action_function
= intern ("deferred-action-function");
10994 staticpro (&Qdeferred_action_function
);
10996 Qcommand_hook_internal
= intern ("command-hook-internal");
10997 staticpro (&Qcommand_hook_internal
);
10999 Qfunction_key
= intern ("function-key");
11000 staticpro (&Qfunction_key
);
11001 Qmouse_click
= intern ("mouse-click");
11002 staticpro (&Qmouse_click
);
11003 #if defined (WINDOWSNT) || defined (MAC_OS)
11004 Qlanguage_change
= intern ("language-change");
11005 staticpro (&Qlanguage_change
);
11007 Qdrag_n_drop
= intern ("drag-n-drop");
11008 staticpro (&Qdrag_n_drop
);
11010 Qsave_session
= intern ("save-session");
11011 staticpro(&Qsave_session
);
11013 Qusr1_signal
= intern ("usr1-signal");
11014 staticpro (&Qusr1_signal
);
11015 Qusr2_signal
= intern ("usr2-signal");
11016 staticpro (&Qusr2_signal
);
11018 Qmenu_enable
= intern ("menu-enable");
11019 staticpro (&Qmenu_enable
);
11020 Qmenu_alias
= intern ("menu-alias");
11021 staticpro (&Qmenu_alias
);
11022 QCenable
= intern (":enable");
11023 staticpro (&QCenable
);
11024 QCvisible
= intern (":visible");
11025 staticpro (&QCvisible
);
11026 QChelp
= intern (":help");
11027 staticpro (&QChelp
);
11028 QCfilter
= intern (":filter");
11029 staticpro (&QCfilter
);
11030 QCbutton
= intern (":button");
11031 staticpro (&QCbutton
);
11032 QCkeys
= intern (":keys");
11033 staticpro (&QCkeys
);
11034 QCkey_sequence
= intern (":key-sequence");
11035 staticpro (&QCkey_sequence
);
11036 QCtoggle
= intern (":toggle");
11037 staticpro (&QCtoggle
);
11038 QCradio
= intern (":radio");
11039 staticpro (&QCradio
);
11041 Qmode_line
= intern ("mode-line");
11042 staticpro (&Qmode_line
);
11043 Qvertical_line
= intern ("vertical-line");
11044 staticpro (&Qvertical_line
);
11045 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11046 staticpro (&Qvertical_scroll_bar
);
11047 Qmenu_bar
= intern ("menu-bar");
11048 staticpro (&Qmenu_bar
);
11051 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11052 staticpro (&Qmouse_fixup_help_message
);
11055 Qabove_handle
= intern ("above-handle");
11056 staticpro (&Qabove_handle
);
11057 Qhandle
= intern ("handle");
11058 staticpro (&Qhandle
);
11059 Qbelow_handle
= intern ("below-handle");
11060 staticpro (&Qbelow_handle
);
11061 Qup
= intern ("up");
11063 Qdown
= intern ("down");
11064 staticpro (&Qdown
);
11065 Qtop
= intern ("top");
11067 Qbottom
= intern ("bottom");
11068 staticpro (&Qbottom
);
11069 Qend_scroll
= intern ("end-scroll");
11070 staticpro (&Qend_scroll
);
11071 Qratio
= intern ("ratio");
11072 staticpro (&Qratio
);
11074 Qevent_kind
= intern ("event-kind");
11075 staticpro (&Qevent_kind
);
11076 Qevent_symbol_elements
= intern ("event-symbol-elements");
11077 staticpro (&Qevent_symbol_elements
);
11078 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11079 staticpro (&Qevent_symbol_element_mask
);
11080 Qmodifier_cache
= intern ("modifier-cache");
11081 staticpro (&Qmodifier_cache
);
11083 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11084 staticpro (&Qrecompute_lucid_menubar
);
11085 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11086 staticpro (&Qactivate_menubar_hook
);
11088 Qpolling_period
= intern ("polling-period");
11089 staticpro (&Qpolling_period
);
11091 Qinput_method_function
= intern ("input-method-function");
11092 staticpro (&Qinput_method_function
);
11094 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11095 staticpro (&Qinput_method_exit_on_first_char
);
11096 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11097 staticpro (&Qinput_method_use_echo_area
);
11099 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11100 Fset (Qinput_method_use_echo_area
, Qnil
);
11102 last_point_position_buffer
= Qnil
;
11105 struct event_head
*p
;
11107 for (p
= head_table
;
11108 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11111 *p
->var
= intern (p
->name
);
11112 staticpro (p
->var
);
11113 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11114 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11118 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11119 staticpro (&button_down_location
);
11120 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11121 staticpro (&mouse_syms
);
11122 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11123 staticpro (&wheel_syms
);
11127 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11129 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11130 for (i
= 0; i
< len
; i
++)
11131 if (modifier_names
[i
])
11132 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11133 staticpro (&modifier_symbols
);
11136 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11137 staticpro (&recent_keys
);
11139 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11140 staticpro (&this_command_keys
);
11142 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11143 staticpro (&raw_keybuf
);
11145 Qextended_command_history
= intern ("extended-command-history");
11146 Fset (Qextended_command_history
, Qnil
);
11147 staticpro (&Qextended_command_history
);
11149 accent_key_syms
= Qnil
;
11150 staticpro (&accent_key_syms
);
11152 func_key_syms
= Qnil
;
11153 staticpro (&func_key_syms
);
11155 drag_n_drop_syms
= Qnil
;
11156 staticpro (&drag_n_drop_syms
);
11158 unread_switch_frame
= Qnil
;
11159 staticpro (&unread_switch_frame
);
11161 internal_last_event_frame
= Qnil
;
11162 staticpro (&internal_last_event_frame
);
11164 read_key_sequence_cmd
= Qnil
;
11165 staticpro (&read_key_sequence_cmd
);
11167 menu_bar_one_keymap_changed_items
= Qnil
;
11168 staticpro (&menu_bar_one_keymap_changed_items
);
11170 defsubr (&Sevent_convert_list
);
11171 defsubr (&Sread_key_sequence
);
11172 defsubr (&Sread_key_sequence_vector
);
11173 defsubr (&Srecursive_edit
);
11175 defsubr (&Strack_mouse
);
11177 defsubr (&Sinput_pending_p
);
11178 defsubr (&Scommand_execute
);
11179 defsubr (&Srecent_keys
);
11180 defsubr (&Sthis_command_keys
);
11181 defsubr (&Sthis_command_keys_vector
);
11182 defsubr (&Sthis_single_command_keys
);
11183 defsubr (&Sthis_single_command_raw_keys
);
11184 defsubr (&Sreset_this_command_lengths
);
11185 defsubr (&Sclear_this_command_keys
);
11186 defsubr (&Ssuspend_emacs
);
11187 defsubr (&Sabort_recursive_edit
);
11188 defsubr (&Sexit_recursive_edit
);
11189 defsubr (&Srecursion_depth
);
11190 defsubr (&Stop_level
);
11191 defsubr (&Sdiscard_input
);
11192 defsubr (&Sopen_dribble_file
);
11193 defsubr (&Sset_input_mode
);
11194 defsubr (&Scurrent_input_mode
);
11195 defsubr (&Sexecute_extended_command
);
11196 defsubr (&Sposn_at_point
);
11197 defsubr (&Sposn_at_x_y
);
11199 DEFVAR_LISP ("last-command-char", &last_command_char
,
11200 doc
: /* Last input event that was part of a command. */);
11202 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11203 doc
: /* Last input event that was part of a command. */);
11205 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11206 doc
: /* Last input event in a command, except for mouse menu events.
11207 Mouse menus give back keys that don't look like mouse events;
11208 this variable holds the actual mouse event that led to the menu,
11209 so that you can determine whether the command was run by mouse or not. */);
11211 DEFVAR_LISP ("last-input-char", &last_input_char
,
11212 doc
: /* Last input event. */);
11214 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11215 doc
: /* Last input event. */);
11217 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11218 doc
: /* List of events to be read as the command input.
11219 These events are processed first, before actual keyboard input. */);
11220 Vunread_command_events
= Qnil
;
11222 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11223 doc
: /* If not -1, an object to be read as next command input event. */);
11225 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11226 doc
: /* List of events to be processed as input by input methods.
11227 These events are processed after `unread-command-events', but
11228 before actual keyboard input. */);
11229 Vunread_post_input_method_events
= Qnil
;
11231 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11232 doc
: /* List of events to be processed as input by input methods.
11233 These events are processed after `unread-command-events', but
11234 before actual keyboard input. */);
11235 Vunread_input_method_events
= Qnil
;
11237 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11238 doc
: /* Meta-prefix character code.
11239 Meta-foo as command input turns into this character followed by foo. */);
11240 XSETINT (meta_prefix_char
, 033);
11242 DEFVAR_KBOARD ("last-command", Vlast_command
,
11243 doc
: /* The last command executed.
11244 Normally a symbol with a function definition, but can be whatever was found
11245 in the keymap, or whatever the variable `this-command' was set to by that
11248 The value `mode-exit' is special; it means that the previous command
11249 read an event that told it to exit, and it did so and unread that event.
11250 In other words, the present command is the event that made the previous
11253 The value `kill-region' is special; it means that the previous command
11254 was a kill command. */);
11256 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11257 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11259 DEFVAR_LISP ("this-command", &Vthis_command
,
11260 doc
: /* The command now being executed.
11261 The command can set this variable; whatever is put here
11262 will be in `last-command' during the following command. */);
11263 Vthis_command
= Qnil
;
11265 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11266 doc
: /* The command bound to the current key sequence before remapping.
11267 It equals `this-command' if the original command was not remapped through
11268 any of the active keymaps. Otherwise, the value of `this-command' is the
11269 result of looking up the original command in the active keymaps. */);
11270 Vthis_original_command
= Qnil
;
11272 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11273 doc
: /* *Number of input events between auto-saves.
11274 Zero means disable autosaving due to number of characters typed. */);
11275 auto_save_interval
= 300;
11277 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11278 doc
: /* *Number of seconds idle time before auto-save.
11279 Zero or nil means disable auto-saving due to idleness.
11280 After auto-saving due to this many seconds of idle time,
11281 Emacs also does a garbage collection if that seems to be warranted. */);
11282 XSETFASTINT (Vauto_save_timeout
, 30);
11284 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11285 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11286 The value may be integer or floating point. */);
11287 Vecho_keystrokes
= make_number (1);
11289 DEFVAR_INT ("polling-period", &polling_period
,
11290 doc
: /* *Interval between polling for input during Lisp execution.
11291 The reason for polling is to make C-g work to stop a running program.
11292 Polling is needed only when using X windows and SIGIO does not work.
11293 Polling is automatically disabled in all other cases. */);
11294 polling_period
= 2;
11296 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11297 doc
: /* *Maximum time between mouse clicks to make a double-click.
11298 Measured in milliseconds. nil means disable double-click recognition;
11299 t means double-clicks have no time limit and are detected
11300 by position only. */);
11301 Vdouble_click_time
= make_number (500);
11303 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11304 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11305 On window-system frames, value is the number of pixels the mouse may have
11306 moved horizontally or vertically between two clicks to make a double-click.
11307 On non window-system frames, value is interpreted in units of 1/8 characters
11310 This variable is also the threshold for motion of the mouse
11311 to count as a drag. */);
11312 double_click_fuzz
= 3;
11314 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11315 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11316 inhibit_local_menu_bar_menus
= 0;
11318 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11319 doc
: /* Number of complete key sequences read as input so far.
11320 This includes key sequences read from keyboard macros.
11321 The number is effectively the number of interactive command invocations. */);
11322 num_input_keys
= 0;
11324 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11325 doc
: /* Number of input events read from the keyboard so far.
11326 This does not include events generated by keyboard macros. */);
11327 num_nonmacro_input_events
= 0;
11329 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11330 doc
: /* The frame in which the most recently read event occurred.
11331 If the last event came from a keyboard macro, this is set to `macro'. */);
11332 Vlast_event_frame
= Qnil
;
11334 /* This variable is set up in sysdep.c. */
11335 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11336 doc
: /* The ERASE character as set by the user with stty. */);
11338 DEFVAR_LISP ("help-char", &Vhelp_char
,
11339 doc
: /* Character to recognize as meaning Help.
11340 When it is read, do `(eval help-form)', and display result if it's a string.
11341 If the value of `help-form' is nil, this char can be read normally. */);
11342 XSETINT (Vhelp_char
, Ctl ('H'));
11344 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11345 doc
: /* List of input events to recognize as meaning Help.
11346 These work just like the value of `help-char' (see that). */);
11347 Vhelp_event_list
= Qnil
;
11349 DEFVAR_LISP ("help-form", &Vhelp_form
,
11350 doc
: /* Form to execute when character `help-char' is read.
11351 If the form returns a string, that string is displayed.
11352 If `help-form' is nil, the help char is not recognized. */);
11355 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11356 doc
: /* Command to run when `help-char' character follows a prefix key.
11357 This command is used only when there is no actual binding
11358 for that character after that prefix key. */);
11359 Vprefix_help_command
= Qnil
;
11361 DEFVAR_LISP ("top-level", &Vtop_level
,
11362 doc
: /* Form to evaluate when Emacs starts up.
11363 Useful to set before you dump a modified Emacs. */);
11366 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11367 doc
: /* Translate table for keyboard input, or nil.
11368 If non-nil, the value should be a char-table. Each character read
11369 from the keyboard is looked up in this char-table. If the value found
11370 there is non-nil, then it is used instead of the actual input character.
11372 The value can also be a string or vector, but this is considered obsolete.
11373 If it is a string or vector of length N, character codes N and up are left
11374 untranslated. In a vector, an element which is nil means "no translation".
11376 This is applied to the characters supplied to input methods, not their
11377 output. See also `translation-table-for-input'. */);
11378 Vkeyboard_translate_table
= Qnil
;
11380 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11381 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11382 \(Even if the operating system has support for stopping a process.\) */);
11383 cannot_suspend
= 0;
11385 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11386 doc
: /* Non-nil means prompt with menus when appropriate.
11387 This is done when reading from a keymap that has a prompt string,
11388 for elements that have prompt strings.
11389 The menu is displayed on the screen
11390 if X menus were enabled at configuration
11391 time and the previous event was a mouse click prefix key.
11392 Otherwise, menu prompting uses the echo area. */);
11393 menu_prompting
= 1;
11395 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11396 doc
: /* Character to see next line of menu prompt.
11397 Type this character while in a menu prompt to rotate around the lines of it. */);
11398 XSETINT (menu_prompt_more_char
, ' ');
11400 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11401 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11402 Emacs applies the modifiers of the character stored here to each keyboard
11403 character it reads. For example, after evaluating the expression
11404 (setq extra-keyboard-modifiers ?\\C-x)
11405 all input characters will have the control modifier applied to them.
11407 Note that the character ?\\C-@, equivalent to the integer zero, does
11408 not count as a control character; rather, it counts as a character
11409 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11410 cancels any modification. */);
11411 extra_keyboard_modifiers
= 0;
11413 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11414 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11415 The command loop sets this to nil before each command,
11416 and tests the value when the command returns.
11417 Buffer modification stores t in this variable. */);
11418 Vdeactivate_mark
= Qnil
;
11420 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11421 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11422 Vcommand_hook_internal
= Qnil
;
11424 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11425 doc
: /* Normal hook run before each command is executed.
11426 If an unhandled error happens in running this hook,
11427 the hook value is set to nil, since otherwise the error
11428 might happen repeatedly and make Emacs nonfunctional. */);
11429 Vpre_command_hook
= Qnil
;
11431 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11432 doc
: /* Normal hook run after each command is executed.
11433 If an unhandled error happens in running this hook,
11434 the hook value is set to nil, since otherwise the error
11435 might happen repeatedly and make Emacs nonfunctional. */);
11436 Vpost_command_hook
= Qnil
;
11438 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11439 doc
: /* Normal hook run after each command is executed, if idle.
11440 Errors running the hook are caught and ignored. */);
11441 Vpost_command_idle_hook
= Qnil
;
11443 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11444 doc
: /* Delay time before running `post-command-idle-hook'.
11445 This is measured in microseconds. */);
11446 post_command_idle_delay
= 100000;
11449 DEFVAR_LISP ("echo-area-clear-hook", ...,
11450 doc
: /* Normal hook run when clearing the echo area. */);
11452 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11453 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11455 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11456 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11457 Vlucid_menu_bar_dirty_flag
= Qnil
;
11459 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11460 doc
: /* List of menu bar items to move to the end of the menu bar.
11461 The elements of the list are event types that may have menu bar bindings. */);
11462 Vmenu_bar_final_items
= Qnil
;
11464 DEFVAR_KBOARD ("overriding-terminal-local-map",
11465 Voverriding_terminal_local_map
,
11466 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11467 If this variable is non-nil, it is used as a keymap instead of the
11468 buffer's local map, and the minor mode keymaps and text property keymaps.
11469 It also replaces `overriding-local-map'.
11471 This variable is intended to let commands such as `universal-argument'
11472 set up a different keymap for reading the next command. */);
11474 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11475 doc
: /* Keymap that overrides all other local keymaps.
11476 If this variable is non-nil, it is used as a keymap--replacing the
11477 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11478 Voverriding_local_map
= Qnil
;
11480 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11481 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11482 Otherwise, the menu bar continues to reflect the buffer's local map
11483 and the minor mode maps regardless of `overriding-local-map'. */);
11484 Voverriding_local_map_menu_flag
= Qnil
;
11486 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11487 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11488 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11490 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11491 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11493 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11494 doc
: /* Alist of system-specific X windows key symbols.
11495 Each element should have the form (N . SYMBOL) where N is the
11496 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11497 and SYMBOL is its name. */);
11499 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11500 doc
: /* List of deferred actions to be performed at a later time.
11501 The precise format isn't relevant here; we just check whether it is nil. */);
11502 Vdeferred_action_list
= Qnil
;
11504 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11505 doc
: /* Function to call to handle deferred actions, after each command.
11506 This function is called with no arguments after each command
11507 whenever `deferred-action-list' is non-nil. */);
11508 Vdeferred_action_function
= Qnil
;
11510 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11511 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11512 The value can be a length of time to show the message for.
11513 If the value is non-nil and not a number, we wait 2 seconds. */);
11514 Vsuggest_key_bindings
= Qt
;
11516 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11517 doc
: /* List of active absolute time timers in order of increasing time. */);
11518 Vtimer_list
= Qnil
;
11520 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11521 doc
: /* List of active idle-time timers in order of increasing time. */);
11522 Vtimer_idle_list
= Qnil
;
11524 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11525 doc
: /* If non-nil, the function that implements the current input method.
11526 It's called with one argument, a printing character that was just read.
11527 \(That means a character with code 040...0176.)
11528 Typically this function uses `read-event' to read additional events.
11529 When it does so, it should first bind `input-method-function' to nil
11530 so it will not be called recursively.
11532 The function should return a list of zero or more events
11533 to be used as input. If it wants to put back some events
11534 to be reconsidered, separately, by the input method,
11535 it can add them to the beginning of `unread-command-events'.
11537 The input method function can find in `input-method-previous-method'
11538 the previous echo area message.
11540 The input method function should refer to the variables
11541 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11542 for guidance on what to do. */);
11543 Vinput_method_function
= Qnil
;
11545 DEFVAR_LISP ("input-method-previous-message",
11546 &Vinput_method_previous_message
,
11547 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11548 This variable exists because `read-event' clears the echo area
11549 before running the input method. It is nil if there was no message. */);
11550 Vinput_method_previous_message
= Qnil
;
11552 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11553 doc
: /* If non-nil, the function that implements the display of help.
11554 It's called with one argument, the help string to display. */);
11555 Vshow_help_function
= Qnil
;
11557 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11558 doc
: /* If non-nil, suppress point adjustment after executing a command.
11560 After a command is executed, if point is moved into a region that has
11561 special properties (e.g. composition, display), we adjust point to
11562 the boundary of the region. But, when a command sets this variable to
11563 non-nil, we suppress the point adjustment.
11565 This variable is set to nil before reading a command, and is checked
11566 just after executing the command. */);
11567 Vdisable_point_adjustment
= Qnil
;
11569 DEFVAR_LISP ("global-disable-point-adjustment",
11570 &Vglobal_disable_point_adjustment
,
11571 doc
: /* *If non-nil, always suppress point adjustment.
11573 The default value is nil, in which case, point adjustment are
11574 suppressed only after special commands that set
11575 `disable-point-adjustment' (which see) to non-nil. */);
11576 Vglobal_disable_point_adjustment
= Qnil
;
11578 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11579 doc
: /* Non-nil means updating menu bindings is allowed.
11580 A value of nil means menu bindings should not be updated.
11581 Used during Emacs' startup. */);
11582 update_menu_bindings
= 1;
11584 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11585 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11586 If the value is not a number, such messages don't time out. */);
11587 Vminibuffer_message_timeout
= make_number (2);
11589 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11590 doc
: /* If non-nil, any keyboard input throws to this symbol.
11591 The value of that variable is passed to `quit-flag' and later causes a
11592 peculiar kind of quitting. */);
11593 Vthrow_on_input
= Qnil
;
11597 keys_of_keyboard ()
11599 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11600 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11601 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11602 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11603 initial_define_key (meta_map
, 'x', "execute-extended-command");
11605 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11606 "handle-delete-frame");
11607 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11608 current-prefix-arg, as is done in `handle-switch-frame'.
11609 But `handle-switch-frame is not run from the special-map.
11610 Commands from that map are run in a special way that automatically
11611 preserves the prefix-arg. Restoring the prefix arg here is not just
11612 redundant but harmful:
11614 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11615 - after the first prompt, the exit-minibuffer-hook is run which may
11616 iconify a frame and thus push a `iconify-frame' event.
11617 - after running exit-minibuffer-hook, current-prefix-arg is
11618 restored to the non-nil value it had before the prompt.
11619 - we enter the second prompt.
11620 current-prefix-arg is non-nil, prefix-arg is nil.
11621 - before running the first real event, we run the special iconify-frame
11622 event, but we pass the `special' arg to execute-command so
11623 current-prefix-arg and prefix-arg are left untouched.
11624 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11625 - the next key event will have a spuriously non-nil current-prefix-arg. */
11626 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11628 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11630 /* Handling it at such a low-level causes read_key_sequence to get
11631 * confused because it doesn't realize that the current_buffer was
11632 * changed by read_char.
11634 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11635 * "handle-select-window"); */
11636 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11637 "handle-save-session");
11640 /* Mark the pointers in the kboard objects.
11641 Called by the Fgarbage_collector. */
11647 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11649 if (kb
->kbd_macro_buffer
)
11650 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11652 mark_object (kb
->Voverriding_terminal_local_map
);
11653 mark_object (kb
->Vlast_command
);
11654 mark_object (kb
->Vreal_last_command
);
11655 mark_object (kb
->Vprefix_arg
);
11656 mark_object (kb
->Vlast_prefix_arg
);
11657 mark_object (kb
->kbd_queue
);
11658 mark_object (kb
->defining_kbd_macro
);
11659 mark_object (kb
->Vlast_kbd_macro
);
11660 mark_object (kb
->Vsystem_key_alist
);
11661 mark_object (kb
->system_key_syms
);
11662 mark_object (kb
->Vdefault_minibuffer_frame
);
11663 mark_object (kb
->echo_string
);
11666 struct input_event
*event
;
11667 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11669 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11670 event
= kbd_buffer
;
11671 if (event
->kind
!= SELECTION_REQUEST_EVENT
11672 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11674 mark_object (event
->x
);
11675 mark_object (event
->y
);
11677 mark_object (event
->frame_or_window
);
11678 mark_object (event
->arg
);
11683 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11684 (do not change this comment) */