1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
63 #include <sys/types.h>
72 /* This is to get the definitions of the XK_ symbols. */
79 #endif /* HAVE_NTGUI */
89 /* Variables for blockinput.h: */
91 /* Non-zero if interrupt input is blocked right now. */
92 int interrupt_input_blocked
;
94 /* Nonzero means an input interrupt has arrived
95 during the current critical section. */
96 int interrupt_input_pending
;
99 #ifdef HAVE_WINDOW_SYSTEM
100 /* Make all keyboard buffers much bigger when using X windows. */
102 /* But not too big (local data > 32K error) if on Mac OS Classic. */
103 #define KBD_BUFFER_SIZE 512
105 #define KBD_BUFFER_SIZE 4096
107 #else /* No X-windows, character input */
108 #define KBD_BUFFER_SIZE 4096
109 #endif /* No X-windows */
111 #define abs(x) ((x) >= 0 ? (x) : -(x))
113 /* Following definition copied from eval.c */
117 struct backtrace
*next
;
118 Lisp_Object
*function
;
119 Lisp_Object
*args
; /* Points to vector of args. */
120 int nargs
; /* length of vector. If nargs is UNEVALLED,
121 args points to slot holding list of
124 /* Nonzero means call value of debugger when done with this operation. */
129 KBOARD
*initial_kboard
;
130 KBOARD
*current_kboard
;
134 KBOARD the_only_kboard
;
137 /* Non-nil disable property on a command means
138 do not execute it; call disabled-command-function's value instead. */
139 Lisp_Object Qdisabled
, Qdisabled_command_function
;
141 #define NUM_RECENT_KEYS (100)
142 int recent_keys_index
; /* Index for storing next element into recent_keys */
143 int total_keys
; /* Total number of elements stored into recent_keys */
144 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
146 /* Vector holding the key sequence that invoked the current command.
147 It is reused for each command, and it may be longer than the current
148 sequence; this_command_key_count indicates how many elements
149 actually mean something.
150 It's easier to staticpro a single Lisp_Object than an array. */
151 Lisp_Object this_command_keys
;
152 int this_command_key_count
;
154 /* 1 after calling Freset_this_command_lengths.
156 int this_command_key_count_reset
;
158 /* This vector is used as a buffer to record the events that were actually read
159 by read_key_sequence. */
160 Lisp_Object raw_keybuf
;
161 int raw_keybuf_count
;
163 #define GROW_RAW_KEYBUF \
164 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
166 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
168 new = Fmake_vector (make_number (newsize), Qnil); \
169 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
170 raw_keybuf_count * sizeof (Lisp_Object)); \
174 /* Number of elements of this_command_keys
175 that precede this key sequence. */
176 int this_single_command_key_start
;
178 /* Record values of this_command_key_count and echo_length ()
179 before this command was read. */
180 static int before_command_key_count
;
181 static int before_command_echo_length
;
183 extern int minbuf_level
;
185 extern int message_enable_multibyte
;
187 extern struct backtrace
*backtrace_list
;
189 /* If non-nil, the function that implements the display of help.
190 It's called with one argument, the help string to display. */
192 Lisp_Object Vshow_help_function
;
194 /* If a string, the message displayed before displaying a help-echo
197 Lisp_Object Vpre_help_message
;
199 /* Nonzero means do menu prompting. */
201 static int menu_prompting
;
203 /* Character to see next line of menu prompt. */
205 static Lisp_Object menu_prompt_more_char
;
207 /* For longjmp to where kbd input is being done. */
209 static jmp_buf getcjmp
;
211 /* True while doing kbd input. */
212 int waiting_for_input
;
214 /* True while displaying for echoing. Delays C-g throwing. */
218 /* Non-null means we can start echoing at the next input pause even
219 though there is something in the echo area. */
221 static struct kboard
*ok_to_echo_at_next_pause
;
223 /* The kboard last echoing, or null for none. Reset to 0 in
224 cancel_echoing. If non-null, and a current echo area message
225 exists, and echo_message_buffer is eq to the current message
226 buffer, we know that the message comes from echo_kboard. */
228 struct kboard
*echo_kboard
;
230 /* The buffer used for echoing. Set in echo_now, reset in
233 Lisp_Object echo_message_buffer
;
235 /* Nonzero means disregard local maps for the menu bar. */
236 static int inhibit_local_menu_bar_menus
;
238 /* Nonzero means C-g should cause immediate error-signal. */
241 /* The user's hook function for outputting an error message. */
242 Lisp_Object Vcommand_error_function
;
244 /* The user's ERASE setting. */
245 Lisp_Object Vtty_erase_char
;
247 /* Character to recognize as the help char. */
248 Lisp_Object Vhelp_char
;
250 /* List of other event types to recognize as meaning "help". */
251 Lisp_Object Vhelp_event_list
;
253 /* Form to execute when help char is typed. */
254 Lisp_Object Vhelp_form
;
256 /* Command to run when the help character follows a prefix key. */
257 Lisp_Object Vprefix_help_command
;
259 /* List of items that should move to the end of the menu bar. */
260 Lisp_Object Vmenu_bar_final_items
;
262 /* Non-nil means show the equivalent key-binding for
263 any M-x command that has one.
264 The value can be a length of time to show the message for.
265 If the value is non-nil and not a number, we wait 2 seconds. */
266 Lisp_Object Vsuggest_key_bindings
;
268 /* How long to display an echo-area message when the minibuffer is active.
269 If the value is not a number, such messages don't time out. */
270 Lisp_Object Vminibuffer_message_timeout
;
272 /* Character that causes a quit. Normally C-g.
274 If we are running on an ordinary terminal, this must be an ordinary
275 ASCII char, since we want to make it our interrupt character.
277 If we are not running on an ordinary terminal, it still needs to be
278 an ordinary ASCII char. This character needs to be recognized in
279 the input interrupt handler. At this point, the keystroke is
280 represented as a struct input_event, while the desired quit
281 character is specified as a lispy event. The mapping from struct
282 input_events to lispy events cannot run in an interrupt handler,
283 and the reverse mapping is difficult for anything but ASCII
286 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
290 extern Lisp_Object current_global_map
;
291 extern int minibuf_level
;
293 /* If non-nil, this is a map that overrides all other local maps. */
294 Lisp_Object Voverriding_local_map
;
296 /* If non-nil, Voverriding_local_map applies to the menu bar. */
297 Lisp_Object Voverriding_local_map_menu_flag
;
299 /* Keymap that defines special misc events that should
300 be processed immediately at a low level. */
301 Lisp_Object Vspecial_event_map
;
303 /* Current depth in recursive edits. */
304 int command_loop_level
;
306 /* Total number of times command_loop has read a key sequence. */
307 EMACS_INT num_input_keys
;
309 /* Last input character read as a command. */
310 Lisp_Object last_command_char
;
312 /* Last input character read as a command, not counting menus
313 reached by the mouse. */
314 Lisp_Object last_nonmenu_event
;
316 /* Last input character read for any purpose. */
317 Lisp_Object last_input_char
;
319 /* If not Qnil, a list of objects to be read as subsequent command input. */
320 Lisp_Object Vunread_command_events
;
322 /* If not Qnil, a list of objects to be read as subsequent command input
323 including input method processing. */
324 Lisp_Object Vunread_input_method_events
;
326 /* If not Qnil, a list of objects to be read as subsequent command input
327 but NOT including input method processing. */
328 Lisp_Object Vunread_post_input_method_events
;
330 /* If not -1, an event to be read as subsequent command input. */
331 EMACS_INT unread_command_char
;
333 /* If not Qnil, this is a switch-frame event which we decided to put
334 off until the end of a key sequence. This should be read as the
335 next command input, after any unread_command_events.
337 read_key_sequence uses this to delay switch-frame events until the
338 end of the key sequence; Fread_char uses it to put off switch-frame
339 events until a non-ASCII event is acceptable as input. */
340 Lisp_Object unread_switch_frame
;
342 /* A mask of extra modifier bits to put into every keyboard char. */
343 EMACS_INT extra_keyboard_modifiers
;
345 /* Char to use as prefix when a meta character is typed in.
346 This is bound on entry to minibuffer in case ESC is changed there. */
348 Lisp_Object meta_prefix_char
;
350 /* Last size recorded for a current buffer which is not a minibuffer. */
351 static int last_non_minibuf_size
;
353 /* Number of idle seconds before an auto-save and garbage collection. */
354 static Lisp_Object Vauto_save_timeout
;
356 /* Total number of times read_char has returned. */
357 int num_input_events
;
359 /* Total number of times read_char has returned, outside of macros. */
360 EMACS_INT num_nonmacro_input_events
;
362 /* Auto-save automatically when this many characters have been typed
363 since the last time. */
365 static EMACS_INT auto_save_interval
;
367 /* Value of num_nonmacro_input_events as of last auto save. */
371 /* The command being executed by the command loop.
372 Commands may set this, and the value set will be copied into
373 current_kboard->Vlast_command instead of the actual command. */
374 Lisp_Object Vthis_command
;
376 /* This is like Vthis_command, except that commands never set it. */
377 Lisp_Object real_this_command
;
379 /* If the lookup of the command returns a binding, the original
380 command is stored in this-original-command. It is nil otherwise. */
381 Lisp_Object Vthis_original_command
;
383 /* The value of point when the last command was started. */
384 int last_point_position
;
386 /* The buffer that was current when the last command was started. */
387 Lisp_Object last_point_position_buffer
;
389 /* The window that was selected when the last command was started. */
390 Lisp_Object last_point_position_window
;
392 /* The frame in which the last input event occurred, or Qmacro if the
393 last event came from a macro. We use this to determine when to
394 generate switch-frame events. This may be cleared by functions
395 like Fselect_frame, to make sure that a switch-frame event is
396 generated by the next character. */
397 Lisp_Object internal_last_event_frame
;
399 /* A user-visible version of the above, intended to allow users to
400 figure out where the last event came from, if the event doesn't
401 carry that information itself (i.e. if it was a character). */
402 Lisp_Object Vlast_event_frame
;
404 /* The timestamp of the last input event we received from the X server.
405 X Windows wants this for selection ownership. */
406 unsigned long last_event_timestamp
;
408 Lisp_Object Qself_insert_command
;
409 Lisp_Object Qforward_char
;
410 Lisp_Object Qbackward_char
;
411 Lisp_Object Qundefined
;
412 Lisp_Object Qtimer_event_handler
;
414 /* read_key_sequence stores here the command definition of the
415 key sequence that it reads. */
416 Lisp_Object read_key_sequence_cmd
;
418 /* Echo unfinished commands after this many seconds of pause. */
419 Lisp_Object Vecho_keystrokes
;
421 /* Form to evaluate (if non-nil) when Emacs is started. */
422 Lisp_Object Vtop_level
;
424 /* If non-nil, this implements the current input method. */
425 Lisp_Object Vinput_method_function
;
426 Lisp_Object Qinput_method_function
;
428 /* When we call Vinput_method_function,
429 this holds the echo area message that was just erased. */
430 Lisp_Object Vinput_method_previous_message
;
432 /* Non-nil means deactivate the mark at end of this command. */
433 Lisp_Object Vdeactivate_mark
;
435 /* Menu bar specified in Lucid Emacs fashion. */
437 Lisp_Object Vlucid_menu_bar_dirty_flag
;
438 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
440 Lisp_Object Qecho_area_clear_hook
;
442 /* Hooks to run before and after each command. */
443 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
444 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
445 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
447 /* Parent keymap of terminal-local function-key-map instances. */
448 Lisp_Object Vfunction_key_map
;
450 /* Parent keymap of terminal-local key-translation-map instances. */
451 Lisp_Object Vkey_translation_map
;
453 /* List of deferred actions to be performed at a later time.
454 The precise format isn't relevant here; we just check whether it is nil. */
455 Lisp_Object Vdeferred_action_list
;
457 /* Function to call to handle deferred actions, when there are any. */
458 Lisp_Object Vdeferred_action_function
;
459 Lisp_Object Qdeferred_action_function
;
461 Lisp_Object Qinput_method_exit_on_first_char
;
462 Lisp_Object Qinput_method_use_echo_area
;
464 /* File in which we write all commands we read. */
467 /* Nonzero if input is available. */
470 extern char *pending_malloc_warning
;
472 /* Circular buffer for pre-read keyboard input. */
474 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
476 /* Pointer to next available character in kbd_buffer.
477 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
478 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
479 next available char is in kbd_buffer[0]. */
480 static struct input_event
*kbd_fetch_ptr
;
482 /* Pointer to next place to store character in kbd_buffer. This
483 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
484 character should go in kbd_buffer[0]. */
485 static struct input_event
* volatile kbd_store_ptr
;
487 /* The above pair of variables forms a "queue empty" flag. When we
488 enqueue a non-hook event, we increment kbd_store_ptr. When we
489 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
490 there is input available iff the two pointers are not equal.
492 Why not just have a flag set and cleared by the enqueuing and
493 dequeuing functions? Such a flag could be screwed up by interrupts
494 at inopportune times. */
496 /* If this flag is non-nil, we check mouse_moved to see when the
497 mouse moves, and motion events will appear in the input stream.
498 Otherwise, mouse motion is ignored. */
499 Lisp_Object do_mouse_tracking
;
501 /* Symbols to head events. */
502 Lisp_Object Qmouse_movement
;
503 Lisp_Object Qscroll_bar_movement
;
504 Lisp_Object Qswitch_frame
;
505 Lisp_Object Qdelete_frame
;
506 Lisp_Object Qiconify_frame
;
507 Lisp_Object Qmake_frame_visible
;
508 Lisp_Object Qselect_window
;
509 Lisp_Object Qhelp_echo
;
512 Lisp_Object Qmouse_fixup_help_message
;
515 /* Symbols to denote kinds of events. */
516 Lisp_Object Qfunction_key
;
517 Lisp_Object Qmouse_click
;
518 #if defined (WINDOWSNT) || defined (MAC_OS)
519 Lisp_Object Qlanguage_change
;
521 Lisp_Object Qdrag_n_drop
;
522 Lisp_Object Qsave_session
;
524 Lisp_Object Qmac_apple_event
;
527 /* Lisp_Object Qmouse_movement; - also an event header */
529 /* Properties of event headers. */
530 Lisp_Object Qevent_kind
;
531 Lisp_Object Qevent_symbol_elements
;
533 /* menu item parts */
534 Lisp_Object Qmenu_alias
;
535 Lisp_Object Qmenu_enable
;
536 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
537 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
538 extern Lisp_Object Vdefine_key_rebound_commands
;
539 extern Lisp_Object Qmenu_item
;
541 /* An event header symbol HEAD may have a property named
542 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
543 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
544 mask of modifiers applied to it. If present, this is used to help
545 speed up parse_modifiers. */
546 Lisp_Object Qevent_symbol_element_mask
;
548 /* An unmodified event header BASE may have a property named
549 Qmodifier_cache, which is an alist mapping modifier masks onto
550 modified versions of BASE. If present, this helps speed up
552 Lisp_Object Qmodifier_cache
;
554 /* Symbols to use for parts of windows. */
555 Lisp_Object Qmode_line
;
556 Lisp_Object Qvertical_line
;
557 Lisp_Object Qvertical_scroll_bar
;
558 Lisp_Object Qmenu_bar
;
559 extern Lisp_Object Qleft_margin
, Qright_margin
;
560 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
561 extern Lisp_Object QCmap
;
563 Lisp_Object
recursive_edit_unwind (), command_loop ();
564 Lisp_Object
Fthis_command_keys ();
565 Lisp_Object Qextended_command_history
;
566 EMACS_TIME
timer_check ();
568 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
570 extern char *x_get_keysym_name ();
572 static void record_menu_key ();
573 static int echo_length ();
575 Lisp_Object Qpolling_period
;
577 /* List of absolute timers. Appears in order of next scheduled event. */
578 Lisp_Object Vtimer_list
;
580 /* List of idle time timers. Appears in order of next scheduled event. */
581 Lisp_Object Vtimer_idle_list
;
583 /* Incremented whenever a timer is run. */
586 extern Lisp_Object Vprint_level
, Vprint_length
;
588 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
590 EMACS_TIME
*input_available_clear_time
;
592 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
593 Default is 1 if INTERRUPT_INPUT is defined. */
596 /* Nonzero while interrupts are temporarily deferred during redisplay. */
597 int interrupts_deferred
;
599 /* Allow m- file to inhibit use of FIONREAD. */
600 #ifdef BROKEN_FIONREAD
604 /* We are unable to use interrupts if FIONREAD is not available,
605 so flush SIGIO so we won't try. */
606 #if !defined (FIONREAD)
612 /* If we support a window system, turn on the code to poll periodically
613 to detect C-g. It isn't actually used when doing interrupt input. */
614 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
615 #define POLL_FOR_INPUT
618 /* After a command is executed, if point is moved into a region that
619 has specific properties (e.g. composition, display), we adjust
620 point to the boundary of the region. But, if a command sets this
621 variable to non-nil, we suppress this point adjustment. This
622 variable is set to nil before reading a command. */
624 Lisp_Object Vdisable_point_adjustment
;
626 /* If non-nil, always disable point adjustment. */
628 Lisp_Object Vglobal_disable_point_adjustment
;
630 /* The time when Emacs started being idle. */
632 static EMACS_TIME timer_idleness_start_time
;
634 /* After Emacs stops being idle, this saves the last value
635 of timer_idleness_start_time from when it was idle. */
637 static EMACS_TIME timer_last_idleness_start_time
;
639 /* If non-nil, events produced by disabled menu items and tool-bar
640 buttons are not ignored. Help functions bind this to allow help on
641 those items and buttons. */
642 Lisp_Object Venable_disabled_menus_and_buttons
;
645 /* Global variable declarations. */
647 /* Flags for readable_events. */
648 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
649 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
650 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
652 /* Function for init_keyboard to call with no args (if nonzero). */
653 void (*keyboard_init_hook
) ();
655 static int read_avail_input
P_ ((int));
656 static void get_input_pending
P_ ((int *, int));
657 static int readable_events
P_ ((int));
658 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
659 Lisp_Object
, int *));
660 static Lisp_Object
read_char_x_menu_prompt ();
661 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
663 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
665 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
666 enum scroll_bar_part
,
667 Lisp_Object
, Lisp_Object
,
670 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
671 Lisp_Object
, char **,
672 Lisp_Object
*, unsigned));
673 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
674 static int parse_solitary_modifier
P_ ((Lisp_Object
));
675 static int parse_solitary_modifier ();
676 static void save_getcjmp
P_ ((jmp_buf));
677 static void save_getcjmp ();
678 static void restore_getcjmp
P_ ((jmp_buf));
679 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
680 static void clear_event
P_ ((struct input_event
*));
681 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
682 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
683 static void handle_interrupt
P_ ((void));
684 static void timer_start_idle
P_ ((void));
685 static void timer_stop_idle
P_ ((void));
686 static void timer_resume_idle
P_ ((void));
688 /* Nonzero means don't try to suspend even if the operating system seems
690 static int cannot_suspend
;
692 extern Lisp_Object Qidentity
, Qonly
;
694 /* Install the string STR as the beginning of the string of echoing,
695 so that it serves as a prompt for the next character.
696 Also start echoing. */
702 current_kboard
->echo_string
= str
;
703 current_kboard
->echo_after_prompt
= SCHARS (str
);
707 /* Add C to the echo string, if echoing is going on.
708 C can be a character, which is printed prettily ("M-C-x" and all that
709 jazz), or a symbol, whose name is printed. */
715 if (current_kboard
->immediate_echo
)
717 int size
= KEY_DESCRIPTION_SIZE
+ 100;
718 char *buffer
= (char *) alloca (size
);
720 Lisp_Object echo_string
;
722 echo_string
= current_kboard
->echo_string
;
724 /* If someone has passed us a composite event, use its head symbol. */
729 ptr
= push_key_description (XINT (c
), ptr
, 1);
731 else if (SYMBOLP (c
))
733 Lisp_Object name
= SYMBOL_NAME (c
);
734 int nbytes
= SBYTES (name
);
736 if (size
- (ptr
- buffer
) < nbytes
)
738 int offset
= ptr
- buffer
;
739 size
= max (2 * size
, size
+ nbytes
);
740 buffer
= (char *) alloca (size
);
741 ptr
= buffer
+ offset
;
744 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
745 STRING_MULTIBYTE (name
), 1);
748 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
751 const char *text
= " (Type ? for further options)";
752 int len
= strlen (text
);
754 if (size
- (ptr
- buffer
) < len
)
756 int offset
= ptr
- buffer
;
758 buffer
= (char *) alloca (size
);
759 ptr
= buffer
+ offset
;
762 bcopy (text
, ptr
, len
);
766 /* Replace a dash from echo_dash with a space, otherwise
767 add a space at the end as a separator between keys. */
768 if (STRINGP (echo_string
)
769 && SCHARS (echo_string
) > 1)
771 Lisp_Object last_char
, prev_char
, idx
;
773 idx
= make_number (SCHARS (echo_string
) - 2);
774 prev_char
= Faref (echo_string
, idx
);
776 idx
= make_number (SCHARS (echo_string
) - 1);
777 last_char
= Faref (echo_string
, idx
);
779 /* We test PREV_CHAR to make sure this isn't the echoing
781 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
782 Faset (echo_string
, idx
, make_number (' '));
784 echo_string
= concat2 (echo_string
, build_string (" "));
786 else if (STRINGP (echo_string
))
787 echo_string
= concat2 (echo_string
, build_string (" "));
789 current_kboard
->echo_string
790 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
796 /* Temporarily add a dash to the end of the echo string if it's not
797 empty, so that it serves as a mini-prompt for the very next character. */
802 /* Do nothing if not echoing at all. */
803 if (NILP (current_kboard
->echo_string
))
806 if (!current_kboard
->immediate_echo
807 && SCHARS (current_kboard
->echo_string
) == 0)
810 /* Do nothing if we just printed a prompt. */
811 if (current_kboard
->echo_after_prompt
812 == SCHARS (current_kboard
->echo_string
))
815 /* Do nothing if we have already put a dash at the end. */
816 if (SCHARS (current_kboard
->echo_string
) > 1)
818 Lisp_Object last_char
, prev_char
, idx
;
820 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
821 prev_char
= Faref (current_kboard
->echo_string
, idx
);
823 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
824 last_char
= Faref (current_kboard
->echo_string
, idx
);
826 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
830 /* Put a dash at the end of the buffer temporarily,
831 but make it go away when the next character is added. */
832 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
837 /* Display the current echo string, and begin echoing if not already
843 if (!current_kboard
->immediate_echo
)
846 current_kboard
->immediate_echo
= 1;
848 for (i
= 0; i
< this_command_key_count
; i
++)
852 /* Set before_command_echo_length to the value that would
853 have been saved before the start of this subcommand in
854 command_loop_1, if we had already been echoing then. */
855 if (i
== this_single_command_key_start
)
856 before_command_echo_length
= echo_length ();
858 c
= XVECTOR (this_command_keys
)->contents
[i
];
859 if (! (EVENT_HAS_PARAMETERS (c
)
860 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
864 /* Set before_command_echo_length to the value that would
865 have been saved before the start of this subcommand in
866 command_loop_1, if we had already been echoing then. */
867 if (this_command_key_count
== this_single_command_key_start
)
868 before_command_echo_length
= echo_length ();
870 /* Put a dash at the end to invite the user to type more. */
875 message3_nolog (current_kboard
->echo_string
,
876 SBYTES (current_kboard
->echo_string
),
877 STRING_MULTIBYTE (current_kboard
->echo_string
));
880 /* Record in what buffer we echoed, and from which kboard. */
881 echo_message_buffer
= echo_area_buffer
[0];
882 echo_kboard
= current_kboard
;
884 if (waiting_for_input
&& !NILP (Vquit_flag
))
885 quit_throw_to_read_char ();
888 /* Turn off echoing, for the start of a new command. */
893 current_kboard
->immediate_echo
= 0;
894 current_kboard
->echo_after_prompt
= -1;
895 current_kboard
->echo_string
= Qnil
;
896 ok_to_echo_at_next_pause
= NULL
;
898 echo_message_buffer
= Qnil
;
901 /* Return the length of the current echo string. */
906 return (STRINGP (current_kboard
->echo_string
)
907 ? SCHARS (current_kboard
->echo_string
)
911 /* Truncate the current echo message to its first LEN chars.
912 This and echo_char get used by read_key_sequence when the user
913 switches frames while entering a key sequence. */
916 echo_truncate (nchars
)
919 if (STRINGP (current_kboard
->echo_string
))
920 current_kboard
->echo_string
921 = Fsubstring (current_kboard
->echo_string
,
922 make_number (0), make_number (nchars
));
923 truncate_echo_area (nchars
);
927 /* Functions for manipulating this_command_keys. */
929 add_command_key (key
)
932 #if 0 /* Not needed after we made Freset_this_command_lengths
933 do the job immediately. */
934 /* If reset-this-command-length was called recently, obey it now.
935 See the doc string of that function for an explanation of why. */
936 if (before_command_restore_flag
)
938 this_command_key_count
= before_command_key_count_1
;
939 if (this_command_key_count
< this_single_command_key_start
)
940 this_single_command_key_start
= this_command_key_count
;
941 echo_truncate (before_command_echo_length_1
);
942 before_command_restore_flag
= 0;
946 if (this_command_key_count
>= ASIZE (this_command_keys
))
947 this_command_keys
= larger_vector (this_command_keys
,
948 2 * ASIZE (this_command_keys
),
951 AREF (this_command_keys
, this_command_key_count
) = key
;
952 ++this_command_key_count
;
959 int count
= SPECPDL_INDEX ();
962 if (command_loop_level
> 0)
964 specbind (Qstandard_output
, Qt
);
965 specbind (Qstandard_input
, Qt
);
968 #ifdef HAVE_X_WINDOWS
969 /* The command loop has started an hourglass timer, so we have to
970 cancel it here, otherwise it will fire because the recursive edit
971 can take some time. Do not check for display_hourglass_p here,
972 because it could already be nil. */
976 /* This function may have been called from a debugger called from
977 within redisplay, for instance by Edebugging a function called
978 from fontification-functions. We want to allow redisplay in
979 the debugging session.
981 The recursive edit is left with a `(throw exit ...)'. The `exit'
982 tag is not caught anywhere in redisplay, i.e. when we leave the
983 recursive edit, the original redisplay leading to the recursive
984 edit will be unwound. The outcome should therefore be safe. */
985 specbind (Qinhibit_redisplay
, Qnil
);
988 val
= command_loop ();
990 Fsignal (Qquit
, Qnil
);
991 /* Handle throw from read_minibuf when using minibuffer
992 while it's active but we're in another window. */
994 xsignal1 (Qerror
, val
);
996 return unbind_to (count
, Qnil
);
999 /* When an auto-save happens, record the "time", and don't do again soon. */
1004 last_auto_save
= num_nonmacro_input_events
;
1007 /* Make an auto save happen as soon as possible at command level. */
1010 force_auto_save_soon ()
1012 last_auto_save
= - auto_save_interval
- 1;
1014 record_asynch_buffer_change ();
1017 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1018 doc
: /* Invoke the editor command loop recursively.
1019 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1020 that tells this function to return.
1021 Alternatively, `(throw 'exit t)' makes this function signal an error.
1022 This function is called by the editor initialization to begin editing. */)
1025 int count
= SPECPDL_INDEX ();
1028 /* If we enter while input is blocked, don't lock up here.
1029 This may happen through the debugger during redisplay. */
1030 if (INPUT_BLOCKED_P
)
1033 command_loop_level
++;
1034 update_mode_lines
= 1;
1036 if (command_loop_level
1037 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1038 buffer
= Fcurrent_buffer ();
1042 /* If we leave recursive_edit_1 below with a `throw' for instance,
1043 like it is done in the splash screen display, we have to
1044 make sure that we restore single_kboard as command_loop_1
1045 would have done if it were left normally. */
1046 if (command_loop_level
> 0)
1047 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1048 record_unwind_protect (recursive_edit_unwind
, buffer
);
1050 recursive_edit_1 ();
1051 return unbind_to (count
, Qnil
);
1055 recursive_edit_unwind (buffer
)
1058 if (BUFFERP (buffer
))
1059 Fset_buffer (buffer
);
1061 command_loop_level
--;
1062 update_mode_lines
= 1;
1067 #if 0 /* These two functions are now replaced with
1068 temporarily_switch_to_single_kboard. */
1073 #if 0 /* Theory: if there's anything in Vunread_command_events,
1074 it will right away be read by read_key_sequence,
1075 and then if we do switch KBOARDS, it will go into the side
1076 queue then. So we don't need to do anything special here -- rms. */
1077 if (CONSP (Vunread_command_events
))
1079 current_kboard
->kbd_queue
1080 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1081 current_kboard
->kbd_queue_has_data
= 1;
1083 Vunread_command_events
= Qnil
;
1089 /* Switch to the single-kboard state, making current_kboard
1090 the only KBOARD from which further input is accepted. */
1093 single_kboard_state ()
1101 /* If we're in single_kboard state for kboard KBOARD,
1105 not_single_kboard_state (kboard
)
1109 if (kboard
== current_kboard
)
1114 /* Maintain a stack of kboards, so other parts of Emacs
1115 can switch temporarily to the kboard of a given frame
1116 and then revert to the previous status. */
1121 struct kboard_stack
*next
;
1124 static struct kboard_stack
*kboard_stack
;
1131 struct kboard_stack
*p
1132 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1134 p
->next
= kboard_stack
;
1135 p
->kboard
= current_kboard
;
1147 struct kboard_stack
*p
= kboard_stack
;
1149 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1151 if (t
->kboard
== p
->kboard
)
1153 current_kboard
= p
->kboard
;
1160 /* The terminal we remembered has been deleted. */
1161 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1164 kboard_stack
= p
->next
;
1169 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1170 from which further input is accepted. If F is non-nil, set its
1171 KBOARD as the current keyboard.
1173 This function uses record_unwind_protect to return to the previous
1176 If Emacs is already in single_kboard mode, and F's keyboard is
1177 locked, then this function will throw an errow. */
1180 temporarily_switch_to_single_kboard (f
)
1184 int was_locked
= single_kboard
;
1187 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1188 /* We can not switch keyboards while in single_kboard mode.
1189 In rare cases, Lisp code may call `recursive-edit' (or
1190 `read-minibuffer' or `y-or-n-p') after it switched to a
1191 locked frame. For example, this is likely to happen
1192 when server.el connects to a new terminal while Emacs is in
1193 single_kboard mode. It is best to throw an error instead
1194 of presenting the user with a frozen screen. */
1195 error ("Terminal %d is locked, cannot read from it",
1196 FRAME_TERMINAL (f
)->id
);
1198 /* This call is unnecessary, but helps
1199 `restore_kboard_configuration' discover if somebody changed
1200 `current_kboard' behind our back. */
1201 push_kboard (current_kboard
);
1204 current_kboard
= FRAME_KBOARD (f
);
1206 record_unwind_protect (restore_kboard_configuration
,
1207 (was_locked
? Qt
: Qnil
));
1211 #if 0 /* This function is not needed anymore. */
1213 record_single_kboard_state ()
1216 push_kboard (current_kboard
);
1217 record_unwind_protect (restore_kboard_configuration
,
1218 (single_kboard
? Qt
: Qnil
));
1223 restore_kboard_configuration (was_locked
)
1224 Lisp_Object was_locked
;
1226 if (NILP (was_locked
))
1230 struct kboard
*prev
= current_kboard
;
1233 /* The pop should not change the kboard. */
1234 if (single_kboard
&& current_kboard
!= prev
)
1240 /* Handle errors that are not handled at inner levels
1241 by printing an error message and returning to the editor command loop. */
1247 Lisp_Object old_level
, old_length
;
1248 char macroerror
[50];
1250 #ifdef HAVE_X_WINDOWS
1251 if (display_hourglass_p
)
1252 cancel_hourglass ();
1255 if (!NILP (executing_kbd_macro
))
1257 if (executing_kbd_macro_iterations
== 1)
1258 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1260 sprintf (macroerror
, "After %d kbd macro iterations: ",
1261 executing_kbd_macro_iterations
);
1266 Vstandard_output
= Qt
;
1267 Vstandard_input
= Qt
;
1268 Vexecuting_kbd_macro
= Qnil
;
1269 executing_kbd_macro
= Qnil
;
1270 current_kboard
->Vprefix_arg
= Qnil
;
1271 current_kboard
->Vlast_prefix_arg
= Qnil
;
1274 /* Avoid unquittable loop if data contains a circular list. */
1275 old_level
= Vprint_level
;
1276 old_length
= Vprint_length
;
1277 XSETFASTINT (Vprint_level
, 10);
1278 XSETFASTINT (Vprint_length
, 10);
1279 cmd_error_internal (data
, macroerror
);
1280 Vprint_level
= old_level
;
1281 Vprint_length
= old_length
;
1285 Vinhibit_quit
= Qnil
;
1286 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1288 if (command_loop_level
== 0 && minibuf_level
== 0)
1289 any_kboard_state ();
1293 return make_number (0);
1296 /* Take actions on handling an error. DATA is the data that describes
1299 CONTEXT is a C-string containing ASCII characters only which
1300 describes the context in which the error happened. If we need to
1301 generalize CONTEXT to allow multibyte characters, make it a Lisp
1305 cmd_error_internal (data
, context
)
1309 struct frame
*sf
= SELECTED_FRAME ();
1311 /* The immediate context is not interesting for Quits,
1312 since they are asyncronous. */
1313 if (EQ (XCAR (data
), Qquit
))
1314 Vsignaling_function
= Qnil
;
1319 /* Use user's specified output function if any. */
1320 if (!NILP (Vcommand_error_function
))
1321 call3 (Vcommand_error_function
, data
,
1322 build_string (context
? context
: ""),
1323 Vsignaling_function
);
1324 /* If the window system or terminal frame hasn't been initialized
1325 yet, or we're not interactive, write the message to stderr and exit. */
1326 else if (!sf
->glyphs_initialized_p
1327 || FRAME_INITIAL_P (sf
)
1330 print_error_message (data
, Qexternal_debugging_output
,
1331 context
, Vsignaling_function
);
1332 Fterpri (Qexternal_debugging_output
);
1333 Fkill_emacs (make_number (-1));
1337 clear_message (1, 0);
1339 message_log_maybe_newline ();
1342 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1345 Vsignaling_function
= Qnil
;
1348 Lisp_Object
command_loop_1 ();
1349 Lisp_Object
command_loop_2 ();
1350 Lisp_Object
top_level_1 ();
1352 /* Entry to editor-command-loop.
1353 This level has the catches for exiting/returning to editor command loop.
1354 It returns nil to exit recursive edit, t to abort it. */
1359 if (command_loop_level
> 0 || minibuf_level
> 0)
1362 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1363 executing_kbd_macro
= Qnil
;
1369 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1370 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1371 /* Reset single_kboard in case top-level set it while
1372 evaluating an -f option, or we are stuck there for some
1374 any_kboard_state ();
1376 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1377 executing_kbd_macro
= Qnil
;
1379 /* End of file in -batch run causes exit here. */
1385 /* Here we catch errors in execution of commands within the
1386 editing loop, and reenter the editing loop.
1387 When there is an error, cmd_error runs and returns a non-nil
1388 value to us. A value of nil means that command_loop_1 itself
1389 returned due to end of file (or end of kbd macro). */
1394 register Lisp_Object val
;
1397 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1398 while (!NILP (val
));
1406 return Feval (Vtop_level
);
1412 /* On entry to the outer level, run the startup file */
1413 if (!NILP (Vtop_level
))
1414 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1415 else if (!NILP (Vpurify_flag
))
1416 message ("Bare impure Emacs (standard Lisp code not loaded)");
1418 message ("Bare Emacs (standard Lisp code not loaded)");
1422 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1423 doc
: /* Exit all recursive editing levels. */)
1426 #ifdef HAVE_X_WINDOWS
1427 if (display_hourglass_p
)
1428 cancel_hourglass ();
1431 /* Unblock input if we enter with input blocked. This may happen if
1432 redisplay traps e.g. during tool-bar update with input blocked. */
1433 while (INPUT_BLOCKED_P
)
1436 return Fthrow (Qtop_level
, Qnil
);
1439 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1440 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1443 if (command_loop_level
> 0 || minibuf_level
> 0)
1444 Fthrow (Qexit
, Qnil
);
1446 error ("No recursive edit is in progress");
1450 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1451 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1454 if (command_loop_level
> 0 || minibuf_level
> 0)
1457 error ("No recursive edit is in progress");
1463 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1464 of this function. */
1467 tracking_off (old_value
)
1468 Lisp_Object old_value
;
1470 do_mouse_tracking
= old_value
;
1471 if (NILP (old_value
))
1473 /* Redisplay may have been preempted because there was input
1474 available, and it assumes it will be called again after the
1475 input has been processed. If the only input available was
1476 the sort that we have just disabled, then we need to call
1478 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1480 redisplay_preserve_echo_area (6);
1481 get_input_pending (&input_pending
,
1482 READABLE_EVENTS_DO_TIMERS_NOW
);
1488 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1489 doc
: /* Evaluate BODY with mouse movement events enabled.
1490 Within a `track-mouse' form, mouse motion generates input events that
1491 you can read with `read-event'.
1492 Normally, mouse motion is ignored.
1493 usage: (track-mouse BODY ...) */)
1497 int count
= SPECPDL_INDEX ();
1500 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1502 do_mouse_tracking
= Qt
;
1504 val
= Fprogn (args
);
1505 return unbind_to (count
, val
);
1508 /* If mouse has moved on some frame, return one of those frames.
1509 Return 0 otherwise. */
1514 Lisp_Object tail
, frame
;
1516 FOR_EACH_FRAME (tail
, frame
)
1518 if (XFRAME (frame
)->mouse_moved
)
1519 return XFRAME (frame
);
1525 #endif /* HAVE_MOUSE */
1527 /* This is the actual command reading loop,
1528 sans error-handling encapsulation. */
1530 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1532 void safe_run_hooks
P_ ((Lisp_Object
));
1533 static void adjust_point_for_property
P_ ((int, int));
1535 /* Cancel hourglass from protect_unwind.
1537 #ifdef HAVE_X_WINDOWS
1539 cancel_hourglass_unwind (arg
)
1542 cancel_hourglass ();
1553 Lisp_Object keybuf
[30];
1556 int prev_modiff
= 0;
1557 struct buffer
*prev_buffer
= NULL
;
1558 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1560 int was_locked
= single_kboard
;
1563 int already_adjusted
= 0;
1565 current_kboard
->Vprefix_arg
= Qnil
;
1566 current_kboard
->Vlast_prefix_arg
= Qnil
;
1567 Vdeactivate_mark
= Qnil
;
1568 waiting_for_input
= 0;
1572 this_command_key_count
= 0;
1573 this_command_key_count_reset
= 0;
1574 this_single_command_key_start
= 0;
1576 if (NILP (Vmemory_full
))
1578 /* Make sure this hook runs after commands that get errors and
1579 throw to top level. */
1580 /* Note that the value cell will never directly contain nil
1581 if the symbol is a local variable. */
1582 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1583 safe_run_hooks (Qpost_command_hook
);
1585 /* If displaying a message, resize the echo area window to fit
1586 that message's size exactly. */
1587 if (!NILP (echo_area_buffer
[0]))
1588 resize_echo_area_exactly ();
1590 if (!NILP (Vdeferred_action_list
))
1591 safe_run_hooks (Qdeferred_action_function
);
1594 /* Do this after running Vpost_command_hook, for consistency. */
1595 current_kboard
->Vlast_command
= Vthis_command
;
1596 current_kboard
->Vreal_last_command
= real_this_command
;
1600 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1603 /* Make sure the current window's buffer is selected. */
1604 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1605 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1607 /* Display any malloc warning that just came out. Use while because
1608 displaying one warning can cause another. */
1610 while (pending_malloc_warning
)
1611 display_malloc_warning ();
1615 Vdeactivate_mark
= Qnil
;
1617 /* If minibuffer on and echo area in use,
1618 wait a short time and redraw minibuffer. */
1621 && !NILP (echo_area_buffer
[0])
1622 && EQ (minibuf_window
, echo_area_window
))
1624 /* Bind inhibit-quit to t so that C-g gets read in
1625 rather than quitting back to the minibuffer. */
1626 int count
= SPECPDL_INDEX ();
1627 specbind (Qinhibit_quit
, Qt
);
1629 if (NUMBERP (Vminibuffer_message_timeout
))
1630 sit_for (Vminibuffer_message_timeout
, 0, 2);
1634 /* Clear the echo area. */
1636 safe_run_hooks (Qecho_area_clear_hook
);
1638 unbind_to (count
, Qnil
);
1640 /* If a C-g came in before, treat it as input now. */
1641 if (!NILP (Vquit_flag
))
1644 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1649 alloca (0); /* Cause a garbage collection now */
1650 /* Since we can free the most stuff here. */
1651 #endif /* C_ALLOCA */
1654 /* Select the frame that the last event came from. Usually,
1655 switch-frame events will take care of this, but if some lisp
1656 code swallows a switch-frame event, we'll fix things up here.
1657 Is this a good idea? */
1658 if (FRAMEP (internal_last_event_frame
)
1659 && !EQ (internal_last_event_frame
, selected_frame
))
1660 Fselect_frame (internal_last_event_frame
);
1662 /* If it has changed current-menubar from previous value,
1663 really recompute the menubar from the value. */
1664 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1665 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1666 call0 (Qrecompute_lucid_menubar
);
1668 before_command_key_count
= this_command_key_count
;
1669 before_command_echo_length
= echo_length ();
1671 Vthis_command
= Qnil
;
1672 real_this_command
= Qnil
;
1673 Vthis_original_command
= Qnil
;
1675 /* Read next key sequence; i gets its length. */
1676 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1679 /* A filter may have run while we were reading the input. */
1680 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1682 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1683 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1687 /* Now we have read a key sequence of length I,
1688 or else I is 0 and we found end of file. */
1690 if (i
== 0) /* End of file -- happens only in */
1691 return Qnil
; /* a kbd macro, at the end. */
1692 /* -1 means read_key_sequence got a menu that was rejected.
1693 Just loop around and read another command. */
1697 this_command_key_count
= 0;
1698 this_command_key_count_reset
= 0;
1699 this_single_command_key_start
= 0;
1703 last_command_char
= keybuf
[i
- 1];
1705 /* If the previous command tried to force a specific window-start,
1706 forget about that, in case this command moves point far away
1707 from that position. But also throw away beg_unchanged and
1708 end_unchanged information in that case, so that redisplay will
1709 update the whole window properly. */
1710 if (!NILP (XWINDOW (selected_window
)->force_start
))
1713 XWINDOW (selected_window
)->force_start
= Qnil
;
1714 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1715 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1718 cmd
= read_key_sequence_cmd
;
1719 if (!NILP (Vexecuting_kbd_macro
))
1721 if (!NILP (Vquit_flag
))
1723 Vexecuting_kbd_macro
= Qt
;
1724 QUIT
; /* Make some noise. */
1725 /* Will return since macro now empty. */
1729 /* Do redisplay processing after this command except in special
1730 cases identified below. */
1731 prev_buffer
= current_buffer
;
1732 prev_modiff
= MODIFF
;
1733 last_point_position
= PT
;
1734 last_point_position_window
= selected_window
;
1735 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1737 /* By default, we adjust point to a boundary of a region that
1738 has such a property that should be treated intangible
1739 (e.g. composition, display). But, some commands will set
1740 this variable differently. */
1741 Vdisable_point_adjustment
= Qnil
;
1743 /* Process filters and timers may have messed with deactivate-mark.
1744 reset it before we execute the command. */
1745 Vdeactivate_mark
= Qnil
;
1747 /* Remap command through active keymaps */
1748 Vthis_original_command
= cmd
;
1752 if (cmd1
= Fcommand_remapping (cmd
, Qnil
), !NILP (cmd1
))
1756 /* Execute the command. */
1758 Vthis_command
= cmd
;
1759 real_this_command
= cmd
;
1760 /* Note that the value cell will never directly contain nil
1761 if the symbol is a local variable. */
1762 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1763 safe_run_hooks (Qpre_command_hook
);
1765 already_adjusted
= 0;
1767 if (NILP (Vthis_command
))
1769 /* nil means key is undefined. */
1770 Lisp_Object keys
= Fvector (i
, keybuf
);
1771 keys
= Fkey_description (keys
, Qnil
);
1773 message_with_string ("%s is undefined", keys
, 0);
1774 current_kboard
->defining_kbd_macro
= Qnil
;
1775 update_mode_lines
= 1;
1776 current_kboard
->Vprefix_arg
= Qnil
;
1780 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1782 /* In case we jump to directly_done. */
1783 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1785 /* Recognize some common commands in common situations and
1786 do them directly. */
1787 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1789 struct Lisp_Char_Table
*dp
1790 = window_display_table (XWINDOW (selected_window
));
1791 lose
= FETCH_CHAR (PT_BYTE
);
1793 if (! NILP (Vpost_command_hook
))
1794 /* Put this before calling adjust_point_for_property
1795 so it will only get called once in any case. */
1797 if (current_buffer
== prev_buffer
1798 && last_point_position
!= PT
1799 && NILP (Vdisable_point_adjustment
)
1800 && NILP (Vglobal_disable_point_adjustment
))
1801 adjust_point_for_property (last_point_position
, 0);
1802 already_adjusted
= 1;
1803 if (PT
== last_point_position
+ 1
1805 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1806 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1807 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1808 && (lose
>= 0x20 && lose
< 0x7f)))
1809 : (lose
>= 0x20 && lose
< 0x7f))
1810 /* To extract the case of continuation on
1811 wide-column characters. */
1812 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1813 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1815 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1817 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1819 && !windows_or_buffers_changed
1820 && EQ (current_buffer
->selective_display
, Qnil
)
1821 && !detect_input_pending ()
1822 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1823 && NILP (Vexecuting_kbd_macro
))
1824 direct_output_forward_char (1);
1827 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1829 struct Lisp_Char_Table
*dp
1830 = window_display_table (XWINDOW (selected_window
));
1832 lose
= FETCH_CHAR (PT_BYTE
);
1833 if (! NILP (Vpost_command_hook
))
1835 if (current_buffer
== prev_buffer
1836 && last_point_position
!= PT
1837 && NILP (Vdisable_point_adjustment
)
1838 && NILP (Vglobal_disable_point_adjustment
))
1839 adjust_point_for_property (last_point_position
, 0);
1840 already_adjusted
= 1;
1841 if (PT
== last_point_position
- 1
1843 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1844 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1845 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1846 && (lose
>= 0x20 && lose
< 0x7f)))
1847 : (lose
>= 0x20 && lose
< 0x7f))
1848 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1850 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1852 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1854 && !windows_or_buffers_changed
1855 && EQ (current_buffer
->selective_display
, Qnil
)
1856 && !detect_input_pending ()
1857 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1858 && NILP (Vexecuting_kbd_macro
))
1859 direct_output_forward_char (-1);
1862 else if (EQ (Vthis_command
, Qself_insert_command
)
1863 /* Try this optimization only on char keystrokes. */
1864 && NATNUMP (last_command_char
)
1865 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1868 = translate_char (Vtranslation_table_for_input
,
1869 XFASTINT (last_command_char
), 0, 0, 0);
1871 if (NILP (Vexecuting_kbd_macro
)
1872 && !EQ (minibuf_window
, selected_window
))
1874 if (!nonundocount
|| nonundocount
>= 20)
1882 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1884 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1886 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1888 || MODIFF
<= SAVE_MODIFF
1889 || windows_or_buffers_changed
1890 || !EQ (current_buffer
->selective_display
, Qnil
)
1891 || detect_input_pending ()
1892 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1893 || !NILP (Vexecuting_kbd_macro
));
1895 value
= internal_self_insert (c
, 0);
1900 if (! NILP (Vpost_command_hook
))
1901 /* Put this before calling adjust_point_for_property
1902 so it will only get called once in any case. */
1905 /* VALUE == 1 when AFTER-CHANGE functions are
1906 installed which is the case most of the time
1907 because FONT-LOCK installs one. */
1908 if (!lose
&& !value
)
1909 direct_output_for_insert (c
);
1914 /* Here for a command that isn't executed directly */
1917 #ifdef HAVE_X_WINDOWS
1918 int scount
= SPECPDL_INDEX ();
1920 if (display_hourglass_p
1921 && NILP (Vexecuting_kbd_macro
))
1923 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1929 if (NILP (current_kboard
->Vprefix_arg
))
1931 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1933 #ifdef HAVE_X_WINDOWS
1934 /* Do not check display_hourglass_p here, because
1935 Fcommand_execute could change it, but we should cancel
1936 hourglass cursor anyway.
1937 But don't cancel the hourglass within a macro
1938 just because a command in the macro finishes. */
1939 if (NILP (Vexecuting_kbd_macro
))
1940 unbind_to (scount
, Qnil
);
1945 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1947 /* Note that the value cell will never directly contain nil
1948 if the symbol is a local variable. */
1949 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1950 safe_run_hooks (Qpost_command_hook
);
1952 /* If displaying a message, resize the echo area window to fit
1953 that message's size exactly. */
1954 if (!NILP (echo_area_buffer
[0]))
1955 resize_echo_area_exactly ();
1957 if (!NILP (Vdeferred_action_list
))
1958 safe_run_hooks (Qdeferred_action_function
);
1960 /* If there is a prefix argument,
1961 1) We don't want Vlast_command to be ``universal-argument''
1962 (that would be dumb), so don't set Vlast_command,
1963 2) we want to leave echoing on so that the prefix will be
1964 echoed as part of this key sequence, so don't call
1966 3) we want to leave this_command_key_count non-zero, so that
1967 read_char will realize that it is re-reading a character, and
1968 not echo it a second time.
1970 If the command didn't actually create a prefix arg,
1971 but is merely a frame event that is transparent to prefix args,
1972 then the above doesn't apply. */
1973 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1975 current_kboard
->Vlast_command
= Vthis_command
;
1976 current_kboard
->Vreal_last_command
= real_this_command
;
1978 this_command_key_count
= 0;
1979 this_command_key_count_reset
= 0;
1980 this_single_command_key_start
= 0;
1983 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1985 /* Setting transient-mark-mode to `only' is a way of
1986 turning it on for just one command. */
1988 if (EQ (Vtransient_mark_mode
, Qidentity
))
1989 Vtransient_mark_mode
= Qnil
;
1990 if (EQ (Vtransient_mark_mode
, Qonly
))
1991 Vtransient_mark_mode
= Qidentity
;
1993 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1995 /* We could also call `deactivate'mark'. */
1996 if (EQ (Vtransient_mark_mode
, Qlambda
))
1997 Vtransient_mark_mode
= Qnil
;
2000 current_buffer
->mark_active
= Qnil
;
2001 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
2004 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
2005 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
2010 if (current_buffer
== prev_buffer
2011 && last_point_position
!= PT
2012 && NILP (Vdisable_point_adjustment
)
2013 && NILP (Vglobal_disable_point_adjustment
)
2014 && !already_adjusted
)
2015 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
2017 /* Install chars successfully executed in kbd macro. */
2019 if (!NILP (current_kboard
->defining_kbd_macro
)
2020 && NILP (current_kboard
->Vprefix_arg
))
2021 finalize_kbd_macro_chars ();
2022 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2025 any_kboard_state ();
2031 extern Lisp_Object Qcomposition
, Qdisplay
;
2033 /* Adjust point to a boundary of a region that has such a property
2034 that should be treated intangible. For the moment, we check
2035 `composition', `display' and `invisible' properties.
2036 LAST_PT is the last position of point. */
2038 extern Lisp_Object Qafter_string
, Qbefore_string
;
2039 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2042 adjust_point_for_property (last_pt
, modified
)
2047 Lisp_Object val
, overlay
, tmp
;
2048 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2051 /* FIXME: cycling is probably not necessary because these properties
2052 can't be usefully combined anyway. */
2053 while (check_composition
|| check_display
|| check_invisible
)
2055 if (check_composition
2056 && PT
> BEGV
&& PT
< ZV
2057 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2058 && COMPOSITION_VALID_P (beg
, end
, val
)
2059 && beg
< PT
/* && end > PT <- It's always the case. */
2060 && (last_pt
<= beg
|| last_pt
>= end
))
2063 SET_PT (PT
< last_pt
? beg
: end
);
2064 check_display
= check_invisible
= 1;
2066 check_composition
= 0;
2068 && PT
> BEGV
&& PT
< ZV
2069 && !NILP (val
= get_char_property_and_overlay
2070 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2071 && display_prop_intangible_p (val
)
2072 && (!OVERLAYP (overlay
)
2073 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2074 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2075 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2076 && (beg
< PT
/* && end > PT <- It's always the case. */
2077 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2080 SET_PT (PT
< last_pt
2081 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2083 check_composition
= check_invisible
= 1;
2086 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2088 int inv
, ellipsis
= 0;
2091 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2093 && !NILP (val
= get_char_property_and_overlay
2094 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2095 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2097 ellipsis
= ellipsis
|| inv
> 1
2098 || (OVERLAYP (overlay
)
2099 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2100 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2101 tmp
= Fnext_single_char_property_change
2102 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2103 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2106 && !NILP (val
= get_char_property_and_overlay
2107 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2108 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2110 ellipsis
= ellipsis
|| inv
> 1
2111 || (OVERLAYP (overlay
)
2112 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2113 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2114 tmp
= Fprevious_single_char_property_change
2115 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2116 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2119 /* Move away from the inside area. */
2120 if (beg
< PT
&& end
> PT
)
2122 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2123 /* We haven't moved yet (so we don't need to fear
2124 infinite-looping) and we were outside the range
2125 before (so either end of the range still corresponds
2126 to a move in the right direction): pretend we moved
2127 less than we actually did, so that we still have
2128 more freedom below in choosing which end of the range
2130 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2131 /* We either have moved already or the last point
2132 was already in the range: we don't get to choose
2133 which end of the range we have to go to. */
2134 : (PT
< last_pt
? beg
: end
));
2135 check_composition
= check_display
= 1;
2137 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2138 the point to something other than its argument, due to
2139 point-motion hooks, intangibility, etc. */
2140 xassert (PT
== beg
|| PT
== end
);
2143 /* Pretend the area doesn't exist if the buffer is not
2145 if (!modified
&& !ellipsis
&& beg
< end
)
2147 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2148 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2149 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2150 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2151 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2152 /* We've already moved as far as we can. Trying to go
2153 to the other end would mean moving backwards and thus
2154 could lead to an infinite loop. */
2156 else if (val
= get_pos_property (make_number (PT
),
2158 TEXT_PROP_MEANS_INVISIBLE (val
)
2159 && (val
= get_pos_property
2160 (make_number (PT
== beg
? end
: beg
),
2162 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2163 (check_composition
= check_display
= 1,
2164 SET_PT (PT
== beg
? end
: beg
));
2167 check_invisible
= 0;
2171 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2174 safe_run_hooks_1 (hook
)
2177 if (NILP (Vrun_hooks
))
2179 return call1 (Vrun_hooks
, Vinhibit_quit
);
2182 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2185 safe_run_hooks_error (data
)
2188 Lisp_Object args
[3];
2189 args
[0] = build_string ("Error in %s: %s");
2190 args
[1] = Vinhibit_quit
;
2193 return Fset (Vinhibit_quit
, Qnil
);
2196 /* If we get an error while running the hook, cause the hook variable
2197 to be nil. Also inhibit quits, so that C-g won't cause the hook
2198 to mysteriously evaporate. */
2201 safe_run_hooks (hook
)
2204 int count
= SPECPDL_INDEX ();
2205 specbind (Qinhibit_quit
, hook
);
2207 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2209 unbind_to (count
, Qnil
);
2213 /* Number of seconds between polling for input. This is a Lisp
2214 variable that can be bound. */
2216 EMACS_INT polling_period
;
2218 /* Nonzero means polling for input is temporarily suppressed. */
2220 int poll_suppress_count
;
2222 /* Asynchronous timer for polling. */
2224 struct atimer
*poll_timer
;
2227 #ifdef POLL_FOR_INPUT
2229 /* Poll for input, so what we catch a C-g if it comes in. This
2230 function is called from x_make_frame_visible, see comment
2236 if (interrupt_input_blocked
== 0
2237 && !waiting_for_input
)
2238 read_avail_input (0);
2241 /* Timer callback function for poll_timer. TIMER is equal to
2245 poll_for_input (timer
)
2246 struct atimer
*timer
;
2248 if (poll_suppress_count
== 0)
2250 interrupt_input_pending
= 1;
2252 poll_for_input_1 ();
2256 #endif /* POLL_FOR_INPUT */
2258 /* Begin signals to poll for input, if they are appropriate.
2259 This function is called unconditionally from various places. */
2264 #ifdef POLL_FOR_INPUT
2265 /* XXX This condition was (read_socket_hook && !interrupt_input),
2266 but read_socket_hook is not global anymore. Let's pretend that
2268 if (!interrupt_input
)
2270 /* Turn alarm handling on unconditionally. It might have
2271 been turned off in process.c. */
2272 turn_on_atimers (1);
2274 /* If poll timer doesn't exist, are we need one with
2275 a different interval, start a new one. */
2276 if (poll_timer
== NULL
2277 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2279 EMACS_TIME interval
;
2282 cancel_atimer (poll_timer
);
2284 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2285 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2286 poll_for_input
, NULL
);
2289 /* Let the timer's callback function poll for input
2290 if this becomes zero. */
2291 --poll_suppress_count
;
2296 /* Nonzero if we are using polling to handle input asynchronously. */
2299 input_polling_used ()
2301 #ifdef POLL_FOR_INPUT
2302 /* XXX This condition was (read_socket_hook && !interrupt_input),
2303 but read_socket_hook is not global anymore. Let's pretend that
2305 return !interrupt_input
;
2311 /* Turn off polling. */
2316 #ifdef POLL_FOR_INPUT
2317 /* XXX This condition was (read_socket_hook && !interrupt_input),
2318 but read_socket_hook is not global anymore. Let's pretend that
2320 if (!interrupt_input
)
2321 ++poll_suppress_count
;
2325 /* Set the value of poll_suppress_count to COUNT
2326 and start or stop polling accordingly. */
2329 set_poll_suppress_count (count
)
2332 #ifdef POLL_FOR_INPUT
2333 if (count
== 0 && poll_suppress_count
!= 0)
2335 poll_suppress_count
= 1;
2338 else if (count
!= 0 && poll_suppress_count
== 0)
2342 poll_suppress_count
= count
;
2346 /* Bind polling_period to a value at least N.
2347 But don't decrease it. */
2350 bind_polling_period (n
)
2353 #ifdef POLL_FOR_INPUT
2354 int new = polling_period
;
2359 stop_other_atimers (poll_timer
);
2361 specbind (Qpolling_period
, make_number (new));
2362 /* Start a new alarm with the new period. */
2367 /* Apply the control modifier to CHARACTER. */
2373 /* Save the upper bits here. */
2374 int upper
= c
& ~0177;
2378 /* Everything in the columns containing the upper-case letters
2379 denotes a control character. */
2380 if (c
>= 0100 && c
< 0140)
2384 /* Set the shift modifier for a control char
2385 made from a shifted letter. But only for letters! */
2386 if (oc
>= 'A' && oc
<= 'Z')
2387 c
|= shift_modifier
;
2390 /* The lower-case letters denote control characters too. */
2391 else if (c
>= 'a' && c
<= 'z')
2394 /* Include the bits for control and shift
2395 only if the basic ASCII code can't indicate them. */
2399 /* Replace the high bits. */
2400 c
|= (upper
& ~ctrl_modifier
);
2405 /* Display the help-echo property of the character after the mouse pointer.
2406 Either show it in the echo area, or call show-help-function to display
2407 it by other means (maybe in a tooltip).
2409 If HELP is nil, that means clear the previous help echo.
2411 If HELP is a string, display that string. If HELP is a function,
2412 call it with OBJECT and POS as arguments; the function should
2413 return a help string or nil for none. For all other types of HELP,
2414 evaluate it to obtain a string.
2416 WINDOW is the window in which the help was generated, if any.
2417 It is nil if not in a window.
2419 If OBJECT is a buffer, POS is the position in the buffer where the
2420 `help-echo' text property was found.
2422 If OBJECT is an overlay, that overlay has a `help-echo' property,
2423 and POS is the position in the overlay's buffer under the mouse.
2425 If OBJECT is a string (an overlay string or a string displayed with
2426 the `display' property). POS is the position in that string under
2429 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2430 echo overwrites a keystroke echo currently displayed in the echo
2433 Note: this function may only be called with HELP nil or a string
2434 from X code running asynchronously. */
2437 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2438 Lisp_Object help
, window
, object
, pos
;
2439 int ok_to_overwrite_keystroke_echo
;
2441 if (!NILP (help
) && !STRINGP (help
))
2443 if (FUNCTIONP (help
))
2445 Lisp_Object args
[4];
2450 help
= safe_call (4, args
);
2453 help
= safe_eval (help
);
2455 if (!STRINGP (help
))
2460 if (!noninteractive
&& STRINGP (help
))
2462 /* The mouse-fixup-help-message Lisp function can call
2463 mouse_position_hook, which resets the mouse_moved flags.
2464 This causes trouble if we are trying to read a mouse motion
2465 event (i.e., if we are inside a `track-mouse' form), so we
2466 restore the mouse_moved flag. */
2467 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2468 help
= call1 (Qmouse_fixup_help_message
, help
);
2474 if (STRINGP (help
) || NILP (help
))
2476 if (!NILP (Vshow_help_function
))
2477 call1 (Vshow_help_function
, help
);
2478 else if (/* Don't overwrite minibuffer contents. */
2479 !MINI_WINDOW_P (XWINDOW (selected_window
))
2480 /* Don't overwrite a keystroke echo. */
2481 && (NILP (echo_message_buffer
)
2482 || ok_to_overwrite_keystroke_echo
)
2483 /* Don't overwrite a prompt. */
2484 && !cursor_in_echo_area
)
2488 int count
= SPECPDL_INDEX ();
2490 if (!help_echo_showing_p
)
2491 Vpre_help_message
= current_message ();
2493 specbind (Qmessage_truncate_lines
, Qt
);
2494 message3_nolog (help
, SBYTES (help
),
2495 STRING_MULTIBYTE (help
));
2496 unbind_to (count
, Qnil
);
2498 else if (STRINGP (Vpre_help_message
))
2500 message3_nolog (Vpre_help_message
,
2501 SBYTES (Vpre_help_message
),
2502 STRING_MULTIBYTE (Vpre_help_message
));
2503 Vpre_help_message
= Qnil
;
2509 help_echo_showing_p
= STRINGP (help
);
2515 /* Input of single characters from keyboard */
2517 Lisp_Object
print_help ();
2518 static Lisp_Object
kbd_buffer_get_event ();
2519 static void record_char ();
2521 #define STOP_POLLING \
2522 do { if (! polling_stopped_here) stop_polling (); \
2523 polling_stopped_here = 1; } while (0)
2525 #define RESUME_POLLING \
2526 do { if (polling_stopped_here) start_polling (); \
2527 polling_stopped_here = 0; } while (0)
2529 /* read a character from the keyboard; call the redisplay if needed */
2530 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2531 -1 means do not do redisplay, but do do autosaving.
2534 /* The arguments MAPS and NMAPS are for menu prompting.
2535 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2537 PREV_EVENT is the previous input event, or nil if we are reading
2538 the first event of a key sequence (or not reading a key sequence).
2539 If PREV_EVENT is t, that is a "magic" value that says
2540 not to run input methods, but in other respects to act as if
2541 not reading a key sequence.
2543 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2544 if we used a mouse menu to read the input, or zero otherwise. If
2545 USED_MOUSE_MENU is null, we don't dereference it.
2547 Value is -2 when we find input on another keyboard. A second call
2548 to read_char will read it.
2550 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2551 specifying the maximum time to wait until. If no input arrives by
2552 that time, stop waiting and return nil.
2554 Value is t if we showed a menu and the user rejected it. */
2557 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2561 Lisp_Object prev_event
;
2562 int *used_mouse_menu
;
2563 EMACS_TIME
*end_time
;
2565 volatile Lisp_Object c
;
2566 int count
, jmpcount
;
2567 jmp_buf local_getcjmp
;
2569 volatile int key_already_recorded
= 0;
2570 Lisp_Object tem
, save
;
2571 volatile Lisp_Object previous_echo_area_message
;
2572 volatile Lisp_Object also_record
;
2573 volatile int reread
;
2574 struct gcpro gcpro1
, gcpro2
;
2575 int polling_stopped_here
= 0;
2576 struct kboard
*orig_kboard
= current_kboard
;
2580 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2581 before_command_key_count
= this_command_key_count
;
2582 before_command_echo_length
= echo_length ();
2585 previous_echo_area_message
= Qnil
;
2587 GCPRO2 (c
, previous_echo_area_message
);
2592 if (CONSP (Vunread_post_input_method_events
))
2594 c
= XCAR (Vunread_post_input_method_events
);
2595 Vunread_post_input_method_events
2596 = XCDR (Vunread_post_input_method_events
);
2598 /* Undo what read_char_x_menu_prompt did when it unread
2599 additional keys returned by Fx_popup_menu. */
2601 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2609 if (unread_command_char
!= -1)
2611 XSETINT (c
, unread_command_char
);
2612 unread_command_char
= -1;
2618 if (CONSP (Vunread_command_events
))
2620 c
= XCAR (Vunread_command_events
);
2621 Vunread_command_events
= XCDR (Vunread_command_events
);
2625 /* Undo what sit-for did when it unread additional keys
2626 inside universal-argument. */
2629 && EQ (XCAR (c
), Qt
))
2635 /* Undo what read_char_x_menu_prompt did when it unread
2636 additional keys returned by Fx_popup_menu. */
2638 && EQ (XCDR (c
), Qdisabled
)
2639 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2642 /* If the queued event is something that used the mouse,
2643 set used_mouse_menu accordingly. */
2645 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2646 *used_mouse_menu
= 1;
2648 goto reread_for_input_method
;
2651 if (CONSP (Vunread_input_method_events
))
2653 c
= XCAR (Vunread_input_method_events
);
2654 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2656 /* Undo what read_char_x_menu_prompt did when it unread
2657 additional keys returned by Fx_popup_menu. */
2659 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2663 goto reread_for_input_method
;
2666 this_command_key_count_reset
= 0;
2668 if (!NILP (Vexecuting_kbd_macro
))
2670 /* We set this to Qmacro; since that's not a frame, nobody will
2671 try to switch frames on us, and the selected window will
2674 Since this event came from a macro, it would be misleading to
2675 leave internal_last_event_frame set to wherever the last
2676 real event came from. Normally, a switch-frame event selects
2677 internal_last_event_frame after each command is read, but
2678 events read from a macro should never cause a new frame to be
2680 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2682 /* Exit the macro if we are at the end.
2683 Also, some things replace the macro with t
2684 to force an early exit. */
2685 if (EQ (Vexecuting_kbd_macro
, Qt
)
2686 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2692 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2693 if (STRINGP (Vexecuting_kbd_macro
)
2694 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2695 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2697 executing_kbd_macro_index
++;
2702 if (!NILP (unread_switch_frame
))
2704 c
= unread_switch_frame
;
2705 unread_switch_frame
= Qnil
;
2707 /* This event should make it into this_command_keys, and get echoed
2708 again, so we do not set `reread'. */
2712 /* if redisplay was requested */
2713 if (commandflag
>= 0)
2715 /* If there is pending input, process any events which are not
2716 user-visible, such as X selection_request events. */
2718 || detect_input_pending_run_timers (0))
2719 swallow_events (0); /* may clear input_pending */
2721 /* Redisplay if no pending input. */
2722 while (!input_pending
)
2724 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2725 redisplay_preserve_echo_area (5);
2730 /* Normal case: no input arrived during redisplay. */
2733 /* Input arrived and pre-empted redisplay.
2734 Process any events which are not user-visible. */
2736 /* If that cleared input_pending, try again to redisplay. */
2740 /* Message turns off echoing unless more keystrokes turn it on again.
2742 The code in 20.x for the condition was
2744 1. echo_area_glyphs && *echo_area_glyphs
2745 2. && echo_area_glyphs != current_kboard->echobuf
2746 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2748 (1) means there's a current message displayed
2750 (2) means it's not the message from echoing from the current
2753 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2754 is set to a non-null value. This is done in read_char and it is
2755 set to echo_area_glyphs after a call to echo_char. That means
2756 ok_to_echo_at_next_pause is either null or
2757 current_kboard->echobuf with the appropriate current_kboard at
2760 So, condition (3) means in clear text ok_to_echo_at_next_pause
2761 must be either null, or the current message isn't from echoing at
2762 all, or it's from echoing from a different kboard than the
2765 if (/* There currently is something in the echo area. */
2766 !NILP (echo_area_buffer
[0])
2767 && (/* And it's either not from echoing. */
2768 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2769 /* Or it's an echo from a different kboard. */
2770 || echo_kboard
!= current_kboard
2771 /* Or we explicitly allow overwriting whatever there is. */
2772 || ok_to_echo_at_next_pause
== NULL
))
2777 /* Try reading a character via menu prompting in the minibuf.
2778 Try this before the sit-for, because the sit-for
2779 would do the wrong thing if we are supposed to do
2780 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2781 after a mouse event so don't try a minibuf menu. */
2783 if (nmaps
> 0 && INTERACTIVE
2784 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2785 /* Don't bring up a menu if we already have another event. */
2786 && NILP (Vunread_command_events
)
2787 && unread_command_char
< 0
2788 && !detect_input_pending_run_timers (0))
2790 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2792 if (INTEGERP (c
) && XINT (c
) == -2)
2793 return c
; /* wrong_kboard_jmpbuf */
2797 key_already_recorded
= 1;
2802 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2803 We will do that below, temporarily for short sections of code,
2804 when appropriate. local_getcjmp must be in effect
2805 around any call to sit_for or kbd_buffer_get_event;
2806 it *must not* be in effect when we call redisplay. */
2808 jmpcount
= SPECPDL_INDEX ();
2809 if (_setjmp (local_getcjmp
))
2811 /* Handle quits while reading the keyboard. */
2812 /* We must have saved the outer value of getcjmp here,
2813 so restore it now. */
2814 restore_getcjmp (save_jump
);
2815 unbind_to (jmpcount
, Qnil
);
2816 XSETINT (c
, quit_char
);
2817 internal_last_event_frame
= selected_frame
;
2818 Vlast_event_frame
= internal_last_event_frame
;
2819 /* If we report the quit char as an event,
2820 don't do so more than once. */
2821 if (!NILP (Vinhibit_quit
))
2826 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2827 if (kb
!= current_kboard
)
2829 Lisp_Object link
= kb
->kbd_queue
;
2830 /* We shouldn't get here if we were in single-kboard mode! */
2835 while (CONSP (XCDR (link
)))
2837 if (!NILP (XCDR (link
)))
2841 kb
->kbd_queue
= Fcons (c
, Qnil
);
2843 XSETCDR (link
, Fcons (c
, Qnil
));
2844 kb
->kbd_queue_has_data
= 1;
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 return make_number (-2); /* wrong_kboard_jmpbuf */
2856 /* Start idle timers if no time limit is supplied. We don't do it
2857 if a time limit is supplied to avoid an infinite recursion in the
2858 situation where an idle timer calls `sit-for'. */
2861 timer_start_idle ();
2863 /* If in middle of key sequence and minibuffer not active,
2864 start echoing if enough time elapses. */
2866 if (minibuf_level
== 0
2868 && !current_kboard
->immediate_echo
2869 && this_command_key_count
> 0
2871 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2872 && NILP (Fzerop (Vecho_keystrokes
))
2873 && (/* No message. */
2874 NILP (echo_area_buffer
[0])
2875 /* Or empty message. */
2876 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2877 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2878 /* Or already echoing from same kboard. */
2879 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2880 /* Or not echoing before and echoing allowed. */
2881 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2883 /* After a mouse event, start echoing right away.
2884 This is because we are probably about to display a menu,
2885 and we don't want to delay before doing so. */
2886 if (EVENT_HAS_PARAMETERS (prev_event
))
2892 save_getcjmp (save_jump
);
2893 restore_getcjmp (local_getcjmp
);
2894 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2895 restore_getcjmp (save_jump
);
2897 && ! CONSP (Vunread_command_events
))
2902 /* Maybe auto save due to number of keystrokes. */
2904 if (commandflag
!= 0
2905 && auto_save_interval
> 0
2906 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2907 && !detect_input_pending_run_timers (0))
2909 Fdo_auto_save (Qnil
, Qnil
);
2910 /* Hooks can actually change some buffers in auto save. */
2914 /* Try reading using an X menu.
2915 This is never confused with reading using the minibuf
2916 because the recursive call of read_char in read_char_minibuf_menu_prompt
2917 does not pass on any keymaps. */
2919 if (nmaps
> 0 && INTERACTIVE
2920 && !NILP (prev_event
)
2921 && EVENT_HAS_PARAMETERS (prev_event
)
2922 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2923 && !EQ (XCAR (prev_event
), Qtool_bar
)
2924 /* Don't bring up a menu if we already have another event. */
2925 && NILP (Vunread_command_events
)
2926 && unread_command_char
< 0)
2928 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2930 /* Now that we have read an event, Emacs is not idle. */
2937 /* Maybe autosave and/or garbage collect due to idleness. */
2939 if (INTERACTIVE
&& NILP (c
))
2941 int delay_level
, buffer_size
;
2943 /* Slow down auto saves logarithmically in size of current buffer,
2944 and garbage collect while we're at it. */
2945 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2946 last_non_minibuf_size
= Z
- BEG
;
2947 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2949 while (buffer_size
> 64)
2950 delay_level
++, buffer_size
-= buffer_size
>> 2;
2951 if (delay_level
< 4) delay_level
= 4;
2952 /* delay_level is 4 for files under around 50k, 7 at 100k,
2953 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2955 /* Auto save if enough time goes by without input. */
2956 if (commandflag
!= 0
2957 && num_nonmacro_input_events
> last_auto_save
2958 && INTEGERP (Vauto_save_timeout
)
2959 && XINT (Vauto_save_timeout
) > 0)
2962 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2964 save_getcjmp (save_jump
);
2965 restore_getcjmp (local_getcjmp
);
2966 tem0
= sit_for (make_number (timeout
), 1, 1);
2967 restore_getcjmp (save_jump
);
2970 && ! CONSP (Vunread_command_events
))
2972 Fdo_auto_save (Qnil
, Qnil
);
2974 /* If we have auto-saved and there is still no input
2975 available, garbage collect if there has been enough
2976 consing going on to make it worthwhile. */
2977 if (!detect_input_pending_run_timers (0)
2978 && consing_since_gc
> gc_cons_threshold
/ 2)
2979 Fgarbage_collect ();
2986 /* Notify the caller if an autosave hook, or a timer, sentinel or
2987 filter in the sit_for calls above have changed the current
2988 kboard. This could happen if they use the minibuffer or start a
2989 recursive edit, like the fancy splash screen in server.el's
2990 filter. If this longjmp wasn't here, read_key_sequence would
2991 interpret the next key sequence using the wrong translation
2992 tables and function keymaps. */
2993 if (NILP (c
) && current_kboard
!= orig_kboard
)
2996 return make_number (-2); /* wrong_kboard_jmpbuf */
2999 /* If this has become non-nil here, it has been set by a timer
3000 or sentinel or filter. */
3001 if (CONSP (Vunread_command_events
))
3003 c
= XCAR (Vunread_command_events
);
3004 Vunread_command_events
= XCDR (Vunread_command_events
);
3007 /* Read something from current KBOARD's side queue, if possible. */
3011 if (current_kboard
->kbd_queue_has_data
)
3013 if (!CONSP (current_kboard
->kbd_queue
))
3015 c
= XCAR (current_kboard
->kbd_queue
);
3016 current_kboard
->kbd_queue
3017 = XCDR (current_kboard
->kbd_queue
);
3018 if (NILP (current_kboard
->kbd_queue
))
3019 current_kboard
->kbd_queue_has_data
= 0;
3020 input_pending
= readable_events (0);
3021 if (EVENT_HAS_PARAMETERS (c
)
3022 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3023 internal_last_event_frame
= XCAR (XCDR (c
));
3024 Vlast_event_frame
= internal_last_event_frame
;
3029 /* If current_kboard's side queue is empty check the other kboards.
3030 If one of them has data that we have not yet seen here,
3031 switch to it and process the data waiting for it.
3033 Note: if the events queued up for another kboard
3034 have already been seen here, and therefore are not a complete command,
3035 the kbd_queue_has_data field is 0, so we skip that kboard here.
3036 That's to avoid an infinite loop switching between kboards here. */
3037 if (NILP (c
) && !single_kboard
)
3040 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3041 if (kb
->kbd_queue_has_data
)
3043 current_kboard
= kb
;
3044 /* This is going to exit from read_char
3045 so we had better get rid of this frame's stuff. */
3047 return make_number (-2); /* wrong_kboard_jmpbuf */
3056 /* Finally, we read from the main queue,
3057 and if that gives us something we can't use yet, we put it on the
3058 appropriate side queue and try again. */
3067 EMACS_GET_TIME (now
);
3068 if (EMACS_TIME_GE (now
, *end_time
))
3072 /* Actually read a character, waiting if necessary. */
3073 save_getcjmp (save_jump
);
3074 restore_getcjmp (local_getcjmp
);
3076 timer_start_idle ();
3077 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3078 restore_getcjmp (save_jump
);
3081 if (! NILP (c
) && (kb
!= current_kboard
))
3083 Lisp_Object link
= kb
->kbd_queue
;
3086 while (CONSP (XCDR (link
)))
3088 if (!NILP (XCDR (link
)))
3092 kb
->kbd_queue
= Fcons (c
, Qnil
);
3094 XSETCDR (link
, Fcons (c
, Qnil
));
3095 kb
->kbd_queue_has_data
= 1;
3099 current_kboard
= kb
;
3100 /* This is going to exit from read_char
3101 so we had better get rid of this frame's stuff. */
3103 return make_number (-2);
3108 /* Terminate Emacs in batch mode if at eof. */
3109 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3110 Fkill_emacs (make_number (1));
3114 /* Add in any extra modifiers, where appropriate. */
3115 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3116 || ((extra_keyboard_modifiers
& 0177) < ' '
3117 && (extra_keyboard_modifiers
& 0177) != 0))
3118 XSETINT (c
, make_ctrl_char (XINT (c
)));
3120 /* Transfer any other modifier bits directly from
3121 extra_keyboard_modifiers to c. Ignore the actual character code
3122 in the low 16 bits of extra_keyboard_modifiers. */
3123 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3134 if (commandflag
>= 0
3135 && !input_pending
&& !detect_input_pending_run_timers (0))
3143 /* Buffer switch events are only for internal wakeups
3144 so don't show them to the user.
3145 Also, don't record a key if we already did. */
3146 if (BUFFERP (c
) || key_already_recorded
)
3149 /* Process special events within read_char
3150 and loop around to read another event. */
3153 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3158 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3159 int was_locked
= single_kboard
;
3160 int count
= SPECPDL_INDEX ();
3161 record_single_kboard_state ();
3164 last_input_char
= c
;
3165 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3167 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3168 /* We stopped being idle for this event; undo that. This
3169 prevents automatic window selection (under
3170 mouse_autoselect_window from acting as a real input event, for
3171 example banishing the mouse under mouse-avoidance-mode. */
3172 timer_resume_idle ();
3174 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3175 /* Resume allowing input from any kboard, if that was true before. */
3177 any_kboard_state ();
3178 unbind_to (count
, Qnil
);
3184 /* Handle things that only apply to characters. */
3187 /* If kbd_buffer_get_event gave us an EOF, return that. */
3191 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3192 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3193 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3194 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3195 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3196 && CHAR_VALID_P (XINT (c
), 0)))
3199 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3200 /* nil in keyboard-translate-table means no translation. */
3206 /* If this event is a mouse click in the menu bar,
3207 return just menu-bar for now. Modify the mouse click event
3208 so we won't do this twice, then queue it up. */
3209 if (EVENT_HAS_PARAMETERS (c
)
3211 && CONSP (EVENT_START (c
))
3212 && CONSP (XCDR (EVENT_START (c
))))
3216 posn
= POSN_POSN (EVENT_START (c
));
3217 /* Handle menu-bar events:
3218 insert the dummy prefix event `menu-bar'. */
3219 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3221 /* Change menu-bar to (menu-bar) as the event "position". */
3222 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3225 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3230 /* Store these characters into recent_keys, the dribble file if any,
3231 and the keyboard macro being defined, if any. */
3233 if (! NILP (also_record
))
3234 record_char (also_record
);
3236 /* Wipe the echo area.
3237 But first, if we are about to use an input method,
3238 save the echo area contents for it to refer to. */
3240 && ! NILP (Vinput_method_function
)
3241 && (unsigned) XINT (c
) >= ' '
3242 && (unsigned) XINT (c
) != 127
3243 && (unsigned) XINT (c
) < 256)
3245 previous_echo_area_message
= Fcurrent_message ();
3246 Vinput_method_previous_message
= previous_echo_area_message
;
3249 /* Now wipe the echo area, except for help events which do their
3250 own stuff with the echo area. */
3252 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3253 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3255 if (!NILP (echo_area_buffer
[0]))
3256 safe_run_hooks (Qecho_area_clear_hook
);
3257 clear_message (1, 0);
3260 reread_for_input_method
:
3262 /* Pass this to the input method, if appropriate. */
3264 && ! NILP (Vinput_method_function
)
3265 /* Don't run the input method within a key sequence,
3266 after the first event of the key sequence. */
3267 && NILP (prev_event
)
3268 && (unsigned) XINT (c
) >= ' '
3269 && (unsigned) XINT (c
) != 127
3270 && (unsigned) XINT (c
) < 256)
3273 int key_count
, key_count_reset
;
3274 struct gcpro gcpro1
;
3275 int count
= SPECPDL_INDEX ();
3277 /* Save the echo status. */
3278 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3279 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3280 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3281 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3284 if (before_command_restore_flag
)
3286 this_command_key_count
= before_command_key_count_1
;
3287 if (this_command_key_count
< this_single_command_key_start
)
3288 this_single_command_key_start
= this_command_key_count
;
3289 echo_truncate (before_command_echo_length_1
);
3290 before_command_restore_flag
= 0;
3294 /* Save the this_command_keys status. */
3295 key_count
= this_command_key_count
;
3296 key_count_reset
= this_command_key_count_reset
;
3299 keys
= Fcopy_sequence (this_command_keys
);
3304 /* Clear out this_command_keys. */
3305 this_command_key_count
= 0;
3306 this_command_key_count_reset
= 0;
3308 /* Now wipe the echo area. */
3309 if (!NILP (echo_area_buffer
[0]))
3310 safe_run_hooks (Qecho_area_clear_hook
);
3311 clear_message (1, 0);
3314 /* If we are not reading a key sequence,
3315 never use the echo area. */
3318 specbind (Qinput_method_use_echo_area
, Qt
);
3321 /* Call the input method. */
3322 tem
= call1 (Vinput_method_function
, c
);
3324 tem
= unbind_to (count
, tem
);
3326 /* Restore the saved echoing state
3327 and this_command_keys state. */
3328 this_command_key_count
= key_count
;
3329 this_command_key_count_reset
= key_count_reset
;
3331 this_command_keys
= keys
;
3334 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3335 current_kboard
->echo_string
= saved_echo_string
;
3336 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3337 if (saved_immediate_echo
)
3342 /* The input method can return no events. */
3345 /* Bring back the previous message, if any. */
3346 if (! NILP (previous_echo_area_message
))
3347 message_with_string ("%s", previous_echo_area_message
, 0);
3350 /* It returned one event or more. */
3352 Vunread_post_input_method_events
3353 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3358 /* Display help if not echoing. */
3359 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3361 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3362 Lisp_Object help
, object
, position
, window
, tem
;
3364 tem
= Fcdr (XCDR (c
));
3367 window
= Fcar (tem
);
3369 object
= Fcar (tem
);
3371 position
= Fcar (tem
);
3373 show_help_echo (help
, window
, object
, position
, 0);
3375 /* We stopped being idle for this event; undo that. */
3377 timer_resume_idle ();
3381 if ((! reread
|| this_command_key_count
== 0
3382 || this_command_key_count_reset
)
3386 /* Don't echo mouse motion events. */
3387 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3388 && NILP (Fzerop (Vecho_keystrokes
))
3389 && ! (EVENT_HAS_PARAMETERS (c
)
3390 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3393 if (! NILP (also_record
))
3394 echo_char (also_record
);
3395 /* Once we reread a character, echoing can happen
3396 the next time we pause to read a new one. */
3397 ok_to_echo_at_next_pause
= current_kboard
;
3400 /* Record this character as part of the current key. */
3401 add_command_key (c
);
3402 if (! NILP (also_record
))
3403 add_command_key (also_record
);
3406 last_input_char
= c
;
3409 /* Process the help character specially if enabled */
3410 if (!NILP (Vhelp_form
) && help_char_p (c
))
3413 count
= SPECPDL_INDEX ();
3415 record_unwind_protect (Fset_window_configuration
,
3416 Fcurrent_window_configuration (Qnil
));
3418 tem0
= Feval (Vhelp_form
);
3420 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3424 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3425 while (BUFFERP (c
));
3426 /* Remove the help from the frame */
3427 unbind_to (count
, Qnil
);
3430 if (EQ (c
, make_number (040)))
3434 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3435 while (BUFFERP (c
));
3444 /* Record a key that came from a mouse menu.
3445 Record it for echoing, for this-command-keys, and so on. */
3451 /* Wipe the echo area. */
3452 clear_message (1, 0);
3457 before_command_key_count
= this_command_key_count
;
3458 before_command_echo_length
= echo_length ();
3461 /* Don't echo mouse motion events. */
3462 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3463 && NILP (Fzerop (Vecho_keystrokes
)))
3467 /* Once we reread a character, echoing can happen
3468 the next time we pause to read a new one. */
3469 ok_to_echo_at_next_pause
= 0;
3472 /* Record this character as part of the current key. */
3473 add_command_key (c
);
3475 /* Re-reading in the middle of a command */
3476 last_input_char
= c
;
3480 /* Return 1 if should recognize C as "the help character". */
3488 if (EQ (c
, Vhelp_char
))
3490 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3491 if (EQ (c
, XCAR (tail
)))
3496 /* Record the input event C in various ways. */
3504 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3506 /* To avoid filling recent_keys with help-echo and mouse-movement
3507 events, we filter out repeated help-echo events, only store the
3508 first and last in a series of mouse-movement events, and don't
3509 store repeated help-echo events which are only separated by
3510 mouse-movement events. */
3512 Lisp_Object ev1
, ev2
, ev3
;
3515 if ((ix1
= recent_keys_index
- 1) < 0)
3516 ix1
= NUM_RECENT_KEYS
- 1;
3517 ev1
= AREF (recent_keys
, ix1
);
3519 if ((ix2
= ix1
- 1) < 0)
3520 ix2
= NUM_RECENT_KEYS
- 1;
3521 ev2
= AREF (recent_keys
, ix2
);
3523 if ((ix3
= ix2
- 1) < 0)
3524 ix3
= NUM_RECENT_KEYS
- 1;
3525 ev3
= AREF (recent_keys
, ix3
);
3527 if (EQ (XCAR (c
), Qhelp_echo
))
3529 /* Don't record `help-echo' in recent_keys unless it shows some help
3530 message, and a different help than the previously recorded
3532 Lisp_Object help
, last_help
;
3534 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3535 if (!STRINGP (help
))
3537 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3538 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3540 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3541 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3542 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3544 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3545 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3546 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3547 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3550 else if (EQ (XCAR (c
), Qmouse_movement
))
3552 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3553 So additional mouse movement events replace the last element. */
3554 Lisp_Object last_window
, window
;
3556 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3557 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3558 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3559 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3560 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3562 ASET (recent_keys
, ix1
, c
);
3568 store_kbd_macro_char (c
);
3573 ASET (recent_keys
, recent_keys_index
, c
);
3574 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3575 recent_keys_index
= 0;
3577 else if (recorded
< 0)
3579 /* We need to remove one or two events from recent_keys.
3580 To do this, we simply put nil at those events and move the
3581 recent_keys_index backwards over those events. Usually,
3582 users will never see those nil events, as they will be
3583 overwritten by the command keys entered to see recent_keys
3586 while (recorded
++ < 0 && total_keys
> 0)
3588 if (total_keys
< NUM_RECENT_KEYS
)
3590 if (--recent_keys_index
< 0)
3591 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3592 ASET (recent_keys
, recent_keys_index
, Qnil
);
3596 num_nonmacro_input_events
++;
3598 /* Write c to the dribble file. If c is a lispy event, write
3599 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3600 If you, dear reader, have a better idea, you've got the source. :-) */
3605 if (XUINT (c
) < 0x100)
3606 putc (XINT (c
), dribble
);
3608 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3612 Lisp_Object dribblee
;
3614 /* If it's a structured event, take the event header. */
3615 dribblee
= EVENT_HEAD (c
);
3617 if (SYMBOLP (dribblee
))
3619 putc ('<', dribble
);
3620 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3621 SBYTES (SYMBOL_NAME (dribblee
)),
3623 putc ('>', dribble
);
3635 struct buffer
*old
= current_buffer
;
3636 Fprinc (object
, Qnil
);
3637 set_buffer_internal (XBUFFER (Vstandard_output
));
3638 call0 (intern ("help-mode"));
3639 set_buffer_internal (old
);
3643 /* Copy out or in the info on where C-g should throw to.
3644 This is used when running Lisp code from within get_char,
3645 in case get_char is called recursively.
3646 See read_process_output. */
3652 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3656 restore_getcjmp (temp
)
3659 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3662 /* Low level keyboard/mouse input.
3663 kbd_buffer_store_event places events in kbd_buffer, and
3664 kbd_buffer_get_event retrieves them. */
3666 /* Return true iff there are any events in the queue that read-char
3667 would return. If this returns false, a read-char would block. */
3669 readable_events (flags
)
3672 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3675 /* If the buffer contains only FOCUS_IN_EVENT events, and
3676 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3677 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3679 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3680 #ifdef USE_TOOLKIT_SCROLL_BARS
3681 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3685 struct input_event
*event
;
3687 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3694 #ifdef USE_TOOLKIT_SCROLL_BARS
3695 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3697 event
->kind
== FOCUS_IN_EVENT
)
3698 #ifdef USE_TOOLKIT_SCROLL_BARS
3699 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3700 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3701 && event
->part
== scroll_bar_handle
3702 && event
->modifiers
== 0)
3707 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3710 while (event
!= kbd_store_ptr
);
3717 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3718 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3723 if (current_kboard
->kbd_queue_has_data
)
3729 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3730 if (kb
->kbd_queue_has_data
)
3736 /* Set this for debugging, to have a way to get out */
3741 event_to_kboard (event
)
3742 struct input_event
*event
;
3745 frame
= event
->frame_or_window
;
3747 frame
= XCAR (frame
);
3748 else if (WINDOWP (frame
))
3749 frame
= WINDOW_FRAME (XWINDOW (frame
));
3751 /* There are still some events that don't set this field.
3752 For now, just ignore the problem.
3753 Also ignore dead frames here. */
3754 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3757 return FRAME_KBOARD (XFRAME (frame
));
3762 Lisp_Object Vthrow_on_input
;
3764 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3767 kbd_buffer_store_event (event
)
3768 register struct input_event
*event
;
3770 kbd_buffer_store_event_hold (event
, 0);
3773 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3775 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3776 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3777 Else, if EVENT is a quit event, store the quit event
3778 in HOLD_QUIT, and return (thus ignoring further events).
3780 This is used in read_avail_input to postpone the processing
3781 of the quit event until all subsequent input events have been
3782 parsed (and discarded).
3786 kbd_buffer_store_event_hold (event
, hold_quit
)
3787 register struct input_event
*event
;
3788 struct input_event
*hold_quit
;
3790 if (event
->kind
== NO_EVENT
)
3793 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3796 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3798 register int c
= event
->code
& 0377;
3800 if (event
->modifiers
& ctrl_modifier
)
3801 c
= make_ctrl_char (c
);
3803 c
|= (event
->modifiers
3804 & (meta_modifier
| alt_modifier
3805 | hyper_modifier
| super_modifier
));
3810 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3811 struct input_event
*sp
;
3813 if (single_kboard
&& kb
!= current_kboard
)
3816 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3817 Fcons (make_number (c
), Qnil
));
3818 kb
->kbd_queue_has_data
= 1;
3819 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3821 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3824 if (event_to_kboard (sp
) == kb
)
3826 sp
->kind
= NO_EVENT
;
3827 sp
->frame_or_window
= Qnil
;
3837 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3841 /* If this results in a quit_char being returned to Emacs as
3842 input, set Vlast_event_frame properly. If this doesn't
3843 get returned to Emacs as an event, the next event read
3844 will set Vlast_event_frame again, so this is safe to do. */
3848 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3850 focus
= event
->frame_or_window
;
3851 internal_last_event_frame
= focus
;
3852 Vlast_event_frame
= focus
;
3855 last_event_timestamp
= event
->timestamp
;
3856 handle_interrupt ();
3860 if (c
&& c
== stop_character
)
3866 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3867 Just ignore the second one. */
3868 else if (event
->kind
== BUFFER_SWITCH_EVENT
3869 && kbd_fetch_ptr
!= kbd_store_ptr
3870 && ((kbd_store_ptr
== kbd_buffer
3871 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3872 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3875 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3876 kbd_store_ptr
= kbd_buffer
;
3878 /* Don't let the very last slot in the buffer become full,
3879 since that would make the two pointers equal,
3880 and that is indistinguishable from an empty buffer.
3881 Discard the event if it would fill the last slot. */
3882 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3884 *kbd_store_ptr
= *event
;
3888 /* If we're inside while-no-input, and this event qualifies
3889 as input, set quit-flag to cause an interrupt. */
3890 if (!NILP (Vthrow_on_input
)
3891 && event
->kind
!= FOCUS_IN_EVENT
3892 && event
->kind
!= HELP_EVENT
3893 && event
->kind
!= DEICONIFY_EVENT
)
3895 Vquit_flag
= Vthrow_on_input
;
3896 /* If we're inside a function that wants immediate quits,
3898 if (immediate_quit
&& NILP (Vinhibit_quit
))
3908 /* Put an input event back in the head of the event queue. */
3911 kbd_buffer_unget_event (event
)
3912 register struct input_event
*event
;
3914 if (kbd_fetch_ptr
== kbd_buffer
)
3915 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3917 /* Don't let the very last slot in the buffer become full, */
3918 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3921 *kbd_fetch_ptr
= *event
;
3926 /* Generate HELP_EVENT input_events in BUFP which has room for
3927 SIZE events. If there's not enough room in BUFP, ignore this
3930 HELP is the help form.
3932 FRAME is the frame on which the help is generated. OBJECT is the
3933 Lisp object where the help was found (a buffer, a string, an
3934 overlay, or nil if neither from a string nor from a buffer. POS is
3935 the position within OBJECT where the help was found.
3937 Value is the number of input_events generated. */
3940 gen_help_event (help
, frame
, window
, object
, pos
)
3941 Lisp_Object help
, frame
, object
, window
;
3944 struct input_event event
;
3948 event
.kind
= HELP_EVENT
;
3949 event
.frame_or_window
= frame
;
3951 event
.x
= WINDOWP (window
) ? window
: frame
;
3954 kbd_buffer_store_event (&event
);
3958 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3961 kbd_buffer_store_help_event (frame
, help
)
3962 Lisp_Object frame
, help
;
3964 struct input_event event
;
3966 event
.kind
= HELP_EVENT
;
3967 event
.frame_or_window
= frame
;
3972 kbd_buffer_store_event (&event
);
3976 /* Discard any mouse events in the event buffer by setting them to
3979 discard_mouse_events ()
3981 struct input_event
*sp
;
3982 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3984 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3987 if (sp
->kind
== MOUSE_CLICK_EVENT
3988 || sp
->kind
== WHEEL_EVENT
3990 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3992 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3994 sp
->kind
= NO_EVENT
;
4000 /* Return non-zero if there are any real events waiting in the event
4001 buffer, not counting `NO_EVENT's.
4003 If DISCARD is non-zero, discard NO_EVENT events at the front of
4004 the input queue, possibly leaving the input queue empty if there
4005 are no real input events. */
4008 kbd_buffer_events_waiting (discard
)
4011 struct input_event
*sp
;
4013 for (sp
= kbd_fetch_ptr
;
4014 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4017 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4024 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4028 /* Clear input event EVENT. */
4032 struct input_event
*event
;
4034 event
->kind
= NO_EVENT
;
4038 /* Read one event from the event buffer, waiting if necessary.
4039 The value is a Lisp object representing the event.
4040 The value is nil for an event that should be ignored,
4041 or that was handled here.
4042 We always read and discard one event. */
4045 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4047 int *used_mouse_menu
;
4048 EMACS_TIME
*end_time
;
4057 *kbp
= current_kboard
;
4061 /* Wait until there is input available. */
4064 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4067 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4071 /* If the quit flag is set, then read_char will return
4072 quit_char, so that counts as "available input." */
4073 if (!NILP (Vquit_flag
))
4074 quit_throw_to_read_char ();
4076 /* One way or another, wait until input is available; then, if
4077 interrupt handlers have not read it, read it now. */
4080 wait_for_kbd_input ();
4082 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4086 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4089 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4094 EMACS_TIME duration
;
4095 EMACS_GET_TIME (duration
);
4096 if (EMACS_TIME_GE (duration
, *end_time
))
4097 return Qnil
; /* finished waiting */
4100 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4101 wait_reading_process_output (EMACS_SECS (duration
),
4102 EMACS_USECS (duration
),
4103 -1, 1, Qnil
, NULL
, 0);
4107 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4109 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4110 /* Pass 1 for EXPECT since we just waited to have input. */
4111 read_avail_input (1);
4112 #endif /* not VMS */
4115 if (CONSP (Vunread_command_events
))
4118 first
= XCAR (Vunread_command_events
);
4119 Vunread_command_events
= XCDR (Vunread_command_events
);
4120 *kbp
= current_kboard
;
4124 /* At this point, we know that there is a readable event available
4125 somewhere. If the event queue is empty, then there must be a
4126 mouse movement enabled and available. */
4127 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4129 struct input_event
*event
;
4131 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4135 last_event_timestamp
= event
->timestamp
;
4138 *kbp
= event_to_kboard (event
);
4140 *kbp
= current_kboard
; /* Better than returning null ptr? */
4142 *kbp
= &the_only_kboard
;
4147 /* These two kinds of events get special handling
4148 and don't actually appear to the command loop.
4149 We return nil for them. */
4150 if (event
->kind
== SELECTION_REQUEST_EVENT
4151 || event
->kind
== SELECTION_CLEAR_EVENT
)
4154 struct input_event copy
;
4156 /* Remove it from the buffer before processing it,
4157 since otherwise swallow_events will see it
4158 and process it again. */
4160 kbd_fetch_ptr
= event
+ 1;
4161 input_pending
= readable_events (0);
4162 x_handle_selection_event (©
);
4164 /* We're getting selection request events, but we don't have
4170 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4171 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4173 /* Make an event (delete-frame (FRAME)). */
4174 obj
= Fcons (event
->frame_or_window
, Qnil
);
4175 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4176 kbd_fetch_ptr
= event
+ 1;
4179 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4180 else if (event
->kind
== ICONIFY_EVENT
)
4182 /* Make an event (iconify-frame (FRAME)). */
4183 obj
= Fcons (event
->frame_or_window
, Qnil
);
4184 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4185 kbd_fetch_ptr
= event
+ 1;
4187 else if (event
->kind
== DEICONIFY_EVENT
)
4189 /* Make an event (make-frame-visible (FRAME)). */
4190 obj
= Fcons (event
->frame_or_window
, Qnil
);
4191 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4192 kbd_fetch_ptr
= event
+ 1;
4195 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4197 /* The value doesn't matter here; only the type is tested. */
4198 XSETBUFFER (obj
, current_buffer
);
4199 kbd_fetch_ptr
= event
+ 1;
4201 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4202 || defined (USE_GTK)
4203 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4205 kbd_fetch_ptr
= event
+ 1;
4206 input_pending
= readable_events (0);
4207 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4208 x_activate_menubar (XFRAME (event
->frame_or_window
));
4211 #if defined (WINDOWSNT) || defined (MAC_OS)
4212 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4215 /* Make an event (language-change (KEY_SCRIPT)). */
4216 obj
= Fcons (make_number (event
->code
), Qnil
);
4218 /* Make an event (language-change (FRAME CHARSET LCID)). */
4219 obj
= Fcons (event
->frame_or_window
, Qnil
);
4221 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4222 kbd_fetch_ptr
= event
+ 1;
4225 else if (event
->kind
== SAVE_SESSION_EVENT
)
4227 obj
= Fcons (Qsave_session
, Qnil
);
4228 kbd_fetch_ptr
= event
+ 1;
4230 /* Just discard these, by returning nil.
4231 With MULTI_KBOARD, these events are used as placeholders
4232 when we need to randomly delete events from the queue.
4233 (They shouldn't otherwise be found in the buffer,
4234 but on some machines it appears they do show up
4235 even without MULTI_KBOARD.) */
4236 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4237 mouse events during a popup-menu call. */
4238 else if (event
->kind
== NO_EVENT
)
4239 kbd_fetch_ptr
= event
+ 1;
4240 else if (event
->kind
== HELP_EVENT
)
4242 Lisp_Object object
, position
, help
, frame
, window
;
4244 frame
= event
->frame_or_window
;
4245 object
= event
->arg
;
4246 position
= make_number (event
->code
);
4249 clear_event (event
);
4251 kbd_fetch_ptr
= event
+ 1;
4252 if (!WINDOWP (window
))
4254 obj
= Fcons (Qhelp_echo
,
4255 list5 (frame
, help
, window
, object
, position
));
4257 else if (event
->kind
== FOCUS_IN_EVENT
)
4259 /* Notification of a FocusIn event. The frame receiving the
4260 focus is in event->frame_or_window. Generate a
4261 switch-frame event if necessary. */
4262 Lisp_Object frame
, focus
;
4264 frame
= event
->frame_or_window
;
4265 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4269 if (!EQ (frame
, internal_last_event_frame
)
4270 && !EQ (frame
, selected_frame
))
4271 obj
= make_lispy_switch_frame (frame
);
4272 internal_last_event_frame
= frame
;
4273 kbd_fetch_ptr
= event
+ 1;
4277 /* If this event is on a different frame, return a switch-frame this
4278 time, and leave the event in the queue for next time. */
4282 frame
= event
->frame_or_window
;
4284 frame
= XCAR (frame
);
4285 else if (WINDOWP (frame
))
4286 frame
= WINDOW_FRAME (XWINDOW (frame
));
4288 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4292 if (! EQ (frame
, internal_last_event_frame
)
4293 && !EQ (frame
, selected_frame
))
4294 obj
= make_lispy_switch_frame (frame
);
4295 internal_last_event_frame
= frame
;
4297 /* If we didn't decide to make a switch-frame event, go ahead
4298 and build a real event from the queue entry. */
4302 obj
= make_lispy_event (event
);
4304 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4305 || defined (USE_GTK)
4306 /* If this was a menu selection, then set the flag to inhibit
4307 writing to last_nonmenu_event. Don't do this if the event
4308 we're returning is (menu-bar), though; that indicates the
4309 beginning of the menu sequence, and we might as well leave
4310 that as the `event with parameters' for this selection. */
4312 && !EQ (event
->frame_or_window
, event
->arg
)
4313 && (event
->kind
== MENU_BAR_EVENT
4314 || event
->kind
== TOOL_BAR_EVENT
))
4315 *used_mouse_menu
= 1;
4318 /* Wipe out this event, to catch bugs. */
4319 clear_event (event
);
4320 kbd_fetch_ptr
= event
+ 1;
4325 /* Try generating a mouse motion event. */
4326 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4328 FRAME_PTR f
= some_mouse_moved ();
4329 Lisp_Object bar_window
;
4330 enum scroll_bar_part part
;
4334 *kbp
= current_kboard
;
4335 /* Note that this uses F to determine which terminal to look at.
4336 If there is no valid info, it does not store anything
4337 so x remains nil. */
4340 /* XXX Can f or mouse_position_hook be NULL here? */
4341 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4342 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4343 &part
, &x
, &y
, &time
);
4347 /* Decide if we should generate a switch-frame event. Don't
4348 generate switch-frame events for motion outside of all Emacs
4354 frame
= FRAME_FOCUS_FRAME (f
);
4356 XSETFRAME (frame
, f
);
4358 if (! EQ (frame
, internal_last_event_frame
)
4359 && !EQ (frame
, selected_frame
))
4360 obj
= make_lispy_switch_frame (frame
);
4361 internal_last_event_frame
= frame
;
4364 /* If we didn't decide to make a switch-frame event, go ahead and
4365 return a mouse-motion event. */
4366 if (!NILP (x
) && NILP (obj
))
4367 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4369 #endif /* HAVE_MOUSE */
4371 /* We were promised by the above while loop that there was
4372 something for us to read! */
4375 input_pending
= readable_events (0);
4377 Vlast_event_frame
= internal_last_event_frame
;
4382 /* Process any events that are not user-visible,
4383 then return, without reading any user-visible events. */
4386 swallow_events (do_display
)
4391 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4393 struct input_event
*event
;
4395 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4399 last_event_timestamp
= event
->timestamp
;
4401 /* These two kinds of events get special handling
4402 and don't actually appear to the command loop. */
4403 if (event
->kind
== SELECTION_REQUEST_EVENT
4404 || event
->kind
== SELECTION_CLEAR_EVENT
)
4407 struct input_event copy
;
4409 /* Remove it from the buffer before processing it,
4410 since otherwise swallow_events called recursively could see it
4411 and process it again. */
4413 kbd_fetch_ptr
= event
+ 1;
4414 input_pending
= readable_events (0);
4415 x_handle_selection_event (©
);
4417 /* We're getting selection request events, but we don't have
4426 old_timers_run
= timers_run
;
4427 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4429 if (timers_run
!= old_timers_run
&& do_display
)
4430 redisplay_preserve_echo_area (7);
4433 /* Record the start of when Emacs is idle,
4434 for the sake of running idle-time timers. */
4441 /* If we are already in the idle state, do nothing. */
4442 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4445 EMACS_GET_TIME (timer_idleness_start_time
);
4447 timer_last_idleness_start_time
= timer_idleness_start_time
;
4449 /* Mark all idle-time timers as once again candidates for running. */
4450 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4454 timer
= XCAR (timers
);
4456 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4458 XVECTOR (timer
)->contents
[0] = Qnil
;
4462 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4467 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4470 /* Resume idle timer from last idle start time. */
4473 timer_resume_idle ()
4475 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4478 timer_idleness_start_time
= timer_last_idleness_start_time
;
4481 /* This is only for debugging. */
4482 struct input_event last_timer_event
;
4484 /* Check whether a timer has fired. To prevent larger problems we simply
4485 disregard elements that are not proper timers. Do not make a circular
4486 timer list for the time being.
4488 Returns the number of seconds to wait until the next timer fires. If a
4489 timer is triggering now, return zero seconds.
4490 If no timer is active, return -1 seconds.
4492 If a timer is ripe, we run it, with quitting turned off.
4494 DO_IT_NOW is now ignored. It used to mean that we should
4495 run the timer directly instead of queueing a timer-event.
4496 Now we always run timers directly. */
4499 timer_check (do_it_now
)
4502 EMACS_TIME nexttime
;
4503 EMACS_TIME now
, idleness_now
;
4504 Lisp_Object timers
, idle_timers
, chosen_timer
;
4505 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4507 EMACS_SET_SECS (nexttime
, -1);
4508 EMACS_SET_USECS (nexttime
, -1);
4510 /* Always consider the ordinary timers. */
4511 timers
= Vtimer_list
;
4512 /* Consider the idle timers only if Emacs is idle. */
4513 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4514 idle_timers
= Vtimer_idle_list
;
4517 chosen_timer
= Qnil
;
4518 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4520 if (CONSP (timers
) || CONSP (idle_timers
))
4522 EMACS_GET_TIME (now
);
4523 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4524 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4527 while (CONSP (timers
) || CONSP (idle_timers
))
4529 Lisp_Object
*vector
;
4530 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4531 EMACS_TIME timer_time
, idle_timer_time
;
4532 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4534 /* Skip past invalid timers and timers already handled. */
4537 timer
= XCAR (timers
);
4538 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4540 timers
= XCDR (timers
);
4543 vector
= XVECTOR (timer
)->contents
;
4545 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4546 || !INTEGERP (vector
[3])
4547 || ! NILP (vector
[0]))
4549 timers
= XCDR (timers
);
4553 if (!NILP (idle_timers
))
4555 timer
= XCAR (idle_timers
);
4556 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4558 idle_timers
= XCDR (idle_timers
);
4561 vector
= XVECTOR (timer
)->contents
;
4563 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4564 || !INTEGERP (vector
[3])
4565 || ! NILP (vector
[0]))
4567 idle_timers
= XCDR (idle_timers
);
4572 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4573 based on the next ordinary timer.
4574 TIMER_DIFFERENCE is the distance in time from NOW to when
4575 this timer becomes ripe (negative if it's already ripe). */
4578 timer
= XCAR (timers
);
4579 vector
= XVECTOR (timer
)->contents
;
4580 EMACS_SET_SECS (timer_time
,
4581 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4582 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4583 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4586 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4587 based on the next idle timer. */
4588 if (!NILP (idle_timers
))
4590 idle_timer
= XCAR (idle_timers
);
4591 vector
= XVECTOR (idle_timer
)->contents
;
4592 EMACS_SET_SECS (idle_timer_time
,
4593 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4594 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4595 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4598 /* Decide which timer is the next timer,
4599 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4600 Also step down the list where we found that timer. */
4602 if (! NILP (timers
) && ! NILP (idle_timers
))
4605 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4606 if (EMACS_TIME_NEG_P (temp
))
4608 chosen_timer
= timer
;
4609 timers
= XCDR (timers
);
4610 difference
= timer_difference
;
4614 chosen_timer
= idle_timer
;
4615 idle_timers
= XCDR (idle_timers
);
4616 difference
= idle_timer_difference
;
4619 else if (! NILP (timers
))
4621 chosen_timer
= timer
;
4622 timers
= XCDR (timers
);
4623 difference
= timer_difference
;
4627 chosen_timer
= idle_timer
;
4628 idle_timers
= XCDR (idle_timers
);
4629 difference
= idle_timer_difference
;
4631 vector
= XVECTOR (chosen_timer
)->contents
;
4633 /* If timer is ripe, run it if it hasn't been run. */
4634 if (EMACS_TIME_NEG_P (difference
)
4635 || (EMACS_SECS (difference
) == 0
4636 && EMACS_USECS (difference
) == 0))
4638 if (NILP (vector
[0]))
4640 int count
= SPECPDL_INDEX ();
4641 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4643 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4644 /* On unbind_to, resume allowing input from any kboard, if that
4646 record_single_kboard_state ();
4648 /* Mark the timer as triggered to prevent problems if the lisp
4649 code fails to reschedule it right. */
4652 specbind (Qinhibit_quit
, Qt
);
4654 call1 (Qtimer_event_handler
, chosen_timer
);
4655 Vdeactivate_mark
= old_deactivate_mark
;
4657 unbind_to (count
, Qnil
);
4659 /* Since we have handled the event,
4660 we don't need to tell the caller to wake up and do it. */
4664 /* When we encounter a timer that is still waiting,
4665 return the amount of time to wait before it is ripe. */
4672 /* No timers are pending in the future. */
4673 /* Return 0 if we generated an event, and -1 if not. */
4678 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4679 doc
: /* Return the current length of Emacs idleness.
4680 The value is returned as a list of three integers. The first has the
4681 most significant 16 bits of the seconds, while the second has the
4682 least significant 16 bits. The third integer gives the microsecond
4685 The microsecond count is zero on systems that do not provide
4686 resolution finer than a second. */)
4689 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4691 EMACS_TIME now
, idleness_now
;
4693 EMACS_GET_TIME (now
);
4694 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4696 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4697 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4698 make_number (EMACS_USECS (idleness_now
)));
4704 /* Caches for modify_event_symbol. */
4705 static Lisp_Object accent_key_syms
;
4706 static Lisp_Object func_key_syms
;
4707 static Lisp_Object mouse_syms
;
4708 static Lisp_Object wheel_syms
;
4709 static Lisp_Object drag_n_drop_syms
;
4711 /* This is a list of keysym codes for special "accent" characters.
4712 It parallels lispy_accent_keys. */
4714 static int lispy_accent_codes
[] =
4716 #ifdef XK_dead_circumflex
4721 #ifdef XK_dead_grave
4726 #ifdef XK_dead_tilde
4731 #ifdef XK_dead_diaeresis
4736 #ifdef XK_dead_macron
4741 #ifdef XK_dead_degree
4746 #ifdef XK_dead_acute
4751 #ifdef XK_dead_cedilla
4756 #ifdef XK_dead_breve
4761 #ifdef XK_dead_ogonek
4766 #ifdef XK_dead_caron
4771 #ifdef XK_dead_doubleacute
4772 XK_dead_doubleacute
,
4776 #ifdef XK_dead_abovedot
4781 #ifdef XK_dead_abovering
4791 #ifdef XK_dead_belowdot
4796 #ifdef XK_dead_voiced_sound
4797 XK_dead_voiced_sound
,
4801 #ifdef XK_dead_semivoiced_sound
4802 XK_dead_semivoiced_sound
,
4818 /* This is a list of Lisp names for special "accent" characters.
4819 It parallels lispy_accent_codes. */
4821 static char *lispy_accent_keys
[] =
4839 "dead-voiced-sound",
4840 "dead-semivoiced-sound",
4846 #define FUNCTION_KEY_OFFSET 0x0
4848 char *lispy_function_keys
[] =
4852 0, /* VK_LBUTTON 0x01 */
4853 0, /* VK_RBUTTON 0x02 */
4854 "cancel", /* VK_CANCEL 0x03 */
4855 0, /* VK_MBUTTON 0x04 */
4857 0, 0, 0, /* 0x05 .. 0x07 */
4859 "backspace", /* VK_BACK 0x08 */
4860 "tab", /* VK_TAB 0x09 */
4862 0, 0, /* 0x0A .. 0x0B */
4864 "clear", /* VK_CLEAR 0x0C */
4865 "return", /* VK_RETURN 0x0D */
4867 0, 0, /* 0x0E .. 0x0F */
4869 0, /* VK_SHIFT 0x10 */
4870 0, /* VK_CONTROL 0x11 */
4871 0, /* VK_MENU 0x12 */
4872 "pause", /* VK_PAUSE 0x13 */
4873 "capslock", /* VK_CAPITAL 0x14 */
4875 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4877 "escape", /* VK_ESCAPE 0x1B */
4879 0, 0, 0, 0, /* 0x1C .. 0x1F */
4881 0, /* VK_SPACE 0x20 */
4882 "prior", /* VK_PRIOR 0x21 */
4883 "next", /* VK_NEXT 0x22 */
4884 "end", /* VK_END 0x23 */
4885 "home", /* VK_HOME 0x24 */
4886 "left", /* VK_LEFT 0x25 */
4887 "up", /* VK_UP 0x26 */
4888 "right", /* VK_RIGHT 0x27 */
4889 "down", /* VK_DOWN 0x28 */
4890 "select", /* VK_SELECT 0x29 */
4891 "print", /* VK_PRINT 0x2A */
4892 "execute", /* VK_EXECUTE 0x2B */
4893 "snapshot", /* VK_SNAPSHOT 0x2C */
4894 "insert", /* VK_INSERT 0x2D */
4895 "delete", /* VK_DELETE 0x2E */
4896 "help", /* VK_HELP 0x2F */
4898 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4900 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4902 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4904 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4906 0, 0, 0, 0, 0, 0, 0, 0, 0,
4907 0, 0, 0, 0, 0, 0, 0, 0, 0,
4908 0, 0, 0, 0, 0, 0, 0, 0,
4910 "lwindow", /* VK_LWIN 0x5B */
4911 "rwindow", /* VK_RWIN 0x5C */
4912 "apps", /* VK_APPS 0x5D */
4914 0, 0, /* 0x5E .. 0x5F */
4916 "kp-0", /* VK_NUMPAD0 0x60 */
4917 "kp-1", /* VK_NUMPAD1 0x61 */
4918 "kp-2", /* VK_NUMPAD2 0x62 */
4919 "kp-3", /* VK_NUMPAD3 0x63 */
4920 "kp-4", /* VK_NUMPAD4 0x64 */
4921 "kp-5", /* VK_NUMPAD5 0x65 */
4922 "kp-6", /* VK_NUMPAD6 0x66 */
4923 "kp-7", /* VK_NUMPAD7 0x67 */
4924 "kp-8", /* VK_NUMPAD8 0x68 */
4925 "kp-9", /* VK_NUMPAD9 0x69 */
4926 "kp-multiply", /* VK_MULTIPLY 0x6A */
4927 "kp-add", /* VK_ADD 0x6B */
4928 "kp-separator", /* VK_SEPARATOR 0x6C */
4929 "kp-subtract", /* VK_SUBTRACT 0x6D */
4930 "kp-decimal", /* VK_DECIMAL 0x6E */
4931 "kp-divide", /* VK_DIVIDE 0x6F */
4932 "f1", /* VK_F1 0x70 */
4933 "f2", /* VK_F2 0x71 */
4934 "f3", /* VK_F3 0x72 */
4935 "f4", /* VK_F4 0x73 */
4936 "f5", /* VK_F5 0x74 */
4937 "f6", /* VK_F6 0x75 */
4938 "f7", /* VK_F7 0x76 */
4939 "f8", /* VK_F8 0x77 */
4940 "f9", /* VK_F9 0x78 */
4941 "f10", /* VK_F10 0x79 */
4942 "f11", /* VK_F11 0x7A */
4943 "f12", /* VK_F12 0x7B */
4944 "f13", /* VK_F13 0x7C */
4945 "f14", /* VK_F14 0x7D */
4946 "f15", /* VK_F15 0x7E */
4947 "f16", /* VK_F16 0x7F */
4948 "f17", /* VK_F17 0x80 */
4949 "f18", /* VK_F18 0x81 */
4950 "f19", /* VK_F19 0x82 */
4951 "f20", /* VK_F20 0x83 */
4952 "f21", /* VK_F21 0x84 */
4953 "f22", /* VK_F22 0x85 */
4954 "f23", /* VK_F23 0x86 */
4955 "f24", /* VK_F24 0x87 */
4957 0, 0, 0, 0, /* 0x88 .. 0x8B */
4958 0, 0, 0, 0, /* 0x8C .. 0x8F */
4960 "kp-numlock", /* VK_NUMLOCK 0x90 */
4961 "scroll", /* VK_SCROLL 0x91 */
4963 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4964 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4965 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4966 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4967 "kp-end", /* VK_NUMPAD_END 0x96 */
4968 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4969 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4970 "kp-up", /* VK_NUMPAD_UP 0x99 */
4971 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4972 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4973 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4974 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4976 0, 0, /* 0x9E .. 0x9F */
4979 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4980 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4981 * No other API or message will distinguish left and right keys this way.
4985 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4986 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4987 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4988 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4989 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4995 "attn", /* VK_ATTN 0xF6 */
4996 "crsel", /* VK_CRSEL 0xF7 */
4997 "exsel", /* VK_EXSEL 0xF8 */
4998 "ereof", /* VK_EREOF 0xF9 */
4999 "play", /* VK_PLAY 0xFA */
5000 "zoom", /* VK_ZOOM 0xFB */
5001 "noname", /* VK_NONAME 0xFC */
5002 "pa1", /* VK_PA1 0xFD */
5003 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5007 #else /* not HAVE_NTGUI */
5009 /* This should be dealt with in XTread_socket now, and that doesn't
5010 depend on the client system having the Kana syms defined. See also
5011 the XK_kana_A case below. */
5014 static char *lispy_kana_keys
[] =
5016 /* X Keysym value */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5024 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5025 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5026 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5027 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5028 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5029 "kana-i", "kana-u", "kana-e", "kana-o",
5030 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5031 "prolongedsound", "kana-A", "kana-I", "kana-U",
5032 "kana-E", "kana-O", "kana-KA", "kana-KI",
5033 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5034 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5035 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5036 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5037 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5038 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5039 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5040 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5041 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5042 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5043 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5044 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5046 #endif /* XK_kana_A */
5049 #define FUNCTION_KEY_OFFSET 0xff00
5051 /* You'll notice that this table is arranged to be conveniently
5052 indexed by X Windows keysym values. */
5053 static char *lispy_function_keys
[] =
5055 /* X Keysym value */
5057 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5058 "backspace", "tab", "linefeed", "clear",
5060 0, 0, 0, "pause", /* 0xff10...1f */
5061 0, 0, 0, 0, 0, 0, 0, "escape",
5063 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5064 "romaji", "hiragana", "katakana", "hiragana-katakana",
5065 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5066 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5067 "eisu-toggle", /* 0xff30...3f */
5068 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5069 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5071 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5072 "down", "prior", "next", "end",
5073 "begin", 0, 0, 0, 0, 0, 0, 0,
5074 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5085 "break", /* 0xff6b */
5088 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5089 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5090 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5091 0, 0, 0, 0, 0, 0, 0, 0,
5092 "kp-tab", /* 0xff89 */
5094 "kp-enter", /* 0xff8d */
5096 "kp-f1", /* 0xff91 */
5100 "kp-home", /* 0xff95 */
5105 "kp-prior", /* kp-page-up */
5106 "kp-next", /* kp-page-down */
5112 0, 0, 0, 0, 0, 0, 0, 0, 0,
5113 "kp-multiply", /* 0xffaa */
5118 "kp-divide", /* 0xffaf */
5119 "kp-0", /* 0xffb0 */
5120 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5123 "kp-equal", /* 0xffbd */
5124 "f1", /* 0xffbe */ /* IsFunctionKey */
5126 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5127 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5128 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5129 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5130 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5131 0, 0, 0, 0, 0, 0, 0, 0,
5132 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5133 0, 0, 0, 0, 0, 0, 0, "delete"
5136 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5137 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5139 static char *iso_lispy_function_keys
[] =
5141 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5142 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5143 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5144 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5145 "iso-lefttab", /* 0xfe20 */
5146 "iso-move-line-up", "iso-move-line-down",
5147 "iso-partial-line-up", "iso-partial-line-down",
5148 "iso-partial-space-left", "iso-partial-space-right",
5149 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5150 "iso-release-margin-left", "iso-release-margin-right",
5151 "iso-release-both-margins",
5152 "iso-fast-cursor-left", "iso-fast-cursor-right",
5153 "iso-fast-cursor-up", "iso-fast-cursor-down",
5154 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5155 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5158 #endif /* not HAVE_NTGUI */
5160 Lisp_Object Vlispy_mouse_stem
;
5162 static char *lispy_wheel_names
[] =
5164 "wheel-up", "wheel-down"
5167 /* drag-n-drop events are generated when a set of selected files are
5168 dragged from another application and dropped onto an Emacs window. */
5169 static char *lispy_drag_n_drop_names
[] =
5174 /* Scroll bar parts. */
5175 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5176 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5177 Lisp_Object Qtop
, Qratio
;
5179 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5180 Lisp_Object
*scroll_bar_parts
[] = {
5181 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5182 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5185 /* User signal events. */
5186 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5188 Lisp_Object
*lispy_user_signals
[] =
5190 &Qusr1_signal
, &Qusr2_signal
5194 /* A vector, indexed by button number, giving the down-going location
5195 of currently depressed buttons, both scroll bar and non-scroll bar.
5197 The elements have the form
5198 (BUTTON-NUMBER MODIFIER-MASK . REST)
5199 where REST is the cdr of a position as it would be reported in the event.
5201 The make_lispy_event function stores positions here to tell the
5202 difference between click and drag events, and to store the starting
5203 location to be included in drag events. */
5205 static Lisp_Object button_down_location
;
5207 /* Information about the most recent up-going button event: Which
5208 button, what location, and what time. */
5210 static int last_mouse_button
;
5211 static int last_mouse_x
;
5212 static int last_mouse_y
;
5213 static unsigned long button_down_time
;
5215 /* The maximum time between clicks to make a double-click, or Qnil to
5216 disable double-click detection, or Qt for no time limit. */
5218 Lisp_Object Vdouble_click_time
;
5220 /* Maximum number of pixels the mouse may be moved between clicks
5221 to make a double-click. */
5223 EMACS_INT double_click_fuzz
;
5225 /* The number of clicks in this multiple-click. */
5227 int double_click_count
;
5229 /* Return position of a mouse click or wheel event */
5232 make_lispy_position (f
, x
, y
, time
)
5238 enum window_part part
;
5239 Lisp_Object posn
= Qnil
;
5240 Lisp_Object extra_info
= Qnil
;
5243 /* Set `window' to the window under frame pixel coordinates (x,y) */
5245 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5246 &part
, &wx
, &wy
, 0);
5250 if (WINDOWP (window
))
5252 /* It's a click in window window at frame coordinates (x,y) */
5253 struct window
*w
= XWINDOW (window
);
5254 Lisp_Object string_info
= Qnil
;
5255 int textpos
= -1, rx
= -1, ry
= -1;
5256 int dx
= -1, dy
= -1;
5257 int width
= -1, height
= -1;
5258 Lisp_Object object
= Qnil
;
5260 /* Set event coordinates to window-relative coordinates
5261 for constructing the Lisp event below. */
5265 if (part
== ON_TEXT
)
5267 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5269 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5271 /* Mode line or header line. Look for a string under
5272 the mouse that may have a `local-map' property. */
5276 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5278 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5279 &object
, &dx
, &dy
, &width
, &height
);
5280 if (STRINGP (string
))
5281 string_info
= Fcons (string
, make_number (charpos
));
5282 if (w
== XWINDOW (selected_window
))
5285 textpos
= XMARKER (w
->pointm
)->charpos
;
5287 else if (part
== ON_VERTICAL_BORDER
)
5289 posn
= Qvertical_line
;
5294 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5299 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5301 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5302 &object
, &dx
, &dy
, &width
, &height
);
5303 if (STRINGP (string
))
5304 string_info
= Fcons (string
, make_number (charpos
));
5305 if (part
== ON_LEFT_MARGIN
)
5308 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5310 else if (part
== ON_LEFT_FRINGE
)
5312 posn
= Qleft_fringe
;
5315 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5317 : window_box_width (w
, LEFT_MARGIN_AREA
));
5320 else if (part
== ON_RIGHT_FRINGE
)
5322 posn
= Qright_fringe
;
5325 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5326 + window_box_width (w
, TEXT_AREA
)
5327 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5328 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5334 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5335 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5340 Lisp_Object string2
, object2
= Qnil
;
5341 struct display_pos p
;
5343 int width2
, height2
;
5344 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5345 &object2
, &dx2
, &dy2
,
5347 textpos
= CHARPOS (p
.pos
);
5348 if (rx
< 0) rx
= wx
;
5349 if (ry
< 0) ry
= wy
;
5350 if (dx
< 0) dx
= dx2
;
5351 if (dy
< 0) dy
= dy2
;
5352 if (width
< 0) width
= width2
;
5353 if (height
< 0) height
= height2
;
5357 posn
= make_number (textpos
);
5358 if (STRINGP (string2
))
5359 string_info
= Fcons (string2
,
5360 make_number (CHARPOS (p
.string_pos
)));
5366 #ifdef HAVE_WINDOW_SYSTEM
5367 if (IMAGEP (object
))
5369 Lisp_Object image_map
, hotspot
;
5370 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5372 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5374 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5375 posn
= XCAR (hotspot
);
5380 extra_info
= Fcons (object
,
5381 Fcons (Fcons (make_number (dx
),
5383 Fcons (Fcons (make_number (width
),
5384 make_number (height
)),
5388 extra_info
= Fcons (string_info
,
5389 Fcons (make_number (textpos
),
5390 Fcons (Fcons (make_number (rx
),
5396 XSETFRAME (window
, f
);
5401 XSETFASTINT (*x
, 0);
5402 XSETFASTINT (*y
, 0);
5405 return Fcons (window
,
5407 Fcons (Fcons (*x
, *y
),
5408 Fcons (make_number (time
),
5412 /* Given a struct input_event, build the lisp event which represents
5413 it. If EVENT is 0, build a mouse movement event from the mouse
5414 movement buffer, which should have a movement event in it.
5416 Note that events must be passed to this function in the order they
5417 are received; this function stores the location of button presses
5418 in order to build drag events when the button is released. */
5421 make_lispy_event (event
)
5422 struct input_event
*event
;
5426 switch (SWITCH_ENUM_CAST (event
->kind
))
5428 /* A simple keystroke. */
5429 case ASCII_KEYSTROKE_EVENT
:
5431 Lisp_Object lispy_c
;
5432 int c
= event
->code
& 0377;
5433 /* Turn ASCII characters into control characters
5435 if (event
->modifiers
& ctrl_modifier
)
5436 c
= make_ctrl_char (c
);
5438 /* Add in the other modifier bits. We took care of ctrl_modifier
5439 just above, and the shift key was taken care of by the X code,
5440 and applied to control characters by make_ctrl_char. */
5441 c
|= (event
->modifiers
5442 & (meta_modifier
| alt_modifier
5443 | hyper_modifier
| super_modifier
));
5444 /* Distinguish Shift-SPC from SPC. */
5445 if ((event
->code
& 0377) == 040
5446 && event
->modifiers
& shift_modifier
)
5447 c
|= shift_modifier
;
5448 button_down_time
= 0;
5449 XSETFASTINT (lispy_c
, c
);
5453 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5455 Lisp_Object lispy_c
;
5456 int c
= event
->code
;
5458 /* Add in the other modifier bits. We took care of ctrl_modifier
5459 just above, and the shift key was taken care of by the X code,
5460 and applied to control characters by make_ctrl_char. */
5461 c
|= (event
->modifiers
5462 & (meta_modifier
| alt_modifier
5463 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5464 /* What about the `shift' modifier ? */
5465 button_down_time
= 0;
5466 XSETFASTINT (lispy_c
, c
);
5470 /* A function key. The symbol may need to have modifier prefixes
5472 case NON_ASCII_KEYSTROKE_EVENT
:
5473 button_down_time
= 0;
5475 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5476 if (event
->code
== lispy_accent_codes
[i
])
5477 return modify_event_symbol (i
,
5479 Qfunction_key
, Qnil
,
5480 lispy_accent_keys
, &accent_key_syms
,
5481 (sizeof (lispy_accent_keys
)
5482 / sizeof (lispy_accent_keys
[0])));
5486 if (event
->code
>= 0x400 && event
->code
< 0x500)
5487 return modify_event_symbol (event
->code
- 0x400,
5488 event
->modifiers
& ~shift_modifier
,
5489 Qfunction_key
, Qnil
,
5490 lispy_kana_keys
, &func_key_syms
,
5491 (sizeof (lispy_kana_keys
)
5492 / sizeof (lispy_kana_keys
[0])));
5493 #endif /* XK_kana_A */
5496 #ifdef ISO_FUNCTION_KEY_OFFSET
5497 if (event
->code
< FUNCTION_KEY_OFFSET
5498 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5499 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5501 Qfunction_key
, Qnil
,
5502 iso_lispy_function_keys
, &func_key_syms
,
5503 (sizeof (iso_lispy_function_keys
)
5504 / sizeof (iso_lispy_function_keys
[0])));
5507 /* Handle system-specific or unknown keysyms. */
5508 if (event
->code
& (1 << 28)
5509 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5510 || (event
->code
- FUNCTION_KEY_OFFSET
5511 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5512 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5514 /* We need to use an alist rather than a vector as the cache
5515 since we can't make a vector long enuf. */
5516 if (NILP (current_kboard
->system_key_syms
))
5517 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5518 return modify_event_symbol (event
->code
,
5521 current_kboard
->Vsystem_key_alist
,
5522 0, ¤t_kboard
->system_key_syms
,
5526 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5528 Qfunction_key
, Qnil
,
5529 lispy_function_keys
, &func_key_syms
,
5530 (sizeof (lispy_function_keys
)
5531 / sizeof (lispy_function_keys
[0])));
5534 /* A mouse click. Figure out where it is, decide whether it's
5535 a press, click or drag, and build the appropriate structure. */
5536 case MOUSE_CLICK_EVENT
:
5537 #ifndef USE_TOOLKIT_SCROLL_BARS
5538 case SCROLL_BAR_CLICK_EVENT
:
5541 int button
= event
->code
;
5543 Lisp_Object position
;
5544 Lisp_Object
*start_pos_ptr
;
5545 Lisp_Object start_pos
;
5549 /* Build the position as appropriate for this mouse click. */
5550 if (event
->kind
== MOUSE_CLICK_EVENT
)
5552 struct frame
*f
= XFRAME (event
->frame_or_window
);
5553 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5557 /* Ignore mouse events that were made on frame that
5558 have been deleted. */
5559 if (! FRAME_LIVE_P (f
))
5562 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5563 /* EVENT->x and EVENT->y are frame-relative pixel
5564 coordinates at this place. Under old redisplay, COLUMN
5565 and ROW are set to frame relative glyph coordinates
5566 which are then used to determine whether this click is
5567 in a menu (non-toolkit version). */
5568 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5569 &column
, &row
, NULL
, 1);
5571 /* In the non-toolkit version, clicks on the menu bar
5572 are ordinary button events in the event buffer.
5573 Distinguish them, and invoke the menu.
5575 (In the toolkit version, the toolkit handles the menu bar
5576 and Emacs doesn't know about it until after the user
5577 makes a selection.) */
5578 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5579 && (event
->modifiers
& down_modifier
))
5581 Lisp_Object items
, item
;
5586 /* Activate the menu bar on the down event. If the
5587 up event comes in before the menu code can deal with it,
5589 if (! (event
->modifiers
& down_modifier
))
5593 /* Find the menu bar item under `column'. */
5595 items
= FRAME_MENU_BAR_ITEMS (f
);
5596 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5598 Lisp_Object pos
, string
;
5599 string
= AREF (items
, i
+ 1);
5600 pos
= AREF (items
, i
+ 3);
5603 if (column
>= XINT (pos
)
5604 && column
< XINT (pos
) + SCHARS (string
))
5606 item
= AREF (items
, i
);
5611 /* ELisp manual 2.4b says (x y) are window relative but
5612 code says they are frame-relative. */
5614 = Fcons (event
->frame_or_window
,
5616 Fcons (Fcons (event
->x
, event
->y
),
5617 Fcons (make_number (event
->timestamp
),
5620 return Fcons (item
, Fcons (position
, Qnil
));
5622 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5624 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5627 #ifndef USE_TOOLKIT_SCROLL_BARS
5630 /* It's a scrollbar click. */
5632 Lisp_Object portion_whole
;
5635 window
= event
->frame_or_window
;
5636 portion_whole
= Fcons (event
->x
, event
->y
);
5637 part
= *scroll_bar_parts
[(int) event
->part
];
5641 Fcons (Qvertical_scroll_bar
,
5642 Fcons (portion_whole
,
5643 Fcons (make_number (event
->timestamp
),
5644 Fcons (part
, Qnil
)))));
5646 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5648 if (button
>= ASIZE (button_down_location
))
5650 button_down_location
= larger_vector (button_down_location
,
5652 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5655 start_pos_ptr
= &AREF (button_down_location
, button
);
5656 start_pos
= *start_pos_ptr
;
5657 *start_pos_ptr
= Qnil
;
5660 /* On window-system frames, use the value of
5661 double-click-fuzz as is. On other frames, interpret it
5662 as a multiple of 1/8 characters. */
5666 if (WINDOWP (event
->frame_or_window
))
5667 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5668 else if (FRAMEP (event
->frame_or_window
))
5669 f
= XFRAME (event
->frame_or_window
);
5673 if (FRAME_WINDOW_P (f
))
5674 fuzz
= double_click_fuzz
;
5676 fuzz
= double_click_fuzz
/ 8;
5678 is_double
= (button
== last_mouse_button
5679 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5680 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5681 && button_down_time
!= 0
5682 && (EQ (Vdouble_click_time
, Qt
)
5683 || (INTEGERP (Vdouble_click_time
)
5684 && ((int)(event
->timestamp
- button_down_time
)
5685 < XINT (Vdouble_click_time
)))));
5688 last_mouse_button
= button
;
5689 last_mouse_x
= XINT (event
->x
);
5690 last_mouse_y
= XINT (event
->y
);
5692 /* If this is a button press, squirrel away the location, so
5693 we can decide later whether it was a click or a drag. */
5694 if (event
->modifiers
& down_modifier
)
5698 double_click_count
++;
5699 event
->modifiers
|= ((double_click_count
> 2)
5704 double_click_count
= 1;
5705 button_down_time
= event
->timestamp
;
5706 *start_pos_ptr
= Fcopy_alist (position
);
5709 /* Now we're releasing a button - check the co-ordinates to
5710 see if this was a click or a drag. */
5711 else if (event
->modifiers
& up_modifier
)
5713 /* If we did not see a down before this up, ignore the up.
5714 Probably this happened because the down event chose a
5715 menu item. It would be an annoyance to treat the
5716 release of the button that chose the menu item as a
5719 if (!CONSP (start_pos
))
5722 event
->modifiers
&= ~up_modifier
;
5723 #if 0 /* Formerly we treated an up with no down as a click event. */
5724 if (!CONSP (start_pos
))
5725 event
->modifiers
|= click_modifier
;
5730 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5732 /* The third element of every position
5733 should be the (x,y) pair. */
5734 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5736 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5738 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5739 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5742 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5743 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5744 /* Maybe the mouse has moved a lot, caused scrolling, and
5745 eventually ended up at the same screen position (but
5746 not buffer position) in which case it is a drag, not
5748 /* FIXME: OTOH if the buffer position has changed
5749 because of a timer or process filter rather than
5750 because of mouse movement, it should be considered as
5751 a click. But mouse-drag-region completely ignores
5752 this case and it hasn't caused any real problem, so
5753 it's probably OK to ignore it as well. */
5754 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5755 /* Mouse hasn't moved (much). */
5756 event
->modifiers
|= click_modifier
;
5759 button_down_time
= 0;
5760 event
->modifiers
|= drag_modifier
;
5763 /* Don't check is_double; treat this as multiple
5764 if the down-event was multiple. */
5765 if (double_click_count
> 1)
5766 event
->modifiers
|= ((double_click_count
> 2)
5772 /* Every mouse event should either have the down_modifier or
5773 the up_modifier set. */
5777 /* Get the symbol we should use for the mouse click. */
5780 head
= modify_event_symbol (button
,
5782 Qmouse_click
, Vlispy_mouse_stem
,
5785 XVECTOR (mouse_syms
)->size
);
5786 if (event
->modifiers
& drag_modifier
)
5791 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5794 Fcons (make_number (double_click_count
),
5805 Lisp_Object position
;
5808 /* Build the position as appropriate for this mouse click. */
5809 struct frame
*f
= XFRAME (event
->frame_or_window
);
5811 /* Ignore wheel events that were made on frame that have been
5813 if (! FRAME_LIVE_P (f
))
5816 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5819 /* Set double or triple modifiers to indicate the wheel speed. */
5821 /* On window-system frames, use the value of
5822 double-click-fuzz as is. On other frames, interpret it
5823 as a multiple of 1/8 characters. */
5828 if (WINDOWP (event
->frame_or_window
))
5829 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5830 else if (FRAMEP (event
->frame_or_window
))
5831 f
= XFRAME (event
->frame_or_window
);
5835 if (FRAME_WINDOW_P (f
))
5836 fuzz
= double_click_fuzz
;
5838 fuzz
= double_click_fuzz
/ 8;
5840 is_double
= (last_mouse_button
< 0
5841 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5842 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5843 && button_down_time
!= 0
5844 && (EQ (Vdouble_click_time
, Qt
)
5845 || (INTEGERP (Vdouble_click_time
)
5846 && ((int)(event
->timestamp
- button_down_time
)
5847 < XINT (Vdouble_click_time
)))));
5850 double_click_count
++;
5851 event
->modifiers
|= ((double_click_count
> 2)
5857 double_click_count
= 1;
5858 event
->modifiers
|= click_modifier
;
5861 button_down_time
= event
->timestamp
;
5862 /* Use a negative value to distinguish wheel from mouse button. */
5863 last_mouse_button
= -1;
5864 last_mouse_x
= XINT (event
->x
);
5865 last_mouse_y
= XINT (event
->y
);
5871 if (event
->modifiers
& up_modifier
)
5873 /* Emit a wheel-up event. */
5874 event
->modifiers
&= ~up_modifier
;
5877 else if (event
->modifiers
& down_modifier
)
5879 /* Emit a wheel-down event. */
5880 event
->modifiers
&= ~down_modifier
;
5884 /* Every wheel event should either have the down_modifier or
5885 the up_modifier set. */
5888 /* Get the symbol we should use for the wheel event. */
5889 head
= modify_event_symbol (symbol_num
,
5895 ASIZE (wheel_syms
));
5898 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5901 Fcons (make_number (double_click_count
),
5910 #ifdef USE_TOOLKIT_SCROLL_BARS
5912 /* We don't have down and up events if using toolkit scroll bars,
5913 so make this always a click event. Store in the `part' of
5914 the Lisp event a symbol which maps to the following actions:
5916 `above_handle' page up
5917 `below_handle' page down
5921 `bottom' bottom of buffer
5922 `handle' thumb has been dragged.
5923 `end-scroll' end of interaction with scroll bar
5925 The incoming input_event contains in its `part' member an
5926 index of type `enum scroll_bar_part' which we can use as an
5927 index in scroll_bar_parts to get the appropriate symbol. */
5929 case SCROLL_BAR_CLICK_EVENT
:
5931 Lisp_Object position
, head
, window
, portion_whole
, part
;
5933 window
= event
->frame_or_window
;
5934 portion_whole
= Fcons (event
->x
, event
->y
);
5935 part
= *scroll_bar_parts
[(int) event
->part
];
5939 Fcons (Qvertical_scroll_bar
,
5940 Fcons (portion_whole
,
5941 Fcons (make_number (event
->timestamp
),
5942 Fcons (part
, Qnil
)))));
5944 /* Always treat scroll bar events as clicks. */
5945 event
->modifiers
|= click_modifier
;
5946 event
->modifiers
&= ~up_modifier
;
5948 if (event
->code
>= ASIZE (mouse_syms
))
5949 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5951 /* Get the symbol we should use for the mouse click. */
5952 head
= modify_event_symbol (event
->code
,
5957 XVECTOR (mouse_syms
)->size
);
5958 return Fcons (head
, Fcons (position
, Qnil
));
5961 #endif /* USE_TOOLKIT_SCROLL_BARS */
5964 case W32_SCROLL_BAR_CLICK_EVENT
:
5966 int button
= event
->code
;
5968 Lisp_Object position
;
5969 Lisp_Object
*start_pos_ptr
;
5970 Lisp_Object start_pos
;
5974 Lisp_Object portion_whole
;
5977 window
= event
->frame_or_window
;
5978 portion_whole
= Fcons (event
->x
, event
->y
);
5979 part
= *scroll_bar_parts
[(int) event
->part
];
5983 Fcons (Qvertical_scroll_bar
,
5984 Fcons (portion_whole
,
5985 Fcons (make_number (event
->timestamp
),
5986 Fcons (part
, Qnil
)))));
5989 /* Always treat W32 scroll bar events as clicks. */
5990 event
->modifiers
|= click_modifier
;
5993 /* Get the symbol we should use for the mouse click. */
5996 head
= modify_event_symbol (button
,
6001 XVECTOR (mouse_syms
)->size
);
6007 #endif /* WINDOWSNT */
6009 case DRAG_N_DROP_EVENT
:
6012 Lisp_Object head
, position
;
6015 f
= XFRAME (event
->frame_or_window
);
6018 /* Ignore mouse events that were made on frames that
6019 have been deleted. */
6020 if (! FRAME_LIVE_P (f
))
6023 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6026 head
= modify_event_symbol (0, event
->modifiers
,
6028 lispy_drag_n_drop_names
,
6029 &drag_n_drop_syms
, 1);
6035 #endif /* HAVE_MOUSE */
6037 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6038 || defined (USE_GTK)
6039 case MENU_BAR_EVENT
:
6040 if (EQ (event
->arg
, event
->frame_or_window
))
6041 /* This is the prefix key. We translate this to
6042 `(menu_bar)' because the code in keyboard.c for menu
6043 events, which we use, relies on this. */
6044 return Fcons (Qmenu_bar
, Qnil
);
6048 case SELECT_WINDOW_EVENT
:
6049 /* Make an event (select-window (WINDOW)). */
6050 return Fcons (Qselect_window
,
6051 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6054 case TOOL_BAR_EVENT
:
6055 if (EQ (event
->arg
, event
->frame_or_window
))
6056 /* This is the prefix key. We translate this to
6057 `(tool_bar)' because the code in keyboard.c for tool bar
6058 events, which we use, relies on this. */
6059 return Fcons (Qtool_bar
, Qnil
);
6060 else if (SYMBOLP (event
->arg
))
6061 return apply_modifiers (event
->modifiers
, event
->arg
);
6064 case USER_SIGNAL_EVENT
:
6065 /* A user signal. */
6066 return *lispy_user_signals
[event
->code
];
6068 case SAVE_SESSION_EVENT
:
6069 return Qsave_session
;
6072 case MAC_APPLE_EVENT
:
6074 Lisp_Object spec
[2];
6078 return Fcons (Qmac_apple_event
,
6079 Fcons (Fvector (2, spec
),
6080 Fcons (event
->arg
, Qnil
)));
6084 /* The 'kind' field of the event is something we don't recognize. */
6093 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6095 Lisp_Object bar_window
;
6096 enum scroll_bar_part part
;
6100 /* Is it a scroll bar movement? */
6101 if (frame
&& ! NILP (bar_window
))
6103 Lisp_Object part_sym
;
6105 part_sym
= *scroll_bar_parts
[(int) part
];
6106 return Fcons (Qscroll_bar_movement
,
6107 (Fcons (Fcons (bar_window
,
6108 Fcons (Qvertical_scroll_bar
,
6109 Fcons (Fcons (x
, y
),
6110 Fcons (make_number (time
),
6116 /* Or is it an ordinary mouse movement? */
6119 Lisp_Object position
;
6121 position
= make_lispy_position (frame
, &x
, &y
, time
);
6123 return Fcons (Qmouse_movement
,
6129 #endif /* HAVE_MOUSE */
6131 /* Construct a switch frame event. */
6133 make_lispy_switch_frame (frame
)
6136 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6139 /* Manipulating modifiers. */
6141 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6143 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6144 SYMBOL's name of the end of the modifiers; the string from this
6145 position is the unmodified symbol name.
6147 This doesn't use any caches. */
6150 parse_modifiers_uncached (symbol
, modifier_end
)
6158 CHECK_SYMBOL (symbol
);
6161 name
= SYMBOL_NAME (symbol
);
6163 for (i
= 0; i
+2 <= SBYTES (name
); )
6165 int this_mod_end
= 0;
6168 /* See if the name continues with a modifier word.
6169 Check that the word appears, but don't check what follows it.
6170 Set this_mod and this_mod_end to record what we find. */
6172 switch (SREF (name
, i
))
6174 #define SINGLE_LETTER_MOD(BIT) \
6175 (this_mod_end = i + 1, this_mod = BIT)
6178 SINGLE_LETTER_MOD (alt_modifier
);
6182 SINGLE_LETTER_MOD (ctrl_modifier
);
6186 SINGLE_LETTER_MOD (hyper_modifier
);
6190 SINGLE_LETTER_MOD (meta_modifier
);
6194 SINGLE_LETTER_MOD (shift_modifier
);
6198 SINGLE_LETTER_MOD (super_modifier
);
6201 #undef SINGLE_LETTER_MOD
6203 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6204 if (i + LEN + 1 <= SBYTES (name) \
6205 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6207 this_mod_end = i + LEN; \
6212 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6213 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6214 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6218 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6220 #undef MULTI_LETTER_MOD
6224 /* If we found no modifier, stop looking for them. */
6225 if (this_mod_end
== 0)
6228 /* Check there is a dash after the modifier, so that it
6229 really is a modifier. */
6230 if (this_mod_end
>= SBYTES (name
)
6231 || SREF (name
, this_mod_end
) != '-')
6234 /* This modifier is real; look for another. */
6235 modifiers
|= this_mod
;
6236 i
= this_mod_end
+ 1;
6239 /* Should we include the `click' modifier? */
6240 if (! (modifiers
& (down_modifier
| drag_modifier
6241 | double_modifier
| triple_modifier
))
6242 && i
+ 7 == SBYTES (name
)
6243 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6244 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6245 modifiers
|= click_modifier
;
6253 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6254 prepended to the string BASE[0..BASE_LEN-1].
6255 This doesn't use any caches. */
6257 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6260 int base_len
, base_len_byte
;
6262 /* Since BASE could contain nulls, we can't use intern here; we have
6263 to use Fintern, which expects a genuine Lisp_String, and keeps a
6266 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6272 /* Only the event queue may use the `up' modifier; it should always
6273 be turned into a click or drag event before presented to lisp code. */
6274 if (modifiers
& up_modifier
)
6277 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6278 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6279 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6280 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6281 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6282 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6283 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6284 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6285 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6286 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6287 /* The click modifier is denoted by the absence of other modifiers. */
6291 mod_len
= p
- new_mods
;
6295 Lisp_Object new_name
;
6297 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6298 mod_len
+ base_len_byte
);
6299 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6300 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6302 return Fintern (new_name
, Qnil
);
6307 static char *modifier_names
[] =
6309 "up", "down", "drag", "click", "double", "triple", 0, 0,
6310 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6311 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6313 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6315 static Lisp_Object modifier_symbols
;
6317 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6319 lispy_modifier_list (modifiers
)
6322 Lisp_Object modifier_list
;
6325 modifier_list
= Qnil
;
6326 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6327 if (modifiers
& (1<<i
))
6328 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6331 return modifier_list
;
6335 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6336 where UNMODIFIED is the unmodified form of SYMBOL,
6337 MASK is the set of modifiers present in SYMBOL's name.
6338 This is similar to parse_modifiers_uncached, but uses the cache in
6339 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6340 Qevent_symbol_elements property. */
6343 parse_modifiers (symbol
)
6346 Lisp_Object elements
;
6348 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6349 if (CONSP (elements
))
6354 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6355 Lisp_Object unmodified
;
6358 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6359 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6362 if (modifiers
& ~INTMASK
)
6364 XSETFASTINT (mask
, modifiers
);
6365 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6367 /* Cache the parsing results on SYMBOL. */
6368 Fput (symbol
, Qevent_symbol_element_mask
,
6370 Fput (symbol
, Qevent_symbol_elements
,
6371 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6373 /* Since we know that SYMBOL is modifiers applied to unmodified,
6374 it would be nice to put that in unmodified's cache.
6375 But we can't, since we're not sure that parse_modifiers is
6382 /* Apply the modifiers MODIFIERS to the symbol BASE.
6383 BASE must be unmodified.
6385 This is like apply_modifiers_uncached, but uses BASE's
6386 Qmodifier_cache property, if present. It also builds
6387 Qevent_symbol_elements properties, since it has that info anyway.
6389 apply_modifiers copies the value of BASE's Qevent_kind property to
6390 the modified symbol. */
6392 apply_modifiers (modifiers
, base
)
6396 Lisp_Object cache
, index
, entry
, new_symbol
;
6398 /* Mask out upper bits. We don't know where this value's been. */
6399 modifiers
&= INTMASK
;
6401 /* The click modifier never figures into cache indices. */
6402 cache
= Fget (base
, Qmodifier_cache
);
6403 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6404 entry
= assq_no_quit (index
, cache
);
6407 new_symbol
= XCDR (entry
);
6410 /* We have to create the symbol ourselves. */
6411 new_symbol
= apply_modifiers_uncached (modifiers
,
6412 SDATA (SYMBOL_NAME (base
)),
6413 SCHARS (SYMBOL_NAME (base
)),
6414 SBYTES (SYMBOL_NAME (base
)));
6416 /* Add the new symbol to the base's cache. */
6417 entry
= Fcons (index
, new_symbol
);
6418 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6420 /* We have the parsing info now for free, so we could add it to
6422 XSETFASTINT (index, modifiers);
6423 Fput (new_symbol, Qevent_symbol_element_mask,
6424 Fcons (base, Fcons (index, Qnil)));
6425 Fput (new_symbol, Qevent_symbol_elements,
6426 Fcons (base, lispy_modifier_list (modifiers)));
6427 Sadly, this is only correct if `base' is indeed a base event,
6428 which is not necessarily the case. -stef */
6431 /* Make sure this symbol is of the same kind as BASE.
6433 You'd think we could just set this once and for all when we
6434 intern the symbol above, but reorder_modifiers may call us when
6435 BASE's property isn't set right; we can't assume that just
6436 because it has a Qmodifier_cache property it must have its
6437 Qevent_kind set right as well. */
6438 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6442 kind
= Fget (base
, Qevent_kind
);
6444 Fput (new_symbol
, Qevent_kind
, kind
);
6451 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6452 return a symbol with the modifiers placed in the canonical order.
6453 Canonical order is alphabetical, except for down and drag, which
6454 always come last. The 'click' modifier is never written out.
6456 Fdefine_key calls this to make sure that (for example) C-M-foo
6457 and M-C-foo end up being equivalent in the keymap. */
6460 reorder_modifiers (symbol
)
6463 /* It's hopefully okay to write the code this way, since everything
6464 will soon be in caches, and no consing will be done at all. */
6467 parsed
= parse_modifiers (symbol
);
6468 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6473 /* For handling events, we often want to produce a symbol whose name
6474 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6475 to some base, like the name of a function key or mouse button.
6476 modify_event_symbol produces symbols of this sort.
6478 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6479 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6482 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6483 into symbol names, or a string specifying a name stem used to
6484 construct a symbol name or the form `STEM-N', where N is the decimal
6485 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6486 non-nil; otherwise NAME_TABLE is used.
6488 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6489 persist between calls to modify_event_symbol that it can use to
6490 store a cache of the symbols it's generated for this NAME_TABLE
6491 before. The object stored there may be a vector or an alist.
6493 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6495 MODIFIERS is a set of modifier bits (as given in struct input_events)
6496 whose prefixes should be applied to the symbol name.
6498 SYMBOL_KIND is the value to be placed in the event_kind property of
6499 the returned symbol.
6501 The symbols we create are supposed to have an
6502 `event-symbol-elements' property, which lists the modifiers present
6503 in the symbol's name. */
6506 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6507 name_table
, symbol_table
, table_size
)
6510 Lisp_Object symbol_kind
;
6511 Lisp_Object name_alist_or_stem
;
6513 Lisp_Object
*symbol_table
;
6514 unsigned int table_size
;
6517 Lisp_Object symbol_int
;
6519 /* Get rid of the "vendor-specific" bit here. */
6520 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6522 /* Is this a request for a valid symbol? */
6523 if (symbol_num
< 0 || symbol_num
>= table_size
)
6526 if (CONSP (*symbol_table
))
6527 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6529 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6530 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6531 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6532 we've never used that symbol before. */
6535 if (! VECTORP (*symbol_table
)
6536 || XVECTOR (*symbol_table
)->size
!= table_size
)
6540 XSETFASTINT (size
, table_size
);
6541 *symbol_table
= Fmake_vector (size
, Qnil
);
6544 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6547 /* Have we already used this symbol before? */
6550 /* No; let's create it. */
6551 if (CONSP (name_alist_or_stem
))
6552 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6553 else if (STRINGP (name_alist_or_stem
))
6555 int len
= SBYTES (name_alist_or_stem
);
6556 char *buf
= (char *) alloca (len
+ 50);
6557 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6558 (long) XINT (symbol_int
) + 1);
6559 value
= intern (buf
);
6561 else if (name_table
!= 0 && name_table
[symbol_num
])
6562 value
= intern (name_table
[symbol_num
]);
6564 #ifdef HAVE_WINDOW_SYSTEM
6567 char *name
= x_get_keysym_name (symbol_num
);
6569 value
= intern (name
);
6576 sprintf (buf
, "key-%d", symbol_num
);
6577 value
= intern (buf
);
6580 if (CONSP (*symbol_table
))
6581 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6583 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6585 /* Fill in the cache entries for this symbol; this also
6586 builds the Qevent_symbol_elements property, which the user
6588 apply_modifiers (modifiers
& click_modifier
, value
);
6589 Fput (value
, Qevent_kind
, symbol_kind
);
6592 /* Apply modifiers to that symbol. */
6593 return apply_modifiers (modifiers
, value
);
6596 /* Convert a list that represents an event type,
6597 such as (ctrl meta backspace), into the usual representation of that
6598 event type as a number or a symbol. */
6600 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6601 doc
: /* Convert the event description list EVENT-DESC to an event type.
6602 EVENT-DESC should contain one base event type (a character or symbol)
6603 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6604 drag, down, double or triple). The base must be last.
6605 The return value is an event type (a character or symbol) which
6606 has the same base event type and all the specified modifiers. */)
6608 Lisp_Object event_desc
;
6616 while (CONSP (rest
))
6624 /* Given a symbol, see if it is a modifier name. */
6625 if (SYMBOLP (elt
) && CONSP (rest
))
6626 this = parse_solitary_modifier (elt
);
6630 else if (!NILP (base
))
6631 error ("Two bases given in one event");
6637 /* Let the symbol A refer to the character A. */
6638 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6639 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6641 if (INTEGERP (base
))
6643 /* Turn (shift a) into A. */
6644 if ((modifiers
& shift_modifier
) != 0
6645 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6647 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6648 modifiers
&= ~shift_modifier
;
6651 /* Turn (control a) into C-a. */
6652 if (modifiers
& ctrl_modifier
)
6653 return make_number ((modifiers
& ~ctrl_modifier
)
6654 | make_ctrl_char (XINT (base
)));
6656 return make_number (modifiers
| XINT (base
));
6658 else if (SYMBOLP (base
))
6659 return apply_modifiers (modifiers
, base
);
6662 error ("Invalid base event");
6667 /* Try to recognize SYMBOL as a modifier name.
6668 Return the modifier flag bit, or 0 if not recognized. */
6671 parse_solitary_modifier (symbol
)
6674 Lisp_Object name
= SYMBOL_NAME (symbol
);
6676 switch (SREF (name
, 0))
6678 #define SINGLE_LETTER_MOD(BIT) \
6679 if (SBYTES (name) == 1) \
6682 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6683 if (LEN == SBYTES (name) \
6684 && ! strncmp (SDATA (name), NAME, LEN)) \
6688 SINGLE_LETTER_MOD (alt_modifier
);
6692 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6696 SINGLE_LETTER_MOD (ctrl_modifier
);
6700 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6701 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6705 SINGLE_LETTER_MOD (hyper_modifier
);
6709 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6713 SINGLE_LETTER_MOD (meta_modifier
);
6717 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6721 SINGLE_LETTER_MOD (shift_modifier
);
6725 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6726 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6727 SINGLE_LETTER_MOD (super_modifier
);
6731 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6732 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6733 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6737 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6740 #undef SINGLE_LETTER_MOD
6741 #undef MULTI_LETTER_MOD
6747 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6748 Such a list is not valid as an event,
6749 but it can be a Lucid-style event type list. */
6752 lucid_event_type_list_p (object
)
6757 if (! CONSP (object
))
6760 if (EQ (XCAR (object
), Qhelp_echo
)
6761 || EQ (XCAR (object
), Qvertical_line
)
6762 || EQ (XCAR (object
), Qmode_line
)
6763 || EQ (XCAR (object
), Qheader_line
))
6766 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6770 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6777 /* Store into *addr a value nonzero if terminal input chars are available.
6778 Serves the purpose of ioctl (0, FIONREAD, addr)
6779 but works even if FIONREAD does not exist.
6780 (In fact, this may actually read some input.)
6782 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6783 timer events that are ripe.
6784 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6785 events (FOCUS_IN_EVENT).
6786 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6787 movements and toolkit scroll bar thumb drags. */
6790 get_input_pending (addr
, flags
)
6794 /* First of all, have we already counted some input? */
6795 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6797 /* If input is being read as it arrives, and we have none, there is none. */
6798 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6801 /* Try to read some input and see how much we get. */
6803 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6806 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6809 gobble_input (expected
)
6814 if (interrupt_input
)
6817 mask
= sigblock (sigmask (SIGIO
));
6818 read_avail_input (expected
);
6822 #ifdef POLL_FOR_INPUT
6823 /* XXX This condition was (read_socket_hook && !interrupt_input),
6824 but read_socket_hook is not global anymore. Let's pretend that
6826 if (!interrupt_input
&& poll_suppress_count
== 0)
6829 mask
= sigblock (sigmask (SIGALRM
));
6830 read_avail_input (expected
);
6836 read_avail_input (expected
);
6840 /* Put a BUFFER_SWITCH_EVENT in the buffer
6841 so that read_key_sequence will notice the new current buffer. */
6844 record_asynch_buffer_change ()
6846 struct input_event event
;
6850 event
.kind
= BUFFER_SWITCH_EVENT
;
6851 event
.frame_or_window
= Qnil
;
6855 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6856 The purpose of the event is to make read_key_sequence look up the
6857 keymaps again. If we aren't in read_key_sequence, we don't need one,
6858 and the event could cause trouble by messing up (input-pending-p). */
6859 tem
= Fwaiting_for_user_input_p ();
6863 /* We never need these events if we have no asynchronous subprocesses. */
6867 /* Make sure no interrupt happens while storing the event. */
6869 if (interrupt_input
)
6872 mask
= sigblock (sigmask (SIGIO
));
6873 kbd_buffer_store_event (&event
);
6880 kbd_buffer_store_event (&event
);
6887 /* Read any terminal input already buffered up by the system
6888 into the kbd_buffer, but do not wait.
6890 EXPECTED should be nonzero if the caller knows there is some input.
6892 Except on VMS, all input is read by this function.
6893 If interrupt_input is nonzero, this function MUST be called
6894 only when SIGIO is blocked.
6896 Returns the number of keyboard chars read, or -1 meaning
6897 this is a bad time to try to read input. */
6900 read_avail_input (expected
)
6907 /* Loop through the available terminals, and call their input hooks. */
6911 struct terminal
*next
= t
->next_terminal
;
6913 if (t
->read_socket_hook
)
6916 struct input_event hold_quit
;
6918 EVENT_INIT (hold_quit
);
6919 hold_quit
.kind
= NO_EVENT
;
6921 /* No need for FIONREAD or fcntl; just say don't wait. */
6922 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6928 if (nr
== -1) /* Not OK to read input now. */
6932 else if (nr
== -2) /* Non-transient error. */
6934 /* The terminal device terminated; it should be closed. */
6936 /* Kill Emacs if this was our last terminal. */
6937 if (!terminal_list
->next_terminal
)
6938 /* Formerly simply reported no input, but that
6939 sometimes led to a failure of Emacs to terminate.
6940 SIGHUP seems appropriate if we can't reach the
6942 /* ??? Is it really right to send the signal just to
6943 this process rather than to the whole process
6944 group? Perhaps on systems with FIONREAD Emacs is
6945 alone in its group. */
6946 kill (getpid (), SIGHUP
);
6948 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
6949 if (t
->delete_terminal_hook
)
6950 (*t
->delete_terminal_hook
) (t
);
6952 delete_terminal (t
);
6955 if (hold_quit
.kind
!= NO_EVENT
)
6956 kbd_buffer_store_event (&hold_quit
);
6968 /* This is the tty way of reading available input.
6970 Note that each terminal device has its own `struct terminal' object,
6971 and so this function is called once for each individual termcap
6972 terminal. The first parameter indicates which terminal to read from. */
6975 tty_read_avail_input (struct terminal
*terminal
,
6977 struct input_event
*hold_quit
)
6979 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6980 the kbd_buffer can really hold. That may prevent loss
6981 of characters on some systems when input is stuffed at us. */
6982 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6984 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6987 if (terminal
->deleted
) /* Don't read from a deleted terminal. */
6990 if (terminal
->type
!= output_termcap
)
6993 /* XXX I think the following code should be moved to separate hook
6994 functions in system-dependent files. */
6997 #else /* not WINDOWSNT */
6999 n_to_read
= dos_keysns ();
7003 cbuf
[0] = dos_keyread ();
7006 #else /* not MSDOS */
7008 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7012 return 0; /* The terminal is suspended. */
7014 /* Determine how many characters we should *try* to read. */
7016 /* Find out how much input is available. */
7017 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7019 if (! noninteractive
)
7020 return -2; /* Close this terminal. */
7026 if (n_to_read
> sizeof cbuf
)
7027 n_to_read
= sizeof cbuf
;
7028 #else /* no FIONREAD */
7029 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
7030 /* Read some input if available, but don't wait. */
7031 n_to_read
= sizeof cbuf
;
7032 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7038 /* Now read; for one reason or another, this will not block.
7039 NREAD is set to the number of chars read. */
7042 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7043 /* POSIX infers that processes which are not in the session leader's
7044 process group won't get SIGHUP's at logout time. BSDI adheres to
7045 this part standard and returns -1 from read (0) with errno==EIO
7046 when the control tty is taken away.
7047 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7048 if (nread
== -1 && errno
== EIO
)
7049 return -2; /* Close this terminal. */
7050 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
7051 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7052 This looks incorrect, but it isn't, because _BSD causes
7053 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7054 and that causes a value other than 0 when there is no input. */
7056 return -2; /* Close this terminal. */
7060 /* We used to retry the read if it was interrupted.
7061 But this does the wrong thing when O_NDELAY causes
7062 an EAGAIN error. Does anybody know of a situation
7063 where a retry is actually needed? */
7065 nread
< 0 && (errno
== EAGAIN
7079 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
7080 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7081 #endif /* USG or DGUX or CYGWIN */
7082 #endif /* no FIONREAD */
7087 #endif /* not MSDOS */
7088 #endif /* not WINDOWSNT */
7090 for (i
= 0; i
< nread
; i
++)
7092 struct input_event buf
;
7094 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7096 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7097 buf
.modifiers
= meta_modifier
;
7098 if (tty
->meta_key
!= 2)
7102 /* Set the frame corresponding to the active tty. Note that the
7103 value of selected_frame is not reliable here, redisplay tends
7104 to temporarily change it. */
7105 buf
.frame_or_window
= tty
->top_frame
;
7108 kbd_buffer_store_event (&buf
);
7109 /* Don't look at input that follows a C-g too closely.
7110 This reduces lossage due to autorepeat on C-g. */
7111 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7112 && buf
.code
== quit_char
)
7118 #endif /* not VMS */
7121 handle_async_input ()
7124 extern int select_alarmed
;
7127 interrupt_input_pending
= 0;
7132 nread
= read_avail_input (1);
7133 /* -1 means it's not ok to read the input now.
7134 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7135 0 means there was no keyboard input available. */
7140 select_alarmed
= 1; /* Force the select emulator back to life */
7145 #ifdef SIGIO /* for entire page */
7146 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7149 input_available_signal (signo
)
7152 /* Must preserve main program's value of errno. */
7153 int old_errno
= errno
;
7154 #if defined (USG) && !defined (POSIX_SIGNALS)
7155 /* USG systems forget handlers when they are used;
7156 must reestablish each time */
7157 signal (signo
, input_available_signal
);
7165 interrupt_input_pending
= 1;
7167 SIGNAL_THREAD_CHECK (signo
);
7170 if (input_available_clear_time
)
7171 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7174 handle_async_input ();
7184 /* Send ourselves a SIGIO.
7186 This function exists so that the UNBLOCK_INPUT macro in
7187 blockinput.h can have some way to take care of input we put off
7188 dealing with, without assuming that every file which uses
7189 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7191 reinvoke_input_signal ()
7194 handle_async_input ();
7200 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7201 static Lisp_Object menu_bar_one_keymap_changed_items
;
7203 /* These variables hold the vector under construction within
7204 menu_bar_items and its subroutines, and the current index
7205 for storing into that vector. */
7206 static Lisp_Object menu_bar_items_vector
;
7207 static int menu_bar_items_index
;
7209 /* Return a vector of menu items for a menu bar, appropriate
7210 to the current buffer. Each item has three elements in the vector:
7213 OLD is an old vector we can optionally reuse, or nil. */
7216 menu_bar_items (old
)
7219 /* The number of keymaps we're scanning right now, and the number of
7220 keymaps we have allocated space for. */
7223 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7224 in the current keymaps, or nil where it is not a prefix. */
7227 Lisp_Object def
, tail
;
7236 /* In order to build the menus, we need to call the keymap
7237 accessors. They all call QUIT. But this function is called
7238 during redisplay, during which a quit is fatal. So inhibit
7239 quitting while building the menus.
7240 We do this instead of specbind because (1) errors will clear it anyway
7241 and (2) this avoids risk of specpdl overflow. */
7242 oquit
= Vinhibit_quit
;
7246 menu_bar_items_vector
= old
;
7248 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7249 menu_bar_items_index
= 0;
7251 /* Build our list of keymaps.
7252 If we recognize a function key and replace its escape sequence in
7253 keybuf with its symbol, or if the sequence starts with a mouse
7254 click and we need to switch buffers, we jump back here to rebuild
7255 the initial keymaps from the current buffer. */
7259 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7260 if (!NILP (Voverriding_local_map_menu_flag
))
7262 /* Yes, use them (if non-nil) as well as the global map. */
7263 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7265 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7266 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7267 if (!NILP (Voverriding_local_map
))
7268 maps
[nmaps
++] = Voverriding_local_map
;
7272 /* No, so use major and minor mode keymaps and keymap property.
7273 Note that menu-bar bindings in the local-map and keymap
7274 properties may not work reliable, as they are only
7275 recognized when the menu-bar (or mode-line) is updated,
7276 which does not normally happen after every command. */
7279 nminor
= current_minor_maps (NULL
, &tmaps
);
7280 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7282 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7283 maps
[nmaps
++] = tem
;
7284 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7286 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7288 maps
[nmaps
++] = current_global_map
;
7291 /* Look up in each map the dummy prefix key `menu-bar'. */
7295 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7296 if (!NILP (maps
[mapno
]))
7298 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7302 menu_bar_one_keymap_changed_items
= Qnil
;
7303 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7307 /* Move to the end those items that should be at the end. */
7309 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7312 int end
= menu_bar_items_index
;
7314 for (i
= 0; i
< end
; i
+= 4)
7315 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7317 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7318 /* Move the item at index I to the end,
7319 shifting all the others forward. */
7320 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7321 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7322 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7323 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7325 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7326 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7327 (end
- i
- 4) * sizeof (Lisp_Object
));
7328 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7329 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7330 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7331 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7336 /* Add nil, nil, nil, nil at the end. */
7337 i
= menu_bar_items_index
;
7338 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7341 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7342 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7343 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7344 menu_bar_items_vector
= tem
;
7346 /* Add this item. */
7347 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7348 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7349 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7350 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7351 menu_bar_items_index
= i
;
7353 Vinhibit_quit
= oquit
;
7354 return menu_bar_items_vector
;
7357 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7358 If there's already an item for KEY, add this DEF to it. */
7360 Lisp_Object item_properties
;
7363 menu_bar_item (key
, item
, dummy1
, dummy2
)
7364 Lisp_Object key
, item
, dummy1
;
7367 struct gcpro gcpro1
;
7371 if (EQ (item
, Qundefined
))
7373 /* If a map has an explicit `undefined' as definition,
7374 discard any previously made menu bar item. */
7376 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7377 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7379 if (menu_bar_items_index
> i
+ 4)
7380 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7381 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7382 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7383 menu_bar_items_index
-= 4;
7387 /* If this keymap has already contributed to this KEY,
7388 don't contribute to it a second time. */
7389 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7390 if (!NILP (tem
) || NILP (item
))
7393 menu_bar_one_keymap_changed_items
7394 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7396 /* We add to menu_bar_one_keymap_changed_items before doing the
7397 parse_menu_item, so that if it turns out it wasn't a menu item,
7398 it still correctly hides any further menu item. */
7400 i
= parse_menu_item (item
, 0, 1);
7405 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7407 /* Find any existing item for this KEY. */
7408 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7409 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7412 /* If we did not find this KEY, add it at the end. */
7413 if (i
== menu_bar_items_index
)
7415 /* If vector is too small, get a bigger one. */
7416 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7419 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7420 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7421 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7422 menu_bar_items_vector
= tem
;
7425 /* Add this item. */
7426 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7427 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7428 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7429 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7430 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7431 menu_bar_items_index
= i
;
7433 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7437 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7438 /* If the new and the old items are not both keymaps,
7439 the lookup will only find `item'. */
7440 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7441 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7445 /* This is used as the handler when calling menu_item_eval_property. */
7447 menu_item_eval_property_1 (arg
)
7450 /* If we got a quit from within the menu computation,
7451 quit all the way out of it. This takes care of C-] in the debugger. */
7452 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7453 Fsignal (Qquit
, Qnil
);
7458 /* Evaluate an expression and return the result (or nil if something
7459 went wrong). Used to evaluate dynamic parts of menu items. */
7461 menu_item_eval_property (sexpr
)
7464 int count
= SPECPDL_INDEX ();
7466 specbind (Qinhibit_redisplay
, Qt
);
7467 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7468 menu_item_eval_property_1
);
7469 return unbind_to (count
, val
);
7472 /* This function parses a menu item and leaves the result in the
7473 vector item_properties.
7474 ITEM is a key binding, a possible menu item.
7475 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7476 evaluate dynamic expressions in the menu item.
7477 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7479 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7480 parse_menu_item returns true if the item is a menu item and false
7484 parse_menu_item (item
, notreal
, inmenubar
)
7486 int notreal
, inmenubar
;
7488 Lisp_Object def
, tem
, item_string
, start
;
7489 Lisp_Object cachelist
;
7491 Lisp_Object keyhint
;
7502 /* Create item_properties vector if necessary. */
7503 if (NILP (item_properties
))
7505 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7507 /* Initialize optional entries. */
7508 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7509 AREF (item_properties
, i
) = Qnil
;
7510 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7512 /* Save the item here to protect it from GC. */
7513 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7515 item_string
= XCAR (item
);
7519 if (STRINGP (item_string
))
7521 /* Old format menu item. */
7522 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7524 /* Maybe help string. */
7525 if (CONSP (item
) && STRINGP (XCAR (item
)))
7527 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7532 /* Maybe key binding cache. */
7533 if (CONSP (item
) && CONSP (XCAR (item
))
7534 && (NILP (XCAR (XCAR (item
)))
7535 || VECTORP (XCAR (XCAR (item
)))))
7537 cachelist
= XCAR (item
);
7541 /* This is the real definition--the function to run. */
7542 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7544 /* Get enable property, if any. */
7547 tem
= Fget (item
, Qmenu_enable
);
7548 if (!NILP (Venable_disabled_menus_and_buttons
))
7549 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7550 else if (!NILP (tem
))
7551 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7554 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7556 /* New format menu item. */
7557 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7558 start
= XCDR (item
);
7561 /* We have a real binding. */
7562 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7564 item
= XCDR (start
);
7565 /* Is there a cache list with key equivalences. */
7566 if (CONSP (item
) && CONSP (XCAR (item
)))
7568 cachelist
= XCAR (item
);
7572 /* Parse properties. */
7573 while (CONSP (item
) && CONSP (XCDR (item
)))
7578 if (EQ (tem
, QCenable
))
7580 if (!NILP (Venable_disabled_menus_and_buttons
))
7581 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7583 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7585 else if (EQ (tem
, QCvisible
) && !notreal
)
7587 /* If got a visible property and that evaluates to nil
7588 then ignore this item. */
7589 tem
= menu_item_eval_property (XCAR (item
));
7593 else if (EQ (tem
, QChelp
))
7594 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7595 else if (EQ (tem
, QCfilter
))
7597 else if (EQ (tem
, QCkey_sequence
))
7600 if (NILP (cachelist
)
7601 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7602 /* Be GC protected. Set keyhint to item instead of tem. */
7605 else if (EQ (tem
, QCkeys
))
7608 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7609 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7611 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7616 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7618 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7620 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7627 else if (inmenubar
|| !NILP (start
))
7631 return 0; /* not a menu item */
7633 /* If item string is not a string, evaluate it to get string.
7634 If we don't get a string, skip this item. */
7635 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7636 if (!(STRINGP (item_string
) || notreal
))
7638 item_string
= menu_item_eval_property (item_string
);
7639 if (!STRINGP (item_string
))
7641 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7644 /* If got a filter apply it on definition. */
7645 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7648 def
= menu_item_eval_property (list2 (XCAR (filter
),
7649 list2 (Qquote
, def
)));
7651 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7654 /* Enable or disable selection of item. */
7655 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7661 tem
= menu_item_eval_property (tem
);
7662 if (inmenubar
&& NILP (tem
))
7663 return 0; /* Ignore disabled items in menu bar. */
7664 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7667 /* If we got no definition, this item is just unselectable text which
7668 is OK in a submenu but not in the menubar. */
7670 return (inmenubar
? 0 : 1);
7672 /* See if this is a separate pane or a submenu. */
7673 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7674 tem
= get_keymap (def
, 0, 1);
7675 /* For a subkeymap, just record its details and exit. */
7678 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7679 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7683 /* At the top level in the menu bar, do likewise for commands also.
7684 The menu bar does not display equivalent key bindings anyway.
7685 ITEM_PROPERTY_DEF is already set up properly. */
7689 /* This is a command. See if there is an equivalent key binding. */
7690 if (NILP (cachelist
))
7692 /* We have to create a cachelist. */
7693 CHECK_IMPURE (start
);
7694 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7695 cachelist
= XCAR (XCDR (start
));
7697 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7698 if (!NILP (keyhint
))
7700 XSETCAR (cachelist
, XCAR (keyhint
));
7703 else if (STRINGP (tem
))
7705 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7706 XSETCAR (cachelist
, Qt
);
7710 tem
= XCAR (cachelist
);
7717 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
7719 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7722 def
= XCAR (prefix
);
7723 prefix
= XCDR (prefix
);
7726 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7728 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7730 if (newcache
/* Always check first time. */
7731 /* Should we check everything when precomputing key
7733 /* If something had no key binding before, don't recheck it
7734 because that is too slow--except if we have a list of
7735 rebound commands in Vdefine_key_rebound_commands, do
7736 recheck any command that appears in that list. */
7737 || (CONSP (Vdefine_key_rebound_commands
)
7738 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7741 /* We had a saved key. Is it still bound to the command? */
7744 /* If the command is an alias for another
7745 (such as lmenu.el set it up), check if the
7746 original command matches the cached command. */
7747 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7748 chkcache
= 1; /* Need to recompute key binding. */
7752 /* Recompute equivalent key binding. If the command is an alias
7753 for another (such as lmenu.el set it up), see if the original
7754 command name has equivalent keys. Otherwise look up the
7755 specified command itself. We don't try both, because that
7756 makes lmenu menus slow. */
7758 && SYMBOLP (XSYMBOL (def
)->function
)
7759 && ! NILP (Fget (def
, Qmenu_alias
)))
7760 def
= XSYMBOL (def
)->function
;
7761 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7762 XSETCAR (cachelist
, tem
);
7765 XSETCDR (cachelist
, Qnil
);
7769 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7771 tem
= XCAR (cachelist
);
7775 newcache
= chkcache
;
7778 tem
= Fkey_description (tem
, Qnil
);
7781 if (STRINGP (XCAR (prefix
)))
7782 tem
= concat2 (XCAR (prefix
), tem
);
7783 if (STRINGP (XCDR (prefix
)))
7784 tem
= concat2 (tem
, XCDR (prefix
));
7786 XSETCDR (cachelist
, tem
);
7790 tem
= XCDR (cachelist
);
7791 if (newcache
&& !NILP (tem
))
7793 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7794 XSETCDR (cachelist
, tem
);
7797 /* If we only want to precompute equivalent key bindings, stop here. */
7801 /* If we have an equivalent key binding, use that. */
7802 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7804 /* Include this when menu help is implemented.
7805 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7806 if (!(NILP (tem) || STRINGP (tem)))
7808 tem = menu_item_eval_property (tem);
7811 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7815 /* Handle radio buttons or toggle boxes. */
7816 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7818 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7819 = menu_item_eval_property (tem
);
7826 /***********************************************************************
7828 ***********************************************************************/
7830 /* A vector holding tool bar items while they are parsed in function
7831 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7834 static Lisp_Object tool_bar_items_vector
;
7836 /* A vector holding the result of parse_tool_bar_item. Layout is like
7837 the one for a single item in tool_bar_items_vector. */
7839 static Lisp_Object tool_bar_item_properties
;
7841 /* Next free index in tool_bar_items_vector. */
7843 static int ntool_bar_items
;
7845 /* The symbols `tool-bar', and `:image'. */
7847 extern Lisp_Object Qtool_bar
;
7848 Lisp_Object QCimage
;
7850 /* Function prototypes. */
7852 static void init_tool_bar_items
P_ ((Lisp_Object
));
7853 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7854 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7855 static void append_tool_bar_item
P_ ((void));
7858 /* Return a vector of tool bar items for keymaps currently in effect.
7859 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7860 tool bar items found. */
7863 tool_bar_items (reuse
, nitems
)
7874 /* In order to build the menus, we need to call the keymap
7875 accessors. They all call QUIT. But this function is called
7876 during redisplay, during which a quit is fatal. So inhibit
7877 quitting while building the menus. We do this instead of
7878 specbind because (1) errors will clear it anyway and (2) this
7879 avoids risk of specpdl overflow. */
7880 oquit
= Vinhibit_quit
;
7883 /* Initialize tool_bar_items_vector and protect it from GC. */
7884 init_tool_bar_items (reuse
);
7886 /* Build list of keymaps in maps. Set nmaps to the number of maps
7889 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7890 if (!NILP (Voverriding_local_map_menu_flag
))
7892 /* Yes, use them (if non-nil) as well as the global map. */
7893 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7895 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7896 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7897 if (!NILP (Voverriding_local_map
))
7898 maps
[nmaps
++] = Voverriding_local_map
;
7902 /* No, so use major and minor mode keymaps and keymap property.
7903 Note that tool-bar bindings in the local-map and keymap
7904 properties may not work reliable, as they are only
7905 recognized when the tool-bar (or mode-line) is updated,
7906 which does not normally happen after every command. */
7909 nminor
= current_minor_maps (NULL
, &tmaps
);
7910 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7912 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7913 maps
[nmaps
++] = tem
;
7914 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7916 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7919 /* Add global keymap at the end. */
7920 maps
[nmaps
++] = current_global_map
;
7922 /* Process maps in reverse order and look up in each map the prefix
7924 for (i
= nmaps
- 1; i
>= 0; --i
)
7925 if (!NILP (maps
[i
]))
7929 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7931 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7934 Vinhibit_quit
= oquit
;
7935 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7936 return tool_bar_items_vector
;
7940 /* Process the definition of KEY which is DEF. */
7943 process_tool_bar_item (key
, def
, data
, args
)
7944 Lisp_Object key
, def
, data
;
7948 extern Lisp_Object Qundefined
;
7949 struct gcpro gcpro1
, gcpro2
;
7951 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7955 if (EQ (def
, Qundefined
))
7957 /* If a map has an explicit `undefined' as definition,
7958 discard any previously made item. */
7959 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7961 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7963 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7965 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7966 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7967 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7968 * sizeof (Lisp_Object
)));
7969 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7974 else if (parse_tool_bar_item (key
, def
))
7975 /* Append a new tool bar item to tool_bar_items_vector. Accept
7976 more than one definition for the same key. */
7977 append_tool_bar_item ();
7983 /* Parse a tool bar item specification ITEM for key KEY and return the
7984 result in tool_bar_item_properties. Value is zero if ITEM is
7987 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7989 CAPTION is the caption of the item, If it's not a string, it is
7990 evaluated to get a string.
7992 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7993 as binding are currently ignored.
7995 The following properties are recognized:
7999 FORM is evaluated and specifies whether the tool bar item is
8000 enabled or disabled.
8004 FORM is evaluated and specifies whether the tool bar item is visible.
8006 - `:filter FUNCTION'
8008 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8009 result is stored as the new binding.
8011 - `:button (TYPE SELECTED)'
8013 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8014 and specifies whether the button is selected (pressed) or not.
8018 IMAGES is either a single image specification or a vector of four
8019 image specifications. See enum tool_bar_item_images.
8021 - `:help HELP-STRING'.
8023 Gives a help string to display for the tool bar item. */
8026 parse_tool_bar_item (key
, item
)
8027 Lisp_Object key
, item
;
8029 /* Access slot with index IDX of vector tool_bar_item_properties. */
8030 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8032 Lisp_Object filter
= Qnil
;
8033 Lisp_Object caption
;
8036 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8037 Rule out items that aren't lists, don't start with
8038 `menu-item' or whose rest following `tool-bar-item' is not a
8041 || !EQ (XCAR (item
), Qmenu_item
)
8042 || (item
= XCDR (item
),
8046 /* Create tool_bar_item_properties vector if necessary. Reset it to
8048 if (VECTORP (tool_bar_item_properties
))
8050 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8054 tool_bar_item_properties
8055 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8058 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8059 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8061 /* Get the caption of the item. If the caption is not a string,
8062 evaluate it to get a string. If we don't get a string, skip this
8064 caption
= XCAR (item
);
8065 if (!STRINGP (caption
))
8067 caption
= menu_item_eval_property (caption
);
8068 if (!STRINGP (caption
))
8071 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8073 /* Give up if rest following the caption is not a list. */
8078 /* Store the binding. */
8079 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8082 /* Ignore cached key binding, if any. */
8083 if (CONSP (item
) && CONSP (XCAR (item
)))
8086 /* Process the rest of the properties. */
8087 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8089 Lisp_Object key
, value
;
8092 value
= XCAR (XCDR (item
));
8094 if (EQ (key
, QCenable
))
8096 /* `:enable FORM'. */
8097 if (!NILP (Venable_disabled_menus_and_buttons
))
8098 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8100 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8102 else if (EQ (key
, QCvisible
))
8104 /* `:visible FORM'. If got a visible property and that
8105 evaluates to nil then ignore this item. */
8106 if (NILP (menu_item_eval_property (value
)))
8109 else if (EQ (key
, QChelp
))
8110 /* `:help HELP-STRING'. */
8111 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8112 else if (EQ (key
, QCfilter
))
8113 /* ':filter FORM'. */
8115 else if (EQ (key
, QCbutton
) && CONSP (value
))
8117 /* `:button (TYPE . SELECTED)'. */
8118 Lisp_Object type
, selected
;
8120 type
= XCAR (value
);
8121 selected
= XCDR (value
);
8122 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8124 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8125 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8128 else if (EQ (key
, QCimage
)
8130 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8131 /* Value is either a single image specification or a vector
8132 of 4 such specifications for the different button states. */
8133 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8136 /* If got a filter apply it on binding. */
8138 PROP (TOOL_BAR_ITEM_BINDING
)
8139 = menu_item_eval_property (list2 (filter
,
8141 PROP (TOOL_BAR_ITEM_BINDING
))));
8143 /* See if the binding is a keymap. Give up if it is. */
8144 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8147 /* Enable or disable selection of item. */
8148 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8149 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8150 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8152 /* Handle radio buttons or toggle boxes. */
8153 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8154 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8155 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8163 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8164 that can be reused. */
8167 init_tool_bar_items (reuse
)
8170 if (VECTORP (reuse
))
8171 tool_bar_items_vector
= reuse
;
8173 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8174 ntool_bar_items
= 0;
8178 /* Append parsed tool bar item properties from
8179 tool_bar_item_properties */
8182 append_tool_bar_item ()
8184 Lisp_Object
*to
, *from
;
8186 /* Enlarge tool_bar_items_vector if necessary. */
8187 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8188 >= XVECTOR (tool_bar_items_vector
)->size
)
8190 Lisp_Object new_vector
;
8191 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8193 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8194 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8195 XVECTOR (new_vector
)->contents
,
8196 old_size
* sizeof (Lisp_Object
));
8197 tool_bar_items_vector
= new_vector
;
8200 /* Append entries from tool_bar_item_properties to the end of
8201 tool_bar_items_vector. */
8202 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8203 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8204 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8205 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8212 /* Read a character using menus based on maps in the array MAPS.
8213 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8214 Return t if we displayed a menu but the user rejected it.
8216 PREV_EVENT is the previous input event, or nil if we are reading
8217 the first event of a key sequence.
8219 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8220 if we used a mouse menu to read the input, or zero otherwise. If
8221 USED_MOUSE_MENU is null, we don't dereference it.
8223 The prompting is done based on the prompt-string of the map
8224 and the strings associated with various map elements.
8226 This can be done with X menus or with menus put in the minibuf.
8227 These are done in different ways, depending on how the input will be read.
8228 Menus using X are done after auto-saving in read-char, getting the input
8229 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8230 and do auto-saving in the inner call of read_char. */
8233 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8236 Lisp_Object prev_event
;
8237 int *used_mouse_menu
;
8240 register Lisp_Object name
= Qnil
;
8242 if (used_mouse_menu
)
8243 *used_mouse_menu
= 0;
8245 /* Use local over global Menu maps */
8247 if (! menu_prompting
)
8250 /* Optionally disregard all but the global map. */
8251 if (inhibit_local_menu_bar_menus
)
8253 maps
+= (nmaps
- 1);
8257 /* Get the menu name from the first map that has one (a prompt string). */
8258 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8260 name
= Fkeymap_prompt (maps
[mapno
]);
8265 /* If we don't have any menus, just read a character normally. */
8266 if (!STRINGP (name
))
8270 /* If we got to this point via a mouse click,
8271 use a real menu for mouse selection. */
8272 if (EVENT_HAS_PARAMETERS (prev_event
)
8273 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8274 && !EQ (XCAR (prev_event
), Qtool_bar
))
8276 /* Display the menu and get the selection. */
8277 Lisp_Object
*realmaps
8278 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8282 /* Use the maps that are not nil. */
8283 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8284 if (!NILP (maps
[mapno
]))
8285 realmaps
[nmaps1
++] = maps
[mapno
];
8287 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8292 record_menu_key (XCAR (value
));
8294 /* If we got multiple events, unread all but
8296 There is no way to prevent those unread events
8297 from showing up later in last_nonmenu_event.
8298 So turn symbol and integer events into lists,
8299 to indicate that they came from a mouse menu,
8300 so that when present in last_nonmenu_event
8301 they won't confuse things. */
8302 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8304 record_menu_key (XCAR (tem
));
8305 if (SYMBOLP (XCAR (tem
))
8306 || INTEGERP (XCAR (tem
)))
8307 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8310 /* If we got more than one event, put all but the first
8311 onto this list to be read later.
8312 Return just the first event now. */
8313 Vunread_command_events
8314 = nconc2 (XCDR (value
), Vunread_command_events
);
8315 value
= XCAR (value
);
8317 else if (NILP (value
))
8319 if (used_mouse_menu
)
8320 *used_mouse_menu
= 1;
8323 #endif /* HAVE_MENUS */
8327 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8328 We make this bigger when necessary, and never free it. */
8329 static char *read_char_minibuf_menu_text
;
8330 /* Size of that buffer. */
8331 static int read_char_minibuf_menu_width
;
8334 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8340 register Lisp_Object name
;
8342 /* FIXME: Use the minibuffer's frame width. */
8343 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8346 Lisp_Object rest
, vector
;
8352 if (! menu_prompting
)
8355 /* Make sure we have a big enough buffer for the menu text. */
8356 if (read_char_minibuf_menu_text
== 0)
8358 read_char_minibuf_menu_width
= width
+ 4;
8359 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8361 else if (width
+ 4 > read_char_minibuf_menu_width
)
8363 read_char_minibuf_menu_width
= width
+ 4;
8364 read_char_minibuf_menu_text
8365 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8367 menu
= read_char_minibuf_menu_text
;
8369 /* Get the menu name from the first map that has one (a prompt string). */
8370 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8372 name
= Fkeymap_prompt (maps
[mapno
]);
8377 /* If we don't have any menus, just read a character normally. */
8378 if (!STRINGP (name
))
8381 /* Prompt string always starts with map's prompt, and a space. */
8382 strcpy (menu
, SDATA (name
));
8383 nlength
= SBYTES (name
);
8384 menu
[nlength
++] = ':';
8385 menu
[nlength
++] = ' ';
8388 /* Start prompting at start of first map. */
8392 /* Present the documented bindings, a line at a time. */
8399 Lisp_Object orig_defn_macro
;
8401 /* Loop over elements of map. */
8406 /* If reached end of map, start at beginning of next map. */
8410 /* At end of last map, wrap around to first map if just starting,
8411 or end this line if already have something on it. */
8415 if (notfirst
|| nobindings
) break;
8420 /* Look at the next element of the map. */
8422 elt
= XVECTOR (vector
)->contents
[idx
];
8424 elt
= Fcar_safe (rest
);
8426 if (idx
< 0 && VECTORP (elt
))
8428 /* If we found a dense table in the keymap,
8429 advanced past it, but start scanning its contents. */
8430 rest
= Fcdr_safe (rest
);
8436 /* An ordinary element. */
8437 Lisp_Object event
, tem
;
8441 event
= Fcar_safe (elt
); /* alist */
8442 elt
= Fcdr_safe (elt
);
8446 XSETINT (event
, idx
); /* vector */
8449 /* Ignore the element if it has no prompt string. */
8450 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8452 /* 1 if the char to type matches the string. */
8454 Lisp_Object upcased_event
, downcased_event
;
8455 Lisp_Object desc
= Qnil
;
8457 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8459 upcased_event
= Fupcase (event
);
8460 downcased_event
= Fdowncase (event
);
8461 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8462 || XINT (downcased_event
) == SREF (s
, 0));
8464 desc
= Fsingle_key_description (event
, Qnil
);
8466 #if 0 /* It is redundant to list the equivalent key bindings because
8467 the prefix is what the user has already typed. */
8469 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8471 /* Insert equivalent keybinding. */
8472 s
= concat2 (s
, tem
);
8475 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8476 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8478 /* Insert button prefix. */
8479 Lisp_Object selected
8480 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8481 if (EQ (tem
, QCradio
))
8482 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8484 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8485 s
= concat2 (tem
, s
);
8489 /* If we have room for the prompt string, add it to this line.
8490 If this is the first on the line, always add it. */
8491 if ((SCHARS (s
) + i
+ 2
8492 + (char_matches
? 0 : SCHARS (desc
) + 3))
8498 /* Punctuate between strings. */
8501 strcpy (menu
+ i
, ", ");
8507 /* If the char to type doesn't match the string's
8508 first char, explicitly show what char to type. */
8511 /* Add as much of string as fits. */
8512 thiswidth
= SCHARS (desc
);
8513 if (thiswidth
+ i
> width
)
8514 thiswidth
= width
- i
;
8515 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8517 strcpy (menu
+ i
, " = ");
8521 /* Add as much of string as fits. */
8522 thiswidth
= SCHARS (s
);
8523 if (thiswidth
+ i
> width
)
8524 thiswidth
= width
- i
;
8525 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8531 /* If this element does not fit, end the line now,
8532 and save the element for the next line. */
8533 strcpy (menu
+ i
, "...");
8538 /* Move past this element. */
8539 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8540 /* Handle reaching end of dense table. */
8545 rest
= Fcdr_safe (rest
);
8549 /* Prompt with that and read response. */
8550 message2_nolog (menu
, strlen (menu
),
8551 ! NILP (current_buffer
->enable_multibyte_characters
));
8553 /* Make believe its not a keyboard macro in case the help char
8554 is pressed. Help characters are not recorded because menu prompting
8555 is not used on replay.
8557 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8558 current_kboard
->defining_kbd_macro
= Qnil
;
8560 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8561 while (BUFFERP (obj
));
8562 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8564 if (!INTEGERP (obj
))
8566 else if (XINT (obj
) == -2)
8571 if (! EQ (obj
, menu_prompt_more_char
)
8572 && (!INTEGERP (menu_prompt_more_char
)
8573 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8575 if (!NILP (current_kboard
->defining_kbd_macro
))
8576 store_kbd_macro_char (obj
);
8579 /* Help char - go round again */
8583 /* Reading key sequences. */
8585 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8586 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8587 keymap, or nil otherwise. Return the index of the first keymap in
8588 which KEY has any binding, or NMAPS if no map has a binding.
8590 If KEY is a meta ASCII character, treat it like meta-prefix-char
8591 followed by the corresponding non-meta character. Keymaps in
8592 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8595 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8598 NEXT may be the same array as CURRENT. */
8601 follow_key (key
, nmaps
, current
, defs
, next
)
8603 Lisp_Object
*current
, *defs
, *next
;
8606 int i
, first_binding
;
8608 first_binding
= nmaps
;
8609 for (i
= nmaps
- 1; i
>= 0; i
--)
8611 if (! NILP (current
[i
]))
8613 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8614 if (! NILP (defs
[i
]))
8621 /* Given the set of bindings we've found, produce the next set of maps. */
8622 if (first_binding
< nmaps
)
8623 for (i
= 0; i
< nmaps
; i
++)
8624 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8626 return first_binding
;
8629 /* Structure used to keep track of partial application of key remapping
8630 such as Vfunction_key_map and Vkey_translation_map. */
8631 typedef struct keyremap
8633 /* This is the map originally specified for this use. */
8635 /* This is a submap reached by looking up, in PARENT,
8636 the events from START to END. */
8638 /* Positions [START, END) in the key sequence buffer
8639 are the key that we have scanned so far.
8640 Those events are the ones that we will replace
8641 if PAREHT maps them into a key sequence. */
8645 /* Lookup KEY in MAP.
8646 MAP is a keymap mapping keys to key vectors or functions.
8647 If the mapping is a function and DO_FUNCTION is non-zero, then
8648 the function is called with PROMPT as parameter and its return
8649 value is used as the return value of this function (after checking
8650 that it is indeed a vector). */
8653 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8654 Lisp_Object map
, key
, prompt
;
8659 next
= access_keymap (map
, key
, 1, 0, 1);
8661 /* Handle symbol with autoload definition. */
8662 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8663 && CONSP (XSYMBOL (next
)->function
)
8664 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8665 do_autoload (XSYMBOL (next
)->function
, next
);
8667 /* Handle a symbol whose function definition is a keymap
8669 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8670 && (ARRAYP (XSYMBOL (next
)->function
)
8671 || KEYMAPP (XSYMBOL (next
)->function
)))
8672 next
= XSYMBOL (next
)->function
;
8674 /* If the keymap gives a function, not an
8675 array, then call the function with one arg and use
8676 its value instead. */
8677 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8682 next
= call1 (next
, prompt
);
8683 /* If the function returned something invalid,
8684 barf--don't ignore it.
8685 (To ignore it safely, we would need to gcpro a bunch of
8686 other variables.) */
8687 if (! (VECTORP (next
) || STRINGP (next
)))
8688 error ("Function %s returns invalid key sequence", tem
);
8693 /* Do one step of the key remapping used for function-key-map and
8694 key-translation-map:
8695 KEYBUF is the buffer holding the input events.
8696 BUFSIZE is its maximum size.
8697 FKEY is a pointer to the keyremap structure to use.
8698 INPUT is the index of the last element in KEYBUF.
8699 DOIT if non-zero says that the remapping can actually take place.
8700 DIFF is used to return the number of keys added/removed by the remapping.
8701 PARENT is the root of the keymap.
8702 PROMPT is the prompt to use if the remapping happens through a function.
8703 The return value is non-zero if the remapping actually took place. */
8706 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8707 Lisp_Object
*keybuf
, prompt
;
8709 int input
, doit
, *diff
, bufsize
;
8711 Lisp_Object next
, key
;
8713 key
= keybuf
[fkey
->end
++];
8715 if (KEYMAPP (fkey
->parent
))
8716 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8720 /* If keybuf[fkey->start..fkey->end] is bound in the
8721 map and we're in a position to do the key remapping, replace it with
8722 the binding and restart with fkey->start at the end. */
8723 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8725 int len
= XFASTINT (Flength (next
));
8728 *diff
= len
- (fkey
->end
- fkey
->start
);
8730 if (input
+ *diff
>= bufsize
)
8731 error ("Key sequence too long");
8733 /* Shift the keys that follow fkey->end. */
8735 for (i
= fkey
->end
; i
< input
; i
++)
8736 keybuf
[i
+ *diff
] = keybuf
[i
];
8738 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8739 keybuf
[i
+ *diff
] = keybuf
[i
];
8740 /* Overwrite the old keys with the new ones. */
8741 for (i
= 0; i
< len
; i
++)
8742 keybuf
[fkey
->start
+ i
]
8743 = Faref (next
, make_number (i
));
8745 fkey
->start
= fkey
->end
+= *diff
;
8746 fkey
->map
= fkey
->parent
;
8751 fkey
->map
= get_keymap (next
, 0, 1);
8753 /* If we no longer have a bound suffix, try a new position for
8755 if (!CONSP (fkey
->map
))
8757 fkey
->end
= ++fkey
->start
;
8758 fkey
->map
= fkey
->parent
;
8763 /* Read a sequence of keys that ends with a non prefix character,
8764 storing it in KEYBUF, a buffer of size BUFSIZE.
8766 Return the length of the key sequence stored.
8767 Return -1 if the user rejected a command menu.
8769 Echo starting immediately unless `prompt' is 0.
8771 Where a key sequence ends depends on the currently active keymaps.
8772 These include any minor mode keymaps active in the current buffer,
8773 the current buffer's local map, and the global map.
8775 If a key sequence has no other bindings, we check Vfunction_key_map
8776 to see if some trailing subsequence might be the beginning of a
8777 function key's sequence. If so, we try to read the whole function
8778 key, and substitute its symbolic name into the key sequence.
8780 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8781 `double-' events into similar click events, if that would make them
8782 bound. We try to turn `triple-' events first into `double-' events,
8785 If we get a mouse click in a mode line, vertical divider, or other
8786 non-text area, we treat the click as if it were prefixed by the
8787 symbol denoting that area - `mode-line', `vertical-line', or
8790 If the sequence starts with a mouse click, we read the key sequence
8791 with respect to the buffer clicked on, not the current buffer.
8793 If the user switches frames in the midst of a key sequence, we put
8794 off the switch-frame event until later; the next call to
8795 read_char will return it.
8797 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8798 from the selected window's buffer. */
8801 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8802 can_return_switch_frame
, fix_current_buffer
)
8803 Lisp_Object
*keybuf
;
8806 int dont_downcase_last
;
8807 int can_return_switch_frame
;
8808 int fix_current_buffer
;
8810 volatile Lisp_Object from_string
;
8811 volatile int count
= SPECPDL_INDEX ();
8813 /* How many keys there are in the current key sequence. */
8816 /* The length of the echo buffer when we started reading, and
8817 the length of this_command_keys when we started reading. */
8818 volatile int echo_start
;
8819 volatile int keys_start
;
8821 /* The number of keymaps we're scanning right now, and the number of
8822 keymaps we have allocated space for. */
8824 volatile int nmaps_allocated
= 0;
8826 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8827 the current keymaps. */
8828 Lisp_Object
*volatile defs
= NULL
;
8830 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8831 in the current keymaps, or nil where it is not a prefix. */
8832 Lisp_Object
*volatile submaps
= NULL
;
8834 /* The local map to start out with at start of key sequence. */
8835 volatile Lisp_Object orig_local_map
;
8837 /* The map from the `keymap' property to start out with at start of
8839 volatile Lisp_Object orig_keymap
;
8841 /* 1 if we have already considered switching to the local-map property
8842 of the place where a mouse click occurred. */
8843 volatile int localized_local_map
= 0;
8845 /* The index in defs[] of the first keymap that has a binding for
8846 this key sequence. In other words, the lowest i such that
8847 defs[i] is non-nil. */
8848 volatile int first_binding
;
8849 /* Index of the first key that has no binding.
8850 It is useless to try fkey.start larger than that. */
8851 volatile int first_unbound
;
8853 /* If t < mock_input, then KEYBUF[t] should be read as the next
8856 We use this to recover after recognizing a function key. Once we
8857 realize that a suffix of the current key sequence is actually a
8858 function key's escape sequence, we replace the suffix with the
8859 function key's binding from Vfunction_key_map. Now keybuf
8860 contains a new and different key sequence, so the echo area,
8861 this_command_keys, and the submaps and defs arrays are wrong. In
8862 this situation, we set mock_input to t, set t to 0, and jump to
8863 restart_sequence; the loop will read keys from keybuf up until
8864 mock_input, thus rebuilding the state; and then it will resume
8865 reading characters from the keyboard. */
8866 volatile int mock_input
= 0;
8868 /* If the sequence is unbound in submaps[], then
8869 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8870 and fkey.map is its binding.
8872 These might be > t, indicating that all function key scanning
8873 should hold off until t reaches them. We do this when we've just
8874 recognized a function key, to avoid searching for the function
8875 key's again in Vfunction_key_map. */
8876 volatile keyremap fkey
;
8878 /* Likewise, for key_translation_map. */
8879 volatile keyremap keytran
;
8881 /* If we receive a `switch-frame' or `select-window' event in the middle of
8882 a key sequence, we put it off for later.
8883 While we're reading, we keep the event here. */
8884 volatile Lisp_Object delayed_switch_frame
;
8886 /* See the comment below... */
8887 #if defined (GOBBLE_FIRST_EVENT)
8888 Lisp_Object first_event
;
8891 volatile Lisp_Object original_uppercase
;
8892 volatile int original_uppercase_position
= -1;
8894 /* Gets around Microsoft compiler limitations. */
8897 struct buffer
*starting_buffer
;
8899 /* List of events for which a fake prefix key has been generated. */
8900 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8902 #if defined (GOBBLE_FIRST_EVENT)
8906 struct gcpro gcpro1
;
8908 GCPRO1 (fake_prefixed_keys
);
8909 raw_keybuf_count
= 0;
8911 last_nonmenu_event
= Qnil
;
8913 delayed_switch_frame
= Qnil
;
8918 echo_prompt (prompt
);
8919 else if (cursor_in_echo_area
8920 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8921 && NILP (Fzerop (Vecho_keystrokes
)))
8922 /* This doesn't put in a dash if the echo buffer is empty, so
8923 you don't always see a dash hanging out in the minibuffer. */
8927 /* Record the initial state of the echo area and this_command_keys;
8928 we will need to restore them if we replay a key sequence. */
8930 echo_start
= echo_length ();
8931 keys_start
= this_command_key_count
;
8932 this_single_command_key_start
= keys_start
;
8934 #if defined (GOBBLE_FIRST_EVENT)
8935 /* This doesn't quite work, because some of the things that read_char
8936 does cannot safely be bypassed. It seems too risky to try to make
8939 /* Read the first char of the sequence specially, before setting
8940 up any keymaps, in case a filter runs and switches buffers on us. */
8941 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8943 #endif /* GOBBLE_FIRST_EVENT */
8945 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8946 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8949 /* We jump here when the key sequence has been thoroughly changed, and
8950 we need to rescan it starting from the beginning. When we jump here,
8951 keybuf[0..mock_input] holds the sequence we should reread. */
8954 /* We may switch keyboards between rescans, so we need to
8955 reinitialize fkey and keytran before each replay. */
8956 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8957 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8958 fkey
.start
= fkey
.end
= 0;
8959 keytran
.start
= keytran
.end
= 0;
8961 starting_buffer
= current_buffer
;
8962 first_unbound
= bufsize
+ 1;
8964 /* Build our list of keymaps.
8965 If we recognize a function key and replace its escape sequence in
8966 keybuf with its symbol, or if the sequence starts with a mouse
8967 click and we need to switch buffers, we jump back here to rebuild
8968 the initial keymaps from the current buffer. */
8971 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8973 if (2 > nmaps_allocated
)
8975 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
8976 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
8977 nmaps_allocated
= 2;
8979 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8980 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8982 else if (!NILP (Voverriding_local_map
))
8984 if (2 > nmaps_allocated
)
8986 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
8987 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
8988 nmaps_allocated
= 2;
8990 if (!NILP (Voverriding_local_map
))
8991 submaps
[nmaps
++] = Voverriding_local_map
;
8999 nminor
= current_minor_maps (0, &maps
);
9000 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9002 if (total
> nmaps_allocated
)
9004 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9005 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9006 nmaps_allocated
= total
;
9009 if (!NILP (orig_keymap
))
9010 submaps
[nmaps
++] = orig_keymap
;
9012 bcopy (maps
, (void *) (submaps
+ nmaps
),
9013 nminor
* sizeof (submaps
[0]));
9017 submaps
[nmaps
++] = orig_local_map
;
9019 submaps
[nmaps
++] = current_global_map
;
9021 /* Find an accurate initial value for first_binding. */
9022 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9023 if (! NILP (submaps
[first_binding
]))
9026 /* Start from the beginning in keybuf. */
9029 /* These are no-ops the first time through, but if we restart, they
9030 revert the echo area and this_command_keys to their original state. */
9031 this_command_key_count
= keys_start
;
9032 if (INTERACTIVE
&& t
< mock_input
)
9033 echo_truncate (echo_start
);
9035 /* If the best binding for the current key sequence is a keymap, or
9036 we may be looking at a function key's escape sequence, keep on
9038 while (first_binding
< nmaps
9039 /* Keep reading as long as there's a prefix binding. */
9040 ? !NILP (submaps
[first_binding
])
9041 /* Don't return in the middle of a possible function key sequence,
9042 if the only bindings we found were via case conversion.
9043 Thus, if ESC O a has a function-key-map translation
9044 and ESC o has a binding, don't return after ESC O,
9045 so that we can translate ESC O plus the next character. */
9046 : (fkey
.start
< t
|| keytran
.start
< t
))
9049 int used_mouse_menu
= 0;
9051 /* Where the last real key started. If we need to throw away a
9052 key that has expanded into more than one element of keybuf
9053 (say, a mouse click on the mode line which is being treated
9054 as [mode-line (mouse-...)], then we backtrack to this point
9056 volatile int last_real_key_start
;
9058 /* These variables are analogous to echo_start and keys_start;
9059 while those allow us to restart the entire key sequence,
9060 echo_local_start and keys_local_start allow us to throw away
9062 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9064 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
9065 eassert (fkey
.start
<= fkey
.end
);
9066 eassert (keytran
.start
<= keytran
.end
);
9067 /* key-translation-map is applied *after* function-key-map. */
9068 eassert (keytran
.end
<= fkey
.start
);
9070 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
9071 { /* The prefix upto first_unbound has no binding and has
9072 no translation left to do either, so we know it's unbound.
9073 If we don't stop now, we risk staying here indefinitely
9074 (if the user keeps entering fkey or keytran prefixes
9075 like C-c ESC ESC ESC ESC ...) */
9077 for (i
= first_unbound
+ 1; i
< t
; i
++)
9078 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9079 mock_input
= t
- first_unbound
- 1;
9080 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9081 fkey
.map
= fkey
.parent
;
9082 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9083 keytran
.map
= keytran
.parent
;
9084 goto replay_sequence
;
9088 error ("Key sequence too long");
9091 echo_local_start
= echo_length ();
9092 keys_local_start
= this_command_key_count
;
9093 local_first_binding
= first_binding
;
9096 /* These are no-ops, unless we throw away a keystroke below and
9097 jumped back up to replay_key; in that case, these restore the
9098 variables to their original state, allowing us to replay the
9100 if (INTERACTIVE
&& t
< mock_input
)
9101 echo_truncate (echo_local_start
);
9102 this_command_key_count
= keys_local_start
;
9103 first_binding
= local_first_binding
;
9105 /* By default, assume each event is "real". */
9106 last_real_key_start
= t
;
9108 /* Does mock_input indicate that we are re-reading a key sequence? */
9112 add_command_key (key
);
9113 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9114 && NILP (Fzerop (Vecho_keystrokes
)))
9118 /* If not, we should actually read a character. */
9123 KBOARD
*interrupted_kboard
= current_kboard
;
9124 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9126 key
= read_char (NILP (prompt
), nmaps
,
9127 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9128 &used_mouse_menu
, NULL
);
9130 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9135 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9136 if (k
== interrupted_kboard
)
9141 /* Don't touch interrupted_kboard when it's been
9143 delayed_switch_frame
= Qnil
;
9144 goto replay_sequence
;
9147 if (!NILP (delayed_switch_frame
))
9149 interrupted_kboard
->kbd_queue
9150 = Fcons (delayed_switch_frame
,
9151 interrupted_kboard
->kbd_queue
);
9152 delayed_switch_frame
= Qnil
;
9156 interrupted_kboard
->kbd_queue
9157 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9159 /* If the side queue is non-empty, ensure it begins with a
9160 switch-frame, so we'll replay it in the right context. */
9161 if (CONSP (interrupted_kboard
->kbd_queue
)
9162 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9163 !(EVENT_HAS_PARAMETERS (key
)
9164 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9168 XSETFRAME (frame
, interrupted_frame
);
9169 interrupted_kboard
->kbd_queue
9170 = Fcons (make_lispy_switch_frame (frame
),
9171 interrupted_kboard
->kbd_queue
);
9174 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9175 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9176 goto replay_sequence
;
9181 /* read_char returns t when it shows a menu and the user rejects it.
9185 unbind_to (count
, Qnil
);
9190 /* read_char returns -1 at the end of a macro.
9191 Emacs 18 handles this by returning immediately with a
9192 zero, so that's what we'll do. */
9193 if (INTEGERP (key
) && XINT (key
) == -1)
9196 /* The Microsoft C compiler can't handle the goto that
9202 /* If the current buffer has been changed from under us, the
9203 keymap may have changed, so replay the sequence. */
9206 timer_resume_idle ();
9209 /* Reset the current buffer from the selected window
9210 in case something changed the former and not the latter.
9211 This is to be more consistent with the behavior
9212 of the command_loop_1. */
9213 if (fix_current_buffer
)
9215 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9217 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9218 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9221 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9222 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9223 goto replay_sequence
;
9226 /* If we have a quit that was typed in another frame, and
9227 quit_throw_to_read_char switched buffers,
9228 replay to get the right keymap. */
9230 && XINT (key
) == quit_char
9231 && current_buffer
!= starting_buffer
)
9234 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9238 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9239 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9240 goto replay_sequence
;
9245 if (EVENT_HAS_PARAMETERS (key
)
9246 /* Either a `switch-frame' or a `select-window' event. */
9247 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9249 /* If we're at the beginning of a key sequence, and the caller
9250 says it's okay, go ahead and return this event. If we're
9251 in the midst of a key sequence, delay it until the end. */
9252 if (t
> 0 || !can_return_switch_frame
)
9254 delayed_switch_frame
= key
;
9260 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9263 /* Clicks in non-text areas get prefixed by the symbol
9264 in their CHAR-ADDRESS field. For example, a click on
9265 the mode line is prefixed by the symbol `mode-line'.
9267 Furthermore, key sequences beginning with mouse clicks
9268 are read using the keymaps of the buffer clicked on, not
9269 the current buffer. So we may have to switch the buffer
9272 When we turn one event into two events, we must make sure
9273 that neither of the two looks like the original--so that,
9274 if we replay the events, they won't be expanded again.
9275 If not for this, such reexpansion could happen either here
9276 or when user programs play with this-command-keys. */
9277 if (EVENT_HAS_PARAMETERS (key
))
9282 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9283 if (EQ (kind
, Qmouse_click
))
9285 Lisp_Object window
, posn
;
9287 window
= POSN_WINDOW (EVENT_START (key
));
9288 posn
= POSN_POSN (EVENT_START (key
));
9291 || (!NILP (fake_prefixed_keys
)
9292 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9294 /* We're looking a second time at an event for which
9295 we generated a fake prefix key. Set
9296 last_real_key_start appropriately. */
9298 last_real_key_start
= t
- 1;
9301 /* Key sequences beginning with mouse clicks are
9302 read using the keymaps in the buffer clicked on,
9303 not the current buffer. If we're at the
9304 beginning of a key sequence, switch buffers. */
9305 if (last_real_key_start
== 0
9307 && BUFFERP (XWINDOW (window
)->buffer
)
9308 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9310 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9314 /* Arrange to go back to the original buffer once we're
9315 done reading the key sequence. Note that we can't
9316 use save_excursion_{save,restore} here, because they
9317 save point as well as the current buffer; we don't
9318 want to save point, because redisplay may change it,
9319 to accommodate a Fset_window_start or something. We
9320 don't want to do this at the top of the function,
9321 because we may get input from a subprocess which
9322 wants to change the selected window and stuff (say,
9324 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9326 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9328 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9329 orig_local_map
= get_local_map (PT
, current_buffer
,
9331 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9332 goto replay_sequence
;
9335 /* For a mouse click, get the local text-property keymap
9336 of the place clicked on, rather than point. */
9337 if (last_real_key_start
== 0
9338 && CONSP (XCDR (key
))
9339 && ! localized_local_map
)
9341 Lisp_Object map_here
, start
, pos
;
9343 localized_local_map
= 1;
9344 start
= EVENT_START (key
);
9346 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9348 pos
= POSN_BUFFER_POSN (start
);
9350 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9352 map_here
= get_local_map (XINT (pos
),
9353 current_buffer
, Qlocal_map
);
9354 if (!EQ (map_here
, orig_local_map
))
9356 orig_local_map
= map_here
;
9357 ++localized_local_map
;
9360 map_here
= get_local_map (XINT (pos
),
9361 current_buffer
, Qkeymap
);
9362 if (!EQ (map_here
, orig_keymap
))
9364 orig_keymap
= map_here
;
9365 ++localized_local_map
;
9368 if (localized_local_map
> 1)
9373 goto replay_sequence
;
9379 /* Expand mode-line and scroll-bar events into two events:
9380 use posn as a fake prefix key. */
9382 && (NILP (fake_prefixed_keys
)
9383 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9385 if (t
+ 1 >= bufsize
)
9386 error ("Key sequence too long");
9389 keybuf
[t
+ 1] = key
;
9392 /* Record that a fake prefix key has been generated
9393 for KEY. Don't modify the event; this would
9394 prevent proper action when the event is pushed
9395 back into unread-command-events. */
9396 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9398 /* If on a mode line string with a local keymap,
9399 reconsider the key sequence with that keymap. */
9400 if (string
= POSN_STRING (EVENT_START (key
)),
9401 (CONSP (string
) && STRINGP (XCAR (string
))))
9403 Lisp_Object pos
, map
, map2
;
9405 pos
= XCDR (string
);
9406 string
= XCAR (string
);
9408 && XINT (pos
) < SCHARS (string
))
9410 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9412 orig_local_map
= map
;
9413 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9416 if (!NILP (map
) || !NILP (map2
))
9417 goto replay_sequence
;
9423 else if (NILP (from_string
)
9424 && (string
= POSN_STRING (EVENT_START (key
)),
9425 (CONSP (string
) && STRINGP (XCAR (string
)))))
9427 /* For a click on a string, i.e. overlay string or a
9428 string displayed via the `display' property,
9429 consider `local-map' and `keymap' properties of
9431 Lisp_Object pos
, map
, map2
;
9433 pos
= XCDR (string
);
9434 string
= XCAR (string
);
9436 && XINT (pos
) < SCHARS (string
))
9438 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9440 orig_local_map
= map
;
9441 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9445 if (!NILP (map
) || !NILP (map2
))
9447 from_string
= string
;
9448 goto replay_sequence
;
9453 else if (CONSP (XCDR (key
))
9454 && CONSP (EVENT_START (key
))
9455 && CONSP (XCDR (EVENT_START (key
))))
9459 posn
= POSN_POSN (EVENT_START (key
));
9460 /* Handle menu-bar events:
9461 insert the dummy prefix event `menu-bar'. */
9462 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9464 if (t
+ 1 >= bufsize
)
9465 error ("Key sequence too long");
9469 /* Zap the position in key, so we know that we've
9470 expanded it, and don't try to do so again. */
9471 POSN_SET_POSN (EVENT_START (key
),
9472 Fcons (posn
, Qnil
));
9475 goto replay_sequence
;
9477 else if (CONSP (posn
))
9479 /* We're looking at the second event of a
9480 sequence which we expanded before. Set
9481 last_real_key_start appropriately. */
9482 if (last_real_key_start
== t
&& t
> 0)
9483 last_real_key_start
= t
- 1;
9488 /* We have finally decided that KEY is something we might want
9490 first_binding
= (follow_key (key
,
9491 nmaps
- first_binding
,
9492 submaps
+ first_binding
,
9493 defs
+ first_binding
,
9494 submaps
+ first_binding
)
9497 /* If KEY wasn't bound, we'll try some fallbacks. */
9498 if (first_binding
< nmaps
)
9499 /* This is needed for the following scenario:
9500 event 0: a down-event that gets dropped by calling replay_key.
9501 event 1: some normal prefix like C-h.
9502 After event 0, first_unbound is 0, after event 1 fkey.start
9503 and keytran.start are both 1, so when we see that C-h is bound,
9504 we need to update first_unbound. */
9505 first_unbound
= max (t
+ 1, first_unbound
);
9510 /* Remember the position to put an upper bound on fkey.start. */
9511 first_unbound
= min (t
, first_unbound
);
9513 head
= EVENT_HEAD (key
);
9514 if (help_char_p (head
) && t
> 0)
9516 read_key_sequence_cmd
= Vprefix_help_command
;
9518 last_nonmenu_event
= key
;
9519 /* The Microsoft C compiler can't handle the goto that
9527 Lisp_Object breakdown
;
9530 breakdown
= parse_modifiers (head
);
9531 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9532 /* Attempt to reduce an unbound mouse event to a simpler
9533 event that is bound:
9534 Drags reduce to clicks.
9535 Double-clicks reduce to clicks.
9536 Triple-clicks reduce to double-clicks, then to clicks.
9537 Down-clicks are eliminated.
9538 Double-downs reduce to downs, then are eliminated.
9539 Triple-downs reduce to double-downs, then to downs,
9540 then are eliminated. */
9541 if (modifiers
& (down_modifier
| drag_modifier
9542 | double_modifier
| triple_modifier
))
9544 while (modifiers
& (down_modifier
| drag_modifier
9545 | double_modifier
| triple_modifier
))
9547 Lisp_Object new_head
, new_click
;
9548 if (modifiers
& triple_modifier
)
9549 modifiers
^= (double_modifier
| triple_modifier
);
9550 else if (modifiers
& double_modifier
)
9551 modifiers
&= ~double_modifier
;
9552 else if (modifiers
& drag_modifier
)
9553 modifiers
&= ~drag_modifier
;
9556 /* Dispose of this `down' event by simply jumping
9557 back to replay_key, to get another event.
9559 Note that if this event came from mock input,
9560 then just jumping back to replay_key will just
9561 hand it to us again. So we have to wipe out any
9564 We could delete keybuf[t] and shift everything
9565 after that to the left by one spot, but we'd also
9566 have to fix up any variable that points into
9567 keybuf, and shifting isn't really necessary
9570 Adding prefixes for non-textual mouse clicks
9571 creates two characters of mock input, and both
9572 must be thrown away. If we're only looking at
9573 the prefix now, we can just jump back to
9574 replay_key. On the other hand, if we've already
9575 processed the prefix, and now the actual click
9576 itself is giving us trouble, then we've lost the
9577 state of the keymaps we want to backtrack to, and
9578 we need to replay the whole sequence to rebuild
9581 Beyond that, only function key expansion could
9582 create more than two keys, but that should never
9583 generate mouse events, so it's okay to zero
9584 mock_input in that case too.
9586 FIXME: The above paragraph seems just plain
9587 wrong, if you consider things like
9588 xterm-mouse-mode. -stef
9590 Isn't this just the most wonderful code ever? */
9592 /* If mock_input > t + 1, the above simplification
9593 will actually end up dropping keys on the floor.
9594 This is probably OK for now, but even
9595 if mock_input <= t + 1, we need to adjust fkey
9597 Typical case [header-line down-mouse-N]:
9598 mock_input = 2, t = 1, fkey.end = 1,
9599 last_real_key_start = 0. */
9600 if (fkey
.end
> last_real_key_start
)
9602 fkey
.end
= fkey
.start
9603 = min (last_real_key_start
, fkey
.start
);
9604 fkey
.map
= fkey
.parent
;
9605 if (keytran
.end
> last_real_key_start
)
9607 keytran
.end
= keytran
.start
9608 = min (last_real_key_start
, keytran
.start
);
9609 keytran
.map
= keytran
.parent
;
9612 if (t
== last_real_key_start
)
9619 mock_input
= last_real_key_start
;
9620 goto replay_sequence
;
9625 = apply_modifiers (modifiers
, XCAR (breakdown
));
9627 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9629 /* Look for a binding for this new key. follow_key
9630 promises that it didn't munge submaps the
9631 last time we called it, since key was unbound. */
9633 = (follow_key (new_click
,
9634 nmaps
- local_first_binding
,
9635 submaps
+ local_first_binding
,
9636 defs
+ local_first_binding
,
9637 submaps
+ local_first_binding
)
9638 + local_first_binding
);
9640 /* If that click is bound, go for it. */
9641 if (first_binding
< nmaps
)
9646 /* Otherwise, we'll leave key set to the drag event. */
9653 /* Normally, last_nonmenu_event gets the previous key we read.
9654 But when a mouse popup menu is being used,
9655 we don't update last_nonmenu_event; it continues to hold the mouse
9656 event that preceded the first level of menu. */
9657 if (!used_mouse_menu
)
9658 last_nonmenu_event
= key
;
9660 /* Record what part of this_command_keys is the current key sequence. */
9661 this_single_command_key_start
= this_command_key_count
- t
;
9663 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9664 /* There is a binding and it's not a prefix.
9665 There is thus no function-key in this sequence.
9666 Moving fkey.start is important in this case to allow keytran.start
9667 to go over the sequence before we return (since we keep the
9668 invariant that keytran.end <= fkey.start). */
9671 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9674 /* If the sequence is unbound, see if we can hang a function key
9675 off the end of it. */
9676 /* Continue scan from fkey.end until we find a bound suffix. */
9677 while (fkey
.end
< t
)
9679 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9682 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9683 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9684 max (t
, mock_input
),
9685 /* If there's a binding (i.e.
9686 first_binding >= nmaps) we don't want
9687 to apply this function-key-mapping. */
9688 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9693 mock_input
= diff
+ max (t
, mock_input
);
9694 goto replay_sequence
;
9698 /* Look for this sequence in key-translation-map.
9699 Scan from keytran.end until we find a bound suffix. */
9700 while (keytran
.end
< fkey
.start
)
9702 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9705 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9706 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9711 mock_input
= diff
+ max (t
, mock_input
);
9712 /* Adjust the function-key-map counters. */
9716 goto replay_sequence
;
9720 /* If KEY is not defined in any of the keymaps,
9721 and cannot be part of a function key or translation,
9722 and is an upper case letter
9723 use the corresponding lower-case letter instead. */
9724 if (first_binding
>= nmaps
9725 && fkey
.start
>= t
&& keytran
.start
>= t
9727 && ((((XINT (key
) & 0x3ffff)
9728 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9729 && UPPERCASEP (XINT (key
) & 0x3ffff))
9730 || (XINT (key
) & shift_modifier
)))
9732 Lisp_Object new_key
;
9734 original_uppercase
= key
;
9735 original_uppercase_position
= t
- 1;
9737 if (XINT (key
) & shift_modifier
)
9738 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9740 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9741 | (XINT (key
) & ~0x3ffff)));
9743 /* We have to do this unconditionally, regardless of whether
9744 the lower-case char is defined in the keymaps, because they
9745 might get translated through function-key-map. */
9746 keybuf
[t
- 1] = new_key
;
9747 mock_input
= max (t
, mock_input
);
9749 goto replay_sequence
;
9751 /* If KEY is not defined in any of the keymaps,
9752 and cannot be part of a function key or translation,
9753 and is a shifted function key,
9754 use the corresponding unshifted function key instead. */
9755 if (first_binding
>= nmaps
9756 && fkey
.start
>= t
&& keytran
.start
>= t
9759 Lisp_Object breakdown
;
9762 breakdown
= parse_modifiers (key
);
9763 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9764 if (modifiers
& shift_modifier
)
9766 Lisp_Object new_key
;
9768 original_uppercase
= key
;
9769 original_uppercase_position
= t
- 1;
9771 modifiers
&= ~shift_modifier
;
9772 new_key
= apply_modifiers (modifiers
,
9775 keybuf
[t
- 1] = new_key
;
9776 mock_input
= max (t
, mock_input
);
9777 fkey
.start
= fkey
.end
= 0;
9778 keytran
.start
= keytran
.end
= 0;
9780 goto replay_sequence
;
9786 read_key_sequence_cmd
= (first_binding
< nmaps
9787 ? defs
[first_binding
]
9790 unread_switch_frame
= delayed_switch_frame
;
9791 unbind_to (count
, Qnil
);
9793 /* Don't downcase the last character if the caller says don't.
9794 Don't downcase it if the result is undefined, either. */
9795 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9797 && t
- 1 == original_uppercase_position
)
9798 keybuf
[t
- 1] = original_uppercase
;
9800 /* Occasionally we fabricate events, perhaps by expanding something
9801 according to function-key-map, or by adding a prefix symbol to a
9802 mouse click in the scroll bar or modeline. In this cases, return
9803 the entire generated key sequence, even if we hit an unbound
9804 prefix or a definition before the end. This means that you will
9805 be able to push back the event properly, and also means that
9806 read-key-sequence will always return a logical unit.
9809 for (; t
< mock_input
; t
++)
9811 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9812 && NILP (Fzerop (Vecho_keystrokes
)))
9813 echo_char (keybuf
[t
]);
9814 add_command_key (keybuf
[t
]);
9823 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9824 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9825 The sequence is sufficient to specify a non-prefix command in the
9826 current local and global maps.
9828 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9829 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9830 as a continuation of the previous key.
9832 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9833 convert the last event to lower case. (Normally any upper case event
9834 is converted to lower case if the original event is undefined and the lower
9835 case equivalent is defined.) A non-nil value is appropriate for reading
9836 a key sequence to be defined.
9838 A C-g typed while in this function is treated like any other character,
9839 and `quit-flag' is not set.
9841 If the key sequence starts with a mouse click, then the sequence is read
9842 using the keymaps of the buffer of the window clicked in, not the buffer
9843 of the selected window as normal.
9845 `read-key-sequence' drops unbound button-down events, since you normally
9846 only care about the click or drag events which follow them. If a drag
9847 or multi-click event is unbound, but the corresponding click event would
9848 be bound, `read-key-sequence' turns the event into a click event at the
9849 drag's starting position. This means that you don't have to distinguish
9850 between click and drag, double, or triple events unless you want to.
9852 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9853 lines separating windows, and scroll bars with imaginary keys
9854 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9856 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9857 function will process a switch-frame event if the user switches frames
9858 before typing anything. If the user switches frames in the middle of a
9859 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9860 is nil, then the event will be put off until after the current key sequence.
9862 `read-key-sequence' checks `function-key-map' for function key
9863 sequences, where they wouldn't conflict with ordinary bindings. See
9864 `function-key-map' for more details.
9866 The optional fifth argument COMMAND-LOOP, if non-nil, means
9867 that this key sequence is being read by something that will
9868 read commands one after another. It should be nil if the caller
9869 will read just one key sequence. */)
9870 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9872 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9873 Lisp_Object can_return_switch_frame
, command_loop
;
9875 Lisp_Object keybuf
[30];
9877 struct gcpro gcpro1
;
9878 int count
= SPECPDL_INDEX ();
9881 CHECK_STRING (prompt
);
9884 specbind (Qinput_method_exit_on_first_char
,
9885 (NILP (command_loop
) ? Qt
: Qnil
));
9886 specbind (Qinput_method_use_echo_area
,
9887 (NILP (command_loop
) ? Qt
: Qnil
));
9889 bzero (keybuf
, sizeof keybuf
);
9891 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9893 if (NILP (continue_echo
))
9895 this_command_key_count
= 0;
9896 this_command_key_count_reset
= 0;
9897 this_single_command_key_start
= 0;
9900 #ifdef HAVE_X_WINDOWS
9901 if (display_hourglass_p
)
9902 cancel_hourglass ();
9905 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9906 prompt
, ! NILP (dont_downcase_last
),
9907 ! NILP (can_return_switch_frame
), 0);
9909 #if 0 /* The following is fine for code reading a key sequence and
9910 then proceeding with a lenghty computation, but it's not good
9911 for code reading keys in a loop, like an input method. */
9912 #ifdef HAVE_X_WINDOWS
9913 if (display_hourglass_p
)
9924 return unbind_to (count
, make_event_array (i
, keybuf
));
9927 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9928 Sread_key_sequence_vector
, 1, 5, 0,
9929 doc
: /* Like `read-key-sequence' but always return a vector. */)
9930 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9932 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9933 Lisp_Object can_return_switch_frame
, command_loop
;
9935 Lisp_Object keybuf
[30];
9937 struct gcpro gcpro1
;
9938 int count
= SPECPDL_INDEX ();
9941 CHECK_STRING (prompt
);
9944 specbind (Qinput_method_exit_on_first_char
,
9945 (NILP (command_loop
) ? Qt
: Qnil
));
9946 specbind (Qinput_method_use_echo_area
,
9947 (NILP (command_loop
) ? Qt
: Qnil
));
9949 bzero (keybuf
, sizeof keybuf
);
9951 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9953 if (NILP (continue_echo
))
9955 this_command_key_count
= 0;
9956 this_command_key_count_reset
= 0;
9957 this_single_command_key_start
= 0;
9960 #ifdef HAVE_X_WINDOWS
9961 if (display_hourglass_p
)
9962 cancel_hourglass ();
9965 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9966 prompt
, ! NILP (dont_downcase_last
),
9967 ! NILP (can_return_switch_frame
), 0);
9969 #ifdef HAVE_X_WINDOWS
9970 if (display_hourglass_p
)
9980 return unbind_to (count
, Fvector (i
, keybuf
));
9983 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9984 doc
: /* Execute CMD as an editor command.
9985 CMD must be a symbol that satisfies the `commandp' predicate.
9986 Optional second arg RECORD-FLAG non-nil
9987 means unconditionally put this command in `command-history'.
9988 Otherwise, that is done only if an arg is read using the minibuffer.
9989 The argument KEYS specifies the value to use instead of (this-command-keys)
9990 when reading the arguments; if it is nil, (this-command-keys) is used.
9991 The argument SPECIAL, if non-nil, means that this command is executing
9992 a special event, so ignore the prefix argument and don't clear it. */)
9993 (cmd
, record_flag
, keys
, special
)
9994 Lisp_Object cmd
, record_flag
, keys
, special
;
9996 register Lisp_Object final
;
9997 register Lisp_Object tem
;
9998 Lisp_Object prefixarg
;
9999 struct backtrace backtrace
;
10000 extern int debug_on_next_call
;
10002 debug_on_next_call
= 0;
10004 if (NILP (special
))
10006 prefixarg
= current_kboard
->Vprefix_arg
;
10007 Vcurrent_prefix_arg
= prefixarg
;
10008 current_kboard
->Vprefix_arg
= Qnil
;
10015 tem
= Fget (cmd
, Qdisabled
);
10016 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10018 tem
= Fsymbol_value (Qdisabled_command_function
);
10020 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10026 final
= Findirect_function (cmd
, Qnil
);
10028 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10030 struct gcpro gcpro1
, gcpro2
;
10032 GCPRO2 (cmd
, prefixarg
);
10033 do_autoload (final
, cmd
);
10040 if (STRINGP (final
) || VECTORP (final
))
10042 /* If requested, place the macro in the command history. For
10043 other sorts of commands, call-interactively takes care of
10045 if (!NILP (record_flag
))
10048 = Fcons (Fcons (Qexecute_kbd_macro
,
10049 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10052 /* Don't keep command history around forever. */
10053 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10055 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10057 XSETCDR (tem
, Qnil
);
10061 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10064 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10066 backtrace
.next
= backtrace_list
;
10067 backtrace_list
= &backtrace
;
10068 backtrace
.function
= &Qcall_interactively
;
10069 backtrace
.args
= &cmd
;
10070 backtrace
.nargs
= 1;
10071 backtrace
.evalargs
= 0;
10072 backtrace
.debug_on_exit
= 0;
10074 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
10076 backtrace_list
= backtrace
.next
;
10084 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10086 doc
: /* Read function name, then read its arguments and call it.
10088 To pass a numeric argument to the command you are invoking with, specify
10089 the numeric argument to this command.
10091 Noninteractively, the argument PREFIXARG is the prefix argument to
10092 give to the command you invoke, if it asks for an argument. */)
10094 Lisp_Object prefixarg
;
10096 Lisp_Object function
;
10098 int saved_last_point_position
;
10099 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10100 Lisp_Object bindings
, value
;
10101 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10102 #ifdef HAVE_X_WINDOWS
10103 /* The call to Fcompleting_read wil start and cancel the hourglass,
10104 but if the hourglass was already scheduled, this means that no
10105 hourglass will be shown for the actual M-x command itself.
10106 So we restart it if it is already scheduled. Note that checking
10107 hourglass_shown_p is not enough, normally the hourglass is not shown,
10108 just scheduled to be shown. */
10109 int hstarted
= hourglass_started ();
10112 saved_keys
= Fvector (this_command_key_count
,
10113 XVECTOR (this_command_keys
)->contents
);
10114 saved_last_point_position_buffer
= last_point_position_buffer
;
10115 saved_last_point_position
= last_point_position
;
10117 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10119 if (EQ (prefixarg
, Qminus
))
10120 strcpy (buf
, "- ");
10121 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10122 strcpy (buf
, "C-u ");
10123 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10124 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10125 else if (INTEGERP (prefixarg
))
10126 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10128 /* This isn't strictly correct if execute-extended-command
10129 is bound to anything else. Perhaps it should use
10130 this_command_keys? */
10131 strcat (buf
, "M-x ");
10133 /* Prompt with buf, and then read a string, completing from and
10134 restricting to the set of all defined commands. Don't provide
10135 any initial input. Save the command read on the extended-command
10137 function
= Fcompleting_read (build_string (buf
),
10138 Vobarray
, Qcommandp
,
10139 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10142 #ifdef HAVE_X_WINDOWS
10143 if (hstarted
) start_hourglass ();
10146 if (STRINGP (function
) && SCHARS (function
) == 0)
10147 error ("No command name given");
10149 /* Set this_command_keys to the concatenation of saved_keys and
10150 function, followed by a RET. */
10155 this_command_key_count
= 0;
10156 this_command_key_count_reset
= 0;
10157 this_single_command_key_start
= 0;
10159 keys
= XVECTOR (saved_keys
)->contents
;
10160 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10161 add_command_key (keys
[i
]);
10163 for (i
= 0; i
< SCHARS (function
); i
++)
10164 add_command_key (Faref (function
, make_number (i
)));
10166 add_command_key (make_number ('\015'));
10169 last_point_position
= saved_last_point_position
;
10170 last_point_position_buffer
= saved_last_point_position_buffer
;
10174 function
= Fintern (function
, Qnil
);
10175 current_kboard
->Vprefix_arg
= prefixarg
;
10176 Vthis_command
= function
;
10177 real_this_command
= function
;
10179 /* If enabled, show which key runs this command. */
10180 if (!NILP (Vsuggest_key_bindings
)
10181 && NILP (Vexecuting_kbd_macro
)
10182 && SYMBOLP (function
))
10183 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10189 GCPRO2 (bindings
, value
);
10190 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10192 /* If the command has a key binding, print it now. */
10193 if (!NILP (bindings
)
10194 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10197 /* But first wait, and skip the message if there is input. */
10198 Lisp_Object waited
;
10200 /* If this command displayed something in the echo area;
10201 wait a few seconds, then display our suggestion message. */
10202 if (NILP (echo_area_buffer
[0]))
10203 waited
= sit_for (make_number (0), 0, 2);
10204 else if (NUMBERP (Vsuggest_key_bindings
))
10205 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10207 waited
= sit_for (make_number (2), 0, 2);
10209 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10211 Lisp_Object binding
;
10213 int message_p
= push_message ();
10214 int count
= SPECPDL_INDEX ();
10216 record_unwind_protect (pop_message_unwind
, Qnil
);
10217 binding
= Fkey_description (bindings
, Qnil
);
10220 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10223 sprintf (newmessage
, "You can run the command `%s' with %s",
10224 SDATA (SYMBOL_NAME (function
)),
10226 message2_nolog (newmessage
,
10227 strlen (newmessage
),
10228 STRING_MULTIBYTE (binding
));
10229 if (NUMBERP (Vsuggest_key_bindings
))
10230 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10232 waited
= sit_for (make_number (2), 0, 2);
10234 if (!NILP (waited
) && message_p
)
10235 restore_message ();
10237 unbind_to (count
, Qnil
);
10241 RETURN_UNGCPRO (value
);
10245 /* Return nonzero if input events are pending. */
10248 detect_input_pending ()
10250 if (!input_pending
)
10251 get_input_pending (&input_pending
, 0);
10253 return input_pending
;
10256 /* Return nonzero if input events other than mouse movements are
10260 detect_input_pending_ignore_squeezables ()
10262 if (!input_pending
)
10263 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10265 return input_pending
;
10268 /* Return nonzero if input events are pending, and run any pending timers. */
10271 detect_input_pending_run_timers (do_display
)
10274 int old_timers_run
= timers_run
;
10276 if (!input_pending
)
10277 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10279 if (old_timers_run
!= timers_run
&& do_display
)
10281 redisplay_preserve_echo_area (8);
10282 /* The following fixes a bug when using lazy-lock with
10283 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10284 from an idle timer function. The symptom of the bug is that
10285 the cursor sometimes doesn't become visible until the next X
10286 event is processed. --gerd. */
10288 Lisp_Object tail
, frame
;
10289 FOR_EACH_FRAME (tail
, frame
)
10290 if (FRAME_RIF (XFRAME (frame
)))
10291 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10295 return input_pending
;
10298 /* This is called in some cases before a possible quit.
10299 It cases the next call to detect_input_pending to recompute input_pending.
10300 So calling this function unnecessarily can't do any harm. */
10303 clear_input_pending ()
10308 /* Return nonzero if there are pending requeued events.
10309 This isn't used yet. The hope is to make wait_reading_process_output
10310 call it, and return if it runs Lisp code that unreads something.
10311 The problem is, kbd_buffer_get_event needs to be fixed to know what
10312 to do in that case. It isn't trivial. */
10315 requeued_events_pending_p ()
10317 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10321 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10322 doc
: /* Return t if command input is currently available with no wait.
10323 Actually, the value is nil only if we can be sure that no input is available;
10324 if there is a doubt, the value is t. */)
10327 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10328 || !NILP (Vunread_post_input_method_events
)
10329 || !NILP (Vunread_input_method_events
))
10332 get_input_pending (&input_pending
,
10333 READABLE_EVENTS_DO_TIMERS_NOW
10334 | READABLE_EVENTS_FILTER_EVENTS
);
10335 return input_pending
> 0 ? Qt
: Qnil
;
10338 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10339 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10342 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10345 if (total_keys
< NUM_RECENT_KEYS
)
10346 return Fvector (total_keys
, keys
);
10349 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10350 bcopy (keys
+ recent_keys_index
,
10351 XVECTOR (val
)->contents
,
10352 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10354 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10355 recent_keys_index
* sizeof (Lisp_Object
));
10360 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10361 doc
: /* Return the key sequence that invoked this command.
10362 However, if the command has called `read-key-sequence', it returns
10363 the last key sequence that has been read.
10364 The value is a string or a vector. */)
10367 return make_event_array (this_command_key_count
,
10368 XVECTOR (this_command_keys
)->contents
);
10371 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10372 doc
: /* Return the key sequence that invoked this command, as a vector.
10373 However, if the command has called `read-key-sequence', it returns
10374 the last key sequence that has been read. */)
10377 return Fvector (this_command_key_count
,
10378 XVECTOR (this_command_keys
)->contents
);
10381 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10382 Sthis_single_command_keys
, 0, 0, 0,
10383 doc
: /* Return the key sequence that invoked this command.
10384 More generally, it returns the last key sequence read, either by
10385 the command loop or by `read-key-sequence'.
10386 Unlike `this-command-keys', this function's value
10387 does not include prefix arguments.
10388 The value is always a vector. */)
10391 return Fvector (this_command_key_count
10392 - this_single_command_key_start
,
10393 (XVECTOR (this_command_keys
)->contents
10394 + this_single_command_key_start
));
10397 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10398 Sthis_single_command_raw_keys
, 0, 0, 0,
10399 doc
: /* Return the raw events that were read for this command.
10400 More generally, it returns the last key sequence read, either by
10401 the command loop or by `read-key-sequence'.
10402 Unlike `this-single-command-keys', this function's value
10403 shows the events before all translations (except for input methods).
10404 The value is always a vector. */)
10407 return Fvector (raw_keybuf_count
,
10408 (XVECTOR (raw_keybuf
)->contents
));
10411 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10412 Sreset_this_command_lengths
, 0, 0, 0,
10413 doc
: /* Make the unread events replace the last command and echo.
10414 Used in `universal-argument-other-key'.
10416 `universal-argument-other-key' rereads the event just typed.
10417 It then gets translated through `function-key-map'.
10418 The translated event has to replace the real events,
10419 both in the value of (this-command-keys) and in echoing.
10420 To achieve this, `universal-argument-other-key' calls
10421 `reset-this-command-lengths', which discards the record of reading
10422 these events the first time. */)
10425 this_command_key_count
= before_command_key_count
;
10426 if (this_command_key_count
< this_single_command_key_start
)
10427 this_single_command_key_start
= this_command_key_count
;
10429 echo_truncate (before_command_echo_length
);
10431 /* Cause whatever we put into unread-command-events
10432 to echo as if it were being freshly read from the keyboard. */
10433 this_command_key_count_reset
= 1;
10438 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10439 Sclear_this_command_keys
, 0, 1, 0,
10440 doc
: /* Clear out the vector that `this-command-keys' returns.
10441 Also clear the record of the last 100 events, unless optional arg
10442 KEEP-RECORD is non-nil. */)
10444 Lisp_Object keep_record
;
10448 this_command_key_count
= 0;
10449 this_command_key_count_reset
= 0;
10451 if (NILP (keep_record
))
10453 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10454 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10456 recent_keys_index
= 0;
10461 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10462 doc
: /* Return the current depth in recursive edits. */)
10466 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10470 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10471 "FOpen dribble file: ",
10472 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10473 If FILE is nil, close any open dribble file. */)
10484 file
= Fexpand_file_name (file
, Qnil
);
10485 dribble
= fopen (SDATA (file
), "w");
10487 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10492 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10493 doc
: /* Discard the contents of the terminal input buffer.
10494 Also end any kbd macro being defined. */)
10497 if (!NILP (current_kboard
->defining_kbd_macro
))
10499 /* Discard the last command from the macro. */
10500 Fcancel_kbd_macro_events ();
10504 update_mode_lines
++;
10506 Vunread_command_events
= Qnil
;
10507 unread_command_char
= -1;
10509 discard_tty_input ();
10511 kbd_fetch_ptr
= kbd_store_ptr
;
10517 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10518 doc
: /* Stop Emacs and return to superior process. You can resume later.
10519 If `cannot-suspend' is non-nil, or if the system doesn't support job
10520 control, run a subshell instead.
10522 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10523 to be read as terminal input by Emacs's parent, after suspension.
10525 Before suspending, run the normal hook `suspend-hook'.
10526 After resumption run the normal hook `suspend-resume-hook'.
10528 Some operating systems cannot stop the Emacs process and resume it later.
10529 On such systems, Emacs starts a subshell instead of suspending. */)
10531 Lisp_Object stuffstring
;
10533 int count
= SPECPDL_INDEX ();
10534 int old_height
, old_width
;
10536 struct gcpro gcpro1
;
10538 if (tty_list
&& tty_list
->next
)
10539 error ("There are other tty frames open; close them before suspending Emacs");
10541 if (!NILP (stuffstring
))
10542 CHECK_STRING (stuffstring
);
10544 /* Run the functions in suspend-hook. */
10545 if (!NILP (Vrun_hooks
))
10546 call1 (Vrun_hooks
, intern ("suspend-hook"));
10548 GCPRO1 (stuffstring
);
10549 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10550 reset_all_sys_modes ();
10551 /* sys_suspend can get an error if it tries to fork a subshell
10552 and the system resources aren't available for that. */
10553 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10555 stuff_buffered_input (stuffstring
);
10556 if (cannot_suspend
)
10560 unbind_to (count
, Qnil
);
10562 /* Check if terminal/window size has changed.
10563 Note that this is not useful when we are running directly
10564 with a window system; but suspend should be disabled in that case. */
10565 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10566 if (width
!= old_width
|| height
!= old_height
)
10567 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10569 /* Run suspend-resume-hook. */
10570 if (!NILP (Vrun_hooks
))
10571 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10577 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10578 Then in any case stuff anything Emacs has read ahead and not used. */
10581 stuff_buffered_input (stuffstring
)
10582 Lisp_Object stuffstring
;
10584 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10585 register unsigned char *p
;
10587 if (STRINGP (stuffstring
))
10589 register int count
;
10591 p
= SDATA (stuffstring
);
10592 count
= SBYTES (stuffstring
);
10593 while (count
-- > 0)
10598 /* Anything we have read ahead, put back for the shell to read. */
10599 /* ?? What should this do when we have multiple keyboards??
10600 Should we ignore anything that was typed in at the "wrong" kboard?
10602 rms: we should stuff everything back into the kboard
10604 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10607 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10608 kbd_fetch_ptr
= kbd_buffer
;
10609 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10610 stuff_char (kbd_fetch_ptr
->code
);
10612 clear_event (kbd_fetch_ptr
);
10616 #endif /* SIGTSTP */
10620 set_waiting_for_input (time_to_clear
)
10621 EMACS_TIME
*time_to_clear
;
10623 input_available_clear_time
= time_to_clear
;
10625 /* Tell handle_interrupt to throw back to read_char, */
10626 waiting_for_input
= 1;
10628 /* If handle_interrupt was called before and buffered a C-g,
10629 make it run again now, to avoid timing error. */
10630 if (!NILP (Vquit_flag
))
10631 quit_throw_to_read_char ();
10635 clear_waiting_for_input ()
10637 /* Tell handle_interrupt not to throw back to read_char, */
10638 waiting_for_input
= 0;
10639 input_available_clear_time
= 0;
10642 /* The SIGINT handler.
10644 If we have a frame on the controlling tty, we assume that the
10645 SIGINT was generated by C-g, so we call handle_interrupt.
10646 Otherwise, the handler kills Emacs. */
10649 interrupt_signal (signalnum
) /* If we don't have an argument, */
10650 int signalnum
; /* some compilers complain in signal calls. */
10652 /* Must preserve main program's value of errno. */
10653 int old_errno
= errno
;
10654 struct terminal
*terminal
;
10656 #if defined (USG) && !defined (POSIX_SIGNALS)
10657 /* USG systems forget handlers when they are used;
10658 must reestablish each time */
10659 signal (SIGINT
, interrupt_signal
);
10660 signal (SIGQUIT
, interrupt_signal
);
10663 SIGNAL_THREAD_CHECK (signalnum
);
10665 /* See if we have an active terminal on our controlling tty. */
10666 terminal
= get_named_tty ("/dev/tty");
10669 /* If there are no frames there, let's pretend that we are a
10670 well-behaving UN*X program and quit. */
10671 Fkill_emacs (Qnil
);
10675 /* Otherwise, the SIGINT was probably generated by C-g. */
10677 /* Set internal_last_event_frame to the top frame of the
10678 controlling tty, if we have a frame there. We disable the
10679 interrupt key on secondary ttys, so the SIGINT must have come
10680 from the controlling tty. */
10681 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10683 handle_interrupt ();
10689 /* This routine is called at interrupt level in response to C-g.
10691 It is called from the SIGINT handler or kbd_buffer_store_event.
10693 If `waiting_for_input' is non zero, then unless `echoing' is
10694 nonzero, immediately throw back to read_char.
10696 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10697 eval to throw, when it gets a chance. If quit-flag is already
10698 non-nil, it stops the job right away. */
10701 handle_interrupt ()
10707 /* XXX This code needs to be revised for multi-tty support. */
10708 if (!NILP (Vquit_flag
)
10710 && get_named_tty ("/dev/tty")
10714 /* If SIGINT isn't blocked, don't let us be interrupted by
10715 another SIGINT, it might be harmful due to non-reentrancy
10716 in I/O functions. */
10717 sigblock (sigmask (SIGINT
));
10720 reset_all_sys_modes ();
10722 #ifdef SIGTSTP /* Support possible in later USG versions */
10724 * On systems which can suspend the current process and return to the original
10725 * shell, this command causes the user to end up back at the shell.
10726 * The "Auto-save" and "Abort" questions are not asked until
10727 * the user elects to return to emacs, at which point he can save the current
10728 * job and either dump core or continue.
10733 if (sys_suspend () == -1)
10735 printf ("Not running as a subprocess;\n");
10736 printf ("you can continue or abort.\n");
10738 #else /* not VMS */
10739 /* Perhaps should really fork an inferior shell?
10740 But that would not provide any way to get back
10741 to the original shell, ever. */
10742 printf ("No support for stopping a process on this operating system;\n");
10743 printf ("you can continue or abort.\n");
10744 #endif /* not VMS */
10745 #endif /* not SIGTSTP */
10747 /* We must remain inside the screen area when the internal terminal
10748 is used. Note that [Enter] is not echoed by dos. */
10751 /* It doesn't work to autosave while GC is in progress;
10752 the code used for auto-saving doesn't cope with the mark bit. */
10753 if (!gc_in_progress
)
10755 printf ("Auto-save? (y or n) ");
10757 if (((c
= getchar ()) & ~040) == 'Y')
10759 Fdo_auto_save (Qt
, Qnil
);
10761 printf ("\r\nAuto-save done");
10762 #else /* not MSDOS */
10763 printf ("Auto-save done\n");
10764 #endif /* not MSDOS */
10766 while (c
!= '\n') c
= getchar ();
10770 /* During GC, it must be safe to reenable quitting again. */
10771 Vinhibit_quit
= Qnil
;
10774 #endif /* not MSDOS */
10775 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10776 printf ("but will instead do a real quit after garbage collection ends\r\n");
10781 printf ("\r\nAbort? (y or n) ");
10782 #else /* not MSDOS */
10784 printf ("Abort (and enter debugger)? (y or n) ");
10785 #else /* not VMS */
10786 printf ("Abort (and dump core)? (y or n) ");
10787 #endif /* not VMS */
10788 #endif /* not MSDOS */
10790 if (((c
= getchar ()) & ~040) == 'Y')
10792 while (c
!= '\n') c
= getchar ();
10794 printf ("\r\nContinuing...\r\n");
10795 #else /* not MSDOS */
10796 printf ("Continuing...\n");
10797 #endif /* not MSDOS */
10799 init_all_sys_modes ();
10804 /* If executing a function that wants to be interrupted out of
10805 and the user has not deferred quitting by binding `inhibit-quit'
10806 then quit right away. */
10807 if (immediate_quit
&& NILP (Vinhibit_quit
))
10809 struct gl_state_s saved
;
10810 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10812 immediate_quit
= 0;
10815 GCPRO4 (saved
.object
, saved
.global_code
,
10816 saved
.current_syntax_table
, saved
.old_prop
);
10817 Fsignal (Qquit
, Qnil
);
10822 /* Else request quit when it's safe */
10826 if (waiting_for_input
&& !echoing
)
10827 quit_throw_to_read_char ();
10830 /* Handle a C-g by making read_char return C-g. */
10833 quit_throw_to_read_char ()
10836 /* Prevent another signal from doing this before we finish. */
10837 clear_waiting_for_input ();
10840 Vunread_command_events
= Qnil
;
10841 unread_command_char
= -1;
10843 #if 0 /* Currently, sit_for is called from read_char without turning
10844 off polling. And that can call set_waiting_for_input.
10845 It seems to be harmless. */
10846 #ifdef POLL_FOR_INPUT
10847 /* May be > 1 if in recursive minibuffer. */
10848 if (poll_suppress_count
== 0)
10852 if (FRAMEP (internal_last_event_frame
)
10853 && !EQ (internal_last_event_frame
, selected_frame
))
10854 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10857 _longjmp (getcjmp
, 1);
10860 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
10861 doc
: /* Set interrupt mode of reading keyboard input.
10862 If INTERRUPT is non-nil, Emacs will use input interrupts;
10863 otherwise Emacs uses CBREAK mode.
10865 See also `current-input-mode'. */)
10867 Lisp_Object interrupt
;
10869 int new_interrupt_input
;
10871 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10872 #ifdef HAVE_X_WINDOWS
10873 if (x_display_list
!= NULL
)
10875 /* When using X, don't give the user a real choice,
10876 because we haven't implemented the mechanisms to support it. */
10877 #ifdef NO_SOCK_SIGIO
10878 new_interrupt_input
= 0;
10879 #else /* not NO_SOCK_SIGIO */
10880 new_interrupt_input
= 1;
10881 #endif /* NO_SOCK_SIGIO */
10885 new_interrupt_input
= !NILP (interrupt
);
10886 #else /* not SIGIO */
10887 new_interrupt_input
= 0;
10888 #endif /* not SIGIO */
10890 /* Our VMS input only works by interrupts, as of now. */
10892 new_interrupt_input
= 1;
10895 if (new_interrupt_input
!= interrupt_input
)
10897 #ifdef POLL_FOR_INPUT
10901 /* this causes startup screen to be restored and messes with the mouse */
10902 reset_all_sys_modes ();
10904 interrupt_input
= new_interrupt_input
;
10906 init_all_sys_modes ();
10909 #ifdef POLL_FOR_INPUT
10910 poll_suppress_count
= 1;
10917 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10918 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10919 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10920 C-q in key sequences.
10922 This setting only has an effect on tty terminals and only when
10923 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10925 See also `current-input-mode'. */)
10927 Lisp_Object flow
, terminal
;
10929 struct terminal
*t
= get_terminal (terminal
, 1);
10930 struct tty_display_info
*tty
;
10931 if (t
== NULL
|| t
->type
!= output_termcap
)
10933 tty
= t
->display_info
.tty
;
10935 if (tty
->flow_control
!= !NILP (flow
))
10938 /* this causes startup screen to be restored and messes with the mouse */
10939 reset_sys_modes (tty
);
10942 tty
->flow_control
= !NILP (flow
);
10945 init_sys_modes (tty
);
10951 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10952 doc
: /* Enable or disable 8-bit input on TERMINAL.
10953 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10954 bit as the Meta modifier.
10956 If META is nil, Emacs will ignore the top bit, on the assumption it is
10959 Otherwise, Emacs will accept and pass through 8-bit input without
10960 specially interpreting the top bit.
10962 This setting only has an effect on tty terminal devices.
10964 Optional parameter TERMINAL specifies the tty terminal device to use.
10965 It may be a terminal id, a frame, or nil for the terminal used by the
10966 currently selected frame.
10968 See also `current-input-mode'. */)
10970 Lisp_Object meta
, terminal
;
10972 struct terminal
*t
= get_terminal (terminal
, 1);
10973 struct tty_display_info
*tty
;
10976 if (t
== NULL
|| t
->type
!= output_termcap
)
10978 tty
= t
->display_info
.tty
;
10982 else if (EQ (meta
, Qt
))
10987 if (tty
->meta_key
!= new_meta
)
10990 /* this causes startup screen to be restored and messes with the mouse */
10991 reset_sys_modes (tty
);
10994 tty
->meta_key
= new_meta
;
10997 init_sys_modes (tty
);
11003 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11004 doc
: /* Specify character used for quitting.
11005 QUIT must be an ASCII character.
11007 This function only has an effect on the controlling tty of the Emacs
11010 See also `current-input-mode'. */)
11014 struct terminal
*t
= get_named_tty ("/dev/tty");
11015 struct tty_display_info
*tty
;
11016 if (t
== NULL
|| t
->type
!= output_termcap
)
11018 tty
= t
->display_info
.tty
;
11020 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11021 error ("QUIT must be an ASCII character");
11024 /* this causes startup screen to be restored and messes with the mouse */
11025 reset_sys_modes (tty
);
11028 /* Don't let this value be out of range. */
11029 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11032 init_sys_modes (tty
);
11038 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11039 doc
: /* Set mode of reading keyboard input.
11040 First arg INTERRUPT non-nil means use input interrupts;
11041 nil means use CBREAK mode.
11042 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11043 (no effect except in CBREAK mode).
11044 Third arg META t means accept 8-bit input (for a Meta key).
11045 META nil means ignore the top bit, on the assumption it is parity.
11046 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11047 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11048 See also `current-input-mode'. */)
11049 (interrupt
, flow
, meta
, quit
)
11050 Lisp_Object interrupt
, flow
, meta
, quit
;
11052 Fset_input_interrupt_mode (interrupt
);
11053 Fset_output_flow_control (flow
, Qnil
);
11054 Fset_input_meta_mode (meta
, Qnil
);
11055 Fset_quit_char (quit
);
11059 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11060 doc
: /* Return information about the way Emacs currently reads keyboard input.
11061 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11062 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11063 nil, Emacs is using CBREAK mode.
11064 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11065 terminal; this does not apply if Emacs uses interrupt-driven input.
11066 META is t if accepting 8-bit input with 8th bit as Meta flag.
11067 META nil means ignoring the top bit, on the assumption it is parity.
11068 META is neither t nor nil if accepting 8-bit input and using
11069 all 8 bits as the character code.
11070 QUIT is the character Emacs currently uses to quit.
11071 The elements of this list correspond to the arguments of
11072 `set-input-mode'. */)
11075 Lisp_Object val
[4];
11076 struct frame
*sf
= XFRAME (selected_frame
);
11078 val
[0] = interrupt_input
? Qt
: Qnil
;
11079 if (FRAME_TERMCAP_P (sf
))
11081 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11082 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11084 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11091 XSETFASTINT (val
[3], quit_char
);
11093 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11096 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11097 doc
: /* Return position information for pixel coordinates X and Y.
11098 By default, X and Y are relative to text area of the selected window.
11099 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11100 If optional fourth arg WHOLE is non-nil, X is relative to the left
11101 edge of the window.
11103 The return value is similar to a mouse click position:
11104 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11105 IMAGE (DX . DY) (WIDTH . HEIGHT))
11106 The `posn-' functions access elements of such lists. */)
11107 (x
, y
, frame_or_window
, whole
)
11108 Lisp_Object x
, y
, frame_or_window
, whole
;
11113 if (NILP (frame_or_window
))
11114 frame_or_window
= selected_window
;
11116 if (WINDOWP (frame_or_window
))
11120 CHECK_LIVE_WINDOW (frame_or_window
);
11122 w
= XWINDOW (frame_or_window
);
11123 XSETINT (x
, (XINT (x
)
11124 + WINDOW_LEFT_EDGE_X (w
)
11126 ? window_box_left_offset (w
, TEXT_AREA
)
11128 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11129 frame_or_window
= w
->frame
;
11132 CHECK_LIVE_FRAME (frame_or_window
);
11134 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11137 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11138 doc
: /* Return position information for buffer POS in WINDOW.
11139 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11141 Return nil if position is not visible in window. Otherwise,
11142 the return value is similar to that returned by `event-start' for
11143 a mouse click at the upper left corner of the glyph corresponding
11144 to the given buffer position:
11145 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11146 IMAGE (DX . DY) (WIDTH . HEIGHT))
11147 The `posn-' functions access elements of such lists. */)
11149 Lisp_Object pos
, window
;
11154 window
= selected_window
;
11156 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11159 Lisp_Object x
= XCAR (tem
);
11160 Lisp_Object y
= XCAR (XCDR (tem
));
11162 /* Point invisible due to hscrolling? */
11165 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11173 * Set up a new kboard object with reasonable initial values.
11179 kb
->Voverriding_terminal_local_map
= Qnil
;
11180 kb
->Vlast_command
= Qnil
;
11181 kb
->Vreal_last_command
= Qnil
;
11182 kb
->Vkeyboard_translate_table
= Qnil
;
11183 kb
->Vprefix_arg
= Qnil
;
11184 kb
->Vlast_prefix_arg
= Qnil
;
11185 kb
->kbd_queue
= Qnil
;
11186 kb
->kbd_queue_has_data
= 0;
11187 kb
->immediate_echo
= 0;
11188 kb
->echo_string
= Qnil
;
11189 kb
->echo_after_prompt
= -1;
11190 kb
->kbd_macro_buffer
= 0;
11191 kb
->kbd_macro_bufsize
= 0;
11192 kb
->defining_kbd_macro
= Qnil
;
11193 kb
->Vlast_kbd_macro
= Qnil
;
11194 kb
->reference_count
= 0;
11195 kb
->Vsystem_key_alist
= Qnil
;
11196 kb
->system_key_syms
= Qnil
;
11197 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11198 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11199 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
11200 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
11201 kb
->Vdefault_minibuffer_frame
= Qnil
;
11205 * Destroy the contents of a kboard object, but not the object itself.
11206 * We use this just before deleting it, or if we're going to initialize
11207 * it a second time.
11213 if (kb
->kbd_macro_buffer
)
11214 xfree (kb
->kbd_macro_buffer
);
11217 #ifdef MULTI_KBOARD
11219 /* Free KB and memory referenced from it. */
11227 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11230 *kbp
= kb
->next_kboard
;
11232 /* Prevent a dangling reference to KB. */
11233 if (kb
== current_kboard
11234 && FRAMEP (selected_frame
)
11235 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11237 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11239 if (current_kboard
== kb
)
11247 #endif /* MULTI_KBOARD */
11252 /* This is correct before outermost invocation of the editor loop */
11253 command_loop_level
= -1;
11254 immediate_quit
= 0;
11255 quit_char
= Ctl ('g');
11256 Vunread_command_events
= Qnil
;
11257 unread_command_char
= -1;
11258 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11260 recent_keys_index
= 0;
11261 kbd_fetch_ptr
= kbd_buffer
;
11262 kbd_store_ptr
= kbd_buffer
;
11264 do_mouse_tracking
= Qnil
;
11268 /* This means that command_loop_1 won't try to select anything the first
11270 internal_last_event_frame
= Qnil
;
11271 Vlast_event_frame
= internal_last_event_frame
;
11273 #ifdef MULTI_KBOARD
11274 current_kboard
= initial_kboard
;
11276 wipe_kboard (current_kboard
);
11277 init_kboard (current_kboard
);
11279 if (!noninteractive
)
11281 /* Before multi-tty support, these handlers used to be installed
11282 only if the current session was a tty session. Now an Emacs
11283 session may have multiple display types, so we always handle
11284 SIGINT. There is special code in interrupt_signal to exit
11285 Emacs on SIGINT when there are no termcap frames on the
11286 controlling terminal. */
11287 signal (SIGINT
, interrupt_signal
);
11288 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11289 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11290 SIGQUIT and we can't tell which one it will give us. */
11291 signal (SIGQUIT
, interrupt_signal
);
11292 #endif /* HAVE_TERMIO */
11294 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11296 if (!noninteractive
)
11297 signal (SIGIO
, input_available_signal
);
11300 /* Use interrupt input by default, if it works and noninterrupt input
11301 has deficiencies. */
11303 #ifdef INTERRUPT_INPUT
11304 interrupt_input
= 1;
11306 interrupt_input
= 0;
11309 /* Our VMS input only works by interrupts, as of now. */
11311 interrupt_input
= 1;
11317 if (keyboard_init_hook
)
11318 (*keyboard_init_hook
) ();
11320 #ifdef POLL_FOR_INPUT
11321 poll_suppress_count
= 1;
11326 /* This type's only use is in syms_of_keyboard, to initialize the
11327 event header symbols and put properties on them. */
11328 struct event_head
{
11334 struct event_head head_table
[] = {
11335 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11336 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11337 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11338 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11339 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11340 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11341 /* `select-window' should be handled just like `switch-frame'
11342 in read_key_sequence. */
11343 {&Qselect_window
, "select-window", &Qswitch_frame
}
11347 syms_of_keyboard ()
11349 Vpre_help_message
= Qnil
;
11350 staticpro (&Vpre_help_message
);
11352 Vlispy_mouse_stem
= build_string ("mouse");
11353 staticpro (&Vlispy_mouse_stem
);
11356 QCimage
= intern (":image");
11357 staticpro (&QCimage
);
11359 staticpro (&Qhelp_echo
);
11360 Qhelp_echo
= intern ("help-echo");
11362 staticpro (&item_properties
);
11363 item_properties
= Qnil
;
11365 staticpro (&tool_bar_item_properties
);
11366 tool_bar_item_properties
= Qnil
;
11367 staticpro (&tool_bar_items_vector
);
11368 tool_bar_items_vector
= Qnil
;
11370 staticpro (&real_this_command
);
11371 real_this_command
= Qnil
;
11373 Qtimer_event_handler
= intern ("timer-event-handler");
11374 staticpro (&Qtimer_event_handler
);
11376 Qdisabled_command_function
= intern ("disabled-command-function");
11377 staticpro (&Qdisabled_command_function
);
11379 Qself_insert_command
= intern ("self-insert-command");
11380 staticpro (&Qself_insert_command
);
11382 Qforward_char
= intern ("forward-char");
11383 staticpro (&Qforward_char
);
11385 Qbackward_char
= intern ("backward-char");
11386 staticpro (&Qbackward_char
);
11388 Qdisabled
= intern ("disabled");
11389 staticpro (&Qdisabled
);
11391 Qundefined
= intern ("undefined");
11392 staticpro (&Qundefined
);
11394 Qpre_command_hook
= intern ("pre-command-hook");
11395 staticpro (&Qpre_command_hook
);
11397 Qpost_command_hook
= intern ("post-command-hook");
11398 staticpro (&Qpost_command_hook
);
11400 Qdeferred_action_function
= intern ("deferred-action-function");
11401 staticpro (&Qdeferred_action_function
);
11403 Qcommand_hook_internal
= intern ("command-hook-internal");
11404 staticpro (&Qcommand_hook_internal
);
11406 Qfunction_key
= intern ("function-key");
11407 staticpro (&Qfunction_key
);
11408 Qmouse_click
= intern ("mouse-click");
11409 staticpro (&Qmouse_click
);
11410 #if defined (WINDOWSNT) || defined (MAC_OS)
11411 Qlanguage_change
= intern ("language-change");
11412 staticpro (&Qlanguage_change
);
11414 Qdrag_n_drop
= intern ("drag-n-drop");
11415 staticpro (&Qdrag_n_drop
);
11417 Qsave_session
= intern ("save-session");
11418 staticpro (&Qsave_session
);
11421 Qmac_apple_event
= intern ("mac-apple-event");
11422 staticpro (&Qmac_apple_event
);
11425 Qusr1_signal
= intern ("usr1-signal");
11426 staticpro (&Qusr1_signal
);
11427 Qusr2_signal
= intern ("usr2-signal");
11428 staticpro (&Qusr2_signal
);
11430 Qmenu_enable
= intern ("menu-enable");
11431 staticpro (&Qmenu_enable
);
11432 Qmenu_alias
= intern ("menu-alias");
11433 staticpro (&Qmenu_alias
);
11434 QCenable
= intern (":enable");
11435 staticpro (&QCenable
);
11436 QCvisible
= intern (":visible");
11437 staticpro (&QCvisible
);
11438 QChelp
= intern (":help");
11439 staticpro (&QChelp
);
11440 QCfilter
= intern (":filter");
11441 staticpro (&QCfilter
);
11442 QCbutton
= intern (":button");
11443 staticpro (&QCbutton
);
11444 QCkeys
= intern (":keys");
11445 staticpro (&QCkeys
);
11446 QCkey_sequence
= intern (":key-sequence");
11447 staticpro (&QCkey_sequence
);
11448 QCtoggle
= intern (":toggle");
11449 staticpro (&QCtoggle
);
11450 QCradio
= intern (":radio");
11451 staticpro (&QCradio
);
11453 Qmode_line
= intern ("mode-line");
11454 staticpro (&Qmode_line
);
11455 Qvertical_line
= intern ("vertical-line");
11456 staticpro (&Qvertical_line
);
11457 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11458 staticpro (&Qvertical_scroll_bar
);
11459 Qmenu_bar
= intern ("menu-bar");
11460 staticpro (&Qmenu_bar
);
11463 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11464 staticpro (&Qmouse_fixup_help_message
);
11467 Qabove_handle
= intern ("above-handle");
11468 staticpro (&Qabove_handle
);
11469 Qhandle
= intern ("handle");
11470 staticpro (&Qhandle
);
11471 Qbelow_handle
= intern ("below-handle");
11472 staticpro (&Qbelow_handle
);
11473 Qup
= intern ("up");
11475 Qdown
= intern ("down");
11476 staticpro (&Qdown
);
11477 Qtop
= intern ("top");
11479 Qbottom
= intern ("bottom");
11480 staticpro (&Qbottom
);
11481 Qend_scroll
= intern ("end-scroll");
11482 staticpro (&Qend_scroll
);
11483 Qratio
= intern ("ratio");
11484 staticpro (&Qratio
);
11486 Qevent_kind
= intern ("event-kind");
11487 staticpro (&Qevent_kind
);
11488 Qevent_symbol_elements
= intern ("event-symbol-elements");
11489 staticpro (&Qevent_symbol_elements
);
11490 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11491 staticpro (&Qevent_symbol_element_mask
);
11492 Qmodifier_cache
= intern ("modifier-cache");
11493 staticpro (&Qmodifier_cache
);
11495 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11496 staticpro (&Qrecompute_lucid_menubar
);
11497 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11498 staticpro (&Qactivate_menubar_hook
);
11500 Qpolling_period
= intern ("polling-period");
11501 staticpro (&Qpolling_period
);
11503 Qinput_method_function
= intern ("input-method-function");
11504 staticpro (&Qinput_method_function
);
11506 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11507 staticpro (&Qinput_method_exit_on_first_char
);
11508 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11509 staticpro (&Qinput_method_use_echo_area
);
11511 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11512 Fset (Qinput_method_use_echo_area
, Qnil
);
11514 last_point_position_buffer
= Qnil
;
11515 last_point_position_window
= Qnil
;
11518 struct event_head
*p
;
11520 for (p
= head_table
;
11521 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11524 *p
->var
= intern (p
->name
);
11525 staticpro (p
->var
);
11526 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11527 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11531 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11532 staticpro (&button_down_location
);
11533 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11534 staticpro (&mouse_syms
);
11535 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11536 staticpro (&wheel_syms
);
11540 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11542 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11543 for (i
= 0; i
< len
; i
++)
11544 if (modifier_names
[i
])
11545 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11546 staticpro (&modifier_symbols
);
11549 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11550 staticpro (&recent_keys
);
11552 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11553 staticpro (&this_command_keys
);
11555 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11556 staticpro (&raw_keybuf
);
11558 Qextended_command_history
= intern ("extended-command-history");
11559 Fset (Qextended_command_history
, Qnil
);
11560 staticpro (&Qextended_command_history
);
11562 accent_key_syms
= Qnil
;
11563 staticpro (&accent_key_syms
);
11565 func_key_syms
= Qnil
;
11566 staticpro (&func_key_syms
);
11568 drag_n_drop_syms
= Qnil
;
11569 staticpro (&drag_n_drop_syms
);
11571 unread_switch_frame
= Qnil
;
11572 staticpro (&unread_switch_frame
);
11574 internal_last_event_frame
= Qnil
;
11575 staticpro (&internal_last_event_frame
);
11577 read_key_sequence_cmd
= Qnil
;
11578 staticpro (&read_key_sequence_cmd
);
11580 menu_bar_one_keymap_changed_items
= Qnil
;
11581 staticpro (&menu_bar_one_keymap_changed_items
);
11583 menu_bar_items_vector
= Qnil
;
11584 staticpro (&menu_bar_items_vector
);
11586 defsubr (&Scurrent_idle_time
);
11587 defsubr (&Sevent_convert_list
);
11588 defsubr (&Sread_key_sequence
);
11589 defsubr (&Sread_key_sequence_vector
);
11590 defsubr (&Srecursive_edit
);
11592 defsubr (&Strack_mouse
);
11594 defsubr (&Sinput_pending_p
);
11595 defsubr (&Scommand_execute
);
11596 defsubr (&Srecent_keys
);
11597 defsubr (&Sthis_command_keys
);
11598 defsubr (&Sthis_command_keys_vector
);
11599 defsubr (&Sthis_single_command_keys
);
11600 defsubr (&Sthis_single_command_raw_keys
);
11601 defsubr (&Sreset_this_command_lengths
);
11602 defsubr (&Sclear_this_command_keys
);
11603 defsubr (&Ssuspend_emacs
);
11604 defsubr (&Sabort_recursive_edit
);
11605 defsubr (&Sexit_recursive_edit
);
11606 defsubr (&Srecursion_depth
);
11607 defsubr (&Stop_level
);
11608 defsubr (&Sdiscard_input
);
11609 defsubr (&Sopen_dribble_file
);
11610 defsubr (&Sset_input_interrupt_mode
);
11611 defsubr (&Sset_output_flow_control
);
11612 defsubr (&Sset_input_meta_mode
);
11613 defsubr (&Sset_quit_char
);
11614 defsubr (&Sset_input_mode
);
11615 defsubr (&Scurrent_input_mode
);
11616 defsubr (&Sexecute_extended_command
);
11617 defsubr (&Sposn_at_point
);
11618 defsubr (&Sposn_at_x_y
);
11620 DEFVAR_LISP ("last-command-char", &last_command_char
,
11621 doc
: /* Last input event that was part of a command. */);
11623 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11624 doc
: /* Last input event that was part of a command. */);
11626 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11627 doc
: /* Last input event in a command, except for mouse menu events.
11628 Mouse menus give back keys that don't look like mouse events;
11629 this variable holds the actual mouse event that led to the menu,
11630 so that you can determine whether the command was run by mouse or not. */);
11632 DEFVAR_LISP ("last-input-char", &last_input_char
,
11633 doc
: /* Last input event. */);
11635 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11636 doc
: /* Last input event. */);
11638 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11639 doc
: /* List of events to be read as the command input.
11640 These events are processed first, before actual keyboard input.
11641 Events read from this list are not normally added to `this-command-keys',
11642 as they will already have been added once as they were read for the first time.
11643 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11644 Vunread_command_events
= Qnil
;
11646 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11647 doc
: /* If not -1, an object to be read as next command input event. */);
11649 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11650 doc
: /* List of events to be processed as input by input methods.
11651 These events are processed before `unread-command-events'
11652 and actual keyboard input without given to `input-method-function'. */);
11653 Vunread_post_input_method_events
= Qnil
;
11655 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11656 doc
: /* List of events to be processed as input by input methods.
11657 These events are processed after `unread-command-events', but
11658 before actual keyboard input.
11659 If there's an active input method, the events are given to
11660 `input-method-function'. */);
11661 Vunread_input_method_events
= Qnil
;
11663 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11664 doc
: /* Meta-prefix character code.
11665 Meta-foo as command input turns into this character followed by foo. */);
11666 XSETINT (meta_prefix_char
, 033);
11668 DEFVAR_KBOARD ("last-command", Vlast_command
,
11669 doc
: /* The last command executed.
11670 Normally a symbol with a function definition, but can be whatever was found
11671 in the keymap, or whatever the variable `this-command' was set to by that
11674 The value `mode-exit' is special; it means that the previous command
11675 read an event that told it to exit, and it did so and unread that event.
11676 In other words, the present command is the event that made the previous
11679 The value `kill-region' is special; it means that the previous command
11680 was a kill command.
11682 `last-command' has a separate binding for each terminal device.
11683 See Info node `(elisp)Multiple displays'. */);
11685 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11686 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11688 DEFVAR_LISP ("this-command", &Vthis_command
,
11689 doc
: /* The command now being executed.
11690 The command can set this variable; whatever is put here
11691 will be in `last-command' during the following command. */);
11692 Vthis_command
= Qnil
;
11694 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11695 doc
: /* The command bound to the current key sequence before remapping.
11696 It equals `this-command' if the original command was not remapped through
11697 any of the active keymaps. Otherwise, the value of `this-command' is the
11698 result of looking up the original command in the active keymaps. */);
11699 Vthis_original_command
= Qnil
;
11701 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11702 doc
: /* *Number of input events between auto-saves.
11703 Zero means disable autosaving due to number of characters typed. */);
11704 auto_save_interval
= 300;
11706 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11707 doc
: /* *Number of seconds idle time before auto-save.
11708 Zero or nil means disable auto-saving due to idleness.
11709 After auto-saving due to this many seconds of idle time,
11710 Emacs also does a garbage collection if that seems to be warranted. */);
11711 XSETFASTINT (Vauto_save_timeout
, 30);
11713 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11714 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11715 The value may be integer or floating point. */);
11716 Vecho_keystrokes
= make_number (1);
11718 DEFVAR_INT ("polling-period", &polling_period
,
11719 doc
: /* *Interval between polling for input during Lisp execution.
11720 The reason for polling is to make C-g work to stop a running program.
11721 Polling is needed only when using X windows and SIGIO does not work.
11722 Polling is automatically disabled in all other cases. */);
11723 polling_period
= 2;
11725 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11726 doc
: /* *Maximum time between mouse clicks to make a double-click.
11727 Measured in milliseconds. nil means disable double-click recognition;
11728 t means double-clicks have no time limit and are detected
11729 by position only. */);
11730 Vdouble_click_time
= make_number (500);
11732 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11733 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11734 On window-system frames, value is the number of pixels the mouse may have
11735 moved horizontally or vertically between two clicks to make a double-click.
11736 On non window-system frames, value is interpreted in units of 1/8 characters
11739 This variable is also the threshold for motion of the mouse
11740 to count as a drag. */);
11741 double_click_fuzz
= 3;
11743 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11744 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11745 inhibit_local_menu_bar_menus
= 0;
11747 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11748 doc
: /* Number of complete key sequences read as input so far.
11749 This includes key sequences read from keyboard macros.
11750 The number is effectively the number of interactive command invocations. */);
11751 num_input_keys
= 0;
11753 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11754 doc
: /* Number of input events read from the keyboard so far.
11755 This does not include events generated by keyboard macros. */);
11756 num_nonmacro_input_events
= 0;
11758 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11759 doc
: /* The frame in which the most recently read event occurred.
11760 If the last event came from a keyboard macro, this is set to `macro'. */);
11761 Vlast_event_frame
= Qnil
;
11763 /* This variable is set up in sysdep.c. */
11764 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11765 doc
: /* The ERASE character as set by the user with stty. */);
11767 DEFVAR_LISP ("help-char", &Vhelp_char
,
11768 doc
: /* Character to recognize as meaning Help.
11769 When it is read, do `(eval help-form)', and display result if it's a string.
11770 If the value of `help-form' is nil, this char can be read normally. */);
11771 XSETINT (Vhelp_char
, Ctl ('H'));
11773 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11774 doc
: /* List of input events to recognize as meaning Help.
11775 These work just like the value of `help-char' (see that). */);
11776 Vhelp_event_list
= Qnil
;
11778 DEFVAR_LISP ("help-form", &Vhelp_form
,
11779 doc
: /* Form to execute when character `help-char' is read.
11780 If the form returns a string, that string is displayed.
11781 If `help-form' is nil, the help char is not recognized. */);
11784 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11785 doc
: /* Command to run when `help-char' character follows a prefix key.
11786 This command is used only when there is no actual binding
11787 for that character after that prefix key. */);
11788 Vprefix_help_command
= Qnil
;
11790 DEFVAR_LISP ("top-level", &Vtop_level
,
11791 doc
: /* Form to evaluate when Emacs starts up.
11792 Useful to set before you dump a modified Emacs. */);
11795 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11796 doc
: /* Translate table for local keyboard input, or nil.
11797 If non-nil, the value should be a char-table. Each character read
11798 from the keyboard is looked up in this char-table. If the value found
11799 there is non-nil, then it is used instead of the actual input character.
11801 The value can also be a string or vector, but this is considered obsolete.
11802 If it is a string or vector of length N, character codes N and up are left
11803 untranslated. In a vector, an element which is nil means "no translation".
11805 This is applied to the characters supplied to input methods, not their
11806 output. See also `translation-table-for-input'.
11808 This variable has a separate binding for each terminal. See Info node
11809 `(elisp)Multiple displays'. */);
11811 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11812 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11813 \(Even if the operating system has support for stopping a process.\) */);
11814 cannot_suspend
= 0;
11816 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11817 doc
: /* Non-nil means prompt with menus when appropriate.
11818 This is done when reading from a keymap that has a prompt string,
11819 for elements that have prompt strings.
11820 The menu is displayed on the screen
11821 if X menus were enabled at configuration
11822 time and the previous event was a mouse click prefix key.
11823 Otherwise, menu prompting uses the echo area. */);
11824 menu_prompting
= 1;
11826 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11827 doc
: /* Character to see next line of menu prompt.
11828 Type this character while in a menu prompt to rotate around the lines of it. */);
11829 XSETINT (menu_prompt_more_char
, ' ');
11831 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11832 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11833 Emacs applies the modifiers of the character stored here to each keyboard
11834 character it reads. For example, after evaluating the expression
11835 (setq extra-keyboard-modifiers ?\\C-x)
11836 all input characters will have the control modifier applied to them.
11838 Note that the character ?\\C-@, equivalent to the integer zero, does
11839 not count as a control character; rather, it counts as a character
11840 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11841 cancels any modification. */);
11842 extra_keyboard_modifiers
= 0;
11844 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11845 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11846 The command loop sets this to nil before each command,
11847 and tests the value when the command returns.
11848 Buffer modification stores t in this variable. */);
11849 Vdeactivate_mark
= Qnil
;
11851 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11852 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11853 Vcommand_hook_internal
= Qnil
;
11855 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11856 doc
: /* Normal hook run before each command is executed.
11857 If an unhandled error happens in running this hook,
11858 the hook value is set to nil, since otherwise the error
11859 might happen repeatedly and make Emacs nonfunctional. */);
11860 Vpre_command_hook
= Qnil
;
11862 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11863 doc
: /* Normal hook run after each command is executed.
11864 If an unhandled error happens in running this hook,
11865 the hook value is set to nil, since otherwise the error
11866 might happen repeatedly and make Emacs nonfunctional. */);
11867 Vpost_command_hook
= Qnil
;
11870 DEFVAR_LISP ("echo-area-clear-hook", ...,
11871 doc
: /* Normal hook run when clearing the echo area. */);
11873 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11874 staticpro (&Qecho_area_clear_hook
);
11875 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11877 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11878 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11879 Vlucid_menu_bar_dirty_flag
= Qnil
;
11881 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11882 doc
: /* List of menu bar items to move to the end of the menu bar.
11883 The elements of the list are event types that may have menu bar bindings. */);
11884 Vmenu_bar_final_items
= Qnil
;
11886 DEFVAR_KBOARD ("overriding-terminal-local-map",
11887 Voverriding_terminal_local_map
,
11888 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11889 If this variable is non-nil, it is used as a keymap instead of the
11890 buffer's local map, and the minor mode keymaps and text property keymaps.
11891 It also replaces `overriding-local-map'.
11893 This variable is intended to let commands such as `universal-argument'
11894 set up a different keymap for reading the next command.
11896 `overriding-terminal-local-map' has a separate binding for each
11898 See Info node `(elisp)Multiple displays'. */);
11900 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11901 doc
: /* Keymap that overrides all other local keymaps.
11902 If this variable is non-nil, it is used as a keymap--replacing the
11903 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11904 Voverriding_local_map
= Qnil
;
11906 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11907 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11908 Otherwise, the menu bar continues to reflect the buffer's local map
11909 and the minor mode maps regardless of `overriding-local-map'. */);
11910 Voverriding_local_map_menu_flag
= Qnil
;
11912 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11913 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11914 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11916 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11917 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11919 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11920 doc
: /* Alist of system-specific X windows key symbols.
11921 Each element should have the form (N . SYMBOL) where N is the
11922 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11923 and SYMBOL is its name.
11925 `system-key-alist' has a separate binding for each terminal device.
11926 See Info node `(elisp)Multiple displays'. */);
11928 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11929 doc
: /* Keymap that translates key sequences to key sequences during input.
11930 This is used mainly for mapping ASCII function key sequences into
11931 real Emacs function key events (symbols).
11933 The `read-key-sequence' function replaces any subsequence bound by
11934 `local-function-key-map' with its binding. More precisely, when the
11935 active keymaps have no binding for the current key sequence but
11936 `local-function-key-map' binds a suffix of the sequence to a vector or
11937 string, `read-key-sequence' replaces the matching suffix with its
11938 binding, and continues with the new sequence.
11940 If the binding is a function, it is called with one argument (the prompt)
11941 and its return value (a key sequence) is used.
11943 The events that come from bindings in `local-function-key-map' are not
11944 themselves looked up in `local-function-key-map'.
11946 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11947 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11948 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11949 typing `ESC O P x' would return [f1 x].
11951 `local-function-key-map' has a separate binding for each terminal
11952 device. See Info node `(elisp)Multiple displays'. If you need to
11953 define a binding on all terminals, change `function-key-map'
11954 instead. Initially, `local-function-key-map' is an empty keymap that
11955 has `function-key-map' as its parent on all terminal devices. */);
11957 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11958 doc
: /* The parent keymap of all `local-function-key-map' instances.
11959 Function key definitions that apply to all terminal devices should go
11960 here. If a mapping is defined in both the current
11961 `local-function-key-map' binding and this variable, then the local
11962 definition will take precendence. */);
11963 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11965 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11966 doc
: /* Keymap of key translations that can override keymaps.
11967 This keymap works like `function-key-map', but comes after that,
11968 and its non-prefix bindings override ordinary bindings.
11970 `key-translation-map' has a separate binding for each terminal device.
11971 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11972 translation on all terminals, change `global-key-translation-map' instead. */);
11974 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11975 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11976 Key translations that apply to all terminal devices should go here. */);
11977 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11979 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11980 doc
: /* List of deferred actions to be performed at a later time.
11981 The precise format isn't relevant here; we just check whether it is nil. */);
11982 Vdeferred_action_list
= Qnil
;
11984 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11985 doc
: /* Function to call to handle deferred actions, after each command.
11986 This function is called with no arguments after each command
11987 whenever `deferred-action-list' is non-nil. */);
11988 Vdeferred_action_function
= Qnil
;
11990 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11991 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11992 The value can be a length of time to show the message for.
11993 If the value is non-nil and not a number, we wait 2 seconds. */);
11994 Vsuggest_key_bindings
= Qt
;
11996 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11997 doc
: /* List of active absolute time timers in order of increasing time. */);
11998 Vtimer_list
= Qnil
;
12000 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12001 doc
: /* List of active idle-time timers in order of increasing time. */);
12002 Vtimer_idle_list
= Qnil
;
12004 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12005 doc
: /* If non-nil, the function that implements the current input method.
12006 It's called with one argument, a printing character that was just read.
12007 \(That means a character with code 040...0176.)
12008 Typically this function uses `read-event' to read additional events.
12009 When it does so, it should first bind `input-method-function' to nil
12010 so it will not be called recursively.
12012 The function should return a list of zero or more events
12013 to be used as input. If it wants to put back some events
12014 to be reconsidered, separately, by the input method,
12015 it can add them to the beginning of `unread-command-events'.
12017 The input method function can find in `input-method-previous-method'
12018 the previous echo area message.
12020 The input method function should refer to the variables
12021 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12022 for guidance on what to do. */);
12023 Vinput_method_function
= Qnil
;
12025 DEFVAR_LISP ("input-method-previous-message",
12026 &Vinput_method_previous_message
,
12027 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12028 This variable exists because `read-event' clears the echo area
12029 before running the input method. It is nil if there was no message. */);
12030 Vinput_method_previous_message
= Qnil
;
12032 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12033 doc
: /* If non-nil, the function that implements the display of help.
12034 It's called with one argument, the help string to display. */);
12035 Vshow_help_function
= Qnil
;
12037 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12038 doc
: /* If non-nil, suppress point adjustment after executing a command.
12040 After a command is executed, if point is moved into a region that has
12041 special properties (e.g. composition, display), we adjust point to
12042 the boundary of the region. But, when a command sets this variable to
12043 non-nil, we suppress the point adjustment.
12045 This variable is set to nil before reading a command, and is checked
12046 just after executing the command. */);
12047 Vdisable_point_adjustment
= Qnil
;
12049 DEFVAR_LISP ("global-disable-point-adjustment",
12050 &Vglobal_disable_point_adjustment
,
12051 doc
: /* *If non-nil, always suppress point adjustment.
12053 The default value is nil, in which case, point adjustment are
12054 suppressed only after special commands that set
12055 `disable-point-adjustment' (which see) to non-nil. */);
12056 Vglobal_disable_point_adjustment
= Qnil
;
12058 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12059 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12060 If the value is not a number, such messages don't time out. */);
12061 Vminibuffer_message_timeout
= make_number (2);
12063 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12064 doc
: /* If non-nil, any keyboard input throws to this symbol.
12065 The value of that variable is passed to `quit-flag' and later causes a
12066 peculiar kind of quitting. */);
12067 Vthrow_on_input
= Qnil
;
12069 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12070 doc
: /* If non-nil, function to output error messages.
12071 The arguments are the error data, a list of the form
12072 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12073 such as just as `condition-case' would bind its variable to,
12074 the context (a string which normally goes at the start of the message),
12075 and the Lisp function within which the error was signaled. */);
12076 Vcommand_error_function
= Qnil
;
12078 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12079 &Venable_disabled_menus_and_buttons
,
12080 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12082 Help functions bind this to allow help on disabled menu items
12083 and tool-bar buttons. */);
12084 Venable_disabled_menus_and_buttons
= Qnil
;
12088 keys_of_keyboard ()
12090 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12091 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12092 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12093 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12094 initial_define_key (meta_map
, 'x', "execute-extended-command");
12096 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12097 "handle-delete-frame");
12098 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12099 current-prefix-arg, as is done in `handle-switch-frame'.
12100 But `handle-switch-frame is not run from the special-map.
12101 Commands from that map are run in a special way that automatically
12102 preserves the prefix-arg. Restoring the prefix arg here is not just
12103 redundant but harmful:
12105 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12106 - after the first prompt, the exit-minibuffer-hook is run which may
12107 iconify a frame and thus push a `iconify-frame' event.
12108 - after running exit-minibuffer-hook, current-prefix-arg is
12109 restored to the non-nil value it had before the prompt.
12110 - we enter the second prompt.
12111 current-prefix-arg is non-nil, prefix-arg is nil.
12112 - before running the first real event, we run the special iconify-frame
12113 event, but we pass the `special' arg to execute-command so
12114 current-prefix-arg and prefix-arg are left untouched.
12115 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12116 - the next key event will have a spuriously non-nil current-prefix-arg. */
12117 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12119 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12121 /* Handling it at such a low-level causes read_key_sequence to get
12122 * confused because it doesn't realize that the current_buffer was
12123 * changed by read_char.
12125 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12126 * "handle-select-window"); */
12127 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12128 "handle-save-session");
12131 /* Mark the pointers in the kboard objects.
12132 Called by the Fgarbage_collector. */
12138 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12140 if (kb
->kbd_macro_buffer
)
12141 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12143 mark_object (kb
->Voverriding_terminal_local_map
);
12144 mark_object (kb
->Vlast_command
);
12145 mark_object (kb
->Vreal_last_command
);
12146 mark_object (kb
->Vkeyboard_translate_table
);
12147 mark_object (kb
->Vprefix_arg
);
12148 mark_object (kb
->Vlast_prefix_arg
);
12149 mark_object (kb
->kbd_queue
);
12150 mark_object (kb
->defining_kbd_macro
);
12151 mark_object (kb
->Vlast_kbd_macro
);
12152 mark_object (kb
->Vsystem_key_alist
);
12153 mark_object (kb
->system_key_syms
);
12154 mark_object (kb
->Vlocal_function_key_map
);
12155 mark_object (kb
->Vlocal_key_translation_map
);
12156 mark_object (kb
->Vdefault_minibuffer_frame
);
12157 mark_object (kb
->echo_string
);
12160 struct input_event
*event
;
12161 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12163 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12164 event
= kbd_buffer
;
12165 if (event
->kind
!= SELECTION_REQUEST_EVENT
12166 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12168 mark_object (event
->x
);
12169 mark_object (event
->y
);
12171 mark_object (event
->frame_or_window
);
12172 mark_object (event
->arg
);
12177 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12178 (do not change this comment) */