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, 2007, 2008, 2009 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 3 of the License, or
11 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
68 /* This is to get the definitions of the XK_ symbols. */
75 #endif /* HAVE_NTGUI */
85 /* Variables for blockinput.h: */
87 /* Non-zero if interrupt input is blocked right now. */
88 volatile int interrupt_input_blocked
;
90 /* Nonzero means an input interrupt has arrived
91 during the current critical section. */
92 int interrupt_input_pending
;
94 /* This var should be (interrupt_input_pending || pending_atimers).
95 The QUIT macro checks this instead of interrupt_input_pending and
96 pending_atimers separately, to reduce code size. So, any code that
97 changes interrupt_input_pending or pending_atimers should update
103 #define KBD_BUFFER_SIZE 4096
105 KBOARD
*initial_kboard
;
106 KBOARD
*current_kboard
;
110 /* Non-nil disable property on a command means
111 do not execute it; call disabled-command-function's value instead. */
112 Lisp_Object Qdisabled
, Qdisabled_command_function
;
114 #define NUM_RECENT_KEYS (300)
115 int recent_keys_index
; /* Index for storing next element into recent_keys */
116 int total_keys
; /* Total number of elements stored into recent_keys */
117 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 int this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 Lisp_Object raw_keybuf
;
134 int raw_keybuf_count
;
136 /* Non-nil if the present key sequence was obtained by shift translation. */
137 Lisp_Object Vthis_command_keys_shift_translated
;
139 #define GROW_RAW_KEYBUF \
140 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
141 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
143 /* Number of elements of this_command_keys
144 that precede this key sequence. */
145 int this_single_command_key_start
;
147 /* Record values of this_command_key_count and echo_length ()
148 before this command was read. */
149 static int before_command_key_count
;
150 static int before_command_echo_length
;
152 extern int minbuf_level
;
154 extern int message_enable_multibyte
;
156 /* If non-nil, the function that implements the display of help.
157 It's called with one argument, the help string to display. */
159 Lisp_Object Vshow_help_function
;
161 /* Nonzero means do menu prompting. */
163 static int menu_prompting
;
165 /* Character to see next line of menu prompt. */
167 static Lisp_Object menu_prompt_more_char
;
169 /* For longjmp to where kbd input is being done. */
171 static jmp_buf getcjmp
;
173 /* True while doing kbd input. */
174 int waiting_for_input
;
176 /* True while displaying for echoing. Delays C-g throwing. */
180 /* Non-null means we can start echoing at the next input pause even
181 though there is something in the echo area. */
183 static struct kboard
*ok_to_echo_at_next_pause
;
185 /* The kboard last echoing, or null for none. Reset to 0 in
186 cancel_echoing. If non-null, and a current echo area message
187 exists, and echo_message_buffer is eq to the current message
188 buffer, we know that the message comes from echo_kboard. */
190 struct kboard
*echo_kboard
;
192 /* The buffer used for echoing. Set in echo_now, reset in
195 Lisp_Object echo_message_buffer
;
197 /* Nonzero means disregard local maps for the menu bar. */
198 static int inhibit_local_menu_bar_menus
;
200 /* Nonzero means C-g should cause immediate error-signal. */
203 /* The user's hook function for outputting an error message. */
204 Lisp_Object Vcommand_error_function
;
206 /* The user's ERASE setting. */
207 Lisp_Object Vtty_erase_char
;
209 /* Character to recognize as the help char. */
210 Lisp_Object Vhelp_char
;
212 /* List of other event types to recognize as meaning "help". */
213 Lisp_Object Vhelp_event_list
;
215 /* Form to execute when help char is typed. */
216 Lisp_Object Vhelp_form
;
218 /* Command to run when the help character follows a prefix key. */
219 Lisp_Object Vprefix_help_command
;
221 /* List of items that should move to the end of the menu bar. */
222 Lisp_Object Vmenu_bar_final_items
;
224 /* Non-nil means show the equivalent key-binding for
225 any M-x command that has one.
226 The value can be a length of time to show the message for.
227 If the value is non-nil and not a number, we wait 2 seconds. */
228 Lisp_Object Vsuggest_key_bindings
;
230 /* How long to display an echo-area message when the minibuffer is active.
231 If the value is not a number, such messages don't time out. */
232 Lisp_Object Vminibuffer_message_timeout
;
234 /* Character that causes a quit. Normally C-g.
236 If we are running on an ordinary terminal, this must be an ordinary
237 ASCII char, since we want to make it our interrupt character.
239 If we are not running on an ordinary terminal, it still needs to be
240 an ordinary ASCII char. This character needs to be recognized in
241 the input interrupt handler. At this point, the keystroke is
242 represented as a struct input_event, while the desired quit
243 character is specified as a lispy event. The mapping from struct
244 input_events to lispy events cannot run in an interrupt handler,
245 and the reverse mapping is difficult for anything but ASCII
248 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
252 extern Lisp_Object current_global_map
;
253 extern int minibuf_level
;
255 /* If non-nil, this is a map that overrides all other local maps. */
256 Lisp_Object Voverriding_local_map
;
258 /* If non-nil, Voverriding_local_map applies to the menu bar. */
259 Lisp_Object Voverriding_local_map_menu_flag
;
261 /* Keymap that defines special misc events that should
262 be processed immediately at a low level. */
263 Lisp_Object Vspecial_event_map
;
265 /* Current depth in recursive edits. */
266 int command_loop_level
;
268 /* Total number of times command_loop has read a key sequence. */
269 EMACS_INT num_input_keys
;
271 /* Last input event read as a command. */
272 Lisp_Object last_command_event
;
274 /* Last input character read as a command, not counting menus
275 reached by the mouse. */
276 Lisp_Object last_nonmenu_event
;
278 /* Last input event read for any purpose. */
279 Lisp_Object last_input_event
;
281 /* If not Qnil, a list of objects to be read as subsequent command input. */
282 Lisp_Object Vunread_command_events
;
284 /* If not Qnil, a list of objects to be read as subsequent command input
285 including input method processing. */
286 Lisp_Object Vunread_input_method_events
;
288 /* If not Qnil, a list of objects to be read as subsequent command input
289 but NOT including input method processing. */
290 Lisp_Object Vunread_post_input_method_events
;
292 /* If not -1, an event to be read as subsequent command input. */
293 EMACS_INT unread_command_char
;
295 /* If not Qnil, this is a switch-frame event which we decided to put
296 off until the end of a key sequence. This should be read as the
297 next command input, after any unread_command_events.
299 read_key_sequence uses this to delay switch-frame events until the
300 end of the key sequence; Fread_char uses it to put off switch-frame
301 events until a non-ASCII event is acceptable as input. */
302 Lisp_Object unread_switch_frame
;
304 /* A mask of extra modifier bits to put into every keyboard char. */
305 EMACS_INT extra_keyboard_modifiers
;
307 /* Char to use as prefix when a meta character is typed in.
308 This is bound on entry to minibuffer in case ESC is changed there. */
310 Lisp_Object meta_prefix_char
;
312 /* Last size recorded for a current buffer which is not a minibuffer. */
313 static int last_non_minibuf_size
;
315 /* Number of idle seconds before an auto-save and garbage collection. */
316 static Lisp_Object Vauto_save_timeout
;
318 /* Total number of times read_char has returned. */
319 int num_input_events
;
321 /* Total number of times read_char has returned, outside of macros. */
322 EMACS_INT num_nonmacro_input_events
;
324 /* Auto-save automatically when this many characters have been typed
325 since the last time. */
327 static EMACS_INT auto_save_interval
;
329 /* Value of num_nonmacro_input_events as of last auto save. */
333 /* The command being executed by the command loop.
334 Commands may set this, and the value set will be copied into
335 current_kboard->Vlast_command instead of the actual command. */
336 Lisp_Object Vthis_command
;
338 /* This is like Vthis_command, except that commands never set it. */
339 Lisp_Object real_this_command
;
341 /* If the lookup of the command returns a binding, the original
342 command is stored in this-original-command. It is nil otherwise. */
343 Lisp_Object Vthis_original_command
;
345 /* The value of point when the last command was started. */
346 int last_point_position
;
348 /* The buffer that was current when the last command was started. */
349 Lisp_Object last_point_position_buffer
;
351 /* The window that was selected when the last command was started. */
352 Lisp_Object last_point_position_window
;
354 /* The frame in which the last input event occurred, or Qmacro if the
355 last event came from a macro. We use this to determine when to
356 generate switch-frame events. This may be cleared by functions
357 like Fselect_frame, to make sure that a switch-frame event is
358 generated by the next character. */
359 Lisp_Object internal_last_event_frame
;
361 /* A user-visible version of the above, intended to allow users to
362 figure out where the last event came from, if the event doesn't
363 carry that information itself (i.e. if it was a character). */
364 Lisp_Object Vlast_event_frame
;
366 /* The timestamp of the last input event we received from the X server.
367 X Windows wants this for selection ownership. */
368 unsigned long last_event_timestamp
;
370 Lisp_Object Qself_insert_command
;
371 Lisp_Object Qforward_char
;
372 Lisp_Object Qbackward_char
;
373 Lisp_Object Qundefined
;
374 Lisp_Object Qtimer_event_handler
;
376 /* read_key_sequence stores here the command definition of the
377 key sequence that it reads. */
378 Lisp_Object read_key_sequence_cmd
;
380 /* Echo unfinished commands after this many seconds of pause. */
381 Lisp_Object Vecho_keystrokes
;
383 /* Form to evaluate (if non-nil) when Emacs is started. */
384 Lisp_Object Vtop_level
;
386 /* If non-nil, this implements the current input method. */
387 Lisp_Object Vinput_method_function
;
388 Lisp_Object Qinput_method_function
;
390 /* When we call Vinput_method_function,
391 this holds the echo area message that was just erased. */
392 Lisp_Object Vinput_method_previous_message
;
394 /* Non-nil means deactivate the mark at end of this command. */
395 Lisp_Object Vdeactivate_mark
;
396 Lisp_Object Qdeactivate_mark
;
398 /* Menu bar specified in Lucid Emacs fashion. */
400 Lisp_Object Vlucid_menu_bar_dirty_flag
;
401 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
403 Lisp_Object Qecho_area_clear_hook
;
405 /* Hooks to run before and after each command. */
406 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
407 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
408 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
410 /* Parent keymap of terminal-local function-key-map instances. */
411 Lisp_Object Vfunction_key_map
;
413 /* Keymap of key translations that can override keymaps. */
414 Lisp_Object Vkey_translation_map
;
416 /* List of deferred actions to be performed at a later time.
417 The precise format isn't relevant here; we just check whether it is nil. */
418 Lisp_Object Vdeferred_action_list
;
420 /* Function to call to handle deferred actions, when there are any. */
421 Lisp_Object Vdeferred_action_function
;
422 Lisp_Object Qdeferred_action_function
;
424 Lisp_Object Qinput_method_exit_on_first_char
;
425 Lisp_Object Qinput_method_use_echo_area
;
427 /* File in which we write all commands we read. */
430 /* Nonzero if input is available. */
433 extern char *pending_malloc_warning
;
435 /* Circular buffer for pre-read keyboard input. */
437 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
439 /* Pointer to next available character in kbd_buffer.
440 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
441 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
442 next available char is in kbd_buffer[0]. */
443 static struct input_event
*kbd_fetch_ptr
;
445 /* Pointer to next place to store character in kbd_buffer. This
446 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
447 character should go in kbd_buffer[0]. */
448 static struct input_event
* volatile kbd_store_ptr
;
450 /* The above pair of variables forms a "queue empty" flag. When we
451 enqueue a non-hook event, we increment kbd_store_ptr. When we
452 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
453 there is input available if the two pointers are not equal.
455 Why not just have a flag set and cleared by the enqueuing and
456 dequeuing functions? Such a flag could be screwed up by interrupts
457 at inopportune times. */
459 /* If this flag is non-nil, we check mouse_moved to see when the
460 mouse moves, and motion events will appear in the input stream.
461 Otherwise, mouse motion is ignored. */
462 Lisp_Object do_mouse_tracking
;
464 /* Symbols to head events. */
465 Lisp_Object Qmouse_movement
;
466 Lisp_Object Qscroll_bar_movement
;
467 Lisp_Object Qswitch_frame
;
468 Lisp_Object Qdelete_frame
;
469 Lisp_Object Qiconify_frame
;
470 Lisp_Object Qmake_frame_visible
;
471 Lisp_Object Qselect_window
;
472 Lisp_Object Qhelp_echo
;
474 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
475 Lisp_Object Qmouse_fixup_help_message
;
478 /* Symbols to denote kinds of events. */
479 Lisp_Object Qfunction_key
;
480 Lisp_Object Qmouse_click
;
481 #if defined (WINDOWSNT)
482 Lisp_Object Qlanguage_change
;
484 Lisp_Object Qdrag_n_drop
;
485 Lisp_Object Qsave_session
;
487 Lisp_Object Qdbus_event
;
489 /* Lisp_Object Qmouse_movement; - also an event header */
491 /* Properties of event headers. */
492 Lisp_Object Qevent_kind
;
493 Lisp_Object Qevent_symbol_elements
;
495 /* menu item parts */
496 Lisp_Object Qmenu_alias
;
497 Lisp_Object Qmenu_enable
;
498 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
499 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
500 extern Lisp_Object Vdefine_key_rebound_commands
;
501 extern Lisp_Object Qmenu_item
;
503 /* An event header symbol HEAD may have a property named
504 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
505 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
506 mask of modifiers applied to it. If present, this is used to help
507 speed up parse_modifiers. */
508 Lisp_Object Qevent_symbol_element_mask
;
510 /* An unmodified event header BASE may have a property named
511 Qmodifier_cache, which is an alist mapping modifier masks onto
512 modified versions of BASE. If present, this helps speed up
514 Lisp_Object Qmodifier_cache
;
516 /* Symbols to use for parts of windows. */
517 Lisp_Object Qmode_line
;
518 Lisp_Object Qvertical_line
;
519 Lisp_Object Qvertical_scroll_bar
;
520 Lisp_Object Qmenu_bar
;
521 extern Lisp_Object Qleft_margin
, Qright_margin
;
522 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
523 extern Lisp_Object QCmap
;
525 Lisp_Object
recursive_edit_unwind (), command_loop ();
526 Lisp_Object
Fthis_command_keys ();
527 Lisp_Object Qextended_command_history
;
528 EMACS_TIME
timer_check ();
530 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
532 extern char *x_get_keysym_name ();
534 static void record_menu_key ();
535 static int echo_length ();
537 Lisp_Object Qpolling_period
;
539 /* List of absolute timers. Appears in order of next scheduled event. */
540 Lisp_Object Vtimer_list
;
542 /* List of idle time timers. Appears in order of next scheduled event. */
543 Lisp_Object Vtimer_idle_list
;
545 /* Incremented whenever a timer is run. */
548 extern Lisp_Object Vprint_level
, Vprint_length
;
550 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
552 EMACS_TIME
*input_available_clear_time
;
554 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
555 Default is 1 if INTERRUPT_INPUT is defined. */
558 /* Nonzero while interrupts are temporarily deferred during redisplay. */
559 int interrupts_deferred
;
561 /* Allow m- file to inhibit use of FIONREAD. */
562 #ifdef BROKEN_FIONREAD
566 /* We are unable to use interrupts if FIONREAD is not available,
567 so flush SIGIO so we won't try. */
568 #if !defined (FIONREAD)
574 /* If we support a window system, turn on the code to poll periodically
575 to detect C-g. It isn't actually used when doing interrupt input. */
576 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
577 #define POLL_FOR_INPUT
580 /* After a command is executed, if point is moved into a region that
581 has specific properties (e.g. composition, display), we adjust
582 point to the boundary of the region. But, if a command sets this
583 variable to non-nil, we suppress this point adjustment. This
584 variable is set to nil before reading a command. */
586 Lisp_Object Vdisable_point_adjustment
;
588 /* If non-nil, always disable point adjustment. */
590 Lisp_Object Vglobal_disable_point_adjustment
;
592 /* The time when Emacs started being idle. */
594 static EMACS_TIME timer_idleness_start_time
;
596 /* After Emacs stops being idle, this saves the last value
597 of timer_idleness_start_time from when it was idle. */
599 static EMACS_TIME timer_last_idleness_start_time
;
601 /* If non-nil, events produced by disabled menu items and tool-bar
602 buttons are not ignored. Help functions bind this to allow help on
603 those items and buttons. */
604 Lisp_Object Venable_disabled_menus_and_buttons
;
607 /* Global variable declarations. */
609 /* Flags for readable_events. */
610 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
611 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
612 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
614 /* Function for init_keyboard to call with no args (if nonzero). */
615 void (*keyboard_init_hook
) ();
617 static int read_avail_input
P_ ((int));
618 static void get_input_pending
P_ ((int *, int));
619 static int readable_events
P_ ((int));
620 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
621 Lisp_Object
, int *));
622 static Lisp_Object
read_char_x_menu_prompt ();
623 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
625 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
626 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
627 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
628 enum scroll_bar_part
,
629 Lisp_Object
, Lisp_Object
,
632 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
633 Lisp_Object
, char **,
634 Lisp_Object
*, unsigned));
635 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
636 static void save_getcjmp
P_ ((jmp_buf));
637 static void save_getcjmp ();
638 static void restore_getcjmp
P_ ((jmp_buf));
639 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
640 static void clear_event
P_ ((struct input_event
*));
641 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
642 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
643 static void handle_interrupt
P_ ((void));
644 static void timer_start_idle
P_ ((void));
645 static void timer_stop_idle
P_ ((void));
646 static void timer_resume_idle
P_ ((void));
647 static SIGTYPE handle_user_signal
P_ ((int));
648 static char *find_user_signal_name
P_ ((int));
649 static int store_user_signal_events
P_ ((void));
651 /* Nonzero means don't try to suspend even if the operating system seems
653 static int cannot_suspend
;
655 extern Lisp_Object Qidentity
, Qonly
;
657 /* Install the string STR as the beginning of the string of echoing,
658 so that it serves as a prompt for the next character.
659 Also start echoing. */
665 current_kboard
->echo_string
= str
;
666 current_kboard
->echo_after_prompt
= SCHARS (str
);
670 /* Add C to the echo string, if echoing is going on.
671 C can be a character, which is printed prettily ("M-C-x" and all that
672 jazz), or a symbol, whose name is printed. */
678 if (current_kboard
->immediate_echo
)
680 int size
= KEY_DESCRIPTION_SIZE
+ 100;
681 char *buffer
= (char *) alloca (size
);
683 Lisp_Object echo_string
;
685 echo_string
= current_kboard
->echo_string
;
687 /* If someone has passed us a composite event, use its head symbol. */
692 ptr
= push_key_description (XINT (c
), ptr
, 1);
694 else if (SYMBOLP (c
))
696 Lisp_Object name
= SYMBOL_NAME (c
);
697 int nbytes
= SBYTES (name
);
699 if (size
- (ptr
- buffer
) < nbytes
)
701 int offset
= ptr
- buffer
;
702 size
= max (2 * size
, size
+ nbytes
);
703 buffer
= (char *) alloca (size
);
704 ptr
= buffer
+ offset
;
707 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
708 STRING_MULTIBYTE (name
), 1);
711 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
714 const char *text
= " (Type ? for further options)";
715 int len
= strlen (text
);
717 if (size
- (ptr
- buffer
) < len
)
719 int offset
= ptr
- buffer
;
721 buffer
= (char *) alloca (size
);
722 ptr
= buffer
+ offset
;
725 bcopy (text
, ptr
, len
);
729 /* Replace a dash from echo_dash with a space, otherwise
730 add a space at the end as a separator between keys. */
731 if (STRINGP (echo_string
)
732 && SCHARS (echo_string
) > 1)
734 Lisp_Object last_char
, prev_char
, idx
;
736 idx
= make_number (SCHARS (echo_string
) - 2);
737 prev_char
= Faref (echo_string
, idx
);
739 idx
= make_number (SCHARS (echo_string
) - 1);
740 last_char
= Faref (echo_string
, idx
);
742 /* We test PREV_CHAR to make sure this isn't the echoing
744 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
745 Faset (echo_string
, idx
, make_number (' '));
747 echo_string
= concat2 (echo_string
, build_string (" "));
749 else if (STRINGP (echo_string
))
750 echo_string
= concat2 (echo_string
, build_string (" "));
752 current_kboard
->echo_string
753 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
759 /* Temporarily add a dash to the end of the echo string if it's not
760 empty, so that it serves as a mini-prompt for the very next character. */
765 /* Do nothing if not echoing at all. */
766 if (NILP (current_kboard
->echo_string
))
769 if (!current_kboard
->immediate_echo
770 && SCHARS (current_kboard
->echo_string
) == 0)
773 /* Do nothing if we just printed a prompt. */
774 if (current_kboard
->echo_after_prompt
775 == SCHARS (current_kboard
->echo_string
))
778 /* Do nothing if we have already put a dash at the end. */
779 if (SCHARS (current_kboard
->echo_string
) > 1)
781 Lisp_Object last_char
, prev_char
, idx
;
783 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
784 prev_char
= Faref (current_kboard
->echo_string
, idx
);
786 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
787 last_char
= Faref (current_kboard
->echo_string
, idx
);
789 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
793 /* Put a dash at the end of the buffer temporarily,
794 but make it go away when the next character is added. */
795 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
800 /* Display the current echo string, and begin echoing if not already
806 if (!current_kboard
->immediate_echo
)
809 current_kboard
->immediate_echo
= 1;
811 for (i
= 0; i
< this_command_key_count
; i
++)
815 /* Set before_command_echo_length to the value that would
816 have been saved before the start of this subcommand in
817 command_loop_1, if we had already been echoing then. */
818 if (i
== this_single_command_key_start
)
819 before_command_echo_length
= echo_length ();
821 c
= XVECTOR (this_command_keys
)->contents
[i
];
822 if (! (EVENT_HAS_PARAMETERS (c
)
823 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
827 /* Set before_command_echo_length to the value that would
828 have been saved before the start of this subcommand in
829 command_loop_1, if we had already been echoing then. */
830 if (this_command_key_count
== this_single_command_key_start
)
831 before_command_echo_length
= echo_length ();
833 /* Put a dash at the end to invite the user to type more. */
838 message3_nolog (current_kboard
->echo_string
,
839 SBYTES (current_kboard
->echo_string
),
840 STRING_MULTIBYTE (current_kboard
->echo_string
));
843 /* Record in what buffer we echoed, and from which kboard. */
844 echo_message_buffer
= echo_area_buffer
[0];
845 echo_kboard
= current_kboard
;
847 if (waiting_for_input
&& !NILP (Vquit_flag
))
848 quit_throw_to_read_char ();
851 /* Turn off echoing, for the start of a new command. */
856 current_kboard
->immediate_echo
= 0;
857 current_kboard
->echo_after_prompt
= -1;
858 current_kboard
->echo_string
= Qnil
;
859 ok_to_echo_at_next_pause
= NULL
;
861 echo_message_buffer
= Qnil
;
864 /* Return the length of the current echo string. */
869 return (STRINGP (current_kboard
->echo_string
)
870 ? SCHARS (current_kboard
->echo_string
)
874 /* Truncate the current echo message to its first LEN chars.
875 This and echo_char get used by read_key_sequence when the user
876 switches frames while entering a key sequence. */
879 echo_truncate (nchars
)
882 if (STRINGP (current_kboard
->echo_string
))
883 current_kboard
->echo_string
884 = Fsubstring (current_kboard
->echo_string
,
885 make_number (0), make_number (nchars
));
886 truncate_echo_area (nchars
);
890 /* Functions for manipulating this_command_keys. */
892 add_command_key (key
)
895 #if 0 /* Not needed after we made Freset_this_command_lengths
896 do the job immediately. */
897 /* If reset-this-command-length was called recently, obey it now.
898 See the doc string of that function for an explanation of why. */
899 if (before_command_restore_flag
)
901 this_command_key_count
= before_command_key_count_1
;
902 if (this_command_key_count
< this_single_command_key_start
)
903 this_single_command_key_start
= this_command_key_count
;
904 echo_truncate (before_command_echo_length_1
);
905 before_command_restore_flag
= 0;
909 if (this_command_key_count
>= ASIZE (this_command_keys
))
910 this_command_keys
= larger_vector (this_command_keys
,
911 2 * ASIZE (this_command_keys
),
914 ASET (this_command_keys
, this_command_key_count
, key
);
915 ++this_command_key_count
;
922 int count
= SPECPDL_INDEX ();
925 if (command_loop_level
> 0)
927 specbind (Qstandard_output
, Qt
);
928 specbind (Qstandard_input
, Qt
);
931 #ifdef HAVE_WINDOW_SYSTEM
932 /* The command loop has started an hourglass timer, so we have to
933 cancel it here, otherwise it will fire because the recursive edit
934 can take some time. Do not check for display_hourglass_p here,
935 because it could already be nil. */
939 /* This function may have been called from a debugger called from
940 within redisplay, for instance by Edebugging a function called
941 from fontification-functions. We want to allow redisplay in
942 the debugging session.
944 The recursive edit is left with a `(throw exit ...)'. The `exit'
945 tag is not caught anywhere in redisplay, i.e. when we leave the
946 recursive edit, the original redisplay leading to the recursive
947 edit will be unwound. The outcome should therefore be safe. */
948 specbind (Qinhibit_redisplay
, Qnil
);
951 val
= command_loop ();
953 Fsignal (Qquit
, Qnil
);
954 /* Handle throw from read_minibuf when using minibuffer
955 while it's active but we're in another window. */
957 xsignal1 (Qerror
, val
);
959 return unbind_to (count
, Qnil
);
962 /* When an auto-save happens, record the "time", and don't do again soon. */
967 last_auto_save
= num_nonmacro_input_events
;
970 /* Make an auto save happen as soon as possible at command level. */
973 force_auto_save_soon ()
975 last_auto_save
= - auto_save_interval
- 1;
977 record_asynch_buffer_change ();
980 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
981 doc
: /* Invoke the editor command loop recursively.
982 To get out of the recursive edit, a command can do `(throw 'exit nil)';
983 that tells this function to return.
984 Alternatively, `(throw 'exit t)' makes this function signal an error.
985 This function is called by the editor initialization to begin editing. */)
988 int count
= SPECPDL_INDEX ();
991 /* If we enter while input is blocked, don't lock up here.
992 This may happen through the debugger during redisplay. */
996 command_loop_level
++;
997 update_mode_lines
= 1;
999 if (command_loop_level
1000 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1001 buffer
= Fcurrent_buffer ();
1005 /* If we leave recursive_edit_1 below with a `throw' for instance,
1006 like it is done in the splash screen display, we have to
1007 make sure that we restore single_kboard as command_loop_1
1008 would have done if it were left normally. */
1009 if (command_loop_level
> 0)
1010 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1011 record_unwind_protect (recursive_edit_unwind
, buffer
);
1013 recursive_edit_1 ();
1014 return unbind_to (count
, Qnil
);
1018 recursive_edit_unwind (buffer
)
1021 if (BUFFERP (buffer
))
1022 Fset_buffer (buffer
);
1024 command_loop_level
--;
1025 update_mode_lines
= 1;
1030 #if 0 /* These two functions are now replaced with
1031 temporarily_switch_to_single_kboard. */
1035 #if 0 /* Theory: if there's anything in Vunread_command_events,
1036 it will right away be read by read_key_sequence,
1037 and then if we do switch KBOARDS, it will go into the side
1038 queue then. So we don't need to do anything special here -- rms. */
1039 if (CONSP (Vunread_command_events
))
1041 current_kboard
->kbd_queue
1042 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1043 current_kboard
->kbd_queue_has_data
= 1;
1045 Vunread_command_events
= Qnil
;
1050 /* Switch to the single-kboard state, making current_kboard
1051 the only KBOARD from which further input is accepted. */
1054 single_kboard_state ()
1060 /* If we're in single_kboard state for kboard KBOARD,
1064 not_single_kboard_state (kboard
)
1067 if (kboard
== current_kboard
)
1071 /* Maintain a stack of kboards, so other parts of Emacs
1072 can switch temporarily to the kboard of a given frame
1073 and then revert to the previous status. */
1078 struct kboard_stack
*next
;
1081 static struct kboard_stack
*kboard_stack
;
1087 struct kboard_stack
*p
1088 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1090 p
->next
= kboard_stack
;
1091 p
->kboard
= current_kboard
;
1101 struct kboard_stack
*p
= kboard_stack
;
1103 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1105 if (t
->kboard
== p
->kboard
)
1107 current_kboard
= p
->kboard
;
1114 /* The terminal we remembered has been deleted. */
1115 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1118 kboard_stack
= p
->next
;
1122 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1123 from which further input is accepted. If F is non-nil, set its
1124 KBOARD as the current keyboard.
1126 This function uses record_unwind_protect to return to the previous
1129 If Emacs is already in single_kboard mode, and F's keyboard is
1130 locked, then this function will throw an errow. */
1133 temporarily_switch_to_single_kboard (f
)
1136 int was_locked
= single_kboard
;
1139 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1140 /* We can not switch keyboards while in single_kboard mode.
1141 In rare cases, Lisp code may call `recursive-edit' (or
1142 `read-minibuffer' or `y-or-n-p') after it switched to a
1143 locked frame. For example, this is likely to happen
1144 when server.el connects to a new terminal while Emacs is in
1145 single_kboard mode. It is best to throw an error instead
1146 of presenting the user with a frozen screen. */
1147 error ("Terminal %d is locked, cannot read from it",
1148 FRAME_TERMINAL (f
)->id
);
1150 /* This call is unnecessary, but helps
1151 `restore_kboard_configuration' discover if somebody changed
1152 `current_kboard' behind our back. */
1153 push_kboard (current_kboard
);
1156 current_kboard
= FRAME_KBOARD (f
);
1158 record_unwind_protect (restore_kboard_configuration
,
1159 (was_locked
? Qt
: Qnil
));
1162 #if 0 /* This function is not needed anymore. */
1164 record_single_kboard_state ()
1167 push_kboard (current_kboard
);
1168 record_unwind_protect (restore_kboard_configuration
,
1169 (single_kboard
? Qt
: Qnil
));
1174 restore_kboard_configuration (was_locked
)
1175 Lisp_Object was_locked
;
1177 if (NILP (was_locked
))
1181 struct kboard
*prev
= current_kboard
;
1184 /* The pop should not change the kboard. */
1185 if (single_kboard
&& current_kboard
!= prev
)
1192 /* Handle errors that are not handled at inner levels
1193 by printing an error message and returning to the editor command loop. */
1199 Lisp_Object old_level
, old_length
;
1200 char macroerror
[50];
1202 #ifdef HAVE_WINDOW_SYSTEM
1203 if (display_hourglass_p
)
1204 cancel_hourglass ();
1207 if (!NILP (executing_kbd_macro
))
1209 if (executing_kbd_macro_iterations
== 1)
1210 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1212 sprintf (macroerror
, "After %d kbd macro iterations: ",
1213 executing_kbd_macro_iterations
);
1218 Vstandard_output
= Qt
;
1219 Vstandard_input
= Qt
;
1220 Vexecuting_kbd_macro
= Qnil
;
1221 executing_kbd_macro
= Qnil
;
1222 current_kboard
->Vprefix_arg
= Qnil
;
1223 current_kboard
->Vlast_prefix_arg
= Qnil
;
1226 /* Avoid unquittable loop if data contains a circular list. */
1227 old_level
= Vprint_level
;
1228 old_length
= Vprint_length
;
1229 XSETFASTINT (Vprint_level
, 10);
1230 XSETFASTINT (Vprint_length
, 10);
1231 cmd_error_internal (data
, macroerror
);
1232 Vprint_level
= old_level
;
1233 Vprint_length
= old_length
;
1237 Vinhibit_quit
= Qnil
;
1238 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1239 if (command_loop_level
== 0 && minibuf_level
== 0)
1240 any_kboard_state ();
1243 return make_number (0);
1246 /* Take actions on handling an error. DATA is the data that describes
1249 CONTEXT is a C-string containing ASCII characters only which
1250 describes the context in which the error happened. If we need to
1251 generalize CONTEXT to allow multibyte characters, make it a Lisp
1255 cmd_error_internal (data
, context
)
1259 struct frame
*sf
= SELECTED_FRAME ();
1261 /* The immediate context is not interesting for Quits,
1262 since they are asyncronous. */
1263 if (EQ (XCAR (data
), Qquit
))
1264 Vsignaling_function
= Qnil
;
1269 /* Use user's specified output function if any. */
1270 if (!NILP (Vcommand_error_function
))
1271 call3 (Vcommand_error_function
, data
,
1272 context
? build_string (context
) : empty_unibyte_string
,
1273 Vsignaling_function
);
1274 /* If the window system or terminal frame hasn't been initialized
1275 yet, or we're not interactive, write the message to stderr and exit. */
1276 else if (!sf
->glyphs_initialized_p
1277 /* The initial frame is a special non-displaying frame. It
1278 will be current in daemon mode when there are no frames
1279 to display, and in non-daemon mode before the real frame
1280 has finished initializing. If an error is thrown in the
1281 latter case while creating the frame, then the frame
1282 will never be displayed, so the safest thing to do is
1283 write to stderr and quit. In daemon mode, there are
1284 many other potential errors that do not prevent frames
1285 from being created, so continuing as normal is better in
1287 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1290 print_error_message (data
, Qexternal_debugging_output
,
1291 context
, Vsignaling_function
);
1292 Fterpri (Qexternal_debugging_output
);
1293 Fkill_emacs (make_number (-1));
1297 clear_message (1, 0);
1299 message_log_maybe_newline ();
1302 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1305 Vsignaling_function
= Qnil
;
1308 Lisp_Object
command_loop_1 ();
1309 Lisp_Object
command_loop_2 ();
1310 Lisp_Object
top_level_1 ();
1312 /* Entry to editor-command-loop.
1313 This level has the catches for exiting/returning to editor command loop.
1314 It returns nil to exit recursive edit, t to abort it. */
1319 if (command_loop_level
> 0 || minibuf_level
> 0)
1322 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1323 executing_kbd_macro
= Qnil
;
1329 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1330 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1331 /* Reset single_kboard in case top-level set it while
1332 evaluating an -f option, or we are stuck there for some
1334 any_kboard_state ();
1336 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1337 executing_kbd_macro
= Qnil
;
1339 /* End of file in -batch run causes exit here. */
1345 /* Here we catch errors in execution of commands within the
1346 editing loop, and reenter the editing loop.
1347 When there is an error, cmd_error runs and returns a non-nil
1348 value to us. A value of nil means that command_loop_1 itself
1349 returned due to end of file (or end of kbd macro). */
1354 register Lisp_Object val
;
1357 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1358 while (!NILP (val
));
1366 return Feval (Vtop_level
);
1372 /* On entry to the outer level, run the startup file */
1373 if (!NILP (Vtop_level
))
1374 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1375 else if (!NILP (Vpurify_flag
))
1376 message ("Bare impure Emacs (standard Lisp code not loaded)");
1378 message ("Bare Emacs (standard Lisp code not loaded)");
1382 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1383 doc
: /* Exit all recursive editing levels.
1384 This also exits all active minibuffers. */)
1387 #ifdef HAVE_WINDOW_SYSTEM
1388 if (display_hourglass_p
)
1389 cancel_hourglass ();
1392 /* Unblock input if we enter with input blocked. This may happen if
1393 redisplay traps e.g. during tool-bar update with input blocked. */
1394 while (INPUT_BLOCKED_P
)
1397 return Fthrow (Qtop_level
, Qnil
);
1400 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1401 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1404 if (command_loop_level
> 0 || minibuf_level
> 0)
1405 Fthrow (Qexit
, Qnil
);
1407 error ("No recursive edit is in progress");
1411 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1412 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1415 if (command_loop_level
> 0 || minibuf_level
> 0)
1418 error ("No recursive edit is in progress");
1422 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1424 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1425 of this function. */
1428 tracking_off (old_value
)
1429 Lisp_Object old_value
;
1431 do_mouse_tracking
= old_value
;
1432 if (NILP (old_value
))
1434 /* Redisplay may have been preempted because there was input
1435 available, and it assumes it will be called again after the
1436 input has been processed. If the only input available was
1437 the sort that we have just disabled, then we need to call
1439 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1441 redisplay_preserve_echo_area (6);
1442 get_input_pending (&input_pending
,
1443 READABLE_EVENTS_DO_TIMERS_NOW
);
1449 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1450 doc
: /* Evaluate BODY with mouse movement events enabled.
1451 Within a `track-mouse' form, mouse motion generates input events that
1452 you can read with `read-event'.
1453 Normally, mouse motion is ignored.
1454 usage: (track-mouse BODY...) */)
1458 int count
= SPECPDL_INDEX ();
1461 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1463 do_mouse_tracking
= Qt
;
1465 val
= Fprogn (args
);
1466 return unbind_to (count
, val
);
1469 /* If mouse has moved on some frame, return one of those frames.
1473 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1474 after resizing the tool-bar window. */
1476 int ignore_mouse_drag_p
;
1481 Lisp_Object tail
, frame
;
1483 if (ignore_mouse_drag_p
)
1485 /* ignore_mouse_drag_p = 0; */
1489 FOR_EACH_FRAME (tail
, frame
)
1491 if (XFRAME (frame
)->mouse_moved
)
1492 return XFRAME (frame
);
1498 #endif /* HAVE_MOUSE || HAVE_GPM */
1500 /* This is the actual command reading loop,
1501 sans error-handling encapsulation. */
1503 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1505 void safe_run_hooks
P_ ((Lisp_Object
));
1506 static void adjust_point_for_property
P_ ((int, int));
1508 /* Cancel hourglass from protect_unwind.
1510 #ifdef HAVE_WINDOW_SYSTEM
1512 cancel_hourglass_unwind (arg
)
1515 cancel_hourglass ();
1526 Lisp_Object keybuf
[30];
1528 int prev_modiff
= 0;
1529 struct buffer
*prev_buffer
= NULL
;
1530 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1531 int was_locked
= single_kboard
;
1533 int already_adjusted
= 0;
1535 current_kboard
->Vprefix_arg
= Qnil
;
1536 current_kboard
->Vlast_prefix_arg
= Qnil
;
1537 Vdeactivate_mark
= Qnil
;
1538 waiting_for_input
= 0;
1542 this_command_key_count
= 0;
1543 this_command_key_count_reset
= 0;
1544 this_single_command_key_start
= 0;
1546 if (NILP (Vmemory_full
))
1548 /* Make sure this hook runs after commands that get errors and
1549 throw to top level. */
1550 /* Note that the value cell will never directly contain nil
1551 if the symbol is a local variable. */
1552 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1553 safe_run_hooks (Qpost_command_hook
);
1555 /* If displaying a message, resize the echo area window to fit
1556 that message's size exactly. */
1557 if (!NILP (echo_area_buffer
[0]))
1558 resize_echo_area_exactly ();
1560 if (!NILP (Vdeferred_action_list
))
1561 safe_run_hooks (Qdeferred_action_function
);
1564 /* Do this after running Vpost_command_hook, for consistency. */
1565 current_kboard
->Vlast_command
= Vthis_command
;
1566 current_kboard
->Vreal_last_command
= real_this_command
;
1567 if (!CONSP (last_command_event
))
1568 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1572 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1575 /* Make sure the current window's buffer is selected. */
1576 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1577 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1579 /* Display any malloc warning that just came out. Use while because
1580 displaying one warning can cause another. */
1582 while (pending_malloc_warning
)
1583 display_malloc_warning ();
1585 Vdeactivate_mark
= Qnil
;
1587 /* If minibuffer on and echo area in use,
1588 wait a short time and redraw minibuffer. */
1591 && !NILP (echo_area_buffer
[0])
1592 && EQ (minibuf_window
, echo_area_window
)
1593 && NUMBERP (Vminibuffer_message_timeout
))
1595 /* Bind inhibit-quit to t so that C-g gets read in
1596 rather than quitting back to the minibuffer. */
1597 int count
= SPECPDL_INDEX ();
1598 specbind (Qinhibit_quit
, Qt
);
1600 sit_for (Vminibuffer_message_timeout
, 0, 2);
1602 /* Clear the echo area. */
1604 safe_run_hooks (Qecho_area_clear_hook
);
1606 unbind_to (count
, Qnil
);
1608 /* If a C-g came in before, treat it as input now. */
1609 if (!NILP (Vquit_flag
))
1612 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1617 /* Select the frame that the last event came from. Usually,
1618 switch-frame events will take care of this, but if some lisp
1619 code swallows a switch-frame event, we'll fix things up here.
1620 Is this a good idea? */
1621 if (FRAMEP (internal_last_event_frame
)
1622 && !EQ (internal_last_event_frame
, selected_frame
))
1623 Fselect_frame (internal_last_event_frame
, Qnil
);
1625 /* If it has changed current-menubar from previous value,
1626 really recompute the menubar from the value. */
1627 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1628 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1629 call0 (Qrecompute_lucid_menubar
);
1631 before_command_key_count
= this_command_key_count
;
1632 before_command_echo_length
= echo_length ();
1634 Vthis_command
= Qnil
;
1635 real_this_command
= Qnil
;
1636 Vthis_original_command
= Qnil
;
1637 Vthis_command_keys_shift_translated
= Qnil
;
1639 /* Read next key sequence; i gets its length. */
1640 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1643 /* A filter may have run while we were reading the input. */
1644 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1646 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1647 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1651 /* Now we have read a key sequence of length I,
1652 or else I is 0 and we found end of file. */
1654 if (i
== 0) /* End of file -- happens only in */
1655 return Qnil
; /* a kbd macro, at the end. */
1656 /* -1 means read_key_sequence got a menu that was rejected.
1657 Just loop around and read another command. */
1661 this_command_key_count
= 0;
1662 this_command_key_count_reset
= 0;
1663 this_single_command_key_start
= 0;
1667 last_command_event
= keybuf
[i
- 1];
1669 /* If the previous command tried to force a specific window-start,
1670 forget about that, in case this command moves point far away
1671 from that position. But also throw away beg_unchanged and
1672 end_unchanged information in that case, so that redisplay will
1673 update the whole window properly. */
1674 if (!NILP (XWINDOW (selected_window
)->force_start
))
1677 XWINDOW (selected_window
)->force_start
= Qnil
;
1678 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1679 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1682 cmd
= read_key_sequence_cmd
;
1683 if (!NILP (Vexecuting_kbd_macro
))
1685 if (!NILP (Vquit_flag
))
1687 Vexecuting_kbd_macro
= Qt
;
1688 QUIT
; /* Make some noise. */
1689 /* Will return since macro now empty. */
1693 /* Do redisplay processing after this command except in special
1694 cases identified below. */
1695 prev_buffer
= current_buffer
;
1696 prev_modiff
= MODIFF
;
1697 last_point_position
= PT
;
1698 last_point_position_window
= selected_window
;
1699 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1701 /* By default, we adjust point to a boundary of a region that
1702 has such a property that should be treated intangible
1703 (e.g. composition, display). But, some commands will set
1704 this variable differently. */
1705 Vdisable_point_adjustment
= Qnil
;
1707 /* Process filters and timers may have messed with deactivate-mark.
1708 reset it before we execute the command. */
1709 Vdeactivate_mark
= Qnil
;
1711 /* Remap command through active keymaps */
1712 Vthis_original_command
= cmd
;
1716 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1720 /* Execute the command. */
1722 Vthis_command
= cmd
;
1723 real_this_command
= cmd
;
1724 /* Note that the value cell will never directly contain nil
1725 if the symbol is a local variable. */
1726 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1727 safe_run_hooks (Qpre_command_hook
);
1729 already_adjusted
= 0;
1731 if (NILP (Vthis_command
))
1733 /* nil means key is undefined. */
1734 Lisp_Object keys
= Fvector (i
, keybuf
);
1735 keys
= Fkey_description (keys
, Qnil
);
1737 message_with_string ("%s is undefined", keys
, 0);
1738 current_kboard
->defining_kbd_macro
= Qnil
;
1739 update_mode_lines
= 1;
1740 current_kboard
->Vprefix_arg
= Qnil
;
1744 if (NILP (current_kboard
->Vprefix_arg
))
1746 /* In case we jump to directly_done. */
1747 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1749 /* Recognize some common commands in common situations and
1750 do them directly. */
1751 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1752 && NILP (Vthis_command_keys_shift_translated
)
1753 && !CONSP (Vtransient_mark_mode
))
1755 struct Lisp_Char_Table
*dp
1756 = window_display_table (XWINDOW (selected_window
));
1757 lose
= FETCH_CHAR (PT_BYTE
);
1759 if (! NILP (Vpost_command_hook
))
1760 /* Put this before calling adjust_point_for_property
1761 so it will only get called once in any case. */
1763 if (current_buffer
== prev_buffer
1764 && last_point_position
!= PT
1765 && NILP (Vdisable_point_adjustment
)
1766 && NILP (Vglobal_disable_point_adjustment
))
1767 adjust_point_for_property (last_point_position
, 0);
1768 already_adjusted
= 1;
1769 if (PT
== last_point_position
+ 1
1771 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1772 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1773 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1774 && (lose
>= 0x20 && lose
< 0x7f)))
1775 : (lose
>= 0x20 && lose
< 0x7f))
1776 /* To extract the case of continuation on
1777 wide-column characters. */
1778 && ASCII_BYTE_P (lose
)
1779 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1781 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1783 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1785 && !windows_or_buffers_changed
1786 && EQ (current_buffer
->selective_display
, Qnil
)
1787 && !detect_input_pending ()
1788 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1789 && NILP (Vexecuting_kbd_macro
))
1790 direct_output_forward_char (1);
1793 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1794 && NILP (Vthis_command_keys_shift_translated
)
1795 && !CONSP (Vtransient_mark_mode
))
1797 struct Lisp_Char_Table
*dp
1798 = window_display_table (XWINDOW (selected_window
));
1800 lose
= FETCH_CHAR (PT_BYTE
);
1801 if (! NILP (Vpost_command_hook
))
1803 if (current_buffer
== prev_buffer
1804 && last_point_position
!= PT
1805 && NILP (Vdisable_point_adjustment
)
1806 && NILP (Vglobal_disable_point_adjustment
))
1807 adjust_point_for_property (last_point_position
, 0);
1808 already_adjusted
= 1;
1809 if (PT
== last_point_position
- 1
1811 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1812 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1813 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1814 && (lose
>= 0x20 && lose
< 0x7f)))
1815 : (lose
>= 0x20 && lose
< 0x7f))
1816 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1818 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1820 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1822 && !windows_or_buffers_changed
1823 && EQ (current_buffer
->selective_display
, Qnil
)
1824 && !detect_input_pending ()
1825 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1826 && NILP (Vexecuting_kbd_macro
))
1827 direct_output_forward_char (-1);
1830 else if (EQ (Vthis_command
, Qself_insert_command
)
1831 /* Try this optimization only on char keystrokes. */
1832 && NATNUMP (last_command_event
)
1833 && CHAR_VALID_P (XFASTINT (last_command_event
), 0))
1836 = translate_char (Vtranslation_table_for_input
,
1837 XFASTINT (last_command_event
));
1839 if (NILP (Vexecuting_kbd_macro
)
1840 && !EQ (minibuf_window
, selected_window
))
1842 if (!nonundocount
|| nonundocount
>= 20)
1850 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1852 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1854 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1856 || MODIFF
<= SAVE_MODIFF
1857 || windows_or_buffers_changed
1858 || !EQ (current_buffer
->selective_display
, Qnil
)
1859 || detect_input_pending ()
1860 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1861 || !NILP (Vexecuting_kbd_macro
));
1863 value
= internal_self_insert (c
, 0);
1868 if (! NILP (Vpost_command_hook
))
1869 /* Put this before calling adjust_point_for_property
1870 so it will only get called once in any case. */
1873 /* VALUE == 1 when AFTER-CHANGE functions are
1874 installed which is the case most of the time
1875 because FONT-LOCK installs one. */
1876 if (!lose
&& !value
)
1877 direct_output_for_insert (c
);
1882 /* Here for a command that isn't executed directly */
1885 #ifdef HAVE_WINDOW_SYSTEM
1886 int scount
= SPECPDL_INDEX ();
1888 if (display_hourglass_p
1889 && NILP (Vexecuting_kbd_macro
))
1891 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1897 if (NILP (current_kboard
->Vprefix_arg
))
1899 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1901 #ifdef HAVE_WINDOW_SYSTEM
1902 /* Do not check display_hourglass_p here, because
1903 Fcommand_execute could change it, but we should cancel
1904 hourglass cursor anyway.
1905 But don't cancel the hourglass within a macro
1906 just because a command in the macro finishes. */
1907 if (NILP (Vexecuting_kbd_macro
))
1908 unbind_to (scount
, Qnil
);
1913 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1915 /* Note that the value cell will never directly contain nil
1916 if the symbol is a local variable. */
1917 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1918 safe_run_hooks (Qpost_command_hook
);
1920 /* If displaying a message, resize the echo area window to fit
1921 that message's size exactly. */
1922 if (!NILP (echo_area_buffer
[0]))
1923 resize_echo_area_exactly ();
1925 if (!NILP (Vdeferred_action_list
))
1926 safe_run_hooks (Qdeferred_action_function
);
1928 /* If there is a prefix argument,
1929 1) We don't want Vlast_command to be ``universal-argument''
1930 (that would be dumb), so don't set Vlast_command,
1931 2) we want to leave echoing on so that the prefix will be
1932 echoed as part of this key sequence, so don't call
1934 3) we want to leave this_command_key_count non-zero, so that
1935 read_char will realize that it is re-reading a character, and
1936 not echo it a second time.
1938 If the command didn't actually create a prefix arg,
1939 but is merely a frame event that is transparent to prefix args,
1940 then the above doesn't apply. */
1941 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1943 current_kboard
->Vlast_command
= Vthis_command
;
1944 current_kboard
->Vreal_last_command
= real_this_command
;
1945 if (!CONSP (last_command_event
))
1946 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1948 this_command_key_count
= 0;
1949 this_command_key_count_reset
= 0;
1950 this_single_command_key_start
= 0;
1953 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1955 /* In Emacs 22, setting transient-mark-mode to `only' was a
1956 way of turning it on for just one command. This usage is
1957 obsolete, but support it anyway. */
1958 if (EQ (Vtransient_mark_mode
, Qidentity
))
1959 Vtransient_mark_mode
= Qnil
;
1960 else if (EQ (Vtransient_mark_mode
, Qonly
))
1961 Vtransient_mark_mode
= Qidentity
;
1963 if (!NILP (Vdeactivate_mark
))
1964 call0 (Qdeactivate_mark
);
1965 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1966 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1971 if (current_buffer
== prev_buffer
1972 && last_point_position
!= PT
1973 && NILP (Vdisable_point_adjustment
)
1974 && NILP (Vglobal_disable_point_adjustment
)
1975 && !already_adjusted
)
1976 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1978 /* Install chars successfully executed in kbd macro. */
1980 if (!NILP (current_kboard
->defining_kbd_macro
)
1981 && NILP (current_kboard
->Vprefix_arg
))
1982 finalize_kbd_macro_chars ();
1983 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1985 any_kboard_state ();
1990 extern Lisp_Object Qcomposition
, Qdisplay
;
1992 /* Adjust point to a boundary of a region that has such a property
1993 that should be treated intangible. For the moment, we check
1994 `composition', `display' and `invisible' properties.
1995 LAST_PT is the last position of point. */
1997 extern Lisp_Object Qafter_string
, Qbefore_string
;
1998 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2001 adjust_point_for_property (last_pt
, modified
)
2006 Lisp_Object val
, overlay
, tmp
;
2007 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2010 /* FIXME: cycling is probably not necessary because these properties
2011 can't be usefully combined anyway. */
2012 while (check_composition
|| check_display
|| check_invisible
)
2014 /* FIXME: check `intangible'. */
2015 if (check_composition
2016 && PT
> BEGV
&& PT
< ZV
2017 && (beg
= composition_adjust_point (last_pt
)) != PT
)
2020 check_display
= check_invisible
= 1;
2022 check_composition
= 0;
2024 && PT
> BEGV
&& PT
< ZV
2025 && !NILP (val
= get_char_property_and_overlay
2026 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2027 && display_prop_intangible_p (val
)
2028 && (!OVERLAYP (overlay
)
2029 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2030 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2031 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2032 && (beg
< PT
/* && end > PT <- It's always the case. */
2033 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2036 SET_PT (PT
< last_pt
2037 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2039 check_composition
= check_invisible
= 1;
2042 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2044 int inv
, ellipsis
= 0;
2047 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2049 && !NILP (val
= get_char_property_and_overlay
2050 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2051 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2053 ellipsis
= ellipsis
|| inv
> 1
2054 || (OVERLAYP (overlay
)
2055 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2056 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2057 tmp
= Fnext_single_char_property_change
2058 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2059 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2062 && !NILP (val
= get_char_property_and_overlay
2063 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2064 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2066 ellipsis
= ellipsis
|| inv
> 1
2067 || (OVERLAYP (overlay
)
2068 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2069 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2070 tmp
= Fprevious_single_char_property_change
2071 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2072 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2075 /* Move away from the inside area. */
2076 if (beg
< PT
&& end
> PT
)
2078 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2079 /* We haven't moved yet (so we don't need to fear
2080 infinite-looping) and we were outside the range
2081 before (so either end of the range still corresponds
2082 to a move in the right direction): pretend we moved
2083 less than we actually did, so that we still have
2084 more freedom below in choosing which end of the range
2086 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2087 /* We either have moved already or the last point
2088 was already in the range: we don't get to choose
2089 which end of the range we have to go to. */
2090 : (PT
< last_pt
? beg
: end
));
2091 check_composition
= check_display
= 1;
2093 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2094 the point to something other than its argument, due to
2095 point-motion hooks, intangibility, etc. */
2096 xassert (PT
== beg
|| PT
== end
);
2099 /* Pretend the area doesn't exist if the buffer is not
2101 if (!modified
&& !ellipsis
&& beg
< end
)
2103 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2104 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2105 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2106 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2107 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2108 /* We've already moved as far as we can. Trying to go
2109 to the other end would mean moving backwards and thus
2110 could lead to an infinite loop. */
2112 else if (val
= get_pos_property (make_number (PT
),
2114 TEXT_PROP_MEANS_INVISIBLE (val
)
2115 && (val
= get_pos_property
2116 (make_number (PT
== beg
? end
: beg
),
2118 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2119 (check_composition
= check_display
= 1,
2120 SET_PT (PT
== beg
? end
: beg
));
2123 check_invisible
= 0;
2127 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2130 safe_run_hooks_1 (hook
)
2133 if (NILP (Vrun_hooks
))
2135 return call1 (Vrun_hooks
, Vinhibit_quit
);
2138 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2141 safe_run_hooks_error (data
)
2144 Lisp_Object args
[3];
2145 args
[0] = build_string ("Error in %s: %s");
2146 args
[1] = Vinhibit_quit
;
2149 return Fset (Vinhibit_quit
, Qnil
);
2152 /* If we get an error while running the hook, cause the hook variable
2153 to be nil. Also inhibit quits, so that C-g won't cause the hook
2154 to mysteriously evaporate. */
2157 safe_run_hooks (hook
)
2160 int count
= SPECPDL_INDEX ();
2161 specbind (Qinhibit_quit
, hook
);
2163 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2165 unbind_to (count
, Qnil
);
2169 /* Number of seconds between polling for input. This is a Lisp
2170 variable that can be bound. */
2172 EMACS_INT polling_period
;
2174 /* Nonzero means polling for input is temporarily suppressed. */
2176 int poll_suppress_count
;
2178 /* Asynchronous timer for polling. */
2180 struct atimer
*poll_timer
;
2183 #ifdef POLL_FOR_INPUT
2185 /* Poll for input, so what we catch a C-g if it comes in. This
2186 function is called from x_make_frame_visible, see comment
2192 if (interrupt_input_blocked
== 0
2193 && !waiting_for_input
)
2194 read_avail_input (0);
2197 /* Timer callback function for poll_timer. TIMER is equal to
2201 poll_for_input (timer
)
2202 struct atimer
*timer
;
2204 if (poll_suppress_count
== 0)
2207 interrupt_input_pending
= 1;
2208 pending_signals
= 1;
2210 poll_for_input_1 ();
2215 #endif /* POLL_FOR_INPUT */
2217 /* Begin signals to poll for input, if they are appropriate.
2218 This function is called unconditionally from various places. */
2223 #ifdef POLL_FOR_INPUT
2224 /* XXX This condition was (read_socket_hook && !interrupt_input),
2225 but read_socket_hook is not global anymore. Let's pretend that
2227 if (!interrupt_input
)
2229 /* Turn alarm handling on unconditionally. It might have
2230 been turned off in process.c. */
2231 turn_on_atimers (1);
2233 /* If poll timer doesn't exist, are we need one with
2234 a different interval, start a new one. */
2235 if (poll_timer
== NULL
2236 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2238 EMACS_TIME interval
;
2241 cancel_atimer (poll_timer
);
2243 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2244 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2245 poll_for_input
, NULL
);
2248 /* Let the timer's callback function poll for input
2249 if this becomes zero. */
2250 --poll_suppress_count
;
2255 /* Nonzero if we are using polling to handle input asynchronously. */
2258 input_polling_used ()
2260 #ifdef POLL_FOR_INPUT
2261 /* XXX This condition was (read_socket_hook && !interrupt_input),
2262 but read_socket_hook is not global anymore. Let's pretend that
2264 return !interrupt_input
;
2270 /* Turn off polling. */
2275 #ifdef POLL_FOR_INPUT
2276 /* XXX This condition was (read_socket_hook && !interrupt_input),
2277 but read_socket_hook is not global anymore. Let's pretend that
2279 if (!interrupt_input
)
2280 ++poll_suppress_count
;
2284 /* Set the value of poll_suppress_count to COUNT
2285 and start or stop polling accordingly. */
2288 set_poll_suppress_count (count
)
2291 #ifdef POLL_FOR_INPUT
2292 if (count
== 0 && poll_suppress_count
!= 0)
2294 poll_suppress_count
= 1;
2297 else if (count
!= 0 && poll_suppress_count
== 0)
2301 poll_suppress_count
= count
;
2305 /* Bind polling_period to a value at least N.
2306 But don't decrease it. */
2309 bind_polling_period (n
)
2312 #ifdef POLL_FOR_INPUT
2313 int new = polling_period
;
2318 stop_other_atimers (poll_timer
);
2320 specbind (Qpolling_period
, make_number (new));
2321 /* Start a new alarm with the new period. */
2326 /* Apply the control modifier to CHARACTER. */
2332 /* Save the upper bits here. */
2333 int upper
= c
& ~0177;
2335 if (! ASCII_BYTE_P (c
))
2336 return c
|= ctrl_modifier
;
2340 /* Everything in the columns containing the upper-case letters
2341 denotes a control character. */
2342 if (c
>= 0100 && c
< 0140)
2346 /* Set the shift modifier for a control char
2347 made from a shifted letter. But only for letters! */
2348 if (oc
>= 'A' && oc
<= 'Z')
2349 c
|= shift_modifier
;
2352 /* The lower-case letters denote control characters too. */
2353 else if (c
>= 'a' && c
<= 'z')
2356 /* Include the bits for control and shift
2357 only if the basic ASCII code can't indicate them. */
2361 /* Replace the high bits. */
2362 c
|= (upper
& ~ctrl_modifier
);
2367 /* Display the help-echo property of the character after the mouse pointer.
2368 Either show it in the echo area, or call show-help-function to display
2369 it by other means (maybe in a tooltip).
2371 If HELP is nil, that means clear the previous help echo.
2373 If HELP is a string, display that string. If HELP is a function,
2374 call it with OBJECT and POS as arguments; the function should
2375 return a help string or nil for none. For all other types of HELP,
2376 evaluate it to obtain a string.
2378 WINDOW is the window in which the help was generated, if any.
2379 It is nil if not in a window.
2381 If OBJECT is a buffer, POS is the position in the buffer where the
2382 `help-echo' text property was found.
2384 If OBJECT is an overlay, that overlay has a `help-echo' property,
2385 and POS is the position in the overlay's buffer under the mouse.
2387 If OBJECT is a string (an overlay string or a string displayed with
2388 the `display' property). POS is the position in that string under
2391 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2392 echo overwrites a keystroke echo currently displayed in the echo
2395 Note: this function may only be called with HELP nil or a string
2396 from X code running asynchronously. */
2399 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2400 Lisp_Object help
, window
, object
, pos
;
2401 int ok_to_overwrite_keystroke_echo
;
2403 if (!NILP (help
) && !STRINGP (help
))
2405 if (FUNCTIONP (help
))
2407 Lisp_Object args
[4];
2412 help
= safe_call (4, args
);
2415 help
= safe_eval (help
);
2417 if (!STRINGP (help
))
2421 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2422 if (!noninteractive
&& STRINGP (help
))
2424 /* The mouse-fixup-help-message Lisp function can call
2425 mouse_position_hook, which resets the mouse_moved flags.
2426 This causes trouble if we are trying to read a mouse motion
2427 event (i.e., if we are inside a `track-mouse' form), so we
2428 restore the mouse_moved flag. */
2429 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2430 help
= call1 (Qmouse_fixup_help_message
, help
);
2436 if (STRINGP (help
) || NILP (help
))
2438 if (!NILP (Vshow_help_function
))
2439 call1 (Vshow_help_function
, help
);
2440 help_echo_showing_p
= STRINGP (help
);
2446 /* Input of single characters from keyboard */
2448 Lisp_Object
print_help ();
2449 static Lisp_Object
kbd_buffer_get_event ();
2450 static void record_char ();
2452 static Lisp_Object help_form_saved_window_configs
;
2454 read_char_help_form_unwind (Lisp_Object arg
)
2456 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2457 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2458 if (!NILP (window_config
))
2459 Fset_window_configuration (window_config
);
2463 #define STOP_POLLING \
2464 do { if (! polling_stopped_here) stop_polling (); \
2465 polling_stopped_here = 1; } while (0)
2467 #define RESUME_POLLING \
2468 do { if (polling_stopped_here) start_polling (); \
2469 polling_stopped_here = 0; } while (0)
2471 /* read a character from the keyboard; call the redisplay if needed */
2472 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2473 -1 means do not do redisplay, but do do autosaving.
2476 /* The arguments MAPS and NMAPS are for menu prompting.
2477 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2479 PREV_EVENT is the previous input event, or nil if we are reading
2480 the first event of a key sequence (or not reading a key sequence).
2481 If PREV_EVENT is t, that is a "magic" value that says
2482 not to run input methods, but in other respects to act as if
2483 not reading a key sequence.
2485 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2486 if we used a mouse menu to read the input, or zero otherwise. If
2487 USED_MOUSE_MENU is null, we don't dereference it.
2489 Value is -2 when we find input on another keyboard. A second call
2490 to read_char will read it.
2492 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2493 specifying the maximum time to wait until. If no input arrives by
2494 that time, stop waiting and return nil.
2496 Value is t if we showed a menu and the user rejected it. */
2499 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2503 Lisp_Object prev_event
;
2504 int *used_mouse_menu
;
2505 EMACS_TIME
*end_time
;
2507 volatile Lisp_Object c
;
2508 int count
, jmpcount
;
2509 jmp_buf local_getcjmp
;
2511 volatile int key_already_recorded
= 0;
2512 Lisp_Object tem
, save
;
2513 volatile Lisp_Object previous_echo_area_message
;
2514 volatile Lisp_Object also_record
;
2515 volatile int reread
;
2516 struct gcpro gcpro1
, gcpro2
;
2517 int polling_stopped_here
= 0;
2518 struct kboard
*orig_kboard
= current_kboard
;
2522 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2523 before_command_key_count
= this_command_key_count
;
2524 before_command_echo_length
= echo_length ();
2527 previous_echo_area_message
= Qnil
;
2529 GCPRO2 (c
, previous_echo_area_message
);
2534 if (CONSP (Vunread_post_input_method_events
))
2536 c
= XCAR (Vunread_post_input_method_events
);
2537 Vunread_post_input_method_events
2538 = XCDR (Vunread_post_input_method_events
);
2540 /* Undo what read_char_x_menu_prompt did when it unread
2541 additional keys returned by Fx_popup_menu. */
2543 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2551 if (unread_command_char
!= -1)
2553 XSETINT (c
, unread_command_char
);
2554 unread_command_char
= -1;
2560 if (CONSP (Vunread_command_events
))
2562 int was_disabled
= 0;
2564 c
= XCAR (Vunread_command_events
);
2565 Vunread_command_events
= XCDR (Vunread_command_events
);
2569 /* Undo what sit-for did when it unread additional keys
2570 inside universal-argument. */
2573 && EQ (XCAR (c
), Qt
))
2579 /* Undo what read_char_x_menu_prompt did when it unread
2580 additional keys returned by Fx_popup_menu. */
2582 && EQ (XCDR (c
), Qdisabled
)
2583 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2589 /* If the queued event is something that used the mouse,
2590 set used_mouse_menu accordingly. */
2592 /* Also check was_disabled so last-nonmenu-event won't return
2593 a bad value when submenus are involved. (Bug#447) */
2594 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2595 *used_mouse_menu
= 1;
2597 goto reread_for_input_method
;
2600 if (CONSP (Vunread_input_method_events
))
2602 c
= XCAR (Vunread_input_method_events
);
2603 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2605 /* Undo what read_char_x_menu_prompt did when it unread
2606 additional keys returned by Fx_popup_menu. */
2608 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2612 goto reread_for_input_method
;
2615 this_command_key_count_reset
= 0;
2617 if (!NILP (Vexecuting_kbd_macro
))
2619 /* We set this to Qmacro; since that's not a frame, nobody will
2620 try to switch frames on us, and the selected window will
2623 Since this event came from a macro, it would be misleading to
2624 leave internal_last_event_frame set to wherever the last
2625 real event came from. Normally, a switch-frame event selects
2626 internal_last_event_frame after each command is read, but
2627 events read from a macro should never cause a new frame to be
2629 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2631 /* Exit the macro if we are at the end.
2632 Also, some things replace the macro with t
2633 to force an early exit. */
2634 if (EQ (Vexecuting_kbd_macro
, Qt
)
2635 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2641 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2642 if (STRINGP (Vexecuting_kbd_macro
)
2643 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2644 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2646 executing_kbd_macro_index
++;
2651 if (!NILP (unread_switch_frame
))
2653 c
= unread_switch_frame
;
2654 unread_switch_frame
= Qnil
;
2656 /* This event should make it into this_command_keys, and get echoed
2657 again, so we do not set `reread'. */
2661 /* if redisplay was requested */
2662 if (commandflag
>= 0)
2664 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2666 /* If there is pending input, process any events which are not
2667 user-visible, such as X selection_request events. */
2669 || detect_input_pending_run_timers (0))
2670 swallow_events (0); /* may clear input_pending */
2672 /* Redisplay if no pending input. */
2673 while (!input_pending
)
2675 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2676 redisplay_preserve_echo_area (5);
2681 /* Normal case: no input arrived during redisplay. */
2684 /* Input arrived and pre-empted redisplay.
2685 Process any events which are not user-visible. */
2687 /* If that cleared input_pending, try again to redisplay. */
2690 /* Prevent the redisplay we just did
2691 from messing up echoing of the input after the prompt. */
2692 if (commandflag
== 0 && echo_current
)
2693 echo_message_buffer
= echo_area_buffer
[0];
2697 /* Message turns off echoing unless more keystrokes turn it on again.
2699 The code in 20.x for the condition was
2701 1. echo_area_glyphs && *echo_area_glyphs
2702 2. && echo_area_glyphs != current_kboard->echobuf
2703 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2705 (1) means there's a current message displayed
2707 (2) means it's not the message from echoing from the current
2710 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2711 is set to a non-null value. This is done in read_char and it is
2712 set to echo_area_glyphs after a call to echo_char. That means
2713 ok_to_echo_at_next_pause is either null or
2714 current_kboard->echobuf with the appropriate current_kboard at
2717 So, condition (3) means in clear text ok_to_echo_at_next_pause
2718 must be either null, or the current message isn't from echoing at
2719 all, or it's from echoing from a different kboard than the
2722 if (/* There currently is something in the echo area. */
2723 !NILP (echo_area_buffer
[0])
2724 && (/* And it's either not from echoing. */
2725 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2726 /* Or it's an echo from a different kboard. */
2727 || echo_kboard
!= current_kboard
2728 /* Or we explicitly allow overwriting whatever there is. */
2729 || ok_to_echo_at_next_pause
== NULL
))
2734 /* Try reading a character via menu prompting in the minibuf.
2735 Try this before the sit-for, because the sit-for
2736 would do the wrong thing if we are supposed to do
2737 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2738 after a mouse event so don't try a minibuf menu. */
2740 if (nmaps
> 0 && INTERACTIVE
2741 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2742 /* Don't bring up a menu if we already have another event. */
2743 && NILP (Vunread_command_events
)
2744 && unread_command_char
< 0
2745 && !detect_input_pending_run_timers (0))
2747 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2749 if (INTEGERP (c
) && XINT (c
) == -2)
2750 return c
; /* wrong_kboard_jmpbuf */
2754 key_already_recorded
= 1;
2759 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2760 We will do that below, temporarily for short sections of code,
2761 when appropriate. local_getcjmp must be in effect
2762 around any call to sit_for or kbd_buffer_get_event;
2763 it *must not* be in effect when we call redisplay. */
2765 jmpcount
= SPECPDL_INDEX ();
2766 if (_setjmp (local_getcjmp
))
2768 /* Handle quits while reading the keyboard. */
2769 /* We must have saved the outer value of getcjmp here,
2770 so restore it now. */
2771 restore_getcjmp (save_jump
);
2772 unbind_to (jmpcount
, Qnil
);
2773 XSETINT (c
, quit_char
);
2774 internal_last_event_frame
= selected_frame
;
2775 Vlast_event_frame
= internal_last_event_frame
;
2776 /* If we report the quit char as an event,
2777 don't do so more than once. */
2778 if (!NILP (Vinhibit_quit
))
2782 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2783 if (kb
!= current_kboard
)
2785 Lisp_Object link
= kb
->kbd_queue
;
2786 /* We shouldn't get here if we were in single-kboard mode! */
2791 while (CONSP (XCDR (link
)))
2793 if (!NILP (XCDR (link
)))
2797 kb
->kbd_queue
= Fcons (c
, Qnil
);
2799 XSETCDR (link
, Fcons (c
, Qnil
));
2800 kb
->kbd_queue_has_data
= 1;
2801 current_kboard
= kb
;
2802 /* This is going to exit from read_char
2803 so we had better get rid of this frame's stuff. */
2805 return make_number (-2); /* wrong_kboard_jmpbuf */
2811 /* Start idle timers if no time limit is supplied. We don't do it
2812 if a time limit is supplied to avoid an infinite recursion in the
2813 situation where an idle timer calls `sit-for'. */
2816 timer_start_idle ();
2818 /* If in middle of key sequence and minibuffer not active,
2819 start echoing if enough time elapses. */
2821 if (minibuf_level
== 0
2823 && !current_kboard
->immediate_echo
2824 && this_command_key_count
> 0
2826 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2827 && NILP (Fzerop (Vecho_keystrokes
))
2828 && (/* No message. */
2829 NILP (echo_area_buffer
[0])
2830 /* Or empty message. */
2831 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2832 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2833 /* Or already echoing from same kboard. */
2834 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2835 /* Or not echoing before and echoing allowed. */
2836 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2838 /* After a mouse event, start echoing right away.
2839 This is because we are probably about to display a menu,
2840 and we don't want to delay before doing so. */
2841 if (EVENT_HAS_PARAMETERS (prev_event
))
2847 save_getcjmp (save_jump
);
2848 restore_getcjmp (local_getcjmp
);
2849 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2850 restore_getcjmp (save_jump
);
2852 && ! CONSP (Vunread_command_events
))
2857 /* Maybe auto save due to number of keystrokes. */
2859 if (commandflag
!= 0
2860 && auto_save_interval
> 0
2861 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2862 && !detect_input_pending_run_timers (0))
2864 Fdo_auto_save (Qnil
, Qnil
);
2865 /* Hooks can actually change some buffers in auto save. */
2869 /* Try reading using an X menu.
2870 This is never confused with reading using the minibuf
2871 because the recursive call of read_char in read_char_minibuf_menu_prompt
2872 does not pass on any keymaps. */
2874 if (nmaps
> 0 && INTERACTIVE
2875 && !NILP (prev_event
)
2876 && EVENT_HAS_PARAMETERS (prev_event
)
2877 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2878 && !EQ (XCAR (prev_event
), Qtool_bar
)
2879 /* Don't bring up a menu if we already have another event. */
2880 && NILP (Vunread_command_events
)
2881 && unread_command_char
< 0)
2883 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2885 /* Now that we have read an event, Emacs is not idle. */
2892 /* Maybe autosave and/or garbage collect due to idleness. */
2894 if (INTERACTIVE
&& NILP (c
))
2896 int delay_level
, buffer_size
;
2898 /* Slow down auto saves logarithmically in size of current buffer,
2899 and garbage collect while we're at it. */
2900 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2901 last_non_minibuf_size
= Z
- BEG
;
2902 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2904 while (buffer_size
> 64)
2905 delay_level
++, buffer_size
-= buffer_size
>> 2;
2906 if (delay_level
< 4) delay_level
= 4;
2907 /* delay_level is 4 for files under around 50k, 7 at 100k,
2908 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2910 /* Auto save if enough time goes by without input. */
2911 if (commandflag
!= 0
2912 && num_nonmacro_input_events
> last_auto_save
2913 && INTEGERP (Vauto_save_timeout
)
2914 && XINT (Vauto_save_timeout
) > 0)
2917 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2919 save_getcjmp (save_jump
);
2920 restore_getcjmp (local_getcjmp
);
2921 tem0
= sit_for (make_number (timeout
), 1, 1);
2922 restore_getcjmp (save_jump
);
2925 && ! CONSP (Vunread_command_events
))
2927 Fdo_auto_save (Qnil
, Qnil
);
2929 /* If we have auto-saved and there is still no input
2930 available, garbage collect if there has been enough
2931 consing going on to make it worthwhile. */
2932 if (!detect_input_pending_run_timers (0)
2933 && consing_since_gc
> gc_cons_threshold
/ 2)
2934 Fgarbage_collect ();
2941 /* Notify the caller if an autosave hook, or a timer, sentinel or
2942 filter in the sit_for calls above have changed the current
2943 kboard. This could happen if they use the minibuffer or start a
2944 recursive edit, like the fancy splash screen in server.el's
2945 filter. If this longjmp wasn't here, read_key_sequence would
2946 interpret the next key sequence using the wrong translation
2947 tables and function keymaps. */
2948 if (NILP (c
) && current_kboard
!= orig_kboard
)
2951 return make_number (-2); /* wrong_kboard_jmpbuf */
2954 /* If this has become non-nil here, it has been set by a timer
2955 or sentinel or filter. */
2956 if (CONSP (Vunread_command_events
))
2958 c
= XCAR (Vunread_command_events
);
2959 Vunread_command_events
= XCDR (Vunread_command_events
);
2962 /* Read something from current KBOARD's side queue, if possible. */
2966 if (current_kboard
->kbd_queue_has_data
)
2968 if (!CONSP (current_kboard
->kbd_queue
))
2970 c
= XCAR (current_kboard
->kbd_queue
);
2971 current_kboard
->kbd_queue
2972 = XCDR (current_kboard
->kbd_queue
);
2973 if (NILP (current_kboard
->kbd_queue
))
2974 current_kboard
->kbd_queue_has_data
= 0;
2975 input_pending
= readable_events (0);
2976 if (EVENT_HAS_PARAMETERS (c
)
2977 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2978 internal_last_event_frame
= XCAR (XCDR (c
));
2979 Vlast_event_frame
= internal_last_event_frame
;
2983 /* If current_kboard's side queue is empty check the other kboards.
2984 If one of them has data that we have not yet seen here,
2985 switch to it and process the data waiting for it.
2987 Note: if the events queued up for another kboard
2988 have already been seen here, and therefore are not a complete command,
2989 the kbd_queue_has_data field is 0, so we skip that kboard here.
2990 That's to avoid an infinite loop switching between kboards here. */
2991 if (NILP (c
) && !single_kboard
)
2994 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2995 if (kb
->kbd_queue_has_data
)
2997 current_kboard
= kb
;
2998 /* This is going to exit from read_char
2999 so we had better get rid of this frame's stuff. */
3001 return make_number (-2); /* wrong_kboard_jmpbuf */
3009 /* Finally, we read from the main queue,
3010 and if that gives us something we can't use yet, we put it on the
3011 appropriate side queue and try again. */
3020 EMACS_GET_TIME (now
);
3021 if (EMACS_TIME_GE (now
, *end_time
))
3025 /* Actually read a character, waiting if necessary. */
3026 save_getcjmp (save_jump
);
3027 restore_getcjmp (local_getcjmp
);
3029 timer_start_idle ();
3030 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3031 restore_getcjmp (save_jump
);
3033 if (! NILP (c
) && (kb
!= current_kboard
))
3035 Lisp_Object link
= kb
->kbd_queue
;
3038 while (CONSP (XCDR (link
)))
3040 if (!NILP (XCDR (link
)))
3044 kb
->kbd_queue
= Fcons (c
, Qnil
);
3046 XSETCDR (link
, Fcons (c
, Qnil
));
3047 kb
->kbd_queue_has_data
= 1;
3051 current_kboard
= kb
;
3052 /* This is going to exit from read_char
3053 so we had better get rid of this frame's stuff. */
3055 return make_number (-2);
3059 /* Terminate Emacs in batch mode if at eof. */
3060 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3061 Fkill_emacs (make_number (1));
3065 /* Add in any extra modifiers, where appropriate. */
3066 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3067 || ((extra_keyboard_modifiers
& 0177) < ' '
3068 && (extra_keyboard_modifiers
& 0177) != 0))
3069 XSETINT (c
, make_ctrl_char (XINT (c
)));
3071 /* Transfer any other modifier bits directly from
3072 extra_keyboard_modifiers to c. Ignore the actual character code
3073 in the low 16 bits of extra_keyboard_modifiers. */
3074 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3085 if (commandflag
>= 0
3086 && !input_pending
&& !detect_input_pending_run_timers (0))
3094 /* Buffer switch events are only for internal wakeups
3095 so don't show them to the user.
3096 Also, don't record a key if we already did. */
3097 if (BUFFERP (c
) || key_already_recorded
)
3100 /* Process special events within read_char
3101 and loop around to read another event. */
3104 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3109 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3110 int was_locked
= single_kboard
;
3111 int count
= SPECPDL_INDEX ();
3112 record_single_kboard_state ();
3115 last_input_event
= c
;
3116 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3118 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3119 /* We stopped being idle for this event; undo that. This
3120 prevents automatic window selection (under
3121 mouse_autoselect_window from acting as a real input event, for
3122 example banishing the mouse under mouse-avoidance-mode. */
3123 timer_resume_idle ();
3125 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3126 /* Resume allowing input from any kboard, if that was true before. */
3128 any_kboard_state ();
3129 unbind_to (count
, Qnil
);
3135 /* Handle things that only apply to characters. */
3138 /* If kbd_buffer_get_event gave us an EOF, return that. */
3142 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3143 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3144 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3145 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3146 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3150 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3151 /* nil in keyboard-translate-table means no translation. */
3157 /* If this event is a mouse click in the menu bar,
3158 return just menu-bar for now. Modify the mouse click event
3159 so we won't do this twice, then queue it up. */
3160 if (EVENT_HAS_PARAMETERS (c
)
3162 && CONSP (EVENT_START (c
))
3163 && CONSP (XCDR (EVENT_START (c
))))
3167 posn
= POSN_POSN (EVENT_START (c
));
3168 /* Handle menu-bar events:
3169 insert the dummy prefix event `menu-bar'. */
3170 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3172 /* Change menu-bar to (menu-bar) as the event "position". */
3173 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3176 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3181 /* Store these characters into recent_keys, the dribble file if any,
3182 and the keyboard macro being defined, if any. */
3184 if (! NILP (also_record
))
3185 record_char (also_record
);
3187 /* Wipe the echo area.
3188 But first, if we are about to use an input method,
3189 save the echo area contents for it to refer to. */
3191 && ! NILP (Vinput_method_function
)
3192 && (unsigned) XINT (c
) >= ' '
3193 && (unsigned) XINT (c
) != 127
3194 && (unsigned) XINT (c
) < 256)
3196 previous_echo_area_message
= Fcurrent_message ();
3197 Vinput_method_previous_message
= previous_echo_area_message
;
3200 /* Now wipe the echo area, except for help events which do their
3201 own stuff with the echo area. */
3203 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3204 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3206 if (!NILP (echo_area_buffer
[0]))
3207 safe_run_hooks (Qecho_area_clear_hook
);
3208 clear_message (1, 0);
3211 reread_for_input_method
:
3213 /* Pass this to the input method, if appropriate. */
3215 && ! NILP (Vinput_method_function
)
3216 /* Don't run the input method within a key sequence,
3217 after the first event of the key sequence. */
3218 && NILP (prev_event
)
3219 && (unsigned) XINT (c
) >= ' '
3220 && (unsigned) XINT (c
) != 127
3221 && (unsigned) XINT (c
) < 256)
3224 int key_count
, key_count_reset
;
3225 struct gcpro gcpro1
;
3226 int count
= SPECPDL_INDEX ();
3228 /* Save the echo status. */
3229 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3230 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3231 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3232 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3235 if (before_command_restore_flag
)
3237 this_command_key_count
= before_command_key_count_1
;
3238 if (this_command_key_count
< this_single_command_key_start
)
3239 this_single_command_key_start
= this_command_key_count
;
3240 echo_truncate (before_command_echo_length_1
);
3241 before_command_restore_flag
= 0;
3245 /* Save the this_command_keys status. */
3246 key_count
= this_command_key_count
;
3247 key_count_reset
= this_command_key_count_reset
;
3250 keys
= Fcopy_sequence (this_command_keys
);
3255 /* Clear out this_command_keys. */
3256 this_command_key_count
= 0;
3257 this_command_key_count_reset
= 0;
3259 /* Now wipe the echo area. */
3260 if (!NILP (echo_area_buffer
[0]))
3261 safe_run_hooks (Qecho_area_clear_hook
);
3262 clear_message (1, 0);
3265 /* If we are not reading a key sequence,
3266 never use the echo area. */
3269 specbind (Qinput_method_use_echo_area
, Qt
);
3272 /* Call the input method. */
3273 tem
= call1 (Vinput_method_function
, c
);
3275 tem
= unbind_to (count
, tem
);
3277 /* Restore the saved echoing state
3278 and this_command_keys state. */
3279 this_command_key_count
= key_count
;
3280 this_command_key_count_reset
= key_count_reset
;
3282 this_command_keys
= keys
;
3285 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3286 current_kboard
->echo_string
= saved_echo_string
;
3287 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3288 if (saved_immediate_echo
)
3293 /* The input method can return no events. */
3296 /* Bring back the previous message, if any. */
3297 if (! NILP (previous_echo_area_message
))
3298 message_with_string ("%s", previous_echo_area_message
, 0);
3301 /* It returned one event or more. */
3303 Vunread_post_input_method_events
3304 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3309 /* Display help if not echoing. */
3310 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3312 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3313 Lisp_Object help
, object
, position
, window
, tem
;
3315 tem
= Fcdr (XCDR (c
));
3318 window
= Fcar (tem
);
3320 object
= Fcar (tem
);
3322 position
= Fcar (tem
);
3324 show_help_echo (help
, window
, object
, position
, 0);
3326 /* We stopped being idle for this event; undo that. */
3328 timer_resume_idle ();
3332 if ((! reread
|| this_command_key_count
== 0
3333 || this_command_key_count_reset
)
3337 /* Don't echo mouse motion events. */
3338 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3339 && NILP (Fzerop (Vecho_keystrokes
))
3340 && ! (EVENT_HAS_PARAMETERS (c
)
3341 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3344 if (! NILP (also_record
))
3345 echo_char (also_record
);
3346 /* Once we reread a character, echoing can happen
3347 the next time we pause to read a new one. */
3348 ok_to_echo_at_next_pause
= current_kboard
;
3351 /* Record this character as part of the current key. */
3352 add_command_key (c
);
3353 if (! NILP (also_record
))
3354 add_command_key (also_record
);
3357 last_input_event
= c
;
3360 /* Process the help character specially if enabled */
3361 if (!NILP (Vhelp_form
) && help_char_p (c
))
3364 count
= SPECPDL_INDEX ();
3366 help_form_saved_window_configs
3367 = Fcons (Fcurrent_window_configuration (Qnil
),
3368 help_form_saved_window_configs
);
3369 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3371 tem0
= Feval (Vhelp_form
);
3373 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3378 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3379 if (EVENT_HAS_PARAMETERS (c
)
3380 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3381 XSETCAR (help_form_saved_window_configs
, Qnil
);
3383 while (BUFFERP (c
));
3384 /* Remove the help from the frame */
3385 unbind_to (count
, Qnil
);
3388 if (EQ (c
, make_number (040)))
3392 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3393 while (BUFFERP (c
));
3402 /* Record a key that came from a mouse menu.
3403 Record it for echoing, for this-command-keys, and so on. */
3409 /* Wipe the echo area. */
3410 clear_message (1, 0);
3415 before_command_key_count
= this_command_key_count
;
3416 before_command_echo_length
= echo_length ();
3419 /* Don't echo mouse motion events. */
3420 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3421 && NILP (Fzerop (Vecho_keystrokes
)))
3425 /* Once we reread a character, echoing can happen
3426 the next time we pause to read a new one. */
3427 ok_to_echo_at_next_pause
= 0;
3430 /* Record this character as part of the current key. */
3431 add_command_key (c
);
3433 /* Re-reading in the middle of a command */
3434 last_input_event
= c
;
3438 /* Return 1 if should recognize C as "the help character". */
3446 if (EQ (c
, Vhelp_char
))
3448 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3449 if (EQ (c
, XCAR (tail
)))
3454 /* Record the input event C in various ways. */
3462 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3464 /* To avoid filling recent_keys with help-echo and mouse-movement
3465 events, we filter out repeated help-echo events, only store the
3466 first and last in a series of mouse-movement events, and don't
3467 store repeated help-echo events which are only separated by
3468 mouse-movement events. */
3470 Lisp_Object ev1
, ev2
, ev3
;
3473 if ((ix1
= recent_keys_index
- 1) < 0)
3474 ix1
= NUM_RECENT_KEYS
- 1;
3475 ev1
= AREF (recent_keys
, ix1
);
3477 if ((ix2
= ix1
- 1) < 0)
3478 ix2
= NUM_RECENT_KEYS
- 1;
3479 ev2
= AREF (recent_keys
, ix2
);
3481 if ((ix3
= ix2
- 1) < 0)
3482 ix3
= NUM_RECENT_KEYS
- 1;
3483 ev3
= AREF (recent_keys
, ix3
);
3485 if (EQ (XCAR (c
), Qhelp_echo
))
3487 /* Don't record `help-echo' in recent_keys unless it shows some help
3488 message, and a different help than the previously recorded
3490 Lisp_Object help
, last_help
;
3492 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3493 if (!STRINGP (help
))
3495 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3496 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3498 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3499 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3500 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3502 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3503 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3504 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3505 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3508 else if (EQ (XCAR (c
), Qmouse_movement
))
3510 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3511 So additional mouse movement events replace the last element. */
3512 Lisp_Object last_window
, window
;
3514 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3515 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3516 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3517 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3518 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3520 ASET (recent_keys
, ix1
, c
);
3526 store_kbd_macro_char (c
);
3531 ASET (recent_keys
, recent_keys_index
, c
);
3532 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3533 recent_keys_index
= 0;
3535 else if (recorded
< 0)
3537 /* We need to remove one or two events from recent_keys.
3538 To do this, we simply put nil at those events and move the
3539 recent_keys_index backwards over those events. Usually,
3540 users will never see those nil events, as they will be
3541 overwritten by the command keys entered to see recent_keys
3544 while (recorded
++ < 0 && total_keys
> 0)
3546 if (total_keys
< NUM_RECENT_KEYS
)
3548 if (--recent_keys_index
< 0)
3549 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3550 ASET (recent_keys
, recent_keys_index
, Qnil
);
3554 num_nonmacro_input_events
++;
3556 /* Write c to the dribble file. If c is a lispy event, write
3557 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3558 If you, dear reader, have a better idea, you've got the source. :-) */
3564 if (XUINT (c
) < 0x100)
3565 putc (XINT (c
), dribble
);
3567 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3571 Lisp_Object dribblee
;
3573 /* If it's a structured event, take the event header. */
3574 dribblee
= EVENT_HEAD (c
);
3576 if (SYMBOLP (dribblee
))
3578 putc ('<', dribble
);
3579 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3580 SBYTES (SYMBOL_NAME (dribblee
)),
3582 putc ('>', dribble
);
3595 struct buffer
*old
= current_buffer
;
3596 Fprinc (object
, Qnil
);
3597 set_buffer_internal (XBUFFER (Vstandard_output
));
3598 call0 (intern ("help-mode"));
3599 set_buffer_internal (old
);
3603 /* Copy out or in the info on where C-g should throw to.
3604 This is used when running Lisp code from within get_char,
3605 in case get_char is called recursively.
3606 See read_process_output. */
3612 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3616 restore_getcjmp (temp
)
3619 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3622 /* Low level keyboard/mouse input.
3623 kbd_buffer_store_event places events in kbd_buffer, and
3624 kbd_buffer_get_event retrieves them. */
3626 /* Return true if there are any events in the queue that read-char
3627 would return. If this returns false, a read-char would block. */
3629 readable_events (flags
)
3632 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3635 /* If the buffer contains only FOCUS_IN_EVENT events, and
3636 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3637 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3639 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3640 #ifdef USE_TOOLKIT_SCROLL_BARS
3641 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3645 struct input_event
*event
;
3647 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3654 #ifdef USE_TOOLKIT_SCROLL_BARS
3655 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3657 event
->kind
== FOCUS_IN_EVENT
)
3658 #ifdef USE_TOOLKIT_SCROLL_BARS
3659 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3660 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3661 && event
->part
== scroll_bar_handle
3662 && event
->modifiers
== 0)
3667 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3670 while (event
!= kbd_store_ptr
);
3676 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3677 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3678 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3683 if (current_kboard
->kbd_queue_has_data
)
3689 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3690 if (kb
->kbd_queue_has_data
)
3696 /* Set this for debugging, to have a way to get out */
3700 event_to_kboard (event
)
3701 struct input_event
*event
;
3704 frame
= event
->frame_or_window
;
3706 frame
= XCAR (frame
);
3707 else if (WINDOWP (frame
))
3708 frame
= WINDOW_FRAME (XWINDOW (frame
));
3710 /* There are still some events that don't set this field.
3711 For now, just ignore the problem.
3712 Also ignore dead frames here. */
3713 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3716 return FRAME_KBOARD (XFRAME (frame
));
3720 Lisp_Object Vthrow_on_input
;
3722 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3725 kbd_buffer_store_event (event
)
3726 register struct input_event
*event
;
3728 kbd_buffer_store_event_hold (event
, 0);
3731 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3733 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3734 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3735 Else, if EVENT is a quit event, store the quit event
3736 in HOLD_QUIT, and return (thus ignoring further events).
3738 This is used in read_avail_input to postpone the processing
3739 of the quit event until all subsequent input events have been
3740 parsed (and discarded).
3744 kbd_buffer_store_event_hold (event
, hold_quit
)
3745 register struct input_event
*event
;
3746 struct input_event
*hold_quit
;
3748 if (event
->kind
== NO_EVENT
)
3751 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3754 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3756 register int c
= event
->code
& 0377;
3758 if (event
->modifiers
& ctrl_modifier
)
3759 c
= make_ctrl_char (c
);
3761 c
|= (event
->modifiers
3762 & (meta_modifier
| alt_modifier
3763 | hyper_modifier
| super_modifier
));
3767 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3768 struct input_event
*sp
;
3770 if (single_kboard
&& kb
!= current_kboard
)
3773 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3774 Fcons (make_number (c
), Qnil
));
3775 kb
->kbd_queue_has_data
= 1;
3776 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3778 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3781 if (event_to_kboard (sp
) == kb
)
3783 sp
->kind
= NO_EVENT
;
3784 sp
->frame_or_window
= Qnil
;
3793 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3797 /* If this results in a quit_char being returned to Emacs as
3798 input, set Vlast_event_frame properly. If this doesn't
3799 get returned to Emacs as an event, the next event read
3800 will set Vlast_event_frame again, so this is safe to do. */
3804 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3806 focus
= event
->frame_or_window
;
3807 internal_last_event_frame
= focus
;
3808 Vlast_event_frame
= focus
;
3811 last_event_timestamp
= event
->timestamp
;
3812 handle_interrupt ();
3816 if (c
&& c
== stop_character
)
3822 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3823 Just ignore the second one. */
3824 else if (event
->kind
== BUFFER_SWITCH_EVENT
3825 && kbd_fetch_ptr
!= kbd_store_ptr
3826 && ((kbd_store_ptr
== kbd_buffer
3827 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3828 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3831 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3832 kbd_store_ptr
= kbd_buffer
;
3834 /* Don't let the very last slot in the buffer become full,
3835 since that would make the two pointers equal,
3836 and that is indistinguishable from an empty buffer.
3837 Discard the event if it would fill the last slot. */
3838 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3840 *kbd_store_ptr
= *event
;
3844 /* If we're inside while-no-input, and this event qualifies
3845 as input, set quit-flag to cause an interrupt. */
3846 if (!NILP (Vthrow_on_input
)
3847 && event
->kind
!= FOCUS_IN_EVENT
3848 && event
->kind
!= HELP_EVENT
3849 && event
->kind
!= DEICONIFY_EVENT
)
3851 Vquit_flag
= Vthrow_on_input
;
3852 /* If we're inside a function that wants immediate quits,
3854 if (immediate_quit
&& NILP (Vinhibit_quit
))
3864 /* Put an input event back in the head of the event queue. */
3867 kbd_buffer_unget_event (event
)
3868 register struct input_event
*event
;
3870 if (kbd_fetch_ptr
== kbd_buffer
)
3871 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3873 /* Don't let the very last slot in the buffer become full, */
3874 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3877 *kbd_fetch_ptr
= *event
;
3882 /* Generate HELP_EVENT input_events in BUFP which has room for
3883 SIZE events. If there's not enough room in BUFP, ignore this
3886 HELP is the help form.
3888 FRAME is the frame on which the help is generated. OBJECT is the
3889 Lisp object where the help was found (a buffer, a string, an
3890 overlay, or nil if neither from a string nor from a buffer. POS is
3891 the position within OBJECT where the help was found.
3893 Value is the number of input_events generated. */
3896 gen_help_event (help
, frame
, window
, object
, pos
)
3897 Lisp_Object help
, frame
, object
, window
;
3900 struct input_event event
;
3904 event
.kind
= HELP_EVENT
;
3905 event
.frame_or_window
= frame
;
3907 event
.x
= WINDOWP (window
) ? window
: frame
;
3910 kbd_buffer_store_event (&event
);
3914 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3917 kbd_buffer_store_help_event (frame
, help
)
3918 Lisp_Object frame
, help
;
3920 struct input_event event
;
3922 event
.kind
= HELP_EVENT
;
3923 event
.frame_or_window
= frame
;
3928 kbd_buffer_store_event (&event
);
3932 /* Discard any mouse events in the event buffer by setting them to
3935 discard_mouse_events ()
3937 struct input_event
*sp
;
3938 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3940 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3943 if (sp
->kind
== MOUSE_CLICK_EVENT
3944 || sp
->kind
== WHEEL_EVENT
3945 || sp
->kind
== HORIZ_WHEEL_EVENT
3947 || sp
->kind
== GPM_CLICK_EVENT
3949 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3951 sp
->kind
= NO_EVENT
;
3957 /* Return non-zero if there are any real events waiting in the event
3958 buffer, not counting `NO_EVENT's.
3960 If DISCARD is non-zero, discard NO_EVENT events at the front of
3961 the input queue, possibly leaving the input queue empty if there
3962 are no real input events. */
3965 kbd_buffer_events_waiting (discard
)
3968 struct input_event
*sp
;
3970 for (sp
= kbd_fetch_ptr
;
3971 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3974 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3981 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3985 /* Clear input event EVENT. */
3989 struct input_event
*event
;
3991 event
->kind
= NO_EVENT
;
3995 /* Read one event from the event buffer, waiting if necessary.
3996 The value is a Lisp object representing the event.
3997 The value is nil for an event that should be ignored,
3998 or that was handled here.
3999 We always read and discard one event. */
4002 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4004 int *used_mouse_menu
;
4005 EMACS_TIME
*end_time
;
4011 /* In case we are running as a daemon, only do this before
4012 detaching from the terminal. */
4013 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
4017 *kbp
= current_kboard
;
4021 /* Wait until there is input available. */
4024 /* Break loop if there's an unread command event. Needed in
4025 moused window autoselection which uses a timer to insert such
4027 if (CONSP (Vunread_command_events
))
4030 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4032 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4033 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4037 /* If the quit flag is set, then read_char will return
4038 quit_char, so that counts as "available input." */
4039 if (!NILP (Vquit_flag
))
4040 quit_throw_to_read_char ();
4042 /* One way or another, wait until input is available; then, if
4043 interrupt handlers have not read it, read it now. */
4045 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4049 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4051 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4052 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4057 EMACS_TIME duration
;
4058 EMACS_GET_TIME (duration
);
4059 if (EMACS_TIME_GE (duration
, *end_time
))
4060 return Qnil
; /* finished waiting */
4063 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4064 wait_reading_process_output (EMACS_SECS (duration
),
4065 EMACS_USECS (duration
),
4066 -1, 1, Qnil
, NULL
, 0);
4070 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4072 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4073 /* Pass 1 for EXPECT since we just waited to have input. */
4074 read_avail_input (1);
4077 if (CONSP (Vunread_command_events
))
4080 first
= XCAR (Vunread_command_events
);
4081 Vunread_command_events
= XCDR (Vunread_command_events
);
4082 *kbp
= current_kboard
;
4086 /* At this point, we know that there is a readable event available
4087 somewhere. If the event queue is empty, then there must be a
4088 mouse movement enabled and available. */
4089 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4091 struct input_event
*event
;
4093 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4097 last_event_timestamp
= event
->timestamp
;
4099 *kbp
= event_to_kboard (event
);
4101 *kbp
= current_kboard
; /* Better than returning null ptr? */
4105 /* These two kinds of events get special handling
4106 and don't actually appear to the command loop.
4107 We return nil for them. */
4108 if (event
->kind
== SELECTION_REQUEST_EVENT
4109 || event
->kind
== SELECTION_CLEAR_EVENT
)
4112 struct input_event copy
;
4114 /* Remove it from the buffer before processing it,
4115 since otherwise swallow_events will see it
4116 and process it again. */
4118 kbd_fetch_ptr
= event
+ 1;
4119 input_pending
= readable_events (0);
4120 x_handle_selection_event (©
);
4122 /* We're getting selection request events, but we don't have
4128 #if defined (HAVE_NS)
4129 else if (event
->kind
== NS_TEXT_EVENT
)
4131 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4132 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4134 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4135 kbd_fetch_ptr
= event
+ 1;
4139 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4140 || defined (HAVE_NS)
4141 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4143 /* Make an event (delete-frame (FRAME)). */
4144 obj
= Fcons (event
->frame_or_window
, Qnil
);
4145 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4146 kbd_fetch_ptr
= event
+ 1;
4149 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4150 || defined (HAVE_NS)
4151 else if (event
->kind
== ICONIFY_EVENT
)
4153 /* Make an event (iconify-frame (FRAME)). */
4154 obj
= Fcons (event
->frame_or_window
, Qnil
);
4155 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4156 kbd_fetch_ptr
= event
+ 1;
4158 else if (event
->kind
== DEICONIFY_EVENT
)
4160 /* Make an event (make-frame-visible (FRAME)). */
4161 obj
= Fcons (event
->frame_or_window
, Qnil
);
4162 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4163 kbd_fetch_ptr
= event
+ 1;
4166 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4168 /* The value doesn't matter here; only the type is tested. */
4169 XSETBUFFER (obj
, current_buffer
);
4170 kbd_fetch_ptr
= event
+ 1;
4172 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4173 || defined(HAVE_NS) || defined (USE_GTK)
4174 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4176 kbd_fetch_ptr
= event
+ 1;
4177 input_pending
= readable_events (0);
4178 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4179 x_activate_menubar (XFRAME (event
->frame_or_window
));
4182 #if defined (WINDOWSNT)
4183 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4185 /* Make an event (language-change (FRAME CHARSET LCID)). */
4186 obj
= Fcons (event
->frame_or_window
, Qnil
);
4187 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4188 kbd_fetch_ptr
= event
+ 1;
4191 else if (event
->kind
== SAVE_SESSION_EVENT
)
4193 obj
= Fcons (Qsave_session
, Qnil
);
4194 kbd_fetch_ptr
= event
+ 1;
4196 /* Just discard these, by returning nil.
4197 With MULTI_KBOARD, these events are used as placeholders
4198 when we need to randomly delete events from the queue.
4199 (They shouldn't otherwise be found in the buffer,
4200 but on some machines it appears they do show up
4201 even without MULTI_KBOARD.) */
4202 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4203 mouse events during a popup-menu call. */
4204 else if (event
->kind
== NO_EVENT
)
4205 kbd_fetch_ptr
= event
+ 1;
4206 else if (event
->kind
== HELP_EVENT
)
4208 Lisp_Object object
, position
, help
, frame
, window
;
4210 frame
= event
->frame_or_window
;
4211 object
= event
->arg
;
4212 position
= make_number (event
->code
);
4215 clear_event (event
);
4217 kbd_fetch_ptr
= event
+ 1;
4218 if (!WINDOWP (window
))
4220 obj
= Fcons (Qhelp_echo
,
4221 list5 (frame
, help
, window
, object
, position
));
4223 else if (event
->kind
== FOCUS_IN_EVENT
)
4225 /* Notification of a FocusIn event. The frame receiving the
4226 focus is in event->frame_or_window. Generate a
4227 switch-frame event if necessary. */
4228 Lisp_Object frame
, focus
;
4230 frame
= event
->frame_or_window
;
4231 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4235 if (!EQ (frame
, internal_last_event_frame
)
4236 && !EQ (frame
, selected_frame
))
4237 obj
= make_lispy_switch_frame (frame
);
4238 internal_last_event_frame
= frame
;
4239 kbd_fetch_ptr
= event
+ 1;
4242 else if (event
->kind
== DBUS_EVENT
)
4244 obj
= make_lispy_event (event
);
4245 kbd_fetch_ptr
= event
+ 1;
4250 /* If this event is on a different frame, return a switch-frame this
4251 time, and leave the event in the queue for next time. */
4255 frame
= event
->frame_or_window
;
4257 frame
= XCAR (frame
);
4258 else if (WINDOWP (frame
))
4259 frame
= WINDOW_FRAME (XWINDOW (frame
));
4261 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4265 if (! EQ (frame
, internal_last_event_frame
)
4266 && !EQ (frame
, selected_frame
))
4267 obj
= make_lispy_switch_frame (frame
);
4268 internal_last_event_frame
= frame
;
4270 /* If we didn't decide to make a switch-frame event, go ahead
4271 and build a real event from the queue entry. */
4275 obj
= make_lispy_event (event
);
4277 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4278 || defined(HAVE_NS) || defined (USE_GTK)
4279 /* If this was a menu selection, then set the flag to inhibit
4280 writing to last_nonmenu_event. Don't do this if the event
4281 we're returning is (menu-bar), though; that indicates the
4282 beginning of the menu sequence, and we might as well leave
4283 that as the `event with parameters' for this selection. */
4285 && !EQ (event
->frame_or_window
, event
->arg
)
4286 && (event
->kind
== MENU_BAR_EVENT
4287 || event
->kind
== TOOL_BAR_EVENT
))
4288 *used_mouse_menu
= 1;
4291 /* Wipe out this event, to catch bugs. */
4292 clear_event (event
);
4293 kbd_fetch_ptr
= event
+ 1;
4297 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4298 /* Try generating a mouse motion event. */
4299 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4301 FRAME_PTR f
= some_mouse_moved ();
4302 Lisp_Object bar_window
;
4303 enum scroll_bar_part part
;
4307 *kbp
= current_kboard
;
4308 /* Note that this uses F to determine which terminal to look at.
4309 If there is no valid info, it does not store anything
4310 so x remains nil. */
4313 /* XXX Can f or mouse_position_hook be NULL here? */
4314 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4315 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4316 &part
, &x
, &y
, &time
);
4320 /* Decide if we should generate a switch-frame event. Don't
4321 generate switch-frame events for motion outside of all Emacs
4327 frame
= FRAME_FOCUS_FRAME (f
);
4329 XSETFRAME (frame
, f
);
4331 if (! EQ (frame
, internal_last_event_frame
)
4332 && !EQ (frame
, selected_frame
))
4333 obj
= make_lispy_switch_frame (frame
);
4334 internal_last_event_frame
= frame
;
4337 /* If we didn't decide to make a switch-frame event, go ahead and
4338 return a mouse-motion event. */
4339 if (!NILP (x
) && NILP (obj
))
4340 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4342 #endif /* HAVE_MOUSE || HAVE GPM */
4344 /* We were promised by the above while loop that there was
4345 something for us to read! */
4348 input_pending
= readable_events (0);
4350 Vlast_event_frame
= internal_last_event_frame
;
4355 /* Process any events that are not user-visible,
4356 then return, without reading any user-visible events. */
4359 swallow_events (do_display
)
4364 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4366 struct input_event
*event
;
4368 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4372 last_event_timestamp
= event
->timestamp
;
4374 /* These two kinds of events get special handling
4375 and don't actually appear to the command loop. */
4376 if (event
->kind
== SELECTION_REQUEST_EVENT
4377 || event
->kind
== SELECTION_CLEAR_EVENT
)
4380 struct input_event copy
;
4382 /* Remove it from the buffer before processing it,
4383 since otherwise swallow_events called recursively could see it
4384 and process it again. */
4386 kbd_fetch_ptr
= event
+ 1;
4387 input_pending
= readable_events (0);
4388 x_handle_selection_event (©
);
4390 /* We're getting selection request events, but we don't have
4399 old_timers_run
= timers_run
;
4400 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4402 if (timers_run
!= old_timers_run
&& do_display
)
4403 redisplay_preserve_echo_area (7);
4406 /* Record the start of when Emacs is idle,
4407 for the sake of running idle-time timers. */
4414 /* If we are already in the idle state, do nothing. */
4415 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4418 EMACS_GET_TIME (timer_idleness_start_time
);
4420 timer_last_idleness_start_time
= timer_idleness_start_time
;
4422 /* Mark all idle-time timers as once again candidates for running. */
4423 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4427 timer
= XCAR (timers
);
4429 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4431 XVECTOR (timer
)->contents
[0] = Qnil
;
4435 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4440 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4443 /* Resume idle timer from last idle start time. */
4446 timer_resume_idle ()
4448 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4451 timer_idleness_start_time
= timer_last_idleness_start_time
;
4454 /* This is only for debugging. */
4455 struct input_event last_timer_event
;
4457 /* List of elisp functions to call, delayed because they were generated in
4458 a context where Elisp could not be safely run (e.g. redisplay, signal,
4459 ...). Each lement has the form (FUN . ARGS). */
4460 Lisp_Object pending_funcalls
;
4462 extern Lisp_Object Qapply
;
4464 /* Check whether a timer has fired. To prevent larger problems we simply
4465 disregard elements that are not proper timers. Do not make a circular
4466 timer list for the time being.
4468 Returns the number of seconds to wait until the next timer fires. If a
4469 timer is triggering now, return zero seconds.
4470 If no timer is active, return -1 seconds.
4472 If a timer is ripe, we run it, with quitting turned off.
4474 DO_IT_NOW is now ignored. It used to mean that we should
4475 run the timer directly instead of queueing a timer-event.
4476 Now we always run timers directly. */
4479 timer_check (do_it_now
)
4482 EMACS_TIME nexttime
;
4483 EMACS_TIME now
, idleness_now
;
4484 Lisp_Object timers
, idle_timers
, chosen_timer
;
4485 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4487 EMACS_SET_SECS (nexttime
, -1);
4488 EMACS_SET_USECS (nexttime
, -1);
4490 /* Always consider the ordinary timers. */
4491 timers
= Vtimer_list
;
4492 /* Consider the idle timers only if Emacs is idle. */
4493 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4494 idle_timers
= Vtimer_idle_list
;
4497 chosen_timer
= Qnil
;
4498 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4500 /* First run the code that was delayed. */
4501 while (CONSP (pending_funcalls
))
4503 Lisp_Object funcall
= XCAR (pending_funcalls
);
4504 pending_funcalls
= XCDR (pending_funcalls
);
4505 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4508 if (CONSP (timers
) || CONSP (idle_timers
))
4510 EMACS_GET_TIME (now
);
4511 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4512 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4515 while (CONSP (timers
) || CONSP (idle_timers
))
4517 Lisp_Object
*vector
;
4518 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4519 EMACS_TIME timer_time
, idle_timer_time
;
4520 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4522 /* Skip past invalid timers and timers already handled. */
4525 timer
= XCAR (timers
);
4526 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4528 timers
= XCDR (timers
);
4531 vector
= XVECTOR (timer
)->contents
;
4533 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4534 || !INTEGERP (vector
[3])
4535 || ! NILP (vector
[0]))
4537 timers
= XCDR (timers
);
4541 if (!NILP (idle_timers
))
4543 timer
= XCAR (idle_timers
);
4544 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4546 idle_timers
= XCDR (idle_timers
);
4549 vector
= XVECTOR (timer
)->contents
;
4551 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4552 || !INTEGERP (vector
[3])
4553 || ! NILP (vector
[0]))
4555 idle_timers
= XCDR (idle_timers
);
4560 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4561 based on the next ordinary timer.
4562 TIMER_DIFFERENCE is the distance in time from NOW to when
4563 this timer becomes ripe (negative if it's already ripe). */
4566 timer
= XCAR (timers
);
4567 vector
= XVECTOR (timer
)->contents
;
4568 EMACS_SET_SECS (timer_time
,
4569 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4570 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4571 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4574 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4575 based on the next idle timer. */
4576 if (!NILP (idle_timers
))
4578 idle_timer
= XCAR (idle_timers
);
4579 vector
= XVECTOR (idle_timer
)->contents
;
4580 EMACS_SET_SECS (idle_timer_time
,
4581 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4582 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4583 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4586 /* Decide which timer is the next timer,
4587 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4588 Also step down the list where we found that timer. */
4590 if (! NILP (timers
) && ! NILP (idle_timers
))
4593 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4594 if (EMACS_TIME_NEG_P (temp
))
4596 chosen_timer
= timer
;
4597 timers
= XCDR (timers
);
4598 difference
= timer_difference
;
4602 chosen_timer
= idle_timer
;
4603 idle_timers
= XCDR (idle_timers
);
4604 difference
= idle_timer_difference
;
4607 else if (! NILP (timers
))
4609 chosen_timer
= timer
;
4610 timers
= XCDR (timers
);
4611 difference
= timer_difference
;
4615 chosen_timer
= idle_timer
;
4616 idle_timers
= XCDR (idle_timers
);
4617 difference
= idle_timer_difference
;
4619 vector
= XVECTOR (chosen_timer
)->contents
;
4621 /* If timer is ripe, run it if it hasn't been run. */
4622 if (EMACS_TIME_NEG_P (difference
)
4623 || (EMACS_SECS (difference
) == 0
4624 && EMACS_USECS (difference
) == 0))
4626 if (NILP (vector
[0]))
4628 int count
= SPECPDL_INDEX ();
4629 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4631 /* Mark the timer as triggered to prevent problems if the lisp
4632 code fails to reschedule it right. */
4635 specbind (Qinhibit_quit
, Qt
);
4637 call1 (Qtimer_event_handler
, chosen_timer
);
4638 Vdeactivate_mark
= old_deactivate_mark
;
4640 unbind_to (count
, Qnil
);
4642 /* Since we have handled the event,
4643 we don't need to tell the caller to wake up and do it. */
4647 /* When we encounter a timer that is still waiting,
4648 return the amount of time to wait before it is ripe. */
4655 /* No timers are pending in the future. */
4656 /* Return 0 if we generated an event, and -1 if not. */
4661 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4662 doc
: /* Return the current length of Emacs idleness, or nil.
4663 The value when Emacs is idle is a list of three integers. The first has the
4664 most significant 16 bits of the seconds, while the second has the
4665 least significant 16 bits. The third integer gives the microsecond
4668 The value when Emacs is not idle is nil.
4670 The microsecond count is zero on systems that do not provide
4671 resolution finer than a second. */)
4674 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4676 EMACS_TIME now
, idleness_now
;
4678 EMACS_GET_TIME (now
);
4679 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4681 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4682 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4683 make_number (EMACS_USECS (idleness_now
)));
4689 /* Caches for modify_event_symbol. */
4690 static Lisp_Object accent_key_syms
;
4691 static Lisp_Object func_key_syms
;
4692 static Lisp_Object mouse_syms
;
4693 static Lisp_Object wheel_syms
;
4694 static Lisp_Object drag_n_drop_syms
;
4696 /* This is a list of keysym codes for special "accent" characters.
4697 It parallels lispy_accent_keys. */
4699 static int lispy_accent_codes
[] =
4701 #ifdef XK_dead_circumflex
4706 #ifdef XK_dead_grave
4711 #ifdef XK_dead_tilde
4716 #ifdef XK_dead_diaeresis
4721 #ifdef XK_dead_macron
4726 #ifdef XK_dead_degree
4731 #ifdef XK_dead_acute
4736 #ifdef XK_dead_cedilla
4741 #ifdef XK_dead_breve
4746 #ifdef XK_dead_ogonek
4751 #ifdef XK_dead_caron
4756 #ifdef XK_dead_doubleacute
4757 XK_dead_doubleacute
,
4761 #ifdef XK_dead_abovedot
4766 #ifdef XK_dead_abovering
4776 #ifdef XK_dead_belowdot
4781 #ifdef XK_dead_voiced_sound
4782 XK_dead_voiced_sound
,
4786 #ifdef XK_dead_semivoiced_sound
4787 XK_dead_semivoiced_sound
,
4803 /* This is a list of Lisp names for special "accent" characters.
4804 It parallels lispy_accent_codes. */
4806 static char *lispy_accent_keys
[] =
4824 "dead-voiced-sound",
4825 "dead-semivoiced-sound",
4831 #define FUNCTION_KEY_OFFSET 0x0
4833 char *lispy_function_keys
[] =
4837 0, /* VK_LBUTTON 0x01 */
4838 0, /* VK_RBUTTON 0x02 */
4839 "cancel", /* VK_CANCEL 0x03 */
4840 0, /* VK_MBUTTON 0x04 */
4842 0, 0, 0, /* 0x05 .. 0x07 */
4844 "backspace", /* VK_BACK 0x08 */
4845 "tab", /* VK_TAB 0x09 */
4847 0, 0, /* 0x0A .. 0x0B */
4849 "clear", /* VK_CLEAR 0x0C */
4850 "return", /* VK_RETURN 0x0D */
4852 0, 0, /* 0x0E .. 0x0F */
4854 0, /* VK_SHIFT 0x10 */
4855 0, /* VK_CONTROL 0x11 */
4856 0, /* VK_MENU 0x12 */
4857 "pause", /* VK_PAUSE 0x13 */
4858 "capslock", /* VK_CAPITAL 0x14 */
4859 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4861 "junja", /* VK_JUNJA 0x17 */
4862 "final", /* VK_FINAL 0x18 */
4863 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4865 "escape", /* VK_ESCAPE 0x1B */
4866 "convert", /* VK_CONVERT 0x1C */
4867 "non-convert", /* VK_NONCONVERT 0x1D */
4868 "accept", /* VK_ACCEPT 0x1E */
4869 "mode-change", /* VK_MODECHANGE 0x1F */
4870 0, /* VK_SPACE 0x20 */
4871 "prior", /* VK_PRIOR 0x21 */
4872 "next", /* VK_NEXT 0x22 */
4873 "end", /* VK_END 0x23 */
4874 "home", /* VK_HOME 0x24 */
4875 "left", /* VK_LEFT 0x25 */
4876 "up", /* VK_UP 0x26 */
4877 "right", /* VK_RIGHT 0x27 */
4878 "down", /* VK_DOWN 0x28 */
4879 "select", /* VK_SELECT 0x29 */
4880 "print", /* VK_PRINT 0x2A */
4881 "execute", /* VK_EXECUTE 0x2B */
4882 "snapshot", /* VK_SNAPSHOT 0x2C */
4883 "insert", /* VK_INSERT 0x2D */
4884 "delete", /* VK_DELETE 0x2E */
4885 "help", /* VK_HELP 0x2F */
4887 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4889 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4891 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4893 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4895 0, 0, 0, 0, 0, 0, 0, 0, 0,
4896 0, 0, 0, 0, 0, 0, 0, 0, 0,
4897 0, 0, 0, 0, 0, 0, 0, 0,
4899 "lwindow", /* VK_LWIN 0x5B */
4900 "rwindow", /* VK_RWIN 0x5C */
4901 "apps", /* VK_APPS 0x5D */
4904 "kp-0", /* VK_NUMPAD0 0x60 */
4905 "kp-1", /* VK_NUMPAD1 0x61 */
4906 "kp-2", /* VK_NUMPAD2 0x62 */
4907 "kp-3", /* VK_NUMPAD3 0x63 */
4908 "kp-4", /* VK_NUMPAD4 0x64 */
4909 "kp-5", /* VK_NUMPAD5 0x65 */
4910 "kp-6", /* VK_NUMPAD6 0x66 */
4911 "kp-7", /* VK_NUMPAD7 0x67 */
4912 "kp-8", /* VK_NUMPAD8 0x68 */
4913 "kp-9", /* VK_NUMPAD9 0x69 */
4914 "kp-multiply", /* VK_MULTIPLY 0x6A */
4915 "kp-add", /* VK_ADD 0x6B */
4916 "kp-separator", /* VK_SEPARATOR 0x6C */
4917 "kp-subtract", /* VK_SUBTRACT 0x6D */
4918 "kp-decimal", /* VK_DECIMAL 0x6E */
4919 "kp-divide", /* VK_DIVIDE 0x6F */
4920 "f1", /* VK_F1 0x70 */
4921 "f2", /* VK_F2 0x71 */
4922 "f3", /* VK_F3 0x72 */
4923 "f4", /* VK_F4 0x73 */
4924 "f5", /* VK_F5 0x74 */
4925 "f6", /* VK_F6 0x75 */
4926 "f7", /* VK_F7 0x76 */
4927 "f8", /* VK_F8 0x77 */
4928 "f9", /* VK_F9 0x78 */
4929 "f10", /* VK_F10 0x79 */
4930 "f11", /* VK_F11 0x7A */
4931 "f12", /* VK_F12 0x7B */
4932 "f13", /* VK_F13 0x7C */
4933 "f14", /* VK_F14 0x7D */
4934 "f15", /* VK_F15 0x7E */
4935 "f16", /* VK_F16 0x7F */
4936 "f17", /* VK_F17 0x80 */
4937 "f18", /* VK_F18 0x81 */
4938 "f19", /* VK_F19 0x82 */
4939 "f20", /* VK_F20 0x83 */
4940 "f21", /* VK_F21 0x84 */
4941 "f22", /* VK_F22 0x85 */
4942 "f23", /* VK_F23 0x86 */
4943 "f24", /* VK_F24 0x87 */
4945 0, 0, 0, 0, /* 0x88 .. 0x8B */
4946 0, 0, 0, 0, /* 0x8C .. 0x8F */
4948 "kp-numlock", /* VK_NUMLOCK 0x90 */
4949 "scroll", /* VK_SCROLL 0x91 */
4950 /* Not sure where the following block comes from.
4951 Windows headers have NEC and Fujitsu specific keys in
4952 this block, but nothing generic. */
4953 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4954 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4955 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4956 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4957 "kp-end", /* VK_NUMPAD_END 0x96 */
4958 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4959 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4960 "kp-up", /* VK_NUMPAD_UP 0x99 */
4961 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4962 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4963 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4964 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4966 0, 0, /* 0x9E .. 0x9F */
4969 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4970 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4971 * No other API or message will distinguish left and right keys this way.
4976 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4977 to enable them selectively, and gives access to a few more functions.
4978 See lispy_multimedia_keys below. */
4979 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4980 0, 0, 0, /* 0xAD .. 0xAF Volume */
4981 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4982 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4984 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4985 0, 0, 0, 0, 0, 0, 0, 0, 0,
4987 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4988 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,
4992 "ax", /* VK_OEM_AX 0xE1 */
4993 0, /* VK_OEM_102 0xE2 */
4994 "ico-help", /* VK_ICO_HELP 0xE3 */
4995 "ico-00", /* VK_ICO_00 0xE4 */
4996 0, /* VK_PROCESSKEY 0xE5 */
4997 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4998 "packet", /* VK_PACKET 0xE7 */
5000 "reset", /* VK_OEM_RESET 0xE9 */
5001 "jump", /* VK_OEM_JUMP 0xEA */
5002 "oem-pa1", /* VK_OEM_PA1 0xEB */
5003 "oem-pa2", /* VK_OEM_PA2 0xEC */
5004 "oem-pa3", /* VK_OEM_PA3 0xED */
5005 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5006 "cusel", /* VK_OEM_CUSEL 0xEF */
5007 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5008 "finish", /* VK_OEM_FINISH 0xF1 */
5009 "copy", /* VK_OEM_COPY 0xF2 */
5010 "auto", /* VK_OEM_AUTO 0xF3 */
5011 "enlw", /* VK_OEM_ENLW 0xF4 */
5012 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5013 "attn", /* VK_ATTN 0xF6 */
5014 "crsel", /* VK_CRSEL 0xF7 */
5015 "exsel", /* VK_EXSEL 0xF8 */
5016 "ereof", /* VK_EREOF 0xF9 */
5017 "play", /* VK_PLAY 0xFA */
5018 "zoom", /* VK_ZOOM 0xFB */
5019 "noname", /* VK_NONAME 0xFC */
5020 "pa1", /* VK_PA1 0xFD */
5021 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5025 /* Some of these duplicate the "Media keys" on newer keyboards,
5026 but they are delivered to the application in a different way. */
5027 static char *lispy_multimedia_keys
[] =
5035 "browser-favorites",
5072 "toggle-dictate-command",
5078 "media-fast-forward",
5081 "media-channel-down"
5084 #else /* not HAVE_NTGUI */
5086 /* This should be dealt with in XTread_socket now, and that doesn't
5087 depend on the client system having the Kana syms defined. See also
5088 the XK_kana_A case below. */
5091 static char *lispy_kana_keys
[] =
5093 /* X Keysym value */
5094 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5095 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5096 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5097 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5098 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5099 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5100 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5101 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5102 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5103 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5104 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5105 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5106 "kana-i", "kana-u", "kana-e", "kana-o",
5107 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5108 "prolongedsound", "kana-A", "kana-I", "kana-U",
5109 "kana-E", "kana-O", "kana-KA", "kana-KI",
5110 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5111 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5112 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5113 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5114 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5115 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5116 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5117 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5118 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5119 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5120 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5121 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5123 #endif /* XK_kana_A */
5126 #define FUNCTION_KEY_OFFSET 0xff00
5128 /* You'll notice that this table is arranged to be conveniently
5129 indexed by X Windows keysym values. */
5130 static char *lispy_function_keys
[] =
5132 /* X Keysym value */
5134 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5135 "backspace", "tab", "linefeed", "clear",
5137 0, 0, 0, "pause", /* 0xff10...1f */
5138 0, 0, 0, 0, 0, 0, 0, "escape",
5140 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5141 "romaji", "hiragana", "katakana", "hiragana-katakana",
5142 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5143 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5144 "eisu-toggle", /* 0xff30...3f */
5145 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5146 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5148 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5149 "down", "prior", "next", "end",
5150 "begin", 0, 0, 0, 0, 0, 0, 0,
5151 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5162 "break", /* 0xff6b */
5165 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5166 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5167 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5168 0, 0, 0, 0, 0, 0, 0, 0,
5169 "kp-tab", /* 0xff89 */
5171 "kp-enter", /* 0xff8d */
5173 "kp-f1", /* 0xff91 */
5177 "kp-home", /* 0xff95 */
5182 "kp-prior", /* kp-page-up */
5183 "kp-next", /* kp-page-down */
5189 0, 0, 0, 0, 0, 0, 0, 0, 0,
5190 "kp-multiply", /* 0xffaa */
5195 "kp-divide", /* 0xffaf */
5196 "kp-0", /* 0xffb0 */
5197 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5200 "kp-equal", /* 0xffbd */
5201 "f1", /* 0xffbe */ /* IsFunctionKey */
5203 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5204 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5205 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5206 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5207 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5208 0, 0, 0, 0, 0, 0, 0, 0,
5209 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5210 0, 0, 0, 0, 0, 0, 0, "delete"
5213 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5214 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5216 static char *iso_lispy_function_keys
[] =
5218 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5219 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5220 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5221 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5222 "iso-lefttab", /* 0xfe20 */
5223 "iso-move-line-up", "iso-move-line-down",
5224 "iso-partial-line-up", "iso-partial-line-down",
5225 "iso-partial-space-left", "iso-partial-space-right",
5226 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5227 "iso-release-margin-left", "iso-release-margin-right",
5228 "iso-release-both-margins",
5229 "iso-fast-cursor-left", "iso-fast-cursor-right",
5230 "iso-fast-cursor-up", "iso-fast-cursor-down",
5231 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5232 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5235 #endif /* not HAVE_NTGUI */
5237 Lisp_Object Vlispy_mouse_stem
;
5239 static char *lispy_wheel_names
[] =
5241 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5244 /* drag-n-drop events are generated when a set of selected files are
5245 dragged from another application and dropped onto an Emacs window. */
5246 static char *lispy_drag_n_drop_names
[] =
5251 /* Scroll bar parts. */
5252 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5253 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5254 Lisp_Object Qtop
, Qratio
;
5256 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5257 Lisp_Object
*scroll_bar_parts
[] = {
5258 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5259 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5262 /* A vector, indexed by button number, giving the down-going location
5263 of currently depressed buttons, both scroll bar and non-scroll bar.
5265 The elements have the form
5266 (BUTTON-NUMBER MODIFIER-MASK . REST)
5267 where REST is the cdr of a position as it would be reported in the event.
5269 The make_lispy_event function stores positions here to tell the
5270 difference between click and drag events, and to store the starting
5271 location to be included in drag events. */
5273 static Lisp_Object button_down_location
;
5275 /* Information about the most recent up-going button event: Which
5276 button, what location, and what time. */
5278 static int last_mouse_button
;
5279 static int last_mouse_x
;
5280 static int last_mouse_y
;
5281 static unsigned long button_down_time
;
5283 /* The maximum time between clicks to make a double-click, or Qnil to
5284 disable double-click detection, or Qt for no time limit. */
5286 Lisp_Object Vdouble_click_time
;
5288 /* Maximum number of pixels the mouse may be moved between clicks
5289 to make a double-click. */
5291 EMACS_INT double_click_fuzz
;
5293 /* The number of clicks in this multiple-click. */
5295 int double_click_count
;
5297 /* Return position of a mouse click or wheel event */
5300 make_lispy_position (f
, x
, y
, time
)
5306 enum window_part part
;
5307 Lisp_Object posn
= Qnil
;
5308 Lisp_Object extra_info
= Qnil
;
5311 /* Set `window' to the window under frame pixel coordinates (x,y) */
5313 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5314 &part
, &wx
, &wy
, 0);
5318 if (WINDOWP (window
))
5320 /* It's a click in window window at frame coordinates (x,y) */
5321 struct window
*w
= XWINDOW (window
);
5322 Lisp_Object string_info
= Qnil
;
5323 int textpos
= -1, rx
= -1, ry
= -1;
5324 int dx
= -1, dy
= -1;
5325 int width
= -1, height
= -1;
5326 Lisp_Object object
= Qnil
;
5328 /* Set event coordinates to window-relative coordinates
5329 for constructing the Lisp event below. */
5333 if (part
== ON_TEXT
)
5335 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5337 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5339 /* Mode line or header line. Look for a string under
5340 the mouse that may have a `local-map' property. */
5344 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5346 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5347 &object
, &dx
, &dy
, &width
, &height
);
5348 if (STRINGP (string
))
5349 string_info
= Fcons (string
, make_number (charpos
));
5350 if (w
== XWINDOW (selected_window
)
5351 && current_buffer
== XBUFFER (w
->buffer
))
5354 textpos
= XMARKER (w
->pointm
)->charpos
;
5356 else if (part
== ON_VERTICAL_BORDER
)
5358 posn
= Qvertical_line
;
5363 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5368 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5370 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5371 &object
, &dx
, &dy
, &width
, &height
);
5372 if (STRINGP (string
))
5373 string_info
= Fcons (string
, make_number (charpos
));
5374 if (part
== ON_LEFT_MARGIN
)
5377 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5379 else if (part
== ON_LEFT_FRINGE
)
5381 posn
= Qleft_fringe
;
5384 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5386 : window_box_width (w
, LEFT_MARGIN_AREA
));
5389 else if (part
== ON_RIGHT_FRINGE
)
5391 posn
= Qright_fringe
;
5394 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5395 + window_box_width (w
, TEXT_AREA
)
5396 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5397 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5403 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5404 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5409 Lisp_Object string2
, object2
= Qnil
;
5410 struct display_pos p
;
5412 int width2
, height2
;
5413 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5414 &object2
, &dx2
, &dy2
,
5416 textpos
= CHARPOS (p
.pos
);
5417 if (rx
< 0) rx
= wx
;
5418 if (ry
< 0) ry
= wy
;
5419 if (dx
< 0) dx
= dx2
;
5420 if (dy
< 0) dy
= dy2
;
5421 if (width
< 0) width
= width2
;
5422 if (height
< 0) height
= height2
;
5426 posn
= make_number (textpos
);
5427 if (STRINGP (string2
))
5428 string_info
= Fcons (string2
,
5429 make_number (CHARPOS (p
.string_pos
)));
5435 #ifdef HAVE_WINDOW_SYSTEM
5436 if (IMAGEP (object
))
5438 Lisp_Object image_map
, hotspot
;
5439 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5441 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5443 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5444 posn
= XCAR (hotspot
);
5449 extra_info
= Fcons (object
,
5450 Fcons (Fcons (make_number (dx
),
5452 Fcons (Fcons (make_number (width
),
5453 make_number (height
)),
5457 extra_info
= Fcons (string_info
,
5458 Fcons (make_number (textpos
),
5459 Fcons (Fcons (make_number (rx
),
5465 XSETFRAME (window
, f
);
5470 XSETFASTINT (*x
, 0);
5471 XSETFASTINT (*y
, 0);
5474 return Fcons (window
,
5476 Fcons (Fcons (*x
, *y
),
5477 Fcons (make_number (time
),
5481 /* Given a struct input_event, build the lisp event which represents
5482 it. If EVENT is 0, build a mouse movement event from the mouse
5483 movement buffer, which should have a movement event in it.
5485 Note that events must be passed to this function in the order they
5486 are received; this function stores the location of button presses
5487 in order to build drag events when the button is released. */
5490 make_lispy_event (event
)
5491 struct input_event
*event
;
5495 switch (SWITCH_ENUM_CAST (event
->kind
))
5497 /* A simple keystroke. */
5498 case ASCII_KEYSTROKE_EVENT
:
5499 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5501 Lisp_Object lispy_c
;
5502 int c
= event
->code
;
5503 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5506 eassert (c
== event
->code
);
5507 /* Turn ASCII characters into control characters
5509 if (event
->modifiers
& ctrl_modifier
)
5511 c
= make_ctrl_char (c
);
5512 event
->modifiers
&= ~ctrl_modifier
;
5516 /* Add in the other modifier bits. The shift key was taken care
5517 of by the X code. */
5518 c
|= (event
->modifiers
5519 & (meta_modifier
| alt_modifier
5520 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5521 /* Distinguish Shift-SPC from SPC. */
5522 if ((event
->code
) == 040
5523 && event
->modifiers
& shift_modifier
)
5524 c
|= shift_modifier
;
5525 button_down_time
= 0;
5526 XSETFASTINT (lispy_c
, c
);
5530 /* A function key. The symbol may need to have modifier prefixes
5532 case NON_ASCII_KEYSTROKE_EVENT
:
5533 button_down_time
= 0;
5535 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5536 if (event
->code
== lispy_accent_codes
[i
])
5537 return modify_event_symbol (i
,
5539 Qfunction_key
, Qnil
,
5540 lispy_accent_keys
, &accent_key_syms
,
5541 (sizeof (lispy_accent_keys
)
5542 / sizeof (lispy_accent_keys
[0])));
5546 if (event
->code
>= 0x400 && event
->code
< 0x500)
5547 return modify_event_symbol (event
->code
- 0x400,
5548 event
->modifiers
& ~shift_modifier
,
5549 Qfunction_key
, Qnil
,
5550 lispy_kana_keys
, &func_key_syms
,
5551 (sizeof (lispy_kana_keys
)
5552 / sizeof (lispy_kana_keys
[0])));
5553 #endif /* XK_kana_A */
5556 #ifdef ISO_FUNCTION_KEY_OFFSET
5557 if (event
->code
< FUNCTION_KEY_OFFSET
5558 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5559 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5561 Qfunction_key
, Qnil
,
5562 iso_lispy_function_keys
, &func_key_syms
,
5563 (sizeof (iso_lispy_function_keys
)
5564 / sizeof (iso_lispy_function_keys
[0])));
5567 /* Handle system-specific or unknown keysyms. */
5568 if (event
->code
& (1 << 28)
5569 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5570 || (event
->code
- FUNCTION_KEY_OFFSET
5571 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5572 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5574 /* We need to use an alist rather than a vector as the cache
5575 since we can't make a vector long enuf. */
5576 if (NILP (current_kboard
->system_key_syms
))
5577 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5578 return modify_event_symbol (event
->code
,
5581 current_kboard
->Vsystem_key_alist
,
5582 0, ¤t_kboard
->system_key_syms
,
5586 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5588 Qfunction_key
, Qnil
,
5589 lispy_function_keys
, &func_key_syms
,
5590 (sizeof (lispy_function_keys
)
5591 / sizeof (lispy_function_keys
[0])));
5594 case MULTIMEDIA_KEY_EVENT
:
5595 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5596 / sizeof (lispy_multimedia_keys
[0]))
5597 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5599 return modify_event_symbol (event
->code
, event
->modifiers
,
5600 Qfunction_key
, Qnil
,
5601 lispy_multimedia_keys
, &func_key_syms
,
5602 (sizeof (lispy_multimedia_keys
)
5603 / sizeof (lispy_multimedia_keys
[0])));
5609 /* A mouse click. Figure out where it is, decide whether it's
5610 a press, click or drag, and build the appropriate structure. */
5611 case MOUSE_CLICK_EVENT
:
5612 #ifndef USE_TOOLKIT_SCROLL_BARS
5613 case SCROLL_BAR_CLICK_EVENT
:
5616 int button
= event
->code
;
5618 Lisp_Object position
;
5619 Lisp_Object
*start_pos_ptr
;
5620 Lisp_Object start_pos
;
5624 /* Build the position as appropriate for this mouse click. */
5625 if (event
->kind
== MOUSE_CLICK_EVENT
)
5627 struct frame
*f
= XFRAME (event
->frame_or_window
);
5628 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5632 /* Ignore mouse events that were made on frame that
5633 have been deleted. */
5634 if (! FRAME_LIVE_P (f
))
5637 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5638 /* EVENT->x and EVENT->y are frame-relative pixel
5639 coordinates at this place. Under old redisplay, COLUMN
5640 and ROW are set to frame relative glyph coordinates
5641 which are then used to determine whether this click is
5642 in a menu (non-toolkit version). */
5643 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5644 &column
, &row
, NULL
, 1);
5646 /* In the non-toolkit version, clicks on the menu bar
5647 are ordinary button events in the event buffer.
5648 Distinguish them, and invoke the menu.
5650 (In the toolkit version, the toolkit handles the menu bar
5651 and Emacs doesn't know about it until after the user
5652 makes a selection.) */
5653 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5654 && (event
->modifiers
& down_modifier
))
5656 Lisp_Object items
, item
;
5661 /* Activate the menu bar on the down event. If the
5662 up event comes in before the menu code can deal with it,
5664 if (! (event
->modifiers
& down_modifier
))
5668 /* Find the menu bar item under `column'. */
5670 items
= FRAME_MENU_BAR_ITEMS (f
);
5671 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5673 Lisp_Object pos
, string
;
5674 string
= AREF (items
, i
+ 1);
5675 pos
= AREF (items
, i
+ 3);
5678 if (column
>= XINT (pos
)
5679 && column
< XINT (pos
) + SCHARS (string
))
5681 item
= AREF (items
, i
);
5686 /* ELisp manual 2.4b says (x y) are window relative but
5687 code says they are frame-relative. */
5689 = Fcons (event
->frame_or_window
,
5691 Fcons (Fcons (event
->x
, event
->y
),
5692 Fcons (make_number (event
->timestamp
),
5695 return Fcons (item
, Fcons (position
, Qnil
));
5697 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5699 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5702 #ifndef USE_TOOLKIT_SCROLL_BARS
5705 /* It's a scrollbar click. */
5707 Lisp_Object portion_whole
;
5710 window
= event
->frame_or_window
;
5711 portion_whole
= Fcons (event
->x
, event
->y
);
5712 part
= *scroll_bar_parts
[(int) event
->part
];
5716 Fcons (Qvertical_scroll_bar
,
5717 Fcons (portion_whole
,
5718 Fcons (make_number (event
->timestamp
),
5719 Fcons (part
, Qnil
)))));
5721 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5723 if (button
>= ASIZE (button_down_location
))
5725 button_down_location
= larger_vector (button_down_location
,
5727 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5730 start_pos_ptr
= &AREF (button_down_location
, button
);
5731 start_pos
= *start_pos_ptr
;
5732 *start_pos_ptr
= Qnil
;
5735 /* On window-system frames, use the value of
5736 double-click-fuzz as is. On other frames, interpret it
5737 as a multiple of 1/8 characters. */
5741 if (WINDOWP (event
->frame_or_window
))
5742 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5743 else if (FRAMEP (event
->frame_or_window
))
5744 f
= XFRAME (event
->frame_or_window
);
5748 if (FRAME_WINDOW_P (f
))
5749 fuzz
= double_click_fuzz
;
5751 fuzz
= double_click_fuzz
/ 8;
5753 is_double
= (button
== last_mouse_button
5754 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5755 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5756 && button_down_time
!= 0
5757 && (EQ (Vdouble_click_time
, Qt
)
5758 || (INTEGERP (Vdouble_click_time
)
5759 && ((int)(event
->timestamp
- button_down_time
)
5760 < XINT (Vdouble_click_time
)))));
5763 last_mouse_button
= button
;
5764 last_mouse_x
= XINT (event
->x
);
5765 last_mouse_y
= XINT (event
->y
);
5767 /* If this is a button press, squirrel away the location, so
5768 we can decide later whether it was a click or a drag. */
5769 if (event
->modifiers
& down_modifier
)
5773 double_click_count
++;
5774 event
->modifiers
|= ((double_click_count
> 2)
5779 double_click_count
= 1;
5780 button_down_time
= event
->timestamp
;
5781 *start_pos_ptr
= Fcopy_alist (position
);
5782 ignore_mouse_drag_p
= 0;
5785 /* Now we're releasing a button - check the co-ordinates to
5786 see if this was a click or a drag. */
5787 else if (event
->modifiers
& up_modifier
)
5789 /* If we did not see a down before this up, ignore the up.
5790 Probably this happened because the down event chose a
5791 menu item. It would be an annoyance to treat the
5792 release of the button that chose the menu item as a
5795 if (!CONSP (start_pos
))
5798 event
->modifiers
&= ~up_modifier
;
5799 #if 0 /* Formerly we treated an up with no down as a click event. */
5800 if (!CONSP (start_pos
))
5801 event
->modifiers
|= click_modifier
;
5806 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5808 /* The third element of every position
5809 should be the (x,y) pair. */
5810 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5812 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5814 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5815 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5818 if (ignore_mouse_drag_p
)
5820 event
->modifiers
|= click_modifier
;
5821 ignore_mouse_drag_p
= 0;
5823 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5824 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5825 /* Maybe the mouse has moved a lot, caused scrolling, and
5826 eventually ended up at the same screen position (but
5827 not buffer position) in which case it is a drag, not
5829 /* FIXME: OTOH if the buffer position has changed
5830 because of a timer or process filter rather than
5831 because of mouse movement, it should be considered as
5832 a click. But mouse-drag-region completely ignores
5833 this case and it hasn't caused any real problem, so
5834 it's probably OK to ignore it as well. */
5835 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5836 /* Mouse hasn't moved (much). */
5837 event
->modifiers
|= click_modifier
;
5840 button_down_time
= 0;
5841 event
->modifiers
|= drag_modifier
;
5844 /* Don't check is_double; treat this as multiple
5845 if the down-event was multiple. */
5846 if (double_click_count
> 1)
5847 event
->modifiers
|= ((double_click_count
> 2)
5853 /* Every mouse event should either have the down_modifier or
5854 the up_modifier set. */
5858 /* Get the symbol we should use for the mouse click. */
5861 head
= modify_event_symbol (button
,
5863 Qmouse_click
, Vlispy_mouse_stem
,
5866 XVECTOR (mouse_syms
)->size
);
5867 if (event
->modifiers
& drag_modifier
)
5872 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5875 Fcons (make_number (double_click_count
),
5885 case HORIZ_WHEEL_EVENT
:
5887 Lisp_Object position
;
5890 /* Build the position as appropriate for this mouse click. */
5891 struct frame
*f
= XFRAME (event
->frame_or_window
);
5893 /* Ignore wheel events that were made on frame that have been
5895 if (! FRAME_LIVE_P (f
))
5898 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5901 /* Set double or triple modifiers to indicate the wheel speed. */
5903 /* On window-system frames, use the value of
5904 double-click-fuzz as is. On other frames, interpret it
5905 as a multiple of 1/8 characters. */
5910 if (WINDOWP (event
->frame_or_window
))
5911 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5912 else if (FRAMEP (event
->frame_or_window
))
5913 f
= XFRAME (event
->frame_or_window
);
5917 if (FRAME_WINDOW_P (f
))
5918 fuzz
= double_click_fuzz
;
5920 fuzz
= double_click_fuzz
/ 8;
5922 is_double
= (last_mouse_button
< 0
5923 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5924 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5925 && button_down_time
!= 0
5926 && (EQ (Vdouble_click_time
, Qt
)
5927 || (INTEGERP (Vdouble_click_time
)
5928 && ((int)(event
->timestamp
- button_down_time
)
5929 < XINT (Vdouble_click_time
)))));
5932 double_click_count
++;
5933 event
->modifiers
|= ((double_click_count
> 2)
5939 double_click_count
= 1;
5940 event
->modifiers
|= click_modifier
;
5943 button_down_time
= event
->timestamp
;
5944 /* Use a negative value to distinguish wheel from mouse button. */
5945 last_mouse_button
= -1;
5946 last_mouse_x
= XINT (event
->x
);
5947 last_mouse_y
= XINT (event
->y
);
5953 if (event
->modifiers
& up_modifier
)
5955 /* Emit a wheel-up event. */
5956 event
->modifiers
&= ~up_modifier
;
5959 else if (event
->modifiers
& down_modifier
)
5961 /* Emit a wheel-down event. */
5962 event
->modifiers
&= ~down_modifier
;
5966 /* Every wheel event should either have the down_modifier or
5967 the up_modifier set. */
5970 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5973 /* Get the symbol we should use for the wheel event. */
5974 head
= modify_event_symbol (symbol_num
,
5980 ASIZE (wheel_syms
));
5983 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5986 Fcons (make_number (double_click_count
),
5995 #ifdef USE_TOOLKIT_SCROLL_BARS
5997 /* We don't have down and up events if using toolkit scroll bars,
5998 so make this always a click event. Store in the `part' of
5999 the Lisp event a symbol which maps to the following actions:
6001 `above_handle' page up
6002 `below_handle' page down
6006 `bottom' bottom of buffer
6007 `handle' thumb has been dragged.
6008 `end-scroll' end of interaction with scroll bar
6010 The incoming input_event contains in its `part' member an
6011 index of type `enum scroll_bar_part' which we can use as an
6012 index in scroll_bar_parts to get the appropriate symbol. */
6014 case SCROLL_BAR_CLICK_EVENT
:
6016 Lisp_Object position
, head
, window
, portion_whole
, part
;
6018 window
= event
->frame_or_window
;
6019 portion_whole
= Fcons (event
->x
, event
->y
);
6020 part
= *scroll_bar_parts
[(int) event
->part
];
6024 Fcons (Qvertical_scroll_bar
,
6025 Fcons (portion_whole
,
6026 Fcons (make_number (event
->timestamp
),
6027 Fcons (part
, Qnil
)))));
6029 /* Always treat scroll bar events as clicks. */
6030 event
->modifiers
|= click_modifier
;
6031 event
->modifiers
&= ~up_modifier
;
6033 if (event
->code
>= ASIZE (mouse_syms
))
6034 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6036 /* Get the symbol we should use for the mouse click. */
6037 head
= modify_event_symbol (event
->code
,
6042 XVECTOR (mouse_syms
)->size
);
6043 return Fcons (head
, Fcons (position
, Qnil
));
6046 #endif /* USE_TOOLKIT_SCROLL_BARS */
6048 case DRAG_N_DROP_EVENT
:
6051 Lisp_Object head
, position
;
6054 f
= XFRAME (event
->frame_or_window
);
6057 /* Ignore mouse events that were made on frames that
6058 have been deleted. */
6059 if (! FRAME_LIVE_P (f
))
6062 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6065 head
= modify_event_symbol (0, event
->modifiers
,
6067 lispy_drag_n_drop_names
,
6068 &drag_n_drop_syms
, 1);
6074 #endif /* HAVE_MOUSE */
6076 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6077 || defined(HAVE_NS) || defined (USE_GTK)
6078 case MENU_BAR_EVENT
:
6079 if (EQ (event
->arg
, event
->frame_or_window
))
6080 /* This is the prefix key. We translate this to
6081 `(menu_bar)' because the code in keyboard.c for menu
6082 events, which we use, relies on this. */
6083 return Fcons (Qmenu_bar
, Qnil
);
6087 case SELECT_WINDOW_EVENT
:
6088 /* Make an event (select-window (WINDOW)). */
6089 return Fcons (Qselect_window
,
6090 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6093 case TOOL_BAR_EVENT
:
6094 if (EQ (event
->arg
, event
->frame_or_window
))
6095 /* This is the prefix key. We translate this to
6096 `(tool_bar)' because the code in keyboard.c for tool bar
6097 events, which we use, relies on this. */
6098 return Fcons (Qtool_bar
, Qnil
);
6099 else if (SYMBOLP (event
->arg
))
6100 return apply_modifiers (event
->modifiers
, event
->arg
);
6103 case USER_SIGNAL_EVENT
:
6104 /* A user signal. */
6106 char *name
= find_user_signal_name (event
->code
);
6109 return intern (name
);
6112 case SAVE_SESSION_EVENT
:
6113 return Qsave_session
;
6118 return Fcons (Qdbus_event
, event
->arg
);
6120 #endif /* HAVE_DBUS */
6123 case GPM_CLICK_EVENT
:
6125 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6126 Lisp_Object head
, position
;
6127 Lisp_Object
*start_pos_ptr
;
6128 Lisp_Object start_pos
;
6129 int button
= event
->code
;
6131 if (button
>= ASIZE (button_down_location
))
6133 button_down_location
= larger_vector (button_down_location
,
6135 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6138 start_pos_ptr
= &AREF (button_down_location
, button
);
6139 start_pos
= *start_pos_ptr
;
6141 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6144 if (event
->modifiers
& down_modifier
)
6145 *start_pos_ptr
= Fcopy_alist (position
);
6146 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6148 if (!CONSP (start_pos
))
6150 event
->modifiers
&= ~up_modifier
;
6153 head
= modify_event_symbol (button
,
6155 Qmouse_click
, Vlispy_mouse_stem
,
6158 XVECTOR (mouse_syms
)->size
);
6160 if (event
->modifiers
& drag_modifier
)
6165 else if (event
->modifiers
& double_modifier
)
6168 Fcons (make_number (2),
6170 else if (event
->modifiers
& triple_modifier
)
6173 Fcons (make_number (3),
6180 #endif /* HAVE_GPM */
6182 /* The 'kind' field of the event is something we don't recognize. */
6188 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6191 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6193 Lisp_Object bar_window
;
6194 enum scroll_bar_part part
;
6198 /* Is it a scroll bar movement? */
6199 if (frame
&& ! NILP (bar_window
))
6201 Lisp_Object part_sym
;
6203 part_sym
= *scroll_bar_parts
[(int) part
];
6204 return Fcons (Qscroll_bar_movement
,
6205 (Fcons (Fcons (bar_window
,
6206 Fcons (Qvertical_scroll_bar
,
6207 Fcons (Fcons (x
, y
),
6208 Fcons (make_number (time
),
6214 /* Or is it an ordinary mouse movement? */
6217 Lisp_Object position
;
6219 position
= make_lispy_position (frame
, &x
, &y
, time
);
6221 return Fcons (Qmouse_movement
,
6227 #endif /* HAVE_MOUSE || HAVE GPM */
6229 /* Construct a switch frame event. */
6231 make_lispy_switch_frame (frame
)
6234 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6237 /* Manipulating modifiers. */
6239 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6241 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6242 SYMBOL's name of the end of the modifiers; the string from this
6243 position is the unmodified symbol name.
6245 This doesn't use any caches. */
6248 parse_modifiers_uncached (symbol
, modifier_end
)
6256 CHECK_SYMBOL (symbol
);
6259 name
= SYMBOL_NAME (symbol
);
6261 for (i
= 0; i
+2 <= SBYTES (name
); )
6263 int this_mod_end
= 0;
6266 /* See if the name continues with a modifier word.
6267 Check that the word appears, but don't check what follows it.
6268 Set this_mod and this_mod_end to record what we find. */
6270 switch (SREF (name
, i
))
6272 #define SINGLE_LETTER_MOD(BIT) \
6273 (this_mod_end = i + 1, this_mod = BIT)
6276 SINGLE_LETTER_MOD (alt_modifier
);
6280 SINGLE_LETTER_MOD (ctrl_modifier
);
6284 SINGLE_LETTER_MOD (hyper_modifier
);
6288 SINGLE_LETTER_MOD (meta_modifier
);
6292 SINGLE_LETTER_MOD (shift_modifier
);
6296 SINGLE_LETTER_MOD (super_modifier
);
6299 #undef SINGLE_LETTER_MOD
6301 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6302 if (i + LEN + 1 <= SBYTES (name) \
6303 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6305 this_mod_end = i + LEN; \
6310 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6311 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6312 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6316 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6318 #undef MULTI_LETTER_MOD
6322 /* If we found no modifier, stop looking for them. */
6323 if (this_mod_end
== 0)
6326 /* Check there is a dash after the modifier, so that it
6327 really is a modifier. */
6328 if (this_mod_end
>= SBYTES (name
)
6329 || SREF (name
, this_mod_end
) != '-')
6332 /* This modifier is real; look for another. */
6333 modifiers
|= this_mod
;
6334 i
= this_mod_end
+ 1;
6337 /* Should we include the `click' modifier? */
6338 if (! (modifiers
& (down_modifier
| drag_modifier
6339 | double_modifier
| triple_modifier
))
6340 && i
+ 7 == SBYTES (name
)
6341 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6342 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6343 modifiers
|= click_modifier
;
6345 if (! (modifiers
& (double_modifier
| triple_modifier
))
6346 && i
+ 6 < SBYTES (name
)
6347 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6348 modifiers
|= click_modifier
;
6356 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6357 prepended to the string BASE[0..BASE_LEN-1].
6358 This doesn't use any caches. */
6360 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6363 int base_len
, base_len_byte
;
6365 /* Since BASE could contain nulls, we can't use intern here; we have
6366 to use Fintern, which expects a genuine Lisp_String, and keeps a
6369 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6375 /* Only the event queue may use the `up' modifier; it should always
6376 be turned into a click or drag event before presented to lisp code. */
6377 if (modifiers
& up_modifier
)
6380 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6381 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6382 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6383 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6384 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6385 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6386 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6387 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6388 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6389 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6390 /* The click modifier is denoted by the absence of other modifiers. */
6394 mod_len
= p
- new_mods
;
6398 Lisp_Object new_name
;
6400 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6401 mod_len
+ base_len_byte
);
6402 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6403 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6405 return Fintern (new_name
, Qnil
);
6410 static char *modifier_names
[] =
6412 "up", "down", "drag", "click", "double", "triple", 0, 0,
6413 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6414 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6416 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6418 static Lisp_Object modifier_symbols
;
6420 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6422 lispy_modifier_list (modifiers
)
6425 Lisp_Object modifier_list
;
6428 modifier_list
= Qnil
;
6429 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6430 if (modifiers
& (1<<i
))
6431 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6434 return modifier_list
;
6438 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6439 where UNMODIFIED is the unmodified form of SYMBOL,
6440 MASK is the set of modifiers present in SYMBOL's name.
6441 This is similar to parse_modifiers_uncached, but uses the cache in
6442 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6443 Qevent_symbol_elements property. */
6445 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6448 parse_modifiers (symbol
)
6451 Lisp_Object elements
;
6453 if (INTEGERP (symbol
))
6454 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6455 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6457 else if (!SYMBOLP (symbol
))
6460 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6461 if (CONSP (elements
))
6466 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6467 Lisp_Object unmodified
;
6470 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6471 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6474 if (modifiers
& ~INTMASK
)
6476 XSETFASTINT (mask
, modifiers
);
6477 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6479 /* Cache the parsing results on SYMBOL. */
6480 Fput (symbol
, Qevent_symbol_element_mask
,
6482 Fput (symbol
, Qevent_symbol_elements
,
6483 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6485 /* Since we know that SYMBOL is modifiers applied to unmodified,
6486 it would be nice to put that in unmodified's cache.
6487 But we can't, since we're not sure that parse_modifiers is
6494 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6495 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6496 doc
: /* Parse the event symbol. For internal use. */)
6500 /* Fill the cache if needed. */
6501 parse_modifiers (symbol
);
6502 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6503 and use the Lispier representation stored on Qevent_symbol_elements
6505 return Fget (symbol
, Qevent_symbol_elements
);
6508 /* Apply the modifiers MODIFIERS to the symbol BASE.
6509 BASE must be unmodified.
6511 This is like apply_modifiers_uncached, but uses BASE's
6512 Qmodifier_cache property, if present. It also builds
6513 Qevent_symbol_elements properties, since it has that info anyway.
6515 apply_modifiers copies the value of BASE's Qevent_kind property to
6516 the modified symbol. */
6518 apply_modifiers (modifiers
, base
)
6522 Lisp_Object cache
, index
, entry
, new_symbol
;
6524 /* Mask out upper bits. We don't know where this value's been. */
6525 modifiers
&= INTMASK
;
6527 if (INTEGERP (base
))
6528 return make_number (XINT (base
) | modifiers
);
6530 /* The click modifier never figures into cache indices. */
6531 cache
= Fget (base
, Qmodifier_cache
);
6532 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6533 entry
= assq_no_quit (index
, cache
);
6536 new_symbol
= XCDR (entry
);
6539 /* We have to create the symbol ourselves. */
6540 new_symbol
= apply_modifiers_uncached (modifiers
,
6541 SDATA (SYMBOL_NAME (base
)),
6542 SCHARS (SYMBOL_NAME (base
)),
6543 SBYTES (SYMBOL_NAME (base
)));
6545 /* Add the new symbol to the base's cache. */
6546 entry
= Fcons (index
, new_symbol
);
6547 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6549 /* We have the parsing info now for free, so we could add it to
6551 XSETFASTINT (index, modifiers);
6552 Fput (new_symbol, Qevent_symbol_element_mask,
6553 Fcons (base, Fcons (index, Qnil)));
6554 Fput (new_symbol, Qevent_symbol_elements,
6555 Fcons (base, lispy_modifier_list (modifiers)));
6556 Sadly, this is only correct if `base' is indeed a base event,
6557 which is not necessarily the case. -stef */
6560 /* Make sure this symbol is of the same kind as BASE.
6562 You'd think we could just set this once and for all when we
6563 intern the symbol above, but reorder_modifiers may call us when
6564 BASE's property isn't set right; we can't assume that just
6565 because it has a Qmodifier_cache property it must have its
6566 Qevent_kind set right as well. */
6567 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6571 kind
= Fget (base
, Qevent_kind
);
6573 Fput (new_symbol
, Qevent_kind
, kind
);
6580 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6581 return a symbol with the modifiers placed in the canonical order.
6582 Canonical order is alphabetical, except for down and drag, which
6583 always come last. The 'click' modifier is never written out.
6585 Fdefine_key calls this to make sure that (for example) C-M-foo
6586 and M-C-foo end up being equivalent in the keymap. */
6589 reorder_modifiers (symbol
)
6592 /* It's hopefully okay to write the code this way, since everything
6593 will soon be in caches, and no consing will be done at all. */
6596 parsed
= parse_modifiers (symbol
);
6597 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6602 /* For handling events, we often want to produce a symbol whose name
6603 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6604 to some base, like the name of a function key or mouse button.
6605 modify_event_symbol produces symbols of this sort.
6607 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6608 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6611 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6612 into symbol names, or a string specifying a name stem used to
6613 construct a symbol name or the form `STEM-N', where N is the decimal
6614 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6615 non-nil; otherwise NAME_TABLE is used.
6617 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6618 persist between calls to modify_event_symbol that it can use to
6619 store a cache of the symbols it's generated for this NAME_TABLE
6620 before. The object stored there may be a vector or an alist.
6622 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6624 MODIFIERS is a set of modifier bits (as given in struct input_events)
6625 whose prefixes should be applied to the symbol name.
6627 SYMBOL_KIND is the value to be placed in the event_kind property of
6628 the returned symbol.
6630 The symbols we create are supposed to have an
6631 `event-symbol-elements' property, which lists the modifiers present
6632 in the symbol's name. */
6635 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6636 name_table
, symbol_table
, table_size
)
6639 Lisp_Object symbol_kind
;
6640 Lisp_Object name_alist_or_stem
;
6642 Lisp_Object
*symbol_table
;
6643 unsigned int table_size
;
6646 Lisp_Object symbol_int
;
6648 /* Get rid of the "vendor-specific" bit here. */
6649 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6651 /* Is this a request for a valid symbol? */
6652 if (symbol_num
< 0 || symbol_num
>= table_size
)
6655 if (CONSP (*symbol_table
))
6656 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6658 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6659 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6660 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6661 we've never used that symbol before. */
6664 if (! VECTORP (*symbol_table
)
6665 || XVECTOR (*symbol_table
)->size
!= table_size
)
6669 XSETFASTINT (size
, table_size
);
6670 *symbol_table
= Fmake_vector (size
, Qnil
);
6673 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6676 /* Have we already used this symbol before? */
6679 /* No; let's create it. */
6680 if (CONSP (name_alist_or_stem
))
6681 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6682 else if (STRINGP (name_alist_or_stem
))
6684 int len
= SBYTES (name_alist_or_stem
);
6685 char *buf
= (char *) alloca (len
+ 50);
6686 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6687 (long) XINT (symbol_int
) + 1);
6688 value
= intern (buf
);
6690 else if (name_table
!= 0 && name_table
[symbol_num
])
6691 value
= intern (name_table
[symbol_num
]);
6693 #ifdef HAVE_WINDOW_SYSTEM
6696 char *name
= x_get_keysym_name (symbol_num
);
6698 value
= intern (name
);
6705 sprintf (buf
, "key-%d", symbol_num
);
6706 value
= intern (buf
);
6709 if (CONSP (*symbol_table
))
6710 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6712 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6714 /* Fill in the cache entries for this symbol; this also
6715 builds the Qevent_symbol_elements property, which the user
6717 apply_modifiers (modifiers
& click_modifier
, value
);
6718 Fput (value
, Qevent_kind
, symbol_kind
);
6721 /* Apply modifiers to that symbol. */
6722 return apply_modifiers (modifiers
, value
);
6725 /* Convert a list that represents an event type,
6726 such as (ctrl meta backspace), into the usual representation of that
6727 event type as a number or a symbol. */
6729 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6730 doc
: /* Convert the event description list EVENT-DESC to an event type.
6731 EVENT-DESC should contain one base event type (a character or symbol)
6732 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6733 drag, down, double or triple). The base must be last.
6734 The return value is an event type (a character or symbol) which
6735 has the same base event type and all the specified modifiers. */)
6737 Lisp_Object event_desc
;
6745 while (CONSP (rest
))
6753 /* Given a symbol, see if it is a modifier name. */
6754 if (SYMBOLP (elt
) && CONSP (rest
))
6755 this = parse_solitary_modifier (elt
);
6759 else if (!NILP (base
))
6760 error ("Two bases given in one event");
6766 /* Let the symbol A refer to the character A. */
6767 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6768 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6770 if (INTEGERP (base
))
6772 /* Turn (shift a) into A. */
6773 if ((modifiers
& shift_modifier
) != 0
6774 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6776 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6777 modifiers
&= ~shift_modifier
;
6780 /* Turn (control a) into C-a. */
6781 if (modifiers
& ctrl_modifier
)
6782 return make_number ((modifiers
& ~ctrl_modifier
)
6783 | make_ctrl_char (XINT (base
)));
6785 return make_number (modifiers
| XINT (base
));
6787 else if (SYMBOLP (base
))
6788 return apply_modifiers (modifiers
, base
);
6791 error ("Invalid base event");
6796 /* Try to recognize SYMBOL as a modifier name.
6797 Return the modifier flag bit, or 0 if not recognized. */
6800 parse_solitary_modifier (Lisp_Object symbol
)
6802 Lisp_Object name
= SYMBOL_NAME (symbol
);
6804 switch (SREF (name
, 0))
6806 #define SINGLE_LETTER_MOD(BIT) \
6807 if (SBYTES (name) == 1) \
6810 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6811 if (LEN == SBYTES (name) \
6812 && ! strncmp (SDATA (name), NAME, LEN)) \
6816 SINGLE_LETTER_MOD (alt_modifier
);
6820 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6824 SINGLE_LETTER_MOD (ctrl_modifier
);
6828 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6829 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6833 SINGLE_LETTER_MOD (hyper_modifier
);
6837 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6841 SINGLE_LETTER_MOD (meta_modifier
);
6845 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6849 SINGLE_LETTER_MOD (shift_modifier
);
6853 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6854 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6855 SINGLE_LETTER_MOD (super_modifier
);
6859 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6860 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6861 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6865 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6868 #undef SINGLE_LETTER_MOD
6869 #undef MULTI_LETTER_MOD
6875 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6876 Such a list is not valid as an event,
6877 but it can be a Lucid-style event type list. */
6880 lucid_event_type_list_p (object
)
6885 if (! CONSP (object
))
6888 if (EQ (XCAR (object
), Qhelp_echo
)
6889 || EQ (XCAR (object
), Qvertical_line
)
6890 || EQ (XCAR (object
), Qmode_line
)
6891 || EQ (XCAR (object
), Qheader_line
))
6894 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6898 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6905 /* Store into *addr a value nonzero if terminal input chars are available.
6906 Serves the purpose of ioctl (0, FIONREAD, addr)
6907 but works even if FIONREAD does not exist.
6908 (In fact, this may actually read some input.)
6910 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6911 timer events that are ripe.
6912 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6913 events (FOCUS_IN_EVENT).
6914 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6915 movements and toolkit scroll bar thumb drags. */
6918 get_input_pending (addr
, flags
)
6922 /* First of all, have we already counted some input? */
6923 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6925 /* If input is being read as it arrives, and we have none, there is none. */
6926 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6929 /* Try to read some input and see how much we get. */
6931 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6934 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6937 gobble_input (expected
)
6941 /* Check whether a D-Bus message has arrived. */
6942 xd_read_queued_messages ();
6943 #endif /* HAVE_DBUS */
6946 if (interrupt_input
)
6949 mask
= sigblock (sigmask (SIGIO
));
6950 read_avail_input (expected
);
6954 #ifdef POLL_FOR_INPUT
6955 /* XXX This condition was (read_socket_hook && !interrupt_input),
6956 but read_socket_hook is not global anymore. Let's pretend that
6958 if (!interrupt_input
&& poll_suppress_count
== 0)
6961 mask
= sigblock (sigmask (SIGALRM
));
6962 read_avail_input (expected
);
6968 read_avail_input (expected
);
6971 /* Put a BUFFER_SWITCH_EVENT in the buffer
6972 so that read_key_sequence will notice the new current buffer. */
6975 record_asynch_buffer_change ()
6977 struct input_event event
;
6981 event
.kind
= BUFFER_SWITCH_EVENT
;
6982 event
.frame_or_window
= Qnil
;
6986 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6987 The purpose of the event is to make read_key_sequence look up the
6988 keymaps again. If we aren't in read_key_sequence, we don't need one,
6989 and the event could cause trouble by messing up (input-pending-p). */
6990 tem
= Fwaiting_for_user_input_p ();
6994 /* We never need these events if we have no asynchronous subprocesses. */
6998 /* Make sure no interrupt happens while storing the event. */
7000 if (interrupt_input
)
7003 mask
= sigblock (sigmask (SIGIO
));
7004 kbd_buffer_store_event (&event
);
7011 kbd_buffer_store_event (&event
);
7016 /* Read any terminal input already buffered up by the system
7017 into the kbd_buffer, but do not wait.
7019 EXPECTED should be nonzero if the caller knows there is some input.
7021 Returns the number of keyboard chars read, or -1 meaning
7022 this is a bad time to try to read input. */
7025 read_avail_input (expected
)
7032 /* Store pending user signal events, if any. */
7033 if (store_user_signal_events ())
7036 /* Loop through the available terminals, and call their input hooks. */
7040 struct terminal
*next
= t
->next_terminal
;
7042 if (t
->read_socket_hook
)
7045 struct input_event hold_quit
;
7047 EVENT_INIT (hold_quit
);
7048 hold_quit
.kind
= NO_EVENT
;
7050 /* No need for FIONREAD or fcntl; just say don't wait. */
7051 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7057 if (nr
== -1) /* Not OK to read input now. */
7061 else if (nr
== -2) /* Non-transient error. */
7063 /* The terminal device terminated; it should be closed. */
7065 /* Kill Emacs if this was our last terminal. */
7066 if (!terminal_list
->next_terminal
)
7067 /* Formerly simply reported no input, but that
7068 sometimes led to a failure of Emacs to terminate.
7069 SIGHUP seems appropriate if we can't reach the
7071 /* ??? Is it really right to send the signal just to
7072 this process rather than to the whole process
7073 group? Perhaps on systems with FIONREAD Emacs is
7074 alone in its group. */
7075 kill (getpid (), SIGHUP
);
7077 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7080 XSETTERMINAL (tmp
, t
);
7081 Fdelete_terminal (tmp
, Qnoelisp
);
7085 if (hold_quit
.kind
!= NO_EVENT
)
7086 kbd_buffer_store_event (&hold_quit
);
7098 /* This is the tty way of reading available input.
7100 Note that each terminal device has its own `struct terminal' object,
7101 and so this function is called once for each individual termcap
7102 terminal. The first parameter indicates which terminal to read from. */
7105 tty_read_avail_input (struct terminal
*terminal
,
7107 struct input_event
*hold_quit
)
7109 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7110 the kbd_buffer can really hold. That may prevent loss
7111 of characters on some systems when input is stuffed at us. */
7112 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7114 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7117 if (!terminal
->name
) /* Don't read from a dead terminal. */
7120 if (terminal
->type
!= output_termcap
7121 && terminal
->type
!= output_msdos_raw
)
7124 /* XXX I think the following code should be moved to separate hook
7125 functions in system-dependent files. */
7128 #else /* not WINDOWSNT */
7129 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7133 return 0; /* The terminal is suspended. */
7136 n_to_read
= dos_keysns ();
7140 cbuf
[0] = dos_keyread ();
7143 #else /* not MSDOS */
7148 struct input_event hold_quit
;
7151 EVENT_INIT (hold_quit
);
7152 hold_quit
.kind
= NO_EVENT
;
7154 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7155 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7158 /* Presumably the GPM daemon has closed the connection. */
7160 if (hold_quit
.kind
!= NO_EVENT
)
7161 kbd_buffer_store_event (&hold_quit
);
7165 #endif /* HAVE_GPM */
7167 /* Determine how many characters we should *try* to read. */
7169 /* Find out how much input is available. */
7170 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7172 if (! noninteractive
)
7173 return -2; /* Close this terminal. */
7179 if (n_to_read
> sizeof cbuf
)
7180 n_to_read
= sizeof cbuf
;
7181 #else /* no FIONREAD */
7182 #if defined (USG) || defined(CYGWIN)
7183 /* Read some input if available, but don't wait. */
7184 n_to_read
= sizeof cbuf
;
7185 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7191 /* Now read; for one reason or another, this will not block.
7192 NREAD is set to the number of chars read. */
7195 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7196 /* POSIX infers that processes which are not in the session leader's
7197 process group won't get SIGHUP's at logout time. BSDI adheres to
7198 this part standard and returns -1 from read (0) with errno==EIO
7199 when the control tty is taken away.
7200 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7201 if (nread
== -1 && errno
== EIO
)
7202 return -2; /* Close this terminal. */
7203 #if defined (AIX) && defined (_BSD)
7204 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7205 This looks incorrect, but it isn't, because _BSD causes
7206 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7207 and that causes a value other than 0 when there is no input. */
7209 return -2; /* Close this terminal. */
7213 /* We used to retry the read if it was interrupted.
7214 But this does the wrong thing when O_NDELAY causes
7215 an EAGAIN error. Does anybody know of a situation
7216 where a retry is actually needed? */
7218 nread
< 0 && (errno
== EAGAIN
7232 #if defined (USG) || defined (CYGWIN)
7233 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7234 #endif /* USG or CYGWIN */
7235 #endif /* no FIONREAD */
7240 #endif /* not MSDOS */
7241 #endif /* not WINDOWSNT */
7243 for (i
= 0; i
< nread
; i
++)
7245 struct input_event buf
;
7247 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7249 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7250 buf
.modifiers
= meta_modifier
;
7251 if (tty
->meta_key
!= 2)
7255 /* Set the frame corresponding to the active tty. Note that the
7256 value of selected_frame is not reliable here, redisplay tends
7257 to temporarily change it. */
7258 buf
.frame_or_window
= tty
->top_frame
;
7261 kbd_buffer_store_event (&buf
);
7262 /* Don't look at input that follows a C-g too closely.
7263 This reduces lossage due to autorepeat on C-g. */
7264 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7265 && buf
.code
== quit_char
)
7273 handle_async_input ()
7275 interrupt_input_pending
= 0;
7277 pending_signals
= pending_atimers
;
7283 nread
= read_avail_input (1);
7284 /* -1 means it's not ok to read the input now.
7285 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7286 0 means there was no keyboard input available. */
7293 process_pending_signals ()
7295 if (interrupt_input_pending
)
7296 handle_async_input ();
7297 do_pending_atimers ();
7300 #ifdef SIGIO /* for entire page */
7301 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7304 input_available_signal (signo
)
7307 /* Must preserve main program's value of errno. */
7308 int old_errno
= errno
;
7309 #if defined (USG) && !defined (POSIX_SIGNALS)
7310 /* USG systems forget handlers when they are used;
7311 must reestablish each time */
7312 signal (signo
, input_available_signal
);
7316 interrupt_input_pending
= 1;
7317 pending_signals
= 1;
7319 SIGNAL_THREAD_CHECK (signo
);
7322 if (input_available_clear_time
)
7323 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7326 handle_async_input ();
7333 /* Send ourselves a SIGIO.
7335 This function exists so that the UNBLOCK_INPUT macro in
7336 blockinput.h can have some way to take care of input we put off
7337 dealing with, without assuming that every file which uses
7338 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7340 reinvoke_input_signal ()
7343 handle_async_input ();
7349 /* User signal events. */
7351 struct user_signal_info
7353 /* Signal number. */
7356 /* Name of the signal. */
7359 /* Number of pending signals. */
7362 struct user_signal_info
*next
;
7365 /* List of user signals. */
7366 static struct user_signal_info
*user_signals
= NULL
;
7369 add_user_signal (sig
, name
)
7373 struct user_signal_info
*p
;
7375 for (p
= user_signals
; p
; p
= p
->next
)
7377 /* Already added. */
7380 p
= xmalloc (sizeof (struct user_signal_info
));
7382 p
->name
= xstrdup (name
);
7384 p
->next
= user_signals
;
7387 signal (sig
, handle_user_signal
);
7391 handle_user_signal (sig
)
7394 int old_errno
= errno
;
7395 struct user_signal_info
*p
;
7397 #if defined (USG) && !defined (POSIX_SIGNALS)
7398 /* USG systems forget handlers when they are used;
7399 must reestablish each time */
7400 signal (sig
, handle_user_signal
);
7403 SIGNAL_THREAD_CHECK (sig
);
7405 for (p
= user_signals
; p
; p
= p
->next
)
7410 if (interrupt_input
)
7411 kill (getpid (), SIGIO
);
7415 /* Tell wait_reading_process_output that it needs to wake
7416 up and look around. */
7417 if (input_available_clear_time
)
7418 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7427 find_user_signal_name (sig
)
7430 struct user_signal_info
*p
;
7432 for (p
= user_signals
; p
; p
= p
->next
)
7440 store_user_signal_events ()
7442 struct user_signal_info
*p
;
7443 struct input_event buf
;
7446 for (p
= user_signals
; p
; p
= p
->next
)
7447 if (p
->npending
> 0)
7453 bzero (&buf
, sizeof buf
);
7454 buf
.kind
= USER_SIGNAL_EVENT
;
7455 buf
.frame_or_window
= selected_frame
;
7457 nstored
+= p
->npending
;
7459 mask
= sigblock (sigmask (p
->sig
));
7463 kbd_buffer_store_event (&buf
);
7466 while (p
->npending
> 0);
7474 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7475 static Lisp_Object menu_bar_one_keymap_changed_items
;
7477 /* These variables hold the vector under construction within
7478 menu_bar_items and its subroutines, and the current index
7479 for storing into that vector. */
7480 static Lisp_Object menu_bar_items_vector
;
7481 static int menu_bar_items_index
;
7483 /* Return a vector of menu items for a menu bar, appropriate
7484 to the current buffer. Each item has three elements in the vector:
7487 OLD is an old vector we can optionally reuse, or nil. */
7490 menu_bar_items (old
)
7493 /* The number of keymaps we're scanning right now, and the number of
7494 keymaps we have allocated space for. */
7497 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7498 in the current keymaps, or nil where it is not a prefix. */
7501 Lisp_Object def
, tail
;
7510 /* In order to build the menus, we need to call the keymap
7511 accessors. They all call QUIT. But this function is called
7512 during redisplay, during which a quit is fatal. So inhibit
7513 quitting while building the menus.
7514 We do this instead of specbind because (1) errors will clear it anyway
7515 and (2) this avoids risk of specpdl overflow. */
7516 oquit
= Vinhibit_quit
;
7520 menu_bar_items_vector
= old
;
7522 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7523 menu_bar_items_index
= 0;
7525 /* Build our list of keymaps.
7526 If we recognize a function key and replace its escape sequence in
7527 keybuf with its symbol, or if the sequence starts with a mouse
7528 click and we need to switch buffers, we jump back here to rebuild
7529 the initial keymaps from the current buffer. */
7533 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7534 if (!NILP (Voverriding_local_map_menu_flag
))
7536 /* Yes, use them (if non-nil) as well as the global map. */
7537 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7539 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7540 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7541 if (!NILP (Voverriding_local_map
))
7542 maps
[nmaps
++] = Voverriding_local_map
;
7546 /* No, so use major and minor mode keymaps and keymap property.
7547 Note that menu-bar bindings in the local-map and keymap
7548 properties may not work reliable, as they are only
7549 recognized when the menu-bar (or mode-line) is updated,
7550 which does not normally happen after every command. */
7553 nminor
= current_minor_maps (NULL
, &tmaps
);
7554 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7556 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7557 maps
[nmaps
++] = tem
;
7558 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7560 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7562 maps
[nmaps
++] = current_global_map
;
7565 /* Look up in each map the dummy prefix key `menu-bar'. */
7569 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7570 if (!NILP (maps
[mapno
]))
7572 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7576 menu_bar_one_keymap_changed_items
= Qnil
;
7577 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7581 /* Move to the end those items that should be at the end. */
7583 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7586 int end
= menu_bar_items_index
;
7588 for (i
= 0; i
< end
; i
+= 4)
7589 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7591 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7592 /* Move the item at index I to the end,
7593 shifting all the others forward. */
7594 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7595 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7596 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7597 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7599 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7600 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7601 (end
- i
- 4) * sizeof (Lisp_Object
));
7602 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7603 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7604 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7605 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7610 /* Add nil, nil, nil, nil at the end. */
7611 i
= menu_bar_items_index
;
7612 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7613 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7614 /* Add this item. */
7615 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7616 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7617 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7618 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7619 menu_bar_items_index
= i
;
7621 Vinhibit_quit
= oquit
;
7622 return menu_bar_items_vector
;
7625 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7626 If there's already an item for KEY, add this DEF to it. */
7628 Lisp_Object item_properties
;
7631 menu_bar_item (key
, item
, dummy1
, dummy2
)
7632 Lisp_Object key
, item
, dummy1
;
7635 struct gcpro gcpro1
;
7639 if (EQ (item
, Qundefined
))
7641 /* If a map has an explicit `undefined' as definition,
7642 discard any previously made menu bar item. */
7644 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7645 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7647 if (menu_bar_items_index
> i
+ 4)
7648 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7649 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7650 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7651 menu_bar_items_index
-= 4;
7655 /* If this keymap has already contributed to this KEY,
7656 don't contribute to it a second time. */
7657 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7658 if (!NILP (tem
) || NILP (item
))
7661 menu_bar_one_keymap_changed_items
7662 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7664 /* We add to menu_bar_one_keymap_changed_items before doing the
7665 parse_menu_item, so that if it turns out it wasn't a menu item,
7666 it still correctly hides any further menu item. */
7668 i
= parse_menu_item (item
, 0, 1);
7673 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7675 /* Find any existing item for this KEY. */
7676 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7677 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7680 /* If we did not find this KEY, add it at the end. */
7681 if (i
== menu_bar_items_index
)
7683 /* If vector is too small, get a bigger one. */
7684 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7685 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7686 /* Add this item. */
7687 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7688 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7689 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7690 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7691 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7692 menu_bar_items_index
= i
;
7694 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7698 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7699 /* If the new and the old items are not both keymaps,
7700 the lookup will only find `item'. */
7701 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7702 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7706 /* This is used as the handler when calling menu_item_eval_property. */
7708 menu_item_eval_property_1 (arg
)
7711 /* If we got a quit from within the menu computation,
7712 quit all the way out of it. This takes care of C-] in the debugger. */
7713 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7714 Fsignal (Qquit
, Qnil
);
7719 /* Evaluate an expression and return the result (or nil if something
7720 went wrong). Used to evaluate dynamic parts of menu items. */
7722 menu_item_eval_property (sexpr
)
7725 int count
= SPECPDL_INDEX ();
7727 specbind (Qinhibit_redisplay
, Qt
);
7728 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7729 menu_item_eval_property_1
);
7730 return unbind_to (count
, val
);
7733 /* This function parses a menu item and leaves the result in the
7734 vector item_properties.
7735 ITEM is a key binding, a possible menu item.
7736 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7737 evaluate dynamic expressions in the menu item.
7738 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7740 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7741 parse_menu_item returns true if the item is a menu item and false
7745 parse_menu_item (item
, notreal
, inmenubar
)
7747 int notreal
, inmenubar
;
7749 Lisp_Object def
, tem
, item_string
, start
;
7750 Lisp_Object cachelist
;
7752 Lisp_Object keyhint
;
7763 /* Create item_properties vector if necessary. */
7764 if (NILP (item_properties
))
7766 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7768 /* Initialize optional entries. */
7769 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7770 ASET (item_properties
, i
, Qnil
);
7771 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7773 /* Save the item here to protect it from GC. */
7774 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7776 item_string
= XCAR (item
);
7780 if (STRINGP (item_string
))
7782 /* Old format menu item. */
7783 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7785 /* Maybe help string. */
7786 if (CONSP (item
) && STRINGP (XCAR (item
)))
7788 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7793 /* Maybe key binding cache. */
7794 if (CONSP (item
) && CONSP (XCAR (item
))
7795 && (NILP (XCAR (XCAR (item
)))
7796 || VECTORP (XCAR (XCAR (item
)))))
7798 cachelist
= XCAR (item
);
7802 /* This is the real definition--the function to run. */
7803 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7805 /* Get enable property, if any. */
7808 tem
= Fget (item
, Qmenu_enable
);
7809 if (!NILP (Venable_disabled_menus_and_buttons
))
7810 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7811 else if (!NILP (tem
))
7812 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7815 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7817 /* New format menu item. */
7818 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7819 start
= XCDR (item
);
7822 /* We have a real binding. */
7823 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7825 item
= XCDR (start
);
7826 /* Is there a cache list with key equivalences. */
7827 if (CONSP (item
) && CONSP (XCAR (item
)))
7829 cachelist
= XCAR (item
);
7833 /* Parse properties. */
7834 while (CONSP (item
) && CONSP (XCDR (item
)))
7839 if (EQ (tem
, QCenable
))
7841 if (!NILP (Venable_disabled_menus_and_buttons
))
7842 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7844 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7846 else if (EQ (tem
, QCvisible
) && !notreal
)
7848 /* If got a visible property and that evaluates to nil
7849 then ignore this item. */
7850 tem
= menu_item_eval_property (XCAR (item
));
7854 else if (EQ (tem
, QChelp
))
7855 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7856 else if (EQ (tem
, QCfilter
))
7858 else if (EQ (tem
, QCkey_sequence
))
7861 if (NILP (cachelist
)
7862 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7863 /* Be GC protected. Set keyhint to item instead of tem. */
7866 else if (EQ (tem
, QCkeys
))
7869 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7870 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7872 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7877 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7879 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7881 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7887 else if (inmenubar
|| !NILP (start
))
7891 return 0; /* not a menu item */
7893 /* If item string is not a string, evaluate it to get string.
7894 If we don't get a string, skip this item. */
7895 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7896 if (!(STRINGP (item_string
) || notreal
))
7898 item_string
= menu_item_eval_property (item_string
);
7899 if (!STRINGP (item_string
))
7901 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7904 /* If got a filter apply it on definition. */
7905 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7908 def
= menu_item_eval_property (list2 (XCAR (filter
),
7909 list2 (Qquote
, def
)));
7911 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7914 /* Enable or disable selection of item. */
7915 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7921 tem
= menu_item_eval_property (tem
);
7922 if (inmenubar
&& NILP (tem
))
7923 return 0; /* Ignore disabled items in menu bar. */
7924 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7927 /* If we got no definition, this item is just unselectable text which
7928 is OK in a submenu but not in the menubar. */
7930 return (inmenubar
? 0 : 1);
7932 /* See if this is a separate pane or a submenu. */
7933 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7934 tem
= get_keymap (def
, 0, 1);
7935 /* For a subkeymap, just record its details and exit. */
7938 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7939 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7943 /* At the top level in the menu bar, do likewise for commands also.
7944 The menu bar does not display equivalent key bindings anyway.
7945 ITEM_PROPERTY_DEF is already set up properly. */
7949 /* This is a command. See if there is an equivalent key binding. */
7950 if (NILP (cachelist
))
7952 /* We have to create a cachelist. */
7953 /* With the introduction of where_is_cache, the computation
7954 of equivalent key bindings is sufficiently fast that we
7955 do not need to cache it here any more. */
7956 /* CHECK_IMPURE (start);
7957 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
7958 cachelist = XCAR (XCDR (start)); */
7959 cachelist
= Fcons (Qnil
, Qnil
);
7961 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7962 if (!NILP (keyhint
))
7964 XSETCAR (cachelist
, XCAR (keyhint
));
7967 else if (STRINGP (tem
))
7969 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7970 XSETCAR (cachelist
, Qt
);
7974 tem
= XCAR (cachelist
);
7981 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
7983 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7986 def
= XCAR (prefix
);
7987 prefix
= XCDR (prefix
);
7990 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7992 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7994 if (newcache
/* Always check first time. */
7995 /* Should we check everything when precomputing key
7997 /* If something had no key binding before, don't recheck it
7998 because that is too slow--except if we have a list of
7999 rebound commands in Vdefine_key_rebound_commands, do
8000 recheck any command that appears in that list. */
8001 || (CONSP (Vdefine_key_rebound_commands
)
8002 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8005 /* We had a saved key. Is it still bound to the command? */
8008 /* If the command is an alias for another
8009 (such as lmenu.el set it up), check if the
8010 original command matches the cached command. */
8011 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8012 chkcache
= 1; /* Need to recompute key binding. */
8016 /* Recompute equivalent key binding. If the command is an alias
8017 for another (such as lmenu.el set it up), see if the original
8018 command name has equivalent keys. Otherwise look up the
8019 specified command itself. We don't try both, because that
8020 makes lmenu menus slow. */
8022 && SYMBOLP (XSYMBOL (def
)->function
)
8023 && ! NILP (Fget (def
, Qmenu_alias
)))
8024 def
= XSYMBOL (def
)->function
;
8025 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8026 XSETCAR (cachelist
, tem
);
8029 XSETCDR (cachelist
, Qnil
);
8033 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8035 tem
= XCAR (cachelist
);
8039 newcache
= chkcache
;
8042 tem
= Fkey_description (tem
, Qnil
);
8045 if (STRINGP (XCAR (prefix
)))
8046 tem
= concat2 (XCAR (prefix
), tem
);
8047 if (STRINGP (XCDR (prefix
)))
8048 tem
= concat2 (tem
, XCDR (prefix
));
8050 XSETCDR (cachelist
, tem
);
8054 tem
= XCDR (cachelist
);
8055 if (newcache
&& !NILP (tem
))
8057 tem
= concat2 (build_string (" "), tem
);
8058 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8059 XSETCDR (cachelist
, tem
);
8062 /* If we only want to precompute equivalent key bindings, stop here. */
8066 /* If we have an equivalent key binding, use that. */
8067 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8069 /* Include this when menu help is implemented.
8070 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8071 if (!(NILP (tem) || STRINGP (tem)))
8073 tem = menu_item_eval_property (tem);
8076 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8080 /* Handle radio buttons or toggle boxes. */
8081 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8083 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8084 menu_item_eval_property (tem
));
8091 /***********************************************************************
8093 ***********************************************************************/
8095 /* A vector holding tool bar items while they are parsed in function
8096 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8099 static Lisp_Object tool_bar_items_vector
;
8101 /* A vector holding the result of parse_tool_bar_item. Layout is like
8102 the one for a single item in tool_bar_items_vector. */
8104 static Lisp_Object tool_bar_item_properties
;
8106 /* Next free index in tool_bar_items_vector. */
8108 static int ntool_bar_items
;
8110 /* The symbols `tool-bar', `:image' and `:rtl'. */
8112 extern Lisp_Object Qtool_bar
;
8113 Lisp_Object QCimage
;
8116 /* Function prototypes. */
8118 static void init_tool_bar_items
P_ ((Lisp_Object
));
8119 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8120 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8121 static void append_tool_bar_item
P_ ((void));
8124 /* Return a vector of tool bar items for keymaps currently in effect.
8125 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8126 tool bar items found. */
8129 tool_bar_items (reuse
, nitems
)
8140 /* In order to build the menus, we need to call the keymap
8141 accessors. They all call QUIT. But this function is called
8142 during redisplay, during which a quit is fatal. So inhibit
8143 quitting while building the menus. We do this instead of
8144 specbind because (1) errors will clear it anyway and (2) this
8145 avoids risk of specpdl overflow. */
8146 oquit
= Vinhibit_quit
;
8149 /* Initialize tool_bar_items_vector and protect it from GC. */
8150 init_tool_bar_items (reuse
);
8152 /* Build list of keymaps in maps. Set nmaps to the number of maps
8155 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8156 if (!NILP (Voverriding_local_map_menu_flag
))
8158 /* Yes, use them (if non-nil) as well as the global map. */
8159 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8161 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8162 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8163 if (!NILP (Voverriding_local_map
))
8164 maps
[nmaps
++] = Voverriding_local_map
;
8168 /* No, so use major and minor mode keymaps and keymap property.
8169 Note that tool-bar bindings in the local-map and keymap
8170 properties may not work reliable, as they are only
8171 recognized when the tool-bar (or mode-line) is updated,
8172 which does not normally happen after every command. */
8175 nminor
= current_minor_maps (NULL
, &tmaps
);
8176 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8178 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8179 maps
[nmaps
++] = tem
;
8180 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8182 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8185 /* Add global keymap at the end. */
8186 maps
[nmaps
++] = current_global_map
;
8188 /* Process maps in reverse order and look up in each map the prefix
8190 for (i
= nmaps
- 1; i
>= 0; --i
)
8191 if (!NILP (maps
[i
]))
8195 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8197 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8200 Vinhibit_quit
= oquit
;
8201 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8202 return tool_bar_items_vector
;
8206 /* Process the definition of KEY which is DEF. */
8209 process_tool_bar_item (key
, def
, data
, args
)
8210 Lisp_Object key
, def
, data
;
8214 extern Lisp_Object Qundefined
;
8215 struct gcpro gcpro1
, gcpro2
;
8217 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8221 if (EQ (def
, Qundefined
))
8223 /* If a map has an explicit `undefined' as definition,
8224 discard any previously made item. */
8225 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8227 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8229 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8231 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8232 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8233 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8234 * sizeof (Lisp_Object
)));
8235 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8240 else if (parse_tool_bar_item (key
, def
))
8241 /* Append a new tool bar item to tool_bar_items_vector. Accept
8242 more than one definition for the same key. */
8243 append_tool_bar_item ();
8249 /* Parse a tool bar item specification ITEM for key KEY and return the
8250 result in tool_bar_item_properties. Value is zero if ITEM is
8253 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8255 CAPTION is the caption of the item, If it's not a string, it is
8256 evaluated to get a string.
8258 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8259 as binding are currently ignored.
8261 The following properties are recognized:
8265 FORM is evaluated and specifies whether the tool bar item is
8266 enabled or disabled.
8270 FORM is evaluated and specifies whether the tool bar item is visible.
8272 - `:filter FUNCTION'
8274 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8275 result is stored as the new binding.
8277 - `:button (TYPE SELECTED)'
8279 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8280 and specifies whether the button is selected (pressed) or not.
8284 IMAGES is either a single image specification or a vector of four
8285 image specifications. See enum tool_bar_item_images.
8287 - `:help HELP-STRING'.
8289 Gives a help string to display for the tool bar item. */
8292 parse_tool_bar_item (key
, item
)
8293 Lisp_Object key
, item
;
8295 /* Access slot with index IDX of vector tool_bar_item_properties. */
8296 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8298 Lisp_Object filter
= Qnil
;
8299 Lisp_Object caption
;
8302 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8303 Rule out items that aren't lists, don't start with
8304 `menu-item' or whose rest following `tool-bar-item' is not a
8307 || !EQ (XCAR (item
), Qmenu_item
)
8308 || (item
= XCDR (item
),
8312 /* Create tool_bar_item_properties vector if necessary. Reset it to
8314 if (VECTORP (tool_bar_item_properties
))
8316 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8320 tool_bar_item_properties
8321 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8324 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8325 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8327 /* Get the caption of the item. If the caption is not a string,
8328 evaluate it to get a string. If we don't get a string, skip this
8330 caption
= XCAR (item
);
8331 if (!STRINGP (caption
))
8333 caption
= menu_item_eval_property (caption
);
8334 if (!STRINGP (caption
))
8337 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8339 /* Give up if rest following the caption is not a list. */
8344 /* Store the binding. */
8345 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8348 /* Ignore cached key binding, if any. */
8349 if (CONSP (item
) && CONSP (XCAR (item
)))
8352 /* Process the rest of the properties. */
8353 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8355 Lisp_Object key
, value
;
8358 value
= XCAR (XCDR (item
));
8360 if (EQ (key
, QCenable
))
8362 /* `:enable FORM'. */
8363 if (!NILP (Venable_disabled_menus_and_buttons
))
8364 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8366 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8368 else if (EQ (key
, QCvisible
))
8370 /* `:visible FORM'. If got a visible property and that
8371 evaluates to nil then ignore this item. */
8372 if (NILP (menu_item_eval_property (value
)))
8375 else if (EQ (key
, QChelp
))
8376 /* `:help HELP-STRING'. */
8377 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8378 else if (EQ (key
, QCfilter
))
8379 /* ':filter FORM'. */
8381 else if (EQ (key
, QCbutton
) && CONSP (value
))
8383 /* `:button (TYPE . SELECTED)'. */
8384 Lisp_Object type
, selected
;
8386 type
= XCAR (value
);
8387 selected
= XCDR (value
);
8388 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8390 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8391 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8394 else if (EQ (key
, QCimage
)
8396 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8397 /* Value is either a single image specification or a vector
8398 of 4 such specifications for the different button states. */
8399 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8400 else if (EQ (key
, Qrtl
))
8402 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8405 /* If got a filter apply it on binding. */
8407 PROP (TOOL_BAR_ITEM_BINDING
)
8408 = menu_item_eval_property (list2 (filter
,
8410 PROP (TOOL_BAR_ITEM_BINDING
))));
8412 /* See if the binding is a keymap. Give up if it is. */
8413 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8416 /* Enable or disable selection of item. */
8417 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8418 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8419 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8421 /* Handle radio buttons or toggle boxes. */
8422 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8423 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8424 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8432 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8433 that can be reused. */
8436 init_tool_bar_items (reuse
)
8439 if (VECTORP (reuse
))
8440 tool_bar_items_vector
= reuse
;
8442 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8443 ntool_bar_items
= 0;
8447 /* Append parsed tool bar item properties from
8448 tool_bar_item_properties */
8451 append_tool_bar_item ()
8453 Lisp_Object
*to
, *from
;
8455 /* Enlarge tool_bar_items_vector if necessary. */
8456 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8457 >= XVECTOR (tool_bar_items_vector
)->size
)
8458 tool_bar_items_vector
8459 = larger_vector (tool_bar_items_vector
,
8460 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8462 /* Append entries from tool_bar_item_properties to the end of
8463 tool_bar_items_vector. */
8464 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8465 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8466 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8467 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8474 /* Read a character using menus based on maps in the array MAPS.
8475 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8476 Return t if we displayed a menu but the user rejected it.
8478 PREV_EVENT is the previous input event, or nil if we are reading
8479 the first event of a key sequence.
8481 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8482 if we used a mouse menu to read the input, or zero otherwise. If
8483 USED_MOUSE_MENU is null, we don't dereference it.
8485 The prompting is done based on the prompt-string of the map
8486 and the strings associated with various map elements.
8488 This can be done with X menus or with menus put in the minibuf.
8489 These are done in different ways, depending on how the input will be read.
8490 Menus using X are done after auto-saving in read-char, getting the input
8491 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8492 and do auto-saving in the inner call of read_char. */
8495 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8498 Lisp_Object prev_event
;
8499 int *used_mouse_menu
;
8502 register Lisp_Object name
= Qnil
;
8504 if (used_mouse_menu
)
8505 *used_mouse_menu
= 0;
8507 /* Use local over global Menu maps */
8509 if (! menu_prompting
)
8512 /* Optionally disregard all but the global map. */
8513 if (inhibit_local_menu_bar_menus
)
8515 maps
+= (nmaps
- 1);
8519 /* Get the menu name from the first map that has one (a prompt string). */
8520 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8522 name
= Fkeymap_prompt (maps
[mapno
]);
8527 /* If we don't have any menus, just read a character normally. */
8528 if (!STRINGP (name
))
8532 /* If we got to this point via a mouse click,
8533 use a real menu for mouse selection. */
8534 if (EVENT_HAS_PARAMETERS (prev_event
)
8535 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8536 && !EQ (XCAR (prev_event
), Qtool_bar
))
8538 /* Display the menu and get the selection. */
8539 Lisp_Object
*realmaps
8540 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8544 /* Use the maps that are not nil. */
8545 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8546 if (!NILP (maps
[mapno
]))
8547 realmaps
[nmaps1
++] = maps
[mapno
];
8549 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8554 record_menu_key (XCAR (value
));
8556 /* If we got multiple events, unread all but
8558 There is no way to prevent those unread events
8559 from showing up later in last_nonmenu_event.
8560 So turn symbol and integer events into lists,
8561 to indicate that they came from a mouse menu,
8562 so that when present in last_nonmenu_event
8563 they won't confuse things. */
8564 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8566 record_menu_key (XCAR (tem
));
8567 if (SYMBOLP (XCAR (tem
))
8568 || INTEGERP (XCAR (tem
)))
8569 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8572 /* If we got more than one event, put all but the first
8573 onto this list to be read later.
8574 Return just the first event now. */
8575 Vunread_command_events
8576 = nconc2 (XCDR (value
), Vunread_command_events
);
8577 value
= XCAR (value
);
8579 else if (NILP (value
))
8581 if (used_mouse_menu
)
8582 *used_mouse_menu
= 1;
8585 #endif /* HAVE_MENUS */
8589 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8590 We make this bigger when necessary, and never free it. */
8591 static char *read_char_minibuf_menu_text
;
8592 /* Size of that buffer. */
8593 static int read_char_minibuf_menu_width
;
8596 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8602 register Lisp_Object name
;
8604 /* FIXME: Use the minibuffer's frame width. */
8605 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8608 Lisp_Object rest
, vector
;
8614 if (! menu_prompting
)
8617 /* Get the menu name from the first map that has one (a prompt string). */
8618 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8620 name
= Fkeymap_prompt (maps
[mapno
]);
8625 /* If we don't have any menus, just read a character normally. */
8626 if (!STRINGP (name
))
8629 /* Make sure we have a big enough buffer for the menu text. */
8630 width
= max (width
, SBYTES (name
));
8631 if (read_char_minibuf_menu_text
== 0)
8633 read_char_minibuf_menu_width
= width
+ 4;
8634 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8636 else if (width
+ 4 > read_char_minibuf_menu_width
)
8638 read_char_minibuf_menu_width
= width
+ 4;
8639 read_char_minibuf_menu_text
8640 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8642 menu
= read_char_minibuf_menu_text
;
8644 /* Prompt string always starts with map's prompt, and a space. */
8645 strcpy (menu
, SDATA (name
));
8646 nlength
= SBYTES (name
);
8647 menu
[nlength
++] = ':';
8648 menu
[nlength
++] = ' ';
8651 /* Start prompting at start of first map. */
8655 /* Present the documented bindings, a line at a time. */
8662 Lisp_Object orig_defn_macro
;
8664 /* Loop over elements of map. */
8669 /* If reached end of map, start at beginning of next map. */
8673 /* At end of last map, wrap around to first map if just starting,
8674 or end this line if already have something on it. */
8678 if (notfirst
|| nobindings
) break;
8683 /* Look at the next element of the map. */
8685 elt
= XVECTOR (vector
)->contents
[idx
];
8687 elt
= Fcar_safe (rest
);
8689 if (idx
< 0 && VECTORP (elt
))
8691 /* If we found a dense table in the keymap,
8692 advanced past it, but start scanning its contents. */
8693 rest
= Fcdr_safe (rest
);
8699 /* An ordinary element. */
8700 Lisp_Object event
, tem
;
8704 event
= Fcar_safe (elt
); /* alist */
8705 elt
= Fcdr_safe (elt
);
8709 XSETINT (event
, idx
); /* vector */
8712 /* Ignore the element if it has no prompt string. */
8713 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8715 /* 1 if the char to type matches the string. */
8717 Lisp_Object upcased_event
, downcased_event
;
8718 Lisp_Object desc
= Qnil
;
8720 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8722 upcased_event
= Fupcase (event
);
8723 downcased_event
= Fdowncase (event
);
8724 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8725 || XINT (downcased_event
) == SREF (s
, 0));
8727 desc
= Fsingle_key_description (event
, Qnil
);
8729 #if 0 /* It is redundant to list the equivalent key bindings because
8730 the prefix is what the user has already typed. */
8732 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8734 /* Insert equivalent keybinding. */
8735 s
= concat2 (s
, tem
);
8738 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8739 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8741 /* Insert button prefix. */
8742 Lisp_Object selected
8743 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8744 if (EQ (tem
, QCradio
))
8745 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8747 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8748 s
= concat2 (tem
, s
);
8752 /* If we have room for the prompt string, add it to this line.
8753 If this is the first on the line, always add it. */
8754 if ((SCHARS (s
) + i
+ 2
8755 + (char_matches
? 0 : SCHARS (desc
) + 3))
8761 /* Punctuate between strings. */
8764 strcpy (menu
+ i
, ", ");
8770 /* If the char to type doesn't match the string's
8771 first char, explicitly show what char to type. */
8774 /* Add as much of string as fits. */
8775 thiswidth
= SCHARS (desc
);
8776 if (thiswidth
+ i
> width
)
8777 thiswidth
= width
- i
;
8778 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8780 strcpy (menu
+ i
, " = ");
8784 /* Add as much of string as fits. */
8785 thiswidth
= SCHARS (s
);
8786 if (thiswidth
+ i
> width
)
8787 thiswidth
= width
- i
;
8788 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8794 /* If this element does not fit, end the line now,
8795 and save the element for the next line. */
8796 strcpy (menu
+ i
, "...");
8801 /* Move past this element. */
8802 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8803 /* Handle reaching end of dense table. */
8808 rest
= Fcdr_safe (rest
);
8812 /* Prompt with that and read response. */
8813 message2_nolog (menu
, strlen (menu
),
8814 ! NILP (current_buffer
->enable_multibyte_characters
));
8816 /* Make believe its not a keyboard macro in case the help char
8817 is pressed. Help characters are not recorded because menu prompting
8818 is not used on replay.
8820 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8821 current_kboard
->defining_kbd_macro
= Qnil
;
8823 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8824 while (BUFFERP (obj
));
8825 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8827 if (!INTEGERP (obj
))
8829 else if (XINT (obj
) == -2)
8834 if (! EQ (obj
, menu_prompt_more_char
)
8835 && (!INTEGERP (menu_prompt_more_char
)
8836 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8838 if (!NILP (current_kboard
->defining_kbd_macro
))
8839 store_kbd_macro_char (obj
);
8842 /* Help char - go round again */
8846 /* Reading key sequences. */
8848 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8849 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8850 keymap, or nil otherwise. Return the index of the first keymap in
8851 which KEY has any binding, or NMAPS if no map has a binding.
8853 If KEY is a meta ASCII character, treat it like meta-prefix-char
8854 followed by the corresponding non-meta character. Keymaps in
8855 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8858 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8861 NEXT may be the same array as CURRENT. */
8864 follow_key (key
, nmaps
, current
, defs
, next
)
8866 Lisp_Object
*current
, *defs
, *next
;
8869 int i
, first_binding
;
8871 first_binding
= nmaps
;
8872 for (i
= nmaps
- 1; i
>= 0; i
--)
8874 if (! NILP (current
[i
]))
8876 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8877 if (! NILP (defs
[i
]))
8884 /* Given the set of bindings we've found, produce the next set of maps. */
8885 if (first_binding
< nmaps
)
8886 for (i
= 0; i
< nmaps
; i
++)
8887 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8889 return first_binding
;
8892 /* Structure used to keep track of partial application of key remapping
8893 such as Vfunction_key_map and Vkey_translation_map. */
8894 typedef struct keyremap
8896 /* This is the map originally specified for this use. */
8898 /* This is a submap reached by looking up, in PARENT,
8899 the events from START to END. */
8901 /* Positions [START, END) in the key sequence buffer
8902 are the key that we have scanned so far.
8903 Those events are the ones that we will replace
8904 if PAREHT maps them into a key sequence. */
8908 /* Lookup KEY in MAP.
8909 MAP is a keymap mapping keys to key vectors or functions.
8910 If the mapping is a function and DO_FUNCTION is non-zero, then
8911 the function is called with PROMPT as parameter and its return
8912 value is used as the return value of this function (after checking
8913 that it is indeed a vector). */
8916 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8917 Lisp_Object map
, key
, prompt
;
8922 next
= access_keymap (map
, key
, 1, 0, 1);
8924 /* Handle symbol with autoload definition. */
8925 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8926 && CONSP (XSYMBOL (next
)->function
)
8927 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8928 do_autoload (XSYMBOL (next
)->function
, next
);
8930 /* Handle a symbol whose function definition is a keymap
8932 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8933 && (ARRAYP (XSYMBOL (next
)->function
)
8934 || KEYMAPP (XSYMBOL (next
)->function
)))
8935 next
= XSYMBOL (next
)->function
;
8937 /* If the keymap gives a function, not an
8938 array, then call the function with one arg and use
8939 its value instead. */
8940 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8945 next
= call1 (next
, prompt
);
8946 /* If the function returned something invalid,
8947 barf--don't ignore it.
8948 (To ignore it safely, we would need to gcpro a bunch of
8949 other variables.) */
8950 if (! (VECTORP (next
) || STRINGP (next
)))
8951 error ("Function %s returns invalid key sequence", tem
);
8956 /* Do one step of the key remapping used for function-key-map and
8957 key-translation-map:
8958 KEYBUF is the buffer holding the input events.
8959 BUFSIZE is its maximum size.
8960 FKEY is a pointer to the keyremap structure to use.
8961 INPUT is the index of the last element in KEYBUF.
8962 DOIT if non-zero says that the remapping can actually take place.
8963 DIFF is used to return the number of keys added/removed by the remapping.
8964 PARENT is the root of the keymap.
8965 PROMPT is the prompt to use if the remapping happens through a function.
8966 The return value is non-zero if the remapping actually took place. */
8969 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8970 Lisp_Object
*keybuf
, prompt
;
8972 int input
, doit
, *diff
, bufsize
;
8974 Lisp_Object next
, key
;
8976 key
= keybuf
[fkey
->end
++];
8978 if (KEYMAPP (fkey
->parent
))
8979 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8983 /* If keybuf[fkey->start..fkey->end] is bound in the
8984 map and we're in a position to do the key remapping, replace it with
8985 the binding and restart with fkey->start at the end. */
8986 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8988 int len
= XFASTINT (Flength (next
));
8991 *diff
= len
- (fkey
->end
- fkey
->start
);
8993 if (input
+ *diff
>= bufsize
)
8994 error ("Key sequence too long");
8996 /* Shift the keys that follow fkey->end. */
8998 for (i
= fkey
->end
; i
< input
; i
++)
8999 keybuf
[i
+ *diff
] = keybuf
[i
];
9001 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9002 keybuf
[i
+ *diff
] = keybuf
[i
];
9003 /* Overwrite the old keys with the new ones. */
9004 for (i
= 0; i
< len
; i
++)
9005 keybuf
[fkey
->start
+ i
]
9006 = Faref (next
, make_number (i
));
9008 fkey
->start
= fkey
->end
+= *diff
;
9009 fkey
->map
= fkey
->parent
;
9014 fkey
->map
= get_keymap (next
, 0, 1);
9016 /* If we no longer have a bound suffix, try a new position for
9018 if (!CONSP (fkey
->map
))
9020 fkey
->end
= ++fkey
->start
;
9021 fkey
->map
= fkey
->parent
;
9026 /* Read a sequence of keys that ends with a non prefix character,
9027 storing it in KEYBUF, a buffer of size BUFSIZE.
9029 Return the length of the key sequence stored.
9030 Return -1 if the user rejected a command menu.
9032 Echo starting immediately unless `prompt' is 0.
9034 Where a key sequence ends depends on the currently active keymaps.
9035 These include any minor mode keymaps active in the current buffer,
9036 the current buffer's local map, and the global map.
9038 If a key sequence has no other bindings, we check Vfunction_key_map
9039 to see if some trailing subsequence might be the beginning of a
9040 function key's sequence. If so, we try to read the whole function
9041 key, and substitute its symbolic name into the key sequence.
9043 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9044 `double-' events into similar click events, if that would make them
9045 bound. We try to turn `triple-' events first into `double-' events,
9048 If we get a mouse click in a mode line, vertical divider, or other
9049 non-text area, we treat the click as if it were prefixed by the
9050 symbol denoting that area - `mode-line', `vertical-line', or
9053 If the sequence starts with a mouse click, we read the key sequence
9054 with respect to the buffer clicked on, not the current buffer.
9056 If the user switches frames in the midst of a key sequence, we put
9057 off the switch-frame event until later; the next call to
9058 read_char will return it.
9060 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9061 from the selected window's buffer. */
9064 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9065 can_return_switch_frame
, fix_current_buffer
)
9066 Lisp_Object
*keybuf
;
9069 int dont_downcase_last
;
9070 int can_return_switch_frame
;
9071 int fix_current_buffer
;
9073 volatile Lisp_Object from_string
;
9074 volatile int count
= SPECPDL_INDEX ();
9076 /* How many keys there are in the current key sequence. */
9079 /* The length of the echo buffer when we started reading, and
9080 the length of this_command_keys when we started reading. */
9081 volatile int echo_start
;
9082 volatile int keys_start
;
9084 /* The number of keymaps we're scanning right now, and the number of
9085 keymaps we have allocated space for. */
9087 volatile int nmaps_allocated
= 0;
9089 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9090 the current keymaps. */
9091 Lisp_Object
*volatile defs
= NULL
;
9093 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9094 in the current keymaps, or nil where it is not a prefix. */
9095 Lisp_Object
*volatile submaps
= NULL
;
9097 /* The local map to start out with at start of key sequence. */
9098 volatile Lisp_Object orig_local_map
;
9100 /* The map from the `keymap' property to start out with at start of
9102 volatile Lisp_Object orig_keymap
;
9104 /* 1 if we have already considered switching to the local-map property
9105 of the place where a mouse click occurred. */
9106 volatile int localized_local_map
= 0;
9108 /* The index in submaps[] of the first keymap that has a binding for
9109 this key sequence. In other words, the lowest i such that
9110 submaps[i] is non-nil. */
9111 volatile int first_binding
;
9112 /* Index of the first key that has no binding.
9113 It is useless to try fkey.start larger than that. */
9114 volatile int first_unbound
;
9116 /* If t < mock_input, then KEYBUF[t] should be read as the next
9119 We use this to recover after recognizing a function key. Once we
9120 realize that a suffix of the current key sequence is actually a
9121 function key's escape sequence, we replace the suffix with the
9122 function key's binding from Vfunction_key_map. Now keybuf
9123 contains a new and different key sequence, so the echo area,
9124 this_command_keys, and the submaps and defs arrays are wrong. In
9125 this situation, we set mock_input to t, set t to 0, and jump to
9126 restart_sequence; the loop will read keys from keybuf up until
9127 mock_input, thus rebuilding the state; and then it will resume
9128 reading characters from the keyboard. */
9129 volatile int mock_input
= 0;
9131 /* If the sequence is unbound in submaps[], then
9132 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9133 and fkey.map is its binding.
9135 These might be > t, indicating that all function key scanning
9136 should hold off until t reaches them. We do this when we've just
9137 recognized a function key, to avoid searching for the function
9138 key's again in Vfunction_key_map. */
9139 volatile keyremap fkey
;
9141 /* Likewise, for key_translation_map and input-decode-map. */
9142 volatile keyremap keytran
, indec
;
9144 /* Non-zero if we are trying to map a key by changing an upper-case
9145 letter to lower case, or a shifted function key to an unshifted
9147 volatile int shift_translated
= 0;
9149 /* If we receive a `switch-frame' or `select-window' event in the middle of
9150 a key sequence, we put it off for later.
9151 While we're reading, we keep the event here. */
9152 volatile Lisp_Object delayed_switch_frame
;
9154 /* See the comment below... */
9155 #if defined (GOBBLE_FIRST_EVENT)
9156 Lisp_Object first_event
;
9159 volatile Lisp_Object original_uppercase
;
9160 volatile int original_uppercase_position
= -1;
9162 /* Gets around Microsoft compiler limitations. */
9165 struct buffer
*starting_buffer
;
9167 /* List of events for which a fake prefix key has been generated. */
9168 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9170 #if defined (GOBBLE_FIRST_EVENT)
9174 struct gcpro gcpro1
;
9176 GCPRO1 (fake_prefixed_keys
);
9177 raw_keybuf_count
= 0;
9179 last_nonmenu_event
= Qnil
;
9181 delayed_switch_frame
= Qnil
;
9186 echo_prompt (prompt
);
9187 else if (cursor_in_echo_area
9188 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9189 && NILP (Fzerop (Vecho_keystrokes
)))
9190 /* This doesn't put in a dash if the echo buffer is empty, so
9191 you don't always see a dash hanging out in the minibuffer. */
9195 /* Record the initial state of the echo area and this_command_keys;
9196 we will need to restore them if we replay a key sequence. */
9198 echo_start
= echo_length ();
9199 keys_start
= this_command_key_count
;
9200 this_single_command_key_start
= keys_start
;
9202 #if defined (GOBBLE_FIRST_EVENT)
9203 /* This doesn't quite work, because some of the things that read_char
9204 does cannot safely be bypassed. It seems too risky to try to make
9207 /* Read the first char of the sequence specially, before setting
9208 up any keymaps, in case a filter runs and switches buffers on us. */
9209 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9211 #endif /* GOBBLE_FIRST_EVENT */
9213 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9214 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9217 /* We jump here when we need to reinitialize fkey and keytran; this
9218 happens if we switch keyboards between rescans. */
9219 replay_entire_sequence
:
9221 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9222 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9223 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9224 indec
.start
= indec
.end
= 0;
9225 fkey
.start
= fkey
.end
= 0;
9226 keytran
.start
= keytran
.end
= 0;
9228 /* We jump here when the key sequence has been thoroughly changed, and
9229 we need to rescan it starting from the beginning. When we jump here,
9230 keybuf[0..mock_input] holds the sequence we should reread. */
9233 starting_buffer
= current_buffer
;
9234 first_unbound
= bufsize
+ 1;
9236 /* Build our list of keymaps.
9237 If we recognize a function key and replace its escape sequence in
9238 keybuf with its symbol, or if the sequence starts with a mouse
9239 click and we need to switch buffers, we jump back here to rebuild
9240 the initial keymaps from the current buffer. */
9243 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9245 if (2 > nmaps_allocated
)
9247 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9248 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9249 nmaps_allocated
= 2;
9251 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9253 else if (!NILP (Voverriding_local_map
))
9255 if (2 > nmaps_allocated
)
9257 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9258 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9259 nmaps_allocated
= 2;
9261 submaps
[nmaps
++] = Voverriding_local_map
;
9269 nminor
= current_minor_maps (0, &maps
);
9270 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9272 if (total
> nmaps_allocated
)
9274 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9275 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9276 nmaps_allocated
= total
;
9279 if (!NILP (orig_keymap
))
9280 submaps
[nmaps
++] = orig_keymap
;
9282 bcopy (maps
, (void *) (submaps
+ nmaps
),
9283 nminor
* sizeof (submaps
[0]));
9287 submaps
[nmaps
++] = orig_local_map
;
9289 submaps
[nmaps
++] = current_global_map
;
9291 /* Find an accurate initial value for first_binding. */
9292 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9293 if (! NILP (submaps
[first_binding
]))
9296 /* Start from the beginning in keybuf. */
9299 /* These are no-ops the first time through, but if we restart, they
9300 revert the echo area and this_command_keys to their original state. */
9301 this_command_key_count
= keys_start
;
9302 if (INTERACTIVE
&& t
< mock_input
)
9303 echo_truncate (echo_start
);
9305 /* If the best binding for the current key sequence is a keymap, or
9306 we may be looking at a function key's escape sequence, keep on
9308 while (first_binding
< nmaps
9309 /* Keep reading as long as there's a prefix binding. */
9310 ? !NILP (submaps
[first_binding
])
9311 /* Don't return in the middle of a possible function key sequence,
9312 if the only bindings we found were via case conversion.
9313 Thus, if ESC O a has a function-key-map translation
9314 and ESC o has a binding, don't return after ESC O,
9315 so that we can translate ESC O plus the next character. */
9316 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9319 int used_mouse_menu
= 0;
9321 /* Where the last real key started. If we need to throw away a
9322 key that has expanded into more than one element of keybuf
9323 (say, a mouse click on the mode line which is being treated
9324 as [mode-line (mouse-...)], then we backtrack to this point
9326 volatile int last_real_key_start
;
9328 /* These variables are analogous to echo_start and keys_start;
9329 while those allow us to restart the entire key sequence,
9330 echo_local_start and keys_local_start allow us to throw away
9332 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9334 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9335 eassert (indec
.start
<= indec
.end
);
9336 eassert (fkey
.start
<= fkey
.end
);
9337 eassert (keytran
.start
<= keytran
.end
);
9338 /* key-translation-map is applied *after* function-key-map
9339 which is itself applied *after* input-decode-map. */
9340 eassert (fkey
.end
<= indec
.start
);
9341 eassert (keytran
.end
<= fkey
.start
);
9343 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9344 first_unbound
< keytran
.start
)
9345 { /* The prefix upto first_unbound has no binding and has
9346 no translation left to do either, so we know it's unbound.
9347 If we don't stop now, we risk staying here indefinitely
9348 (if the user keeps entering fkey or keytran prefixes
9349 like C-c ESC ESC ESC ESC ...) */
9351 for (i
= first_unbound
+ 1; i
< t
; i
++)
9352 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9353 mock_input
= t
- first_unbound
- 1;
9354 indec
.end
= indec
.start
-= first_unbound
+ 1;
9355 indec
.map
= indec
.parent
;
9356 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9357 fkey
.map
= fkey
.parent
;
9358 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9359 keytran
.map
= keytran
.parent
;
9360 goto replay_sequence
;
9364 error ("Key sequence too long");
9367 echo_local_start
= echo_length ();
9368 keys_local_start
= this_command_key_count
;
9369 local_first_binding
= first_binding
;
9372 /* These are no-ops, unless we throw away a keystroke below and
9373 jumped back up to replay_key; in that case, these restore the
9374 variables to their original state, allowing us to replay the
9376 if (INTERACTIVE
&& t
< mock_input
)
9377 echo_truncate (echo_local_start
);
9378 this_command_key_count
= keys_local_start
;
9379 first_binding
= local_first_binding
;
9381 /* By default, assume each event is "real". */
9382 last_real_key_start
= t
;
9384 /* Does mock_input indicate that we are re-reading a key sequence? */
9388 add_command_key (key
);
9389 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9390 && NILP (Fzerop (Vecho_keystrokes
)))
9394 /* If not, we should actually read a character. */
9398 KBOARD
*interrupted_kboard
= current_kboard
;
9399 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9400 key
= read_char (NILP (prompt
), nmaps
,
9401 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9402 &used_mouse_menu
, NULL
);
9403 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9408 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9409 if (k
== interrupted_kboard
)
9414 /* Don't touch interrupted_kboard when it's been
9416 delayed_switch_frame
= Qnil
;
9417 goto replay_entire_sequence
;
9420 if (!NILP (delayed_switch_frame
))
9422 interrupted_kboard
->kbd_queue
9423 = Fcons (delayed_switch_frame
,
9424 interrupted_kboard
->kbd_queue
);
9425 delayed_switch_frame
= Qnil
;
9429 interrupted_kboard
->kbd_queue
9430 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9432 /* If the side queue is non-empty, ensure it begins with a
9433 switch-frame, so we'll replay it in the right context. */
9434 if (CONSP (interrupted_kboard
->kbd_queue
)
9435 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9436 !(EVENT_HAS_PARAMETERS (key
)
9437 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9441 XSETFRAME (frame
, interrupted_frame
);
9442 interrupted_kboard
->kbd_queue
9443 = Fcons (make_lispy_switch_frame (frame
),
9444 interrupted_kboard
->kbd_queue
);
9447 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9448 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9449 goto replay_entire_sequence
;
9453 /* read_char returns t when it shows a menu and the user rejects it.
9457 unbind_to (count
, Qnil
);
9462 /* read_char returns -1 at the end of a macro.
9463 Emacs 18 handles this by returning immediately with a
9464 zero, so that's what we'll do. */
9465 if (INTEGERP (key
) && XINT (key
) == -1)
9468 /* The Microsoft C compiler can't handle the goto that
9474 /* If the current buffer has been changed from under us, the
9475 keymap may have changed, so replay the sequence. */
9478 timer_resume_idle ();
9481 /* Reset the current buffer from the selected window
9482 in case something changed the former and not the latter.
9483 This is to be more consistent with the behavior
9484 of the command_loop_1. */
9485 if (fix_current_buffer
)
9487 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9489 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9490 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9493 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9494 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9495 goto replay_sequence
;
9498 /* If we have a quit that was typed in another frame, and
9499 quit_throw_to_read_char switched buffers,
9500 replay to get the right keymap. */
9502 && XINT (key
) == quit_char
9503 && current_buffer
!= starting_buffer
)
9506 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9510 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9511 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9512 goto replay_sequence
;
9517 if (EVENT_HAS_PARAMETERS (key
)
9518 /* Either a `switch-frame' or a `select-window' event. */
9519 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9521 /* If we're at the beginning of a key sequence, and the caller
9522 says it's okay, go ahead and return this event. If we're
9523 in the midst of a key sequence, delay it until the end. */
9524 if (t
> 0 || !can_return_switch_frame
)
9526 delayed_switch_frame
= key
;
9532 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9536 /* Clicks in non-text areas get prefixed by the symbol
9537 in their CHAR-ADDRESS field. For example, a click on
9538 the mode line is prefixed by the symbol `mode-line'.
9540 Furthermore, key sequences beginning with mouse clicks
9541 are read using the keymaps of the buffer clicked on, not
9542 the current buffer. So we may have to switch the buffer
9545 When we turn one event into two events, we must make sure
9546 that neither of the two looks like the original--so that,
9547 if we replay the events, they won't be expanded again.
9548 If not for this, such reexpansion could happen either here
9549 or when user programs play with this-command-keys. */
9550 if (EVENT_HAS_PARAMETERS (key
))
9555 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9556 if (EQ (kind
, Qmouse_click
))
9558 Lisp_Object window
, posn
;
9560 window
= POSN_WINDOW (EVENT_START (key
));
9561 posn
= POSN_POSN (EVENT_START (key
));
9564 || (!NILP (fake_prefixed_keys
)
9565 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9567 /* We're looking a second time at an event for which
9568 we generated a fake prefix key. Set
9569 last_real_key_start appropriately. */
9571 last_real_key_start
= t
- 1;
9574 /* Key sequences beginning with mouse clicks are
9575 read using the keymaps in the buffer clicked on,
9576 not the current buffer. If we're at the
9577 beginning of a key sequence, switch buffers. */
9578 if (last_real_key_start
== 0
9580 && BUFFERP (XWINDOW (window
)->buffer
)
9581 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9583 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9587 /* Arrange to go back to the original buffer once we're
9588 done reading the key sequence. Note that we can't
9589 use save_excursion_{save,restore} here, because they
9590 save point as well as the current buffer; we don't
9591 want to save point, because redisplay may change it,
9592 to accommodate a Fset_window_start or something. We
9593 don't want to do this at the top of the function,
9594 because we may get input from a subprocess which
9595 wants to change the selected window and stuff (say,
9597 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9599 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9601 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9602 orig_local_map
= get_local_map (PT
, current_buffer
,
9604 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9605 goto replay_sequence
;
9608 /* For a mouse click, get the local text-property keymap
9609 of the place clicked on, rather than point. */
9610 if (last_real_key_start
== 0
9611 && CONSP (XCDR (key
))
9612 && ! localized_local_map
)
9614 Lisp_Object map_here
, start
, pos
;
9616 localized_local_map
= 1;
9617 start
= EVENT_START (key
);
9619 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9621 pos
= POSN_BUFFER_POSN (start
);
9623 && XINT (pos
) >= BEGV
9624 && XINT (pos
) <= ZV
)
9626 map_here
= get_local_map (XINT (pos
),
9627 current_buffer
, Qlocal_map
);
9628 if (!EQ (map_here
, orig_local_map
))
9630 orig_local_map
= map_here
;
9631 ++localized_local_map
;
9634 map_here
= get_local_map (XINT (pos
),
9635 current_buffer
, Qkeymap
);
9636 if (!EQ (map_here
, orig_keymap
))
9638 orig_keymap
= map_here
;
9639 ++localized_local_map
;
9642 if (localized_local_map
> 1)
9647 goto replay_sequence
;
9653 /* Expand mode-line and scroll-bar events into two events:
9654 use posn as a fake prefix key. */
9656 && (NILP (fake_prefixed_keys
)
9657 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9659 if (t
+ 1 >= bufsize
)
9660 error ("Key sequence too long");
9663 keybuf
[t
+ 1] = key
;
9666 /* Record that a fake prefix key has been generated
9667 for KEY. Don't modify the event; this would
9668 prevent proper action when the event is pushed
9669 back into unread-command-events. */
9670 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9672 /* If on a mode line string with a local keymap,
9673 reconsider the key sequence with that keymap. */
9674 if (string
= POSN_STRING (EVENT_START (key
)),
9675 (CONSP (string
) && STRINGP (XCAR (string
))))
9677 Lisp_Object pos
, map
, map2
;
9679 pos
= XCDR (string
);
9680 string
= XCAR (string
);
9682 && XINT (pos
) < SCHARS (string
))
9684 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9686 orig_local_map
= map
;
9687 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9690 if (!NILP (map
) || !NILP (map2
))
9691 goto replay_sequence
;
9697 else if (NILP (from_string
)
9698 && (string
= POSN_STRING (EVENT_START (key
)),
9699 (CONSP (string
) && STRINGP (XCAR (string
)))))
9701 /* For a click on a string, i.e. overlay string or a
9702 string displayed via the `display' property,
9703 consider `local-map' and `keymap' properties of
9705 Lisp_Object pos
, map
, map2
;
9707 pos
= XCDR (string
);
9708 string
= XCAR (string
);
9710 && XINT (pos
) < SCHARS (string
))
9712 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9714 orig_local_map
= map
;
9715 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9719 if (!NILP (map
) || !NILP (map2
))
9721 from_string
= string
;
9724 goto replay_sequence
;
9729 else if (CONSP (XCDR (key
))
9730 && CONSP (EVENT_START (key
))
9731 && CONSP (XCDR (EVENT_START (key
))))
9735 posn
= POSN_POSN (EVENT_START (key
));
9736 /* Handle menu-bar events:
9737 insert the dummy prefix event `menu-bar'. */
9738 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9740 if (t
+ 1 >= bufsize
)
9741 error ("Key sequence too long");
9745 /* Zap the position in key, so we know that we've
9746 expanded it, and don't try to do so again. */
9747 POSN_SET_POSN (EVENT_START (key
),
9748 Fcons (posn
, Qnil
));
9751 goto replay_sequence
;
9753 else if (CONSP (posn
))
9755 /* We're looking at the second event of a
9756 sequence which we expanded before. Set
9757 last_real_key_start appropriately. */
9758 if (last_real_key_start
== t
&& t
> 0)
9759 last_real_key_start
= t
- 1;
9764 /* We have finally decided that KEY is something we might want
9766 first_binding
= (follow_key (key
,
9767 nmaps
- first_binding
,
9768 submaps
+ first_binding
,
9769 defs
+ first_binding
,
9770 submaps
+ first_binding
)
9773 /* If KEY wasn't bound, we'll try some fallbacks. */
9774 if (first_binding
< nmaps
)
9775 /* This is needed for the following scenario:
9776 event 0: a down-event that gets dropped by calling replay_key.
9777 event 1: some normal prefix like C-h.
9778 After event 0, first_unbound is 0, after event 1 indec.start,
9779 fkey.start, and keytran.start are all 1, so when we see that
9780 C-h is bound, we need to update first_unbound. */
9781 first_unbound
= max (t
+ 1, first_unbound
);
9786 /* Remember the position to put an upper bound on indec.start. */
9787 first_unbound
= min (t
, first_unbound
);
9789 head
= EVENT_HEAD (key
);
9790 if (help_char_p (head
) && t
> 0)
9792 read_key_sequence_cmd
= Vprefix_help_command
;
9794 last_nonmenu_event
= key
;
9795 /* The Microsoft C compiler can't handle the goto that
9803 Lisp_Object breakdown
;
9806 breakdown
= parse_modifiers (head
);
9807 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9808 /* Attempt to reduce an unbound mouse event to a simpler
9809 event that is bound:
9810 Drags reduce to clicks.
9811 Double-clicks reduce to clicks.
9812 Triple-clicks reduce to double-clicks, then to clicks.
9813 Down-clicks are eliminated.
9814 Double-downs reduce to downs, then are eliminated.
9815 Triple-downs reduce to double-downs, then to downs,
9816 then are eliminated. */
9817 if (modifiers
& (down_modifier
| drag_modifier
9818 | double_modifier
| triple_modifier
))
9820 while (modifiers
& (down_modifier
| drag_modifier
9821 | double_modifier
| triple_modifier
))
9823 Lisp_Object new_head
, new_click
;
9824 if (modifiers
& triple_modifier
)
9825 modifiers
^= (double_modifier
| triple_modifier
);
9826 else if (modifiers
& double_modifier
)
9827 modifiers
&= ~double_modifier
;
9828 else if (modifiers
& drag_modifier
)
9829 modifiers
&= ~drag_modifier
;
9832 /* Dispose of this `down' event by simply jumping
9833 back to replay_key, to get another event.
9835 Note that if this event came from mock input,
9836 then just jumping back to replay_key will just
9837 hand it to us again. So we have to wipe out any
9840 We could delete keybuf[t] and shift everything
9841 after that to the left by one spot, but we'd also
9842 have to fix up any variable that points into
9843 keybuf, and shifting isn't really necessary
9846 Adding prefixes for non-textual mouse clicks
9847 creates two characters of mock input, and both
9848 must be thrown away. If we're only looking at
9849 the prefix now, we can just jump back to
9850 replay_key. On the other hand, if we've already
9851 processed the prefix, and now the actual click
9852 itself is giving us trouble, then we've lost the
9853 state of the keymaps we want to backtrack to, and
9854 we need to replay the whole sequence to rebuild
9857 Beyond that, only function key expansion could
9858 create more than two keys, but that should never
9859 generate mouse events, so it's okay to zero
9860 mock_input in that case too.
9862 FIXME: The above paragraph seems just plain
9863 wrong, if you consider things like
9864 xterm-mouse-mode. -stef
9866 Isn't this just the most wonderful code ever? */
9868 /* If mock_input > t + 1, the above simplification
9869 will actually end up dropping keys on the floor.
9870 This is probably OK for now, but even
9871 if mock_input <= t + 1, we need to adjust indec,
9873 Typical case [header-line down-mouse-N]:
9874 mock_input = 2, t = 1, fkey.end = 1,
9875 last_real_key_start = 0. */
9876 if (indec
.end
> last_real_key_start
)
9878 indec
.end
= indec
.start
9879 = min (last_real_key_start
, indec
.start
);
9880 indec
.map
= indec
.parent
;
9881 if (fkey
.end
> last_real_key_start
)
9883 fkey
.end
= fkey
.start
9884 = min (last_real_key_start
, fkey
.start
);
9885 fkey
.map
= fkey
.parent
;
9886 if (keytran
.end
> last_real_key_start
)
9888 keytran
.end
= keytran
.start
9889 = min (last_real_key_start
, keytran
.start
);
9890 keytran
.map
= keytran
.parent
;
9894 if (t
== last_real_key_start
)
9901 mock_input
= last_real_key_start
;
9902 goto replay_sequence
;
9907 = apply_modifiers (modifiers
, XCAR (breakdown
));
9909 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9911 /* Look for a binding for this new key. follow_key
9912 promises that it didn't munge submaps the
9913 last time we called it, since key was unbound. */
9915 = (follow_key (new_click
,
9916 nmaps
- local_first_binding
,
9917 submaps
+ local_first_binding
,
9918 defs
+ local_first_binding
,
9919 submaps
+ local_first_binding
)
9920 + local_first_binding
);
9922 /* If that click is bound, go for it. */
9923 if (first_binding
< nmaps
)
9928 /* Otherwise, we'll leave key set to the drag event. */
9935 /* Normally, last_nonmenu_event gets the previous key we read.
9936 But when a mouse popup menu is being used,
9937 we don't update last_nonmenu_event; it continues to hold the mouse
9938 event that preceded the first level of menu. */
9939 if (!used_mouse_menu
)
9940 last_nonmenu_event
= key
;
9942 /* Record what part of this_command_keys is the current key sequence. */
9943 this_single_command_key_start
= this_command_key_count
- t
;
9945 /* Look for this sequence in input-decode-map.
9946 Scan from indec.end until we find a bound suffix. */
9947 while (indec
.end
< t
)
9949 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9952 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9953 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9958 mock_input
= diff
+ max (t
, mock_input
);
9959 goto replay_sequence
;
9963 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9964 && indec
.start
>= t
)
9965 /* There is a binding and it's not a prefix.
9966 (and it doesn't have any input-decode-map translation pending).
9967 There is thus no function-key in this sequence.
9968 Moving fkey.start is important in this case to allow keytran.start
9969 to go over the sequence before we return (since we keep the
9970 invariant that keytran.end <= fkey.start). */
9973 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9976 /* If the sequence is unbound, see if we can hang a function key
9977 off the end of it. */
9978 /* Continue scan from fkey.end until we find a bound suffix. */
9979 while (fkey
.end
< indec
.start
)
9981 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9984 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9985 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9986 max (t
, mock_input
),
9987 /* If there's a binding (i.e.
9988 first_binding >= nmaps) we don't want
9989 to apply this function-key-mapping. */
9990 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9995 mock_input
= diff
+ max (t
, mock_input
);
9996 /* Adjust the input-decode-map counters. */
9998 indec
.start
+= diff
;
10000 goto replay_sequence
;
10004 /* Look for this sequence in key-translation-map.
10005 Scan from keytran.end until we find a bound suffix. */
10006 while (keytran
.end
< fkey
.start
)
10008 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10011 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10012 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10017 mock_input
= diff
+ max (t
, mock_input
);
10018 /* Adjust the function-key-map and input-decode-map counters. */
10020 indec
.start
+= diff
;
10022 fkey
.start
+= diff
;
10024 goto replay_sequence
;
10028 /* If KEY is not defined in any of the keymaps,
10029 and cannot be part of a function key or translation,
10030 and is an upper case letter
10031 use the corresponding lower-case letter instead. */
10032 if (first_binding
>= nmaps
10033 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10035 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10036 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10037 || (XINT (key
) & shift_modifier
)))
10039 Lisp_Object new_key
;
10041 original_uppercase
= key
;
10042 original_uppercase_position
= t
- 1;
10044 if (XINT (key
) & shift_modifier
)
10045 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10047 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10048 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10050 /* We have to do this unconditionally, regardless of whether
10051 the lower-case char is defined in the keymaps, because they
10052 might get translated through function-key-map. */
10053 keybuf
[t
- 1] = new_key
;
10054 mock_input
= max (t
, mock_input
);
10055 shift_translated
= 1;
10057 goto replay_sequence
;
10059 /* If KEY is not defined in any of the keymaps,
10060 and cannot be part of a function key or translation,
10061 and is a shifted function key,
10062 use the corresponding unshifted function key instead. */
10063 if (first_binding
>= nmaps
10064 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10066 Lisp_Object breakdown
= parse_modifiers (key
);
10068 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10070 if (modifiers
& shift_modifier
10071 /* Treat uppercase keys as shifted. */
10073 && (KEY_TO_CHAR (key
)
10074 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10075 && UPPERCASEP (KEY_TO_CHAR (key
))))
10077 Lisp_Object new_key
10078 = (modifiers
& shift_modifier
10079 ? apply_modifiers (modifiers
& ~shift_modifier
,
10081 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10083 original_uppercase
= key
;
10084 original_uppercase_position
= t
- 1;
10086 /* We have to do this unconditionally, regardless of whether
10087 the lower-case char is defined in the keymaps, because they
10088 might get translated through function-key-map. */
10089 keybuf
[t
- 1] = new_key
;
10090 mock_input
= max (t
, mock_input
);
10091 /* Reset fkey (and consequently keytran) to apply
10092 function-key-map on the result, so that S-backspace is
10093 correctly mapped to DEL (via backspace). OTOH,
10094 input-decode-map doesn't need to go through it again. */
10095 fkey
.start
= fkey
.end
= 0;
10096 keytran
.start
= keytran
.end
= 0;
10097 shift_translated
= 1;
10099 goto replay_sequence
;
10104 read_key_sequence_cmd
= (first_binding
< nmaps
10105 ? defs
[first_binding
]
10108 unread_switch_frame
= delayed_switch_frame
;
10109 unbind_to (count
, Qnil
);
10111 /* Don't downcase the last character if the caller says don't.
10112 Don't downcase it if the result is undefined, either. */
10113 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10115 && t
- 1 == original_uppercase_position
)
10117 keybuf
[t
- 1] = original_uppercase
;
10118 shift_translated
= 0;
10121 if (shift_translated
)
10122 Vthis_command_keys_shift_translated
= Qt
;
10124 /* Occasionally we fabricate events, perhaps by expanding something
10125 according to function-key-map, or by adding a prefix symbol to a
10126 mouse click in the scroll bar or modeline. In this cases, return
10127 the entire generated key sequence, even if we hit an unbound
10128 prefix or a definition before the end. This means that you will
10129 be able to push back the event properly, and also means that
10130 read-key-sequence will always return a logical unit.
10133 for (; t
< mock_input
; t
++)
10135 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10136 && NILP (Fzerop (Vecho_keystrokes
)))
10137 echo_char (keybuf
[t
]);
10138 add_command_key (keybuf
[t
]);
10145 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10146 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10147 The sequence is sufficient to specify a non-prefix command in the
10148 current local and global maps.
10150 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10151 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10152 as a continuation of the previous key.
10154 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10155 convert the last event to lower case. (Normally any upper case event
10156 is converted to lower case if the original event is undefined and the lower
10157 case equivalent is defined.) A non-nil value is appropriate for reading
10158 a key sequence to be defined.
10160 A C-g typed while in this function is treated like any other character,
10161 and `quit-flag' is not set.
10163 If the key sequence starts with a mouse click, then the sequence is read
10164 using the keymaps of the buffer of the window clicked in, not the buffer
10165 of the selected window as normal.
10167 `read-key-sequence' drops unbound button-down events, since you normally
10168 only care about the click or drag events which follow them. If a drag
10169 or multi-click event is unbound, but the corresponding click event would
10170 be bound, `read-key-sequence' turns the event into a click event at the
10171 drag's starting position. This means that you don't have to distinguish
10172 between click and drag, double, or triple events unless you want to.
10174 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10175 lines separating windows, and scroll bars with imaginary keys
10176 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10178 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10179 function will process a switch-frame event if the user switches frames
10180 before typing anything. If the user switches frames in the middle of a
10181 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10182 is nil, then the event will be put off until after the current key sequence.
10184 `read-key-sequence' checks `function-key-map' for function key
10185 sequences, where they wouldn't conflict with ordinary bindings. See
10186 `function-key-map' for more details.
10188 The optional fifth argument COMMAND-LOOP, if non-nil, means
10189 that this key sequence is being read by something that will
10190 read commands one after another. It should be nil if the caller
10191 will read just one key sequence. */)
10192 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10194 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10195 Lisp_Object can_return_switch_frame
, command_loop
;
10197 Lisp_Object keybuf
[30];
10199 struct gcpro gcpro1
;
10200 int count
= SPECPDL_INDEX ();
10202 if (!NILP (prompt
))
10203 CHECK_STRING (prompt
);
10206 specbind (Qinput_method_exit_on_first_char
,
10207 (NILP (command_loop
) ? Qt
: Qnil
));
10208 specbind (Qinput_method_use_echo_area
,
10209 (NILP (command_loop
) ? Qt
: Qnil
));
10211 bzero (keybuf
, sizeof keybuf
);
10212 GCPRO1 (keybuf
[0]);
10213 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10215 if (NILP (continue_echo
))
10217 this_command_key_count
= 0;
10218 this_command_key_count_reset
= 0;
10219 this_single_command_key_start
= 0;
10222 #ifdef HAVE_WINDOW_SYSTEM
10223 if (display_hourglass_p
)
10224 cancel_hourglass ();
10227 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10228 prompt
, ! NILP (dont_downcase_last
),
10229 ! NILP (can_return_switch_frame
), 0);
10231 #if 0 /* The following is fine for code reading a key sequence and
10232 then proceeding with a lenghty computation, but it's not good
10233 for code reading keys in a loop, like an input method. */
10234 #ifdef HAVE_WINDOW_SYSTEM
10235 if (display_hourglass_p
)
10236 start_hourglass ();
10246 return unbind_to (count
, make_event_array (i
, keybuf
));
10249 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10250 Sread_key_sequence_vector
, 1, 5, 0,
10251 doc
: /* Like `read-key-sequence' but always return a vector. */)
10252 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10254 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10255 Lisp_Object can_return_switch_frame
, command_loop
;
10257 Lisp_Object keybuf
[30];
10259 struct gcpro gcpro1
;
10260 int count
= SPECPDL_INDEX ();
10262 if (!NILP (prompt
))
10263 CHECK_STRING (prompt
);
10266 specbind (Qinput_method_exit_on_first_char
,
10267 (NILP (command_loop
) ? Qt
: Qnil
));
10268 specbind (Qinput_method_use_echo_area
,
10269 (NILP (command_loop
) ? Qt
: Qnil
));
10271 bzero (keybuf
, sizeof keybuf
);
10272 GCPRO1 (keybuf
[0]);
10273 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10275 if (NILP (continue_echo
))
10277 this_command_key_count
= 0;
10278 this_command_key_count_reset
= 0;
10279 this_single_command_key_start
= 0;
10282 #ifdef HAVE_WINDOW_SYSTEM
10283 if (display_hourglass_p
)
10284 cancel_hourglass ();
10287 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10288 prompt
, ! NILP (dont_downcase_last
),
10289 ! NILP (can_return_switch_frame
), 0);
10291 #ifdef HAVE_WINDOW_SYSTEM
10292 if (display_hourglass_p
)
10293 start_hourglass ();
10302 return unbind_to (count
, Fvector (i
, keybuf
));
10305 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10306 doc
: /* Execute CMD as an editor command.
10307 CMD must be a symbol that satisfies the `commandp' predicate.
10308 Optional second arg RECORD-FLAG non-nil
10309 means unconditionally put this command in `command-history'.
10310 Otherwise, that is done only if an arg is read using the minibuffer.
10311 The argument KEYS specifies the value to use instead of (this-command-keys)
10312 when reading the arguments; if it is nil, (this-command-keys) is used.
10313 The argument SPECIAL, if non-nil, means that this command is executing
10314 a special event, so ignore the prefix argument and don't clear it. */)
10315 (cmd
, record_flag
, keys
, special
)
10316 Lisp_Object cmd
, record_flag
, keys
, special
;
10318 register Lisp_Object final
;
10319 register Lisp_Object tem
;
10320 Lisp_Object prefixarg
;
10321 extern int debug_on_next_call
;
10323 debug_on_next_call
= 0;
10325 if (NILP (special
))
10327 prefixarg
= current_kboard
->Vprefix_arg
;
10328 Vcurrent_prefix_arg
= prefixarg
;
10329 current_kboard
->Vprefix_arg
= Qnil
;
10336 tem
= Fget (cmd
, Qdisabled
);
10337 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10339 tem
= Fsymbol_value (Qdisabled_command_function
);
10341 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10347 final
= Findirect_function (cmd
, Qnil
);
10349 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10351 struct gcpro gcpro1
, gcpro2
;
10353 GCPRO2 (cmd
, prefixarg
);
10354 do_autoload (final
, cmd
);
10361 if (STRINGP (final
) || VECTORP (final
))
10363 /* If requested, place the macro in the command history. For
10364 other sorts of commands, call-interactively takes care of
10366 if (!NILP (record_flag
))
10369 = Fcons (Fcons (Qexecute_kbd_macro
,
10370 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10373 /* Don't keep command history around forever. */
10374 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10376 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10378 XSETCDR (tem
, Qnil
);
10382 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10385 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10386 /* Don't call Fcall_interactively directly because we want to make
10387 sure the backtrace has an entry for `call-interactively'.
10388 For the same reason, pass `cmd' rather than `final'. */
10389 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10396 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10398 doc
: /* Read function name, then read its arguments and call it.
10400 To pass a numeric argument to the command you are invoking with, specify
10401 the numeric argument to this command.
10403 Noninteractively, the argument PREFIXARG is the prefix argument to
10404 give to the command you invoke, if it asks for an argument. */)
10406 Lisp_Object prefixarg
;
10408 Lisp_Object function
;
10410 int saved_last_point_position
;
10411 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10412 Lisp_Object bindings
, value
;
10413 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10414 #ifdef HAVE_WINDOW_SYSTEM
10415 /* The call to Fcompleting_read wil start and cancel the hourglass,
10416 but if the hourglass was already scheduled, this means that no
10417 hourglass will be shown for the actual M-x command itself.
10418 So we restart it if it is already scheduled. Note that checking
10419 hourglass_shown_p is not enough, normally the hourglass is not shown,
10420 just scheduled to be shown. */
10421 int hstarted
= hourglass_started ();
10424 saved_keys
= Fvector (this_command_key_count
,
10425 XVECTOR (this_command_keys
)->contents
);
10426 saved_last_point_position_buffer
= last_point_position_buffer
;
10427 saved_last_point_position
= last_point_position
;
10429 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10431 if (EQ (prefixarg
, Qminus
))
10432 strcpy (buf
, "- ");
10433 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10434 strcpy (buf
, "C-u ");
10435 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10436 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10437 else if (INTEGERP (prefixarg
))
10438 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10440 /* This isn't strictly correct if execute-extended-command
10441 is bound to anything else. Perhaps it should use
10442 this_command_keys? */
10443 strcat (buf
, "M-x ");
10445 /* Prompt with buf, and then read a string, completing from and
10446 restricting to the set of all defined commands. Don't provide
10447 any initial input. Save the command read on the extended-command
10449 function
= Fcompleting_read (build_string (buf
),
10450 Vobarray
, Qcommandp
,
10451 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10454 #ifdef HAVE_WINDOW_SYSTEM
10455 if (hstarted
) start_hourglass ();
10458 if (STRINGP (function
) && SCHARS (function
) == 0)
10459 error ("No command name given");
10461 /* Set this_command_keys to the concatenation of saved_keys and
10462 function, followed by a RET. */
10467 this_command_key_count
= 0;
10468 this_command_key_count_reset
= 0;
10469 this_single_command_key_start
= 0;
10471 keys
= XVECTOR (saved_keys
)->contents
;
10472 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10473 add_command_key (keys
[i
]);
10475 for (i
= 0; i
< SCHARS (function
); i
++)
10476 add_command_key (Faref (function
, make_number (i
)));
10478 add_command_key (make_number ('\015'));
10481 last_point_position
= saved_last_point_position
;
10482 last_point_position_buffer
= saved_last_point_position_buffer
;
10486 function
= Fintern (function
, Qnil
);
10487 current_kboard
->Vprefix_arg
= prefixarg
;
10488 Vthis_command
= function
;
10489 real_this_command
= function
;
10491 /* If enabled, show which key runs this command. */
10492 if (!NILP (Vsuggest_key_bindings
)
10493 && NILP (Vexecuting_kbd_macro
)
10494 && SYMBOLP (function
))
10495 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10501 GCPRO3 (bindings
, value
, function
);
10502 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10504 /* If the command has a key binding, print it now. */
10505 if (!NILP (bindings
)
10506 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10509 /* But first wait, and skip the message if there is input. */
10510 Lisp_Object waited
;
10512 /* If this command displayed something in the echo area;
10513 wait a few seconds, then display our suggestion message. */
10514 if (NILP (echo_area_buffer
[0]))
10515 waited
= sit_for (make_number (0), 0, 2);
10516 else if (NUMBERP (Vsuggest_key_bindings
))
10517 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10519 waited
= sit_for (make_number (2), 0, 2);
10521 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10523 Lisp_Object binding
;
10525 int message_p
= push_message ();
10526 int count
= SPECPDL_INDEX ();
10528 record_unwind_protect (pop_message_unwind
, Qnil
);
10529 binding
= Fkey_description (bindings
, Qnil
);
10532 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10535 sprintf (newmessage
, "You can run the command `%s' with %s",
10536 SDATA (SYMBOL_NAME (function
)),
10538 message2_nolog (newmessage
,
10539 strlen (newmessage
),
10540 STRING_MULTIBYTE (binding
));
10541 if (NUMBERP (Vsuggest_key_bindings
))
10542 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10544 waited
= sit_for (make_number (2), 0, 2);
10546 if (!NILP (waited
) && message_p
)
10547 restore_message ();
10549 unbind_to (count
, Qnil
);
10553 RETURN_UNGCPRO (value
);
10557 /* Return nonzero if input events are pending. */
10560 detect_input_pending ()
10562 if (!input_pending
)
10563 get_input_pending (&input_pending
, 0);
10565 return input_pending
;
10568 /* Return nonzero if input events other than mouse movements are
10572 detect_input_pending_ignore_squeezables ()
10574 if (!input_pending
)
10575 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10577 return input_pending
;
10580 /* Return nonzero if input events are pending, and run any pending timers. */
10583 detect_input_pending_run_timers (do_display
)
10586 int old_timers_run
= timers_run
;
10588 if (!input_pending
)
10589 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10591 if (old_timers_run
!= timers_run
&& do_display
)
10593 redisplay_preserve_echo_area (8);
10594 /* The following fixes a bug when using lazy-lock with
10595 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10596 from an idle timer function. The symptom of the bug is that
10597 the cursor sometimes doesn't become visible until the next X
10598 event is processed. --gerd. */
10600 Lisp_Object tail
, frame
;
10601 FOR_EACH_FRAME (tail
, frame
)
10602 if (FRAME_RIF (XFRAME (frame
)))
10603 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10607 return input_pending
;
10610 /* This is called in some cases before a possible quit.
10611 It cases the next call to detect_input_pending to recompute input_pending.
10612 So calling this function unnecessarily can't do any harm. */
10615 clear_input_pending ()
10620 /* Return nonzero if there are pending requeued events.
10621 This isn't used yet. The hope is to make wait_reading_process_output
10622 call it, and return if it runs Lisp code that unreads something.
10623 The problem is, kbd_buffer_get_event needs to be fixed to know what
10624 to do in that case. It isn't trivial. */
10627 requeued_events_pending_p ()
10629 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10633 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10634 doc
: /* Return t if command input is currently available with no wait.
10635 Actually, the value is nil only if we can be sure that no input is available;
10636 if there is a doubt, the value is t. */)
10639 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10640 || !NILP (Vunread_post_input_method_events
)
10641 || !NILP (Vunread_input_method_events
))
10644 get_input_pending (&input_pending
,
10645 READABLE_EVENTS_DO_TIMERS_NOW
10646 | READABLE_EVENTS_FILTER_EVENTS
);
10647 return input_pending
> 0 ? Qt
: Qnil
;
10650 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10651 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10654 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10657 if (total_keys
< NUM_RECENT_KEYS
)
10658 return Fvector (total_keys
, keys
);
10661 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10662 bcopy (keys
+ recent_keys_index
,
10663 XVECTOR (val
)->contents
,
10664 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10666 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10667 recent_keys_index
* sizeof (Lisp_Object
));
10672 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10673 doc
: /* Return the key sequence that invoked this command.
10674 However, if the command has called `read-key-sequence', it returns
10675 the last key sequence that has been read.
10676 The value is a string or a vector.
10678 See also `this-command-keys-vector'. */)
10681 return make_event_array (this_command_key_count
,
10682 XVECTOR (this_command_keys
)->contents
);
10685 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10686 doc
: /* Return the key sequence that invoked this command, as a vector.
10687 However, if the command has called `read-key-sequence', it returns
10688 the last key sequence that has been read.
10690 See also `this-command-keys'. */)
10693 return Fvector (this_command_key_count
,
10694 XVECTOR (this_command_keys
)->contents
);
10697 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10698 Sthis_single_command_keys
, 0, 0, 0,
10699 doc
: /* Return the key sequence that invoked this command.
10700 More generally, it returns the last key sequence read, either by
10701 the command loop or by `read-key-sequence'.
10702 Unlike `this-command-keys', this function's value
10703 does not include prefix arguments.
10704 The value is always a vector. */)
10707 return Fvector (this_command_key_count
10708 - this_single_command_key_start
,
10709 (XVECTOR (this_command_keys
)->contents
10710 + this_single_command_key_start
));
10713 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10714 Sthis_single_command_raw_keys
, 0, 0, 0,
10715 doc
: /* Return the raw events that were read for this command.
10716 More generally, it returns the last key sequence read, either by
10717 the command loop or by `read-key-sequence'.
10718 Unlike `this-single-command-keys', this function's value
10719 shows the events before all translations (except for input methods).
10720 The value is always a vector. */)
10723 return Fvector (raw_keybuf_count
,
10724 (XVECTOR (raw_keybuf
)->contents
));
10727 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10728 Sreset_this_command_lengths
, 0, 0, 0,
10729 doc
: /* Make the unread events replace the last command and echo.
10730 Used in `universal-argument-other-key'.
10732 `universal-argument-other-key' rereads the event just typed.
10733 It then gets translated through `function-key-map'.
10734 The translated event has to replace the real events,
10735 both in the value of (this-command-keys) and in echoing.
10736 To achieve this, `universal-argument-other-key' calls
10737 `reset-this-command-lengths', which discards the record of reading
10738 these events the first time. */)
10741 this_command_key_count
= before_command_key_count
;
10742 if (this_command_key_count
< this_single_command_key_start
)
10743 this_single_command_key_start
= this_command_key_count
;
10745 echo_truncate (before_command_echo_length
);
10747 /* Cause whatever we put into unread-command-events
10748 to echo as if it were being freshly read from the keyboard. */
10749 this_command_key_count_reset
= 1;
10754 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10755 Sclear_this_command_keys
, 0, 1, 0,
10756 doc
: /* Clear out the vector that `this-command-keys' returns.
10757 Also clear the record of the last 100 events, unless optional arg
10758 KEEP-RECORD is non-nil. */)
10760 Lisp_Object keep_record
;
10764 this_command_key_count
= 0;
10765 this_command_key_count_reset
= 0;
10767 if (NILP (keep_record
))
10769 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10770 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10772 recent_keys_index
= 0;
10777 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10778 doc
: /* Return the current depth in recursive edits. */)
10782 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10786 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10787 "FOpen dribble file: ",
10788 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10789 If FILE is nil, close any open dribble file. */)
10802 file
= Fexpand_file_name (file
, Qnil
);
10803 dribble
= fopen (SDATA (file
), "w");
10805 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10810 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10811 doc
: /* Discard the contents of the terminal input buffer.
10812 Also end any kbd macro being defined. */)
10815 if (!NILP (current_kboard
->defining_kbd_macro
))
10817 /* Discard the last command from the macro. */
10818 Fcancel_kbd_macro_events ();
10822 update_mode_lines
++;
10824 Vunread_command_events
= Qnil
;
10825 unread_command_char
= -1;
10827 discard_tty_input ();
10829 kbd_fetch_ptr
= kbd_store_ptr
;
10835 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10836 doc
: /* Stop Emacs and return to superior process. You can resume later.
10837 If `cannot-suspend' is non-nil, or if the system doesn't support job
10838 control, run a subshell instead.
10840 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10841 to be read as terminal input by Emacs's parent, after suspension.
10843 Before suspending, run the normal hook `suspend-hook'.
10844 After resumption run the normal hook `suspend-resume-hook'.
10846 Some operating systems cannot stop the Emacs process and resume it later.
10847 On such systems, Emacs starts a subshell instead of suspending. */)
10849 Lisp_Object stuffstring
;
10851 int count
= SPECPDL_INDEX ();
10852 int old_height
, old_width
;
10854 struct gcpro gcpro1
;
10856 if (tty_list
&& tty_list
->next
)
10857 error ("There are other tty frames open; close them before suspending Emacs");
10859 if (!NILP (stuffstring
))
10860 CHECK_STRING (stuffstring
);
10862 /* Run the functions in suspend-hook. */
10863 if (!NILP (Vrun_hooks
))
10864 call1 (Vrun_hooks
, intern ("suspend-hook"));
10866 GCPRO1 (stuffstring
);
10867 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10868 reset_all_sys_modes ();
10869 /* sys_suspend can get an error if it tries to fork a subshell
10870 and the system resources aren't available for that. */
10871 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10873 stuff_buffered_input (stuffstring
);
10874 if (cannot_suspend
)
10878 unbind_to (count
, Qnil
);
10880 /* Check if terminal/window size has changed.
10881 Note that this is not useful when we are running directly
10882 with a window system; but suspend should be disabled in that case. */
10883 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10884 if (width
!= old_width
|| height
!= old_height
)
10885 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10887 /* Run suspend-resume-hook. */
10888 if (!NILP (Vrun_hooks
))
10889 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10895 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10896 Then in any case stuff anything Emacs has read ahead and not used. */
10899 stuff_buffered_input (stuffstring
)
10900 Lisp_Object stuffstring
;
10902 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10903 register unsigned char *p
;
10905 if (STRINGP (stuffstring
))
10907 register int count
;
10909 p
= SDATA (stuffstring
);
10910 count
= SBYTES (stuffstring
);
10911 while (count
-- > 0)
10916 /* Anything we have read ahead, put back for the shell to read. */
10917 /* ?? What should this do when we have multiple keyboards??
10918 Should we ignore anything that was typed in at the "wrong" kboard?
10920 rms: we should stuff everything back into the kboard
10922 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10925 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10926 kbd_fetch_ptr
= kbd_buffer
;
10927 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10928 stuff_char (kbd_fetch_ptr
->code
);
10930 clear_event (kbd_fetch_ptr
);
10934 #endif /* SIGTSTP */
10938 set_waiting_for_input (time_to_clear
)
10939 EMACS_TIME
*time_to_clear
;
10941 input_available_clear_time
= time_to_clear
;
10943 /* Tell handle_interrupt to throw back to read_char, */
10944 waiting_for_input
= 1;
10946 /* If handle_interrupt was called before and buffered a C-g,
10947 make it run again now, to avoid timing error. */
10948 if (!NILP (Vquit_flag
))
10949 quit_throw_to_read_char ();
10953 clear_waiting_for_input ()
10955 /* Tell handle_interrupt not to throw back to read_char, */
10956 waiting_for_input
= 0;
10957 input_available_clear_time
= 0;
10960 /* The SIGINT handler.
10962 If we have a frame on the controlling tty, we assume that the
10963 SIGINT was generated by C-g, so we call handle_interrupt.
10964 Otherwise, the handler kills Emacs. */
10967 interrupt_signal (signalnum
) /* If we don't have an argument, */
10968 int signalnum
; /* some compilers complain in signal calls. */
10970 /* Must preserve main program's value of errno. */
10971 int old_errno
= errno
;
10972 struct terminal
*terminal
;
10974 #if defined (USG) && !defined (POSIX_SIGNALS)
10975 /* USG systems forget handlers when they are used;
10976 must reestablish each time */
10977 signal (SIGINT
, interrupt_signal
);
10978 signal (SIGQUIT
, interrupt_signal
);
10981 SIGNAL_THREAD_CHECK (signalnum
);
10983 /* See if we have an active terminal on our controlling tty. */
10984 terminal
= get_named_tty ("/dev/tty");
10987 /* If there are no frames there, let's pretend that we are a
10988 well-behaving UN*X program and quit. */
10989 Fkill_emacs (Qnil
);
10993 /* Otherwise, the SIGINT was probably generated by C-g. */
10995 /* Set internal_last_event_frame to the top frame of the
10996 controlling tty, if we have a frame there. We disable the
10997 interrupt key on secondary ttys, so the SIGINT must have come
10998 from the controlling tty. */
10999 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11001 handle_interrupt ();
11007 /* This routine is called at interrupt level in response to C-g.
11009 It is called from the SIGINT handler or kbd_buffer_store_event.
11011 If `waiting_for_input' is non zero, then unless `echoing' is
11012 nonzero, immediately throw back to read_char.
11014 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11015 eval to throw, when it gets a chance. If quit-flag is already
11016 non-nil, it stops the job right away. */
11019 handle_interrupt ()
11025 /* XXX This code needs to be revised for multi-tty support. */
11026 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
11028 /* If SIGINT isn't blocked, don't let us be interrupted by
11029 another SIGINT, it might be harmful due to non-reentrancy
11030 in I/O functions. */
11031 sigblock (sigmask (SIGINT
));
11034 reset_all_sys_modes ();
11036 #ifdef SIGTSTP /* Support possible in later USG versions */
11038 * On systems which can suspend the current process and return to the original
11039 * shell, this command causes the user to end up back at the shell.
11040 * The "Auto-save" and "Abort" questions are not asked until
11041 * the user elects to return to emacs, at which point he can save the current
11042 * job and either dump core or continue.
11046 /* Perhaps should really fork an inferior shell?
11047 But that would not provide any way to get back
11048 to the original shell, ever. */
11049 printf ("No support for stopping a process on this operating system;\n");
11050 printf ("you can continue or abort.\n");
11051 #endif /* not SIGTSTP */
11053 /* We must remain inside the screen area when the internal terminal
11054 is used. Note that [Enter] is not echoed by dos. */
11055 cursor_to (SELECTED_FRAME (), 0, 0);
11057 /* It doesn't work to autosave while GC is in progress;
11058 the code used for auto-saving doesn't cope with the mark bit. */
11059 if (!gc_in_progress
)
11061 printf ("Auto-save? (y or n) ");
11063 if (((c
= getchar ()) & ~040) == 'Y')
11065 Fdo_auto_save (Qt
, Qnil
);
11067 printf ("\r\nAuto-save done");
11068 #else /* not MSDOS */
11069 printf ("Auto-save done\n");
11070 #endif /* not MSDOS */
11072 while (c
!= '\n') c
= getchar ();
11076 /* During GC, it must be safe to reenable quitting again. */
11077 Vinhibit_quit
= Qnil
;
11080 #endif /* not MSDOS */
11081 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11082 printf ("but will instead do a real quit after garbage collection ends\r\n");
11087 printf ("\r\nAbort? (y or n) ");
11088 #else /* not MSDOS */
11089 printf ("Abort (and dump core)? (y or n) ");
11090 #endif /* not MSDOS */
11092 if (((c
= getchar ()) & ~040) == 'Y')
11094 while (c
!= '\n') c
= getchar ();
11096 printf ("\r\nContinuing...\r\n");
11097 #else /* not MSDOS */
11098 printf ("Continuing...\n");
11099 #endif /* not MSDOS */
11101 init_all_sys_modes ();
11106 /* If executing a function that wants to be interrupted out of
11107 and the user has not deferred quitting by binding `inhibit-quit'
11108 then quit right away. */
11109 if (immediate_quit
&& NILP (Vinhibit_quit
))
11111 struct gl_state_s saved
;
11112 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11114 immediate_quit
= 0;
11117 GCPRO4 (saved
.object
, saved
.global_code
,
11118 saved
.current_syntax_table
, saved
.old_prop
);
11119 Fsignal (Qquit
, Qnil
);
11124 /* Else request quit when it's safe */
11128 /* TODO: The longjmp in this call throws the NS event loop integration off,
11129 and it seems to do fine without this. Probably some attention
11130 needs to be paid to the setting of waiting_for_input in
11131 wait_reading_process_output() under HAVE_NS because of the call
11132 to ns_select there (needed because otherwise events aren't picked up
11133 outside of polling since we don't get SIGIO like X and we don't have a
11134 separate event loop thread like W32. */
11136 if (waiting_for_input
&& !echoing
)
11137 quit_throw_to_read_char ();
11141 /* Handle a C-g by making read_char return C-g. */
11144 quit_throw_to_read_char ()
11147 /* Prevent another signal from doing this before we finish. */
11148 clear_waiting_for_input ();
11151 Vunread_command_events
= Qnil
;
11152 unread_command_char
= -1;
11154 #if 0 /* Currently, sit_for is called from read_char without turning
11155 off polling. And that can call set_waiting_for_input.
11156 It seems to be harmless. */
11157 #ifdef POLL_FOR_INPUT
11158 /* May be > 1 if in recursive minibuffer. */
11159 if (poll_suppress_count
== 0)
11163 if (FRAMEP (internal_last_event_frame
)
11164 && !EQ (internal_last_event_frame
, selected_frame
))
11165 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11168 _longjmp (getcjmp
, 1);
11171 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11172 doc
: /* Set interrupt mode of reading keyboard input.
11173 If INTERRUPT is non-nil, Emacs will use input interrupts;
11174 otherwise Emacs uses CBREAK mode.
11176 See also `current-input-mode'. */)
11178 Lisp_Object interrupt
;
11180 int new_interrupt_input
;
11182 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11183 #ifdef HAVE_X_WINDOWS
11184 if (x_display_list
!= NULL
)
11186 /* When using X, don't give the user a real choice,
11187 because we haven't implemented the mechanisms to support it. */
11188 #ifdef NO_SOCK_SIGIO
11189 new_interrupt_input
= 0;
11190 #else /* not NO_SOCK_SIGIO */
11191 new_interrupt_input
= 1;
11192 #endif /* NO_SOCK_SIGIO */
11195 #endif /* HAVE_X_WINDOWS */
11196 new_interrupt_input
= !NILP (interrupt
);
11197 #else /* not SIGIO */
11198 new_interrupt_input
= 0;
11199 #endif /* not SIGIO */
11201 if (new_interrupt_input
!= interrupt_input
)
11203 #ifdef POLL_FOR_INPUT
11207 /* this causes startup screen to be restored and messes with the mouse */
11208 reset_all_sys_modes ();
11210 interrupt_input
= new_interrupt_input
;
11212 init_all_sys_modes ();
11215 #ifdef POLL_FOR_INPUT
11216 poll_suppress_count
= 1;
11223 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11224 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11225 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11226 C-q in key sequences.
11228 This setting only has an effect on tty terminals and only when
11229 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11231 See also `current-input-mode'. */)
11233 Lisp_Object flow
, terminal
;
11235 struct terminal
*t
= get_terminal (terminal
, 1);
11236 struct tty_display_info
*tty
;
11237 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11239 tty
= t
->display_info
.tty
;
11241 if (tty
->flow_control
!= !NILP (flow
))
11244 /* this causes startup screen to be restored and messes with the mouse */
11245 reset_sys_modes (tty
);
11248 tty
->flow_control
= !NILP (flow
);
11251 init_sys_modes (tty
);
11257 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11258 doc
: /* Enable or disable 8-bit input on TERMINAL.
11259 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11260 bit as the Meta modifier.
11262 If META is nil, Emacs will ignore the top bit, on the assumption it is
11265 Otherwise, Emacs will accept and pass through 8-bit input without
11266 specially interpreting the top bit.
11268 This setting only has an effect on tty terminal devices.
11270 Optional parameter TERMINAL specifies the tty terminal device to use.
11271 It may be a terminal id, a frame, or nil for the terminal used by the
11272 currently selected frame.
11274 See also `current-input-mode'. */)
11276 Lisp_Object meta
, terminal
;
11278 struct terminal
*t
= get_terminal (terminal
, 1);
11279 struct tty_display_info
*tty
;
11282 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11284 tty
= t
->display_info
.tty
;
11288 else if (EQ (meta
, Qt
))
11293 if (tty
->meta_key
!= new_meta
)
11296 /* this causes startup screen to be restored and messes with the mouse */
11297 reset_sys_modes (tty
);
11300 tty
->meta_key
= new_meta
;
11303 init_sys_modes (tty
);
11309 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11310 doc
: /* Specify character used for quitting.
11311 QUIT must be an ASCII character.
11313 This function only has an effect on the controlling tty of the Emacs
11316 See also `current-input-mode'. */)
11320 struct terminal
*t
= get_named_tty ("/dev/tty");
11321 struct tty_display_info
*tty
;
11322 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11324 tty
= t
->display_info
.tty
;
11326 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11327 error ("QUIT must be an ASCII character");
11330 /* this causes startup screen to be restored and messes with the mouse */
11331 reset_sys_modes (tty
);
11334 /* Don't let this value be out of range. */
11335 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11338 init_sys_modes (tty
);
11344 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11345 doc
: /* Set mode of reading keyboard input.
11346 First arg INTERRUPT non-nil means use input interrupts;
11347 nil means use CBREAK mode.
11348 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11349 (no effect except in CBREAK mode).
11350 Third arg META t means accept 8-bit input (for a Meta key).
11351 META nil means ignore the top bit, on the assumption it is parity.
11352 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11353 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11354 See also `current-input-mode'. */)
11355 (interrupt
, flow
, meta
, quit
)
11356 Lisp_Object interrupt
, flow
, meta
, quit
;
11358 Fset_input_interrupt_mode (interrupt
);
11359 Fset_output_flow_control (flow
, Qnil
);
11360 Fset_input_meta_mode (meta
, Qnil
);
11362 Fset_quit_char (quit
);
11366 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11367 doc
: /* Return information about the way Emacs currently reads keyboard input.
11368 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11369 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11370 nil, Emacs is using CBREAK mode.
11371 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11372 terminal; this does not apply if Emacs uses interrupt-driven input.
11373 META is t if accepting 8-bit input with 8th bit as Meta flag.
11374 META nil means ignoring the top bit, on the assumption it is parity.
11375 META is neither t nor nil if accepting 8-bit input and using
11376 all 8 bits as the character code.
11377 QUIT is the character Emacs currently uses to quit.
11378 The elements of this list correspond to the arguments of
11379 `set-input-mode'. */)
11382 Lisp_Object val
[4];
11383 struct frame
*sf
= XFRAME (selected_frame
);
11385 val
[0] = interrupt_input
? Qt
: Qnil
;
11386 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11388 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11389 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11391 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11398 XSETFASTINT (val
[3], quit_char
);
11400 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11403 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11404 doc
: /* Return position information for pixel coordinates X and Y.
11405 By default, X and Y are relative to text area of the selected window.
11406 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11407 If optional fourth arg WHOLE is non-nil, X is relative to the left
11408 edge of the window.
11410 The return value is similar to a mouse click position:
11411 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11412 IMAGE (DX . DY) (WIDTH . HEIGHT))
11413 The `posn-' functions access elements of such lists. */)
11414 (x
, y
, frame_or_window
, whole
)
11415 Lisp_Object x
, y
, frame_or_window
, whole
;
11420 if (NILP (frame_or_window
))
11421 frame_or_window
= selected_window
;
11423 if (WINDOWP (frame_or_window
))
11427 CHECK_LIVE_WINDOW (frame_or_window
);
11429 w
= XWINDOW (frame_or_window
);
11430 XSETINT (x
, (XINT (x
)
11431 + WINDOW_LEFT_EDGE_X (w
)
11433 ? window_box_left_offset (w
, TEXT_AREA
)
11435 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11436 frame_or_window
= w
->frame
;
11439 CHECK_LIVE_FRAME (frame_or_window
);
11441 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11444 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11445 doc
: /* Return position information for buffer POS in WINDOW.
11446 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11448 Return nil if position is not visible in window. Otherwise,
11449 the return value is similar to that returned by `event-start' for
11450 a mouse click at the upper left corner of the glyph corresponding
11451 to the given buffer position:
11452 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11453 IMAGE (DX . DY) (WIDTH . HEIGHT))
11454 The `posn-' functions access elements of such lists. */)
11456 Lisp_Object pos
, window
;
11461 window
= selected_window
;
11463 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11466 Lisp_Object x
= XCAR (tem
);
11467 Lisp_Object y
= XCAR (XCDR (tem
));
11469 /* Point invisible due to hscrolling? */
11472 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11480 * Set up a new kboard object with reasonable initial values.
11486 kb
->Voverriding_terminal_local_map
= Qnil
;
11487 kb
->Vlast_command
= Qnil
;
11488 kb
->Vreal_last_command
= Qnil
;
11489 kb
->Vkeyboard_translate_table
= Qnil
;
11490 kb
->Vlast_repeatable_command
= Qnil
;
11491 kb
->Vprefix_arg
= Qnil
;
11492 kb
->Vlast_prefix_arg
= Qnil
;
11493 kb
->kbd_queue
= Qnil
;
11494 kb
->kbd_queue_has_data
= 0;
11495 kb
->immediate_echo
= 0;
11496 kb
->echo_string
= Qnil
;
11497 kb
->echo_after_prompt
= -1;
11498 kb
->kbd_macro_buffer
= 0;
11499 kb
->kbd_macro_bufsize
= 0;
11500 kb
->defining_kbd_macro
= Qnil
;
11501 kb
->Vlast_kbd_macro
= Qnil
;
11502 kb
->reference_count
= 0;
11503 kb
->Vsystem_key_alist
= Qnil
;
11504 kb
->system_key_syms
= Qnil
;
11505 kb
->Vwindow_system
= Qt
; /* Unset. */
11506 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11507 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11508 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11509 kb
->Vdefault_minibuffer_frame
= Qnil
;
11513 * Destroy the contents of a kboard object, but not the object itself.
11514 * We use this just before deleting it, or if we're going to initialize
11515 * it a second time.
11521 xfree (kb
->kbd_macro_buffer
);
11524 /* Free KB and memory referenced from it. */
11532 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11535 *kbp
= kb
->next_kboard
;
11537 /* Prevent a dangling reference to KB. */
11538 if (kb
== current_kboard
11539 && FRAMEP (selected_frame
)
11540 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11542 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11544 if (current_kboard
== kb
)
11555 /* This is correct before outermost invocation of the editor loop */
11556 command_loop_level
= -1;
11557 immediate_quit
= 0;
11558 quit_char
= Ctl ('g');
11559 Vunread_command_events
= Qnil
;
11560 unread_command_char
= -1;
11561 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11563 recent_keys_index
= 0;
11564 kbd_fetch_ptr
= kbd_buffer
;
11565 kbd_store_ptr
= kbd_buffer
;
11566 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11567 do_mouse_tracking
= Qnil
;
11570 interrupt_input_blocked
= 0;
11571 interrupt_input_pending
= 0;
11573 pending_signals
= 0;
11576 /* This means that command_loop_1 won't try to select anything the first
11578 internal_last_event_frame
= Qnil
;
11579 Vlast_event_frame
= internal_last_event_frame
;
11581 current_kboard
= initial_kboard
;
11582 /* Re-initialize the keyboard again. */
11583 wipe_kboard (current_kboard
);
11584 init_kboard (current_kboard
);
11585 /* A value of nil for Vwindow_system normally means a tty, but we also use
11586 it for the initial terminal since there is no window system there. */
11587 current_kboard
->Vwindow_system
= Qnil
;
11589 if (!noninteractive
)
11591 /* Before multi-tty support, these handlers used to be installed
11592 only if the current session was a tty session. Now an Emacs
11593 session may have multiple display types, so we always handle
11594 SIGINT. There is special code in interrupt_signal to exit
11595 Emacs on SIGINT when there are no termcap frames on the
11596 controlling terminal. */
11597 signal (SIGINT
, interrupt_signal
);
11598 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11599 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11600 SIGQUIT and we can't tell which one it will give us. */
11601 signal (SIGQUIT
, interrupt_signal
);
11602 #endif /* HAVE_TERMIO */
11604 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11606 if (!noninteractive
)
11607 signal (SIGIO
, input_available_signal
);
11610 /* Use interrupt input by default, if it works and noninterrupt input
11611 has deficiencies. */
11613 #ifdef INTERRUPT_INPUT
11614 interrupt_input
= 1;
11616 interrupt_input
= 0;
11622 if (keyboard_init_hook
)
11623 (*keyboard_init_hook
) ();
11625 #ifdef POLL_FOR_INPUT
11626 poll_suppress_count
= 1;
11631 /* This type's only use is in syms_of_keyboard, to initialize the
11632 event header symbols and put properties on them. */
11633 struct event_head
{
11639 struct event_head head_table
[] = {
11640 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11641 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11642 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11643 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11644 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11645 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11646 /* `select-window' should be handled just like `switch-frame'
11647 in read_key_sequence. */
11648 {&Qselect_window
, "select-window", &Qswitch_frame
}
11652 syms_of_keyboard ()
11654 pending_funcalls
= Qnil
;
11656 Vlispy_mouse_stem
= build_string ("mouse");
11657 staticpro (&Vlispy_mouse_stem
);
11660 QCimage
= intern (":image");
11661 staticpro (&QCimage
);
11663 staticpro (&Qhelp_echo
);
11664 Qhelp_echo
= intern ("help-echo");
11667 Qrtl
= intern (":rtl");
11669 staticpro (&item_properties
);
11670 item_properties
= Qnil
;
11672 staticpro (&tool_bar_item_properties
);
11673 tool_bar_item_properties
= Qnil
;
11674 staticpro (&tool_bar_items_vector
);
11675 tool_bar_items_vector
= Qnil
;
11677 staticpro (&real_this_command
);
11678 real_this_command
= Qnil
;
11680 Qtimer_event_handler
= intern ("timer-event-handler");
11681 staticpro (&Qtimer_event_handler
);
11683 Qdisabled_command_function
= intern ("disabled-command-function");
11684 staticpro (&Qdisabled_command_function
);
11686 Qself_insert_command
= intern ("self-insert-command");
11687 staticpro (&Qself_insert_command
);
11689 Qforward_char
= intern ("forward-char");
11690 staticpro (&Qforward_char
);
11692 Qbackward_char
= intern ("backward-char");
11693 staticpro (&Qbackward_char
);
11695 Qdisabled
= intern ("disabled");
11696 staticpro (&Qdisabled
);
11698 Qundefined
= intern ("undefined");
11699 staticpro (&Qundefined
);
11701 Qpre_command_hook
= intern ("pre-command-hook");
11702 staticpro (&Qpre_command_hook
);
11704 Qpost_command_hook
= intern ("post-command-hook");
11705 staticpro (&Qpost_command_hook
);
11707 Qdeferred_action_function
= intern ("deferred-action-function");
11708 staticpro (&Qdeferred_action_function
);
11710 Qcommand_hook_internal
= intern ("command-hook-internal");
11711 staticpro (&Qcommand_hook_internal
);
11713 Qfunction_key
= intern ("function-key");
11714 staticpro (&Qfunction_key
);
11715 Qmouse_click
= intern ("mouse-click");
11716 staticpro (&Qmouse_click
);
11717 #if defined (WINDOWSNT)
11718 Qlanguage_change
= intern ("language-change");
11719 staticpro (&Qlanguage_change
);
11721 Qdrag_n_drop
= intern ("drag-n-drop");
11722 staticpro (&Qdrag_n_drop
);
11724 Qsave_session
= intern ("save-session");
11725 staticpro (&Qsave_session
);
11728 Qdbus_event
= intern ("dbus-event");
11729 staticpro (&Qdbus_event
);
11732 Qmenu_enable
= intern ("menu-enable");
11733 staticpro (&Qmenu_enable
);
11734 Qmenu_alias
= intern ("menu-alias");
11735 staticpro (&Qmenu_alias
);
11736 QCenable
= intern (":enable");
11737 staticpro (&QCenable
);
11738 QCvisible
= intern (":visible");
11739 staticpro (&QCvisible
);
11740 QChelp
= intern (":help");
11741 staticpro (&QChelp
);
11742 QCfilter
= intern (":filter");
11743 staticpro (&QCfilter
);
11744 QCbutton
= intern (":button");
11745 staticpro (&QCbutton
);
11746 QCkeys
= intern (":keys");
11747 staticpro (&QCkeys
);
11748 QCkey_sequence
= intern (":key-sequence");
11749 staticpro (&QCkey_sequence
);
11750 QCtoggle
= intern (":toggle");
11751 staticpro (&QCtoggle
);
11752 QCradio
= intern (":radio");
11753 staticpro (&QCradio
);
11755 Qmode_line
= intern ("mode-line");
11756 staticpro (&Qmode_line
);
11757 Qvertical_line
= intern ("vertical-line");
11758 staticpro (&Qvertical_line
);
11759 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11760 staticpro (&Qvertical_scroll_bar
);
11761 Qmenu_bar
= intern ("menu-bar");
11762 staticpro (&Qmenu_bar
);
11764 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11765 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11766 staticpro (&Qmouse_fixup_help_message
);
11769 Qabove_handle
= intern ("above-handle");
11770 staticpro (&Qabove_handle
);
11771 Qhandle
= intern ("handle");
11772 staticpro (&Qhandle
);
11773 Qbelow_handle
= intern ("below-handle");
11774 staticpro (&Qbelow_handle
);
11775 Qup
= intern ("up");
11777 Qdown
= intern ("down");
11778 staticpro (&Qdown
);
11779 Qtop
= intern ("top");
11781 Qbottom
= intern ("bottom");
11782 staticpro (&Qbottom
);
11783 Qend_scroll
= intern ("end-scroll");
11784 staticpro (&Qend_scroll
);
11785 Qratio
= intern ("ratio");
11786 staticpro (&Qratio
);
11788 Qevent_kind
= intern ("event-kind");
11789 staticpro (&Qevent_kind
);
11790 Qevent_symbol_elements
= intern ("event-symbol-elements");
11791 staticpro (&Qevent_symbol_elements
);
11792 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11793 staticpro (&Qevent_symbol_element_mask
);
11794 Qmodifier_cache
= intern ("modifier-cache");
11795 staticpro (&Qmodifier_cache
);
11797 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11798 staticpro (&Qrecompute_lucid_menubar
);
11799 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11800 staticpro (&Qactivate_menubar_hook
);
11802 Qpolling_period
= intern ("polling-period");
11803 staticpro (&Qpolling_period
);
11805 Qinput_method_function
= intern ("input-method-function");
11806 staticpro (&Qinput_method_function
);
11808 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11809 staticpro (&Qinput_method_exit_on_first_char
);
11810 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11811 staticpro (&Qinput_method_use_echo_area
);
11813 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11814 Fset (Qinput_method_use_echo_area
, Qnil
);
11816 last_point_position_buffer
= Qnil
;
11817 last_point_position_window
= Qnil
;
11820 struct event_head
*p
;
11822 for (p
= head_table
;
11823 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11826 *p
->var
= intern (p
->name
);
11827 staticpro (p
->var
);
11828 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11829 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11833 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11834 staticpro (&button_down_location
);
11835 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11836 staticpro (&mouse_syms
);
11837 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11838 staticpro (&wheel_syms
);
11842 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11844 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11845 for (i
= 0; i
< len
; i
++)
11846 if (modifier_names
[i
])
11847 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11848 staticpro (&modifier_symbols
);
11851 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11852 staticpro (&recent_keys
);
11854 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11855 staticpro (&this_command_keys
);
11857 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11858 staticpro (&raw_keybuf
);
11860 Qextended_command_history
= intern ("extended-command-history");
11861 Fset (Qextended_command_history
, Qnil
);
11862 staticpro (&Qextended_command_history
);
11864 accent_key_syms
= Qnil
;
11865 staticpro (&accent_key_syms
);
11867 func_key_syms
= Qnil
;
11868 staticpro (&func_key_syms
);
11870 drag_n_drop_syms
= Qnil
;
11871 staticpro (&drag_n_drop_syms
);
11873 unread_switch_frame
= Qnil
;
11874 staticpro (&unread_switch_frame
);
11876 internal_last_event_frame
= Qnil
;
11877 staticpro (&internal_last_event_frame
);
11879 read_key_sequence_cmd
= Qnil
;
11880 staticpro (&read_key_sequence_cmd
);
11882 menu_bar_one_keymap_changed_items
= Qnil
;
11883 staticpro (&menu_bar_one_keymap_changed_items
);
11885 menu_bar_items_vector
= Qnil
;
11886 staticpro (&menu_bar_items_vector
);
11888 help_form_saved_window_configs
= Qnil
;
11889 staticpro (&help_form_saved_window_configs
);
11891 defsubr (&Scurrent_idle_time
);
11892 defsubr (&Sevent_symbol_parse_modifiers
);
11893 defsubr (&Sevent_convert_list
);
11894 defsubr (&Sread_key_sequence
);
11895 defsubr (&Sread_key_sequence_vector
);
11896 defsubr (&Srecursive_edit
);
11897 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11898 defsubr (&Strack_mouse
);
11900 defsubr (&Sinput_pending_p
);
11901 defsubr (&Scommand_execute
);
11902 defsubr (&Srecent_keys
);
11903 defsubr (&Sthis_command_keys
);
11904 defsubr (&Sthis_command_keys_vector
);
11905 defsubr (&Sthis_single_command_keys
);
11906 defsubr (&Sthis_single_command_raw_keys
);
11907 defsubr (&Sreset_this_command_lengths
);
11908 defsubr (&Sclear_this_command_keys
);
11909 defsubr (&Ssuspend_emacs
);
11910 defsubr (&Sabort_recursive_edit
);
11911 defsubr (&Sexit_recursive_edit
);
11912 defsubr (&Srecursion_depth
);
11913 defsubr (&Stop_level
);
11914 defsubr (&Sdiscard_input
);
11915 defsubr (&Sopen_dribble_file
);
11916 defsubr (&Sset_input_interrupt_mode
);
11917 defsubr (&Sset_output_flow_control
);
11918 defsubr (&Sset_input_meta_mode
);
11919 defsubr (&Sset_quit_char
);
11920 defsubr (&Sset_input_mode
);
11921 defsubr (&Scurrent_input_mode
);
11922 defsubr (&Sexecute_extended_command
);
11923 defsubr (&Sposn_at_point
);
11924 defsubr (&Sposn_at_x_y
);
11926 DEFVAR_LISP ("last-command-event", &last_command_event
,
11927 doc
: /* Last input event that was part of a command. */);
11929 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11930 doc
: /* Last input event in a command, except for mouse menu events.
11931 Mouse menus give back keys that don't look like mouse events;
11932 this variable holds the actual mouse event that led to the menu,
11933 so that you can determine whether the command was run by mouse or not. */);
11935 DEFVAR_LISP ("last-input-event", &last_input_event
,
11936 doc
: /* Last input event. */);
11938 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11939 doc
: /* List of events to be read as the command input.
11940 These events are processed first, before actual keyboard input.
11941 Events read from this list are not normally added to `this-command-keys',
11942 as they will already have been added once as they were read for the first time.
11943 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11944 Vunread_command_events
= Qnil
;
11946 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11947 doc
: /* If not -1, an object to be read as next command input event. */);
11949 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11950 doc
: /* List of events to be processed as input by input methods.
11951 These events are processed before `unread-command-events'
11952 and actual keyboard input, but are not given to `input-method-function'. */);
11953 Vunread_post_input_method_events
= Qnil
;
11955 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11956 doc
: /* List of events to be processed as input by input methods.
11957 These events are processed after `unread-command-events', but
11958 before actual keyboard input.
11959 If there's an active input method, the events are given to
11960 `input-method-function'. */);
11961 Vunread_input_method_events
= Qnil
;
11963 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11964 doc
: /* Meta-prefix character code.
11965 Meta-foo as command input turns into this character followed by foo. */);
11966 XSETINT (meta_prefix_char
, 033);
11968 DEFVAR_KBOARD ("last-command", Vlast_command
,
11969 doc
: /* The last command executed.
11970 Normally a symbol with a function definition, but can be whatever was found
11971 in the keymap, or whatever the variable `this-command' was set to by that
11974 The value `mode-exit' is special; it means that the previous command
11975 read an event that told it to exit, and it did so and unread that event.
11976 In other words, the present command is the event that made the previous
11979 The value `kill-region' is special; it means that the previous command
11980 was a kill command.
11982 `last-command' has a separate binding for each terminal device.
11983 See Info node `(elisp)Multiple displays'. */);
11985 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11986 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11988 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11989 doc
: /* Last command that may be repeated.
11990 The last command executed that was not bound to an input event.
11991 This is the command `repeat' will try to repeat. */);
11993 DEFVAR_LISP ("this-command", &Vthis_command
,
11994 doc
: /* The command now being executed.
11995 The command can set this variable; whatever is put here
11996 will be in `last-command' during the following command. */);
11997 Vthis_command
= Qnil
;
11999 DEFVAR_LISP ("this-command-keys-shift-translated",
12000 &Vthis_command_keys_shift_translated
,
12001 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12002 Shift-translation occurs when there is no binding for the key sequence
12003 as entered, but a binding was found by changing an upper-case letter
12004 to lower-case, or a shifted function key to an unshifted one. */);
12005 Vthis_command_keys_shift_translated
= Qnil
;
12007 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12008 doc
: /* The command bound to the current key sequence before remapping.
12009 It equals `this-command' if the original command was not remapped through
12010 any of the active keymaps. Otherwise, the value of `this-command' is the
12011 result of looking up the original command in the active keymaps. */);
12012 Vthis_original_command
= Qnil
;
12014 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12015 doc
: /* *Number of input events between auto-saves.
12016 Zero means disable autosaving due to number of characters typed. */);
12017 auto_save_interval
= 300;
12019 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12020 doc
: /* *Number of seconds idle time before auto-save.
12021 Zero or nil means disable auto-saving due to idleness.
12022 After auto-saving due to this many seconds of idle time,
12023 Emacs also does a garbage collection if that seems to be warranted. */);
12024 XSETFASTINT (Vauto_save_timeout
, 30);
12026 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12027 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12028 The value may be integer or floating point. */);
12029 Vecho_keystrokes
= make_number (1);
12031 DEFVAR_INT ("polling-period", &polling_period
,
12032 doc
: /* *Interval between polling for input during Lisp execution.
12033 The reason for polling is to make C-g work to stop a running program.
12034 Polling is needed only when using X windows and SIGIO does not work.
12035 Polling is automatically disabled in all other cases. */);
12036 polling_period
= 2;
12038 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12039 doc
: /* *Maximum time between mouse clicks to make a double-click.
12040 Measured in milliseconds. The value nil means disable double-click
12041 recognition; t means double-clicks have no time limit and are detected
12042 by position only. */);
12043 Vdouble_click_time
= make_number (500);
12045 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12046 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12047 On window-system frames, value is the number of pixels the mouse may have
12048 moved horizontally or vertically between two clicks to make a double-click.
12049 On non window-system frames, value is interpreted in units of 1/8 characters
12052 This variable is also the threshold for motion of the mouse
12053 to count as a drag. */);
12054 double_click_fuzz
= 3;
12056 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12057 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12058 inhibit_local_menu_bar_menus
= 0;
12060 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12061 doc
: /* Number of complete key sequences read as input so far.
12062 This includes key sequences read from keyboard macros.
12063 The number is effectively the number of interactive command invocations. */);
12064 num_input_keys
= 0;
12066 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12067 doc
: /* Number of input events read from the keyboard so far.
12068 This does not include events generated by keyboard macros. */);
12069 num_nonmacro_input_events
= 0;
12071 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12072 doc
: /* The frame in which the most recently read event occurred.
12073 If the last event came from a keyboard macro, this is set to `macro'. */);
12074 Vlast_event_frame
= Qnil
;
12076 /* This variable is set up in sysdep.c. */
12077 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12078 doc
: /* The ERASE character as set by the user with stty. */);
12080 DEFVAR_LISP ("help-char", &Vhelp_char
,
12081 doc
: /* Character to recognize as meaning Help.
12082 When it is read, do `(eval help-form)', and display result if it's a string.
12083 If the value of `help-form' is nil, this char can be read normally. */);
12084 XSETINT (Vhelp_char
, Ctl ('H'));
12086 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12087 doc
: /* List of input events to recognize as meaning Help.
12088 These work just like the value of `help-char' (see that). */);
12089 Vhelp_event_list
= Qnil
;
12091 DEFVAR_LISP ("help-form", &Vhelp_form
,
12092 doc
: /* Form to execute when character `help-char' is read.
12093 If the form returns a string, that string is displayed.
12094 If `help-form' is nil, the help char is not recognized. */);
12097 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12098 doc
: /* Command to run when `help-char' character follows a prefix key.
12099 This command is used only when there is no actual binding
12100 for that character after that prefix key. */);
12101 Vprefix_help_command
= Qnil
;
12103 DEFVAR_LISP ("top-level", &Vtop_level
,
12104 doc
: /* Form to evaluate when Emacs starts up.
12105 Useful to set before you dump a modified Emacs. */);
12108 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12109 doc
: /* Translate table for local keyboard input, or nil.
12110 If non-nil, the value should be a char-table. Each character read
12111 from the keyboard is looked up in this char-table. If the value found
12112 there is non-nil, then it is used instead of the actual input character.
12114 The value can also be a string or vector, but this is considered obsolete.
12115 If it is a string or vector of length N, character codes N and up are left
12116 untranslated. In a vector, an element which is nil means "no translation".
12118 This is applied to the characters supplied to input methods, not their
12119 output. See also `translation-table-for-input'.
12121 This variable has a separate binding for each terminal. See Info node
12122 `(elisp)Multiple displays'. */);
12124 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12125 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12126 \(Even if the operating system has support for stopping a process.\) */);
12127 cannot_suspend
= 0;
12129 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12130 doc
: /* Non-nil means prompt with menus when appropriate.
12131 This is done when reading from a keymap that has a prompt string,
12132 for elements that have prompt strings.
12133 The menu is displayed on the screen
12134 if X menus were enabled at configuration
12135 time and the previous event was a mouse click prefix key.
12136 Otherwise, menu prompting uses the echo area. */);
12137 menu_prompting
= 1;
12139 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12140 doc
: /* Character to see next line of menu prompt.
12141 Type this character while in a menu prompt to rotate around the lines of it. */);
12142 XSETINT (menu_prompt_more_char
, ' ');
12144 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12145 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12146 Emacs applies the modifiers of the character stored here to each keyboard
12147 character it reads. For example, after evaluating the expression
12148 (setq extra-keyboard-modifiers ?\\C-x)
12149 all input characters will have the control modifier applied to them.
12151 Note that the character ?\\C-@, equivalent to the integer zero, does
12152 not count as a control character; rather, it counts as a character
12153 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12154 cancels any modification. */);
12155 extra_keyboard_modifiers
= 0;
12157 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12158 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12159 The command loop sets this to nil before each command,
12160 and tests the value when the command returns.
12161 Buffer modification stores t in this variable. */);
12162 Vdeactivate_mark
= Qnil
;
12163 Qdeactivate_mark
= intern ("deactivate-mark");
12164 staticpro (&Qdeactivate_mark
);
12166 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12167 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12168 Vcommand_hook_internal
= Qnil
;
12170 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12171 doc
: /* Normal hook run before each command is executed.
12172 If an unhandled error happens in running this hook,
12173 the hook value is set to nil, since otherwise the error
12174 might happen repeatedly and make Emacs nonfunctional. */);
12175 Vpre_command_hook
= Qnil
;
12177 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12178 doc
: /* Normal hook run after each command is executed.
12179 If an unhandled error happens in running this hook,
12180 the hook value is set to nil, since otherwise the error
12181 might happen repeatedly and make Emacs nonfunctional. */);
12182 Vpost_command_hook
= Qnil
;
12185 DEFVAR_LISP ("echo-area-clear-hook", ...,
12186 doc
: /* Normal hook run when clearing the echo area. */);
12188 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12189 staticpro (&Qecho_area_clear_hook
);
12190 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12192 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12193 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12194 Vlucid_menu_bar_dirty_flag
= Qnil
;
12196 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12197 doc
: /* List of menu bar items to move to the end of the menu bar.
12198 The elements of the list are event types that may have menu bar bindings. */);
12199 Vmenu_bar_final_items
= Qnil
;
12201 DEFVAR_KBOARD ("overriding-terminal-local-map",
12202 Voverriding_terminal_local_map
,
12203 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12204 If this variable is non-nil, it is used as a keymap instead of the
12205 buffer's local map, and the minor mode keymaps and text property keymaps.
12206 It also replaces `overriding-local-map'.
12208 This variable is intended to let commands such as `universal-argument'
12209 set up a different keymap for reading the next command.
12211 `overriding-terminal-local-map' has a separate binding for each
12213 See Info node `(elisp)Multiple displays'. */);
12215 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12216 doc
: /* Keymap that overrides all other local keymaps.
12217 If this variable is non-nil, it is used as a keymap--replacing the
12218 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12219 Voverriding_local_map
= Qnil
;
12221 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12222 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12223 Otherwise, the menu bar continues to reflect the buffer's local map
12224 and the minor mode maps regardless of `overriding-local-map'. */);
12225 Voverriding_local_map_menu_flag
= Qnil
;
12227 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12228 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12229 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12231 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12232 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12234 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12235 doc
: /* Alist of system-specific X windows key symbols.
12236 Each element should have the form (N . SYMBOL) where N is the
12237 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12238 and SYMBOL is its name.
12240 `system-key-alist' has a separate binding for each terminal device.
12241 See Info node `(elisp)Multiple displays'. */);
12243 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12244 doc
: /* Keymap that translates key sequences to key sequences during input.
12245 This is used mainly for mapping key sequences into some preferred
12246 key events (symbols).
12248 The `read-key-sequence' function replaces any subsequence bound by
12249 `local-function-key-map' with its binding. More precisely, when the
12250 active keymaps have no binding for the current key sequence but
12251 `local-function-key-map' binds a suffix of the sequence to a vector or
12252 string, `read-key-sequence' replaces the matching suffix with its
12253 binding, and continues with the new sequence.
12255 If the binding is a function, it is called with one argument (the prompt)
12256 and its return value (a key sequence) is used.
12258 The events that come from bindings in `local-function-key-map' are not
12259 themselves looked up in `local-function-key-map'.
12261 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12262 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12263 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12264 typing `ESC O P x' would return [f1 x].
12266 `local-function-key-map' has a separate binding for each terminal
12267 device. See Info node `(elisp)Multiple displays'. If you need to
12268 define a binding on all terminals, change `function-key-map'
12269 instead. Initially, `local-function-key-map' is an empty keymap that
12270 has `function-key-map' as its parent on all terminal devices. */);
12272 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12273 doc
: /* Keymap that decodes input escape sequences.
12274 This is used mainly for mapping ASCII function key sequences into
12275 real Emacs function key events (symbols).
12277 The `read-key-sequence' function replaces any subsequence bound by
12278 `input-key-map' with its binding. Contrary to `function-key-map',
12279 this map applies its rebinding regardless of the presence of an ordinary
12280 binding. So it is more like `key-translation-map' except that it applies
12281 before `function-key-map' rather than after.
12283 If the binding is a function, it is called with one argument (the prompt)
12284 and its return value (a key sequence) is used.
12286 The events that come from bindings in `input-decode-map' are not
12287 themselves looked up in `input-decode-map'.
12289 This variable is keyboard-local. */);
12291 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12292 doc
: /* The parent keymap of all `local-function-key-map' instances.
12293 Function key definitions that apply to all terminal devices should go
12294 here. If a mapping is defined in both the current
12295 `local-function-key-map' binding and this variable, then the local
12296 definition will take precendence. */);
12297 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12299 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12300 doc
: /* Keymap of key translations that can override keymaps.
12301 This keymap works like `function-key-map', but comes after that,
12302 and its non-prefix bindings override ordinary bindings.
12303 Another difference is that it is global rather than keyboard-local. */);
12304 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12306 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12307 doc
: /* List of deferred actions to be performed at a later time.
12308 The precise format isn't relevant here; we just check whether it is nil. */);
12309 Vdeferred_action_list
= Qnil
;
12311 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12312 doc
: /* Function to call to handle deferred actions, after each command.
12313 This function is called with no arguments after each command
12314 whenever `deferred-action-list' is non-nil. */);
12315 Vdeferred_action_function
= Qnil
;
12317 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12318 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12319 The value can be a length of time to show the message for.
12320 If the value is non-nil and not a number, we wait 2 seconds. */);
12321 Vsuggest_key_bindings
= Qt
;
12323 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12324 doc
: /* List of active absolute time timers in order of increasing time. */);
12325 Vtimer_list
= Qnil
;
12327 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12328 doc
: /* List of active idle-time timers in order of increasing time. */);
12329 Vtimer_idle_list
= Qnil
;
12331 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12332 doc
: /* If non-nil, the function that implements the current input method.
12333 It's called with one argument, a printing character that was just read.
12334 \(That means a character with code 040...0176.)
12335 Typically this function uses `read-event' to read additional events.
12336 When it does so, it should first bind `input-method-function' to nil
12337 so it will not be called recursively.
12339 The function should return a list of zero or more events
12340 to be used as input. If it wants to put back some events
12341 to be reconsidered, separately, by the input method,
12342 it can add them to the beginning of `unread-command-events'.
12344 The input method function can find in `input-method-previous-method'
12345 the previous echo area message.
12347 The input method function should refer to the variables
12348 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12349 for guidance on what to do. */);
12350 Vinput_method_function
= Qnil
;
12352 DEFVAR_LISP ("input-method-previous-message",
12353 &Vinput_method_previous_message
,
12354 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12355 This variable exists because `read-event' clears the echo area
12356 before running the input method. It is nil if there was no message. */);
12357 Vinput_method_previous_message
= Qnil
;
12359 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12360 doc
: /* If non-nil, the function that implements the display of help.
12361 It's called with one argument, the help string to display. */);
12362 Vshow_help_function
= Qnil
;
12364 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12365 doc
: /* If non-nil, suppress point adjustment after executing a command.
12367 After a command is executed, if point is moved into a region that has
12368 special properties (e.g. composition, display), we adjust point to
12369 the boundary of the region. But, when a command sets this variable to
12370 non-nil, we suppress the point adjustment.
12372 This variable is set to nil before reading a command, and is checked
12373 just after executing the command. */);
12374 Vdisable_point_adjustment
= Qnil
;
12376 DEFVAR_LISP ("global-disable-point-adjustment",
12377 &Vglobal_disable_point_adjustment
,
12378 doc
: /* *If non-nil, always suppress point adjustment.
12380 The default value is nil, in which case, point adjustment are
12381 suppressed only after special commands that set
12382 `disable-point-adjustment' (which see) to non-nil. */);
12383 Vglobal_disable_point_adjustment
= Qnil
;
12385 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12386 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12387 If the value is not a number, such messages don't time out. */);
12388 Vminibuffer_message_timeout
= make_number (2);
12390 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12391 doc
: /* If non-nil, any keyboard input throws to this symbol.
12392 The value of that variable is passed to `quit-flag' and later causes a
12393 peculiar kind of quitting. */);
12394 Vthrow_on_input
= Qnil
;
12396 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12397 doc
: /* If non-nil, function to output error messages.
12398 The arguments are the error data, a list of the form
12399 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12400 such as just as `condition-case' would bind its variable to,
12401 the context (a string which normally goes at the start of the message),
12402 and the Lisp function within which the error was signaled. */);
12403 Vcommand_error_function
= Qnil
;
12405 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12406 &Venable_disabled_menus_and_buttons
,
12407 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12409 Help functions bind this to allow help on disabled menu items
12410 and tool-bar buttons. */);
12411 Venable_disabled_menus_and_buttons
= Qnil
;
12413 /* Create the initial keyboard. */
12414 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12415 init_kboard (initial_kboard
);
12416 /* Vwindow_system is left at t for now. */
12417 initial_kboard
->next_kboard
= all_kboards
;
12418 all_kboards
= initial_kboard
;
12422 keys_of_keyboard ()
12424 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12425 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12426 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12427 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12428 initial_define_key (meta_map
, 'x', "execute-extended-command");
12430 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12431 "handle-delete-frame");
12432 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12433 "ns-put-working-text");
12434 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12435 "ns-unput-working-text");
12436 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12437 current-prefix-arg, as is done in `handle-switch-frame'.
12438 But `handle-switch-frame is not run from the special-map.
12439 Commands from that map are run in a special way that automatically
12440 preserves the prefix-arg. Restoring the prefix arg here is not just
12441 redundant but harmful:
12443 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12444 - after the first prompt, the exit-minibuffer-hook is run which may
12445 iconify a frame and thus push a `iconify-frame' event.
12446 - after running exit-minibuffer-hook, current-prefix-arg is
12447 restored to the non-nil value it had before the prompt.
12448 - we enter the second prompt.
12449 current-prefix-arg is non-nil, prefix-arg is nil.
12450 - before running the first real event, we run the special iconify-frame
12451 event, but we pass the `special' arg to execute-command so
12452 current-prefix-arg and prefix-arg are left untouched.
12453 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12454 - the next key event will have a spuriously non-nil current-prefix-arg. */
12455 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12457 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12459 /* Handling it at such a low-level causes read_key_sequence to get
12460 * confused because it doesn't realize that the current_buffer was
12461 * changed by read_char.
12463 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12464 * "handle-select-window"); */
12465 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12466 "handle-save-session");
12469 /* Define a special event which is raised for dbus callback
12471 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12472 "dbus-handle-event");
12476 /* Mark the pointers in the kboard objects.
12477 Called by the Fgarbage_collector. */
12483 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12485 if (kb
->kbd_macro_buffer
)
12486 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12488 mark_object (kb
->Voverriding_terminal_local_map
);
12489 mark_object (kb
->Vlast_command
);
12490 mark_object (kb
->Vreal_last_command
);
12491 mark_object (kb
->Vkeyboard_translate_table
);
12492 mark_object (kb
->Vlast_repeatable_command
);
12493 mark_object (kb
->Vprefix_arg
);
12494 mark_object (kb
->Vlast_prefix_arg
);
12495 mark_object (kb
->kbd_queue
);
12496 mark_object (kb
->defining_kbd_macro
);
12497 mark_object (kb
->Vlast_kbd_macro
);
12498 mark_object (kb
->Vsystem_key_alist
);
12499 mark_object (kb
->system_key_syms
);
12500 mark_object (kb
->Vwindow_system
);
12501 mark_object (kb
->Vinput_decode_map
);
12502 mark_object (kb
->Vlocal_function_key_map
);
12503 mark_object (kb
->Vdefault_minibuffer_frame
);
12504 mark_object (kb
->echo_string
);
12507 struct input_event
*event
;
12508 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12510 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12511 event
= kbd_buffer
;
12512 if (event
->kind
!= SELECTION_REQUEST_EVENT
12513 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12515 mark_object (event
->x
);
12516 mark_object (event
->y
);
12518 mark_object (event
->frame_or_window
);
12519 mark_object (event
->arg
);
12524 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12525 (do not change this comment) */