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/>. */
29 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #include "syssignal.h"
60 #include <sys/types.h>
69 /* This is to get the definitions of the XK_ symbols. */
76 #endif /* HAVE_NTGUI */
86 /* Variables for blockinput.h: */
88 /* Non-zero if interrupt input is blocked right now. */
89 volatile int interrupt_input_blocked
;
91 /* Nonzero means an input interrupt has arrived
92 during the current critical section. */
93 int interrupt_input_pending
;
95 /* This var should be (interrupt_input_pending || pending_atimers).
96 The QUIT macro checks this instead of interrupt_input_pending and
97 pending_atimers separately, to reduce code size. So, any code that
98 changes interrupt_input_pending or pending_atimers should update
104 #define KBD_BUFFER_SIZE 4096
106 KBOARD
*initial_kboard
;
107 KBOARD
*current_kboard
;
111 /* Non-nil disable property on a command means
112 do not execute it; call disabled-command-function's value instead. */
113 Lisp_Object Qdisabled
, Qdisabled_command_function
;
115 #define NUM_RECENT_KEYS (300)
116 int recent_keys_index
; /* Index for storing next element into recent_keys */
117 int total_keys
; /* Total number of elements stored into recent_keys */
118 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
120 /* Vector holding the key sequence that invoked the current command.
121 It is reused for each command, and it may be longer than the current
122 sequence; this_command_key_count indicates how many elements
123 actually mean something.
124 It's easier to staticpro a single Lisp_Object than an array. */
125 Lisp_Object this_command_keys
;
126 int this_command_key_count
;
128 /* 1 after calling Freset_this_command_lengths.
130 int this_command_key_count_reset
;
132 /* This vector is used as a buffer to record the events that were actually read
133 by read_key_sequence. */
134 Lisp_Object raw_keybuf
;
135 int raw_keybuf_count
;
137 /* Non-nil if the present key sequence was obtained by shift translation. */
138 Lisp_Object Vthis_command_keys_shift_translated
;
140 #define GROW_RAW_KEYBUF \
141 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
142 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
144 /* Number of elements of this_command_keys
145 that precede this key sequence. */
146 int this_single_command_key_start
;
148 /* Record values of this_command_key_count and echo_length ()
149 before this command was read. */
150 static int before_command_key_count
;
151 static int before_command_echo_length
;
153 extern int minbuf_level
;
155 extern int message_enable_multibyte
;
157 /* If non-nil, the function that implements the display of help.
158 It's called with one argument, the help string to display. */
160 Lisp_Object Vshow_help_function
;
162 /* Nonzero means do menu prompting. */
164 static int menu_prompting
;
166 /* Character to see next line of menu prompt. */
168 static Lisp_Object menu_prompt_more_char
;
170 /* For longjmp to where kbd input is being done. */
172 static jmp_buf getcjmp
;
174 /* True while doing kbd input. */
175 int waiting_for_input
;
177 /* True while displaying for echoing. Delays C-g throwing. */
181 /* Non-null means we can start echoing at the next input pause even
182 though there is something in the echo area. */
184 static struct kboard
*ok_to_echo_at_next_pause
;
186 /* The kboard last echoing, or null for none. Reset to 0 in
187 cancel_echoing. If non-null, and a current echo area message
188 exists, and echo_message_buffer is eq to the current message
189 buffer, we know that the message comes from echo_kboard. */
191 struct kboard
*echo_kboard
;
193 /* The buffer used for echoing. Set in echo_now, reset in
196 Lisp_Object echo_message_buffer
;
198 /* Nonzero means disregard local maps for the menu bar. */
199 static int inhibit_local_menu_bar_menus
;
201 /* Nonzero means C-g should cause immediate error-signal. */
204 /* The user's hook function for outputting an error message. */
205 Lisp_Object Vcommand_error_function
;
207 /* The user's ERASE setting. */
208 Lisp_Object Vtty_erase_char
;
210 /* Character to recognize as the help char. */
211 Lisp_Object Vhelp_char
;
213 /* List of other event types to recognize as meaning "help". */
214 Lisp_Object Vhelp_event_list
;
216 /* Form to execute when help char is typed. */
217 Lisp_Object Vhelp_form
;
219 /* Command to run when the help character follows a prefix key. */
220 Lisp_Object Vprefix_help_command
;
222 /* List of items that should move to the end of the menu bar. */
223 Lisp_Object Vmenu_bar_final_items
;
225 /* Non-nil means show the equivalent key-binding for
226 any M-x command that has one.
227 The value can be a length of time to show the message for.
228 If the value is non-nil and not a number, we wait 2 seconds. */
229 Lisp_Object Vsuggest_key_bindings
;
231 /* How long to display an echo-area message when the minibuffer is active.
232 If the value is not a number, such messages don't time out. */
233 Lisp_Object Vminibuffer_message_timeout
;
235 /* Character that causes a quit. Normally C-g.
237 If we are running on an ordinary terminal, this must be an ordinary
238 ASCII char, since we want to make it our interrupt character.
240 If we are not running on an ordinary terminal, it still needs to be
241 an ordinary ASCII char. This character needs to be recognized in
242 the input interrupt handler. At this point, the keystroke is
243 represented as a struct input_event, while the desired quit
244 character is specified as a lispy event. The mapping from struct
245 input_events to lispy events cannot run in an interrupt handler,
246 and the reverse mapping is difficult for anything but ASCII
249 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
253 extern Lisp_Object current_global_map
;
254 extern int minibuf_level
;
256 /* If non-nil, this is a map that overrides all other local maps. */
257 Lisp_Object Voverriding_local_map
;
259 /* If non-nil, Voverriding_local_map applies to the menu bar. */
260 Lisp_Object Voverriding_local_map_menu_flag
;
262 /* Keymap that defines special misc events that should
263 be processed immediately at a low level. */
264 Lisp_Object Vspecial_event_map
;
266 /* Current depth in recursive edits. */
267 int command_loop_level
;
269 /* Total number of times command_loop has read a key sequence. */
270 EMACS_INT num_input_keys
;
272 /* Last input event read as a command. */
273 Lisp_Object last_command_event
;
275 /* Last input character read as a command, not counting menus
276 reached by the mouse. */
277 Lisp_Object last_nonmenu_event
;
279 /* Last input event read for any purpose. */
280 Lisp_Object last_input_event
;
282 /* If not Qnil, a list of objects to be read as subsequent command input. */
283 Lisp_Object Vunread_command_events
;
285 /* If not Qnil, a list of objects to be read as subsequent command input
286 including input method processing. */
287 Lisp_Object Vunread_input_method_events
;
289 /* If not Qnil, a list of objects to be read as subsequent command input
290 but NOT including input method processing. */
291 Lisp_Object Vunread_post_input_method_events
;
293 /* If not -1, an event to be read as subsequent command input. */
294 EMACS_INT unread_command_char
;
296 /* If not Qnil, this is a switch-frame event which we decided to put
297 off until the end of a key sequence. This should be read as the
298 next command input, after any unread_command_events.
300 read_key_sequence uses this to delay switch-frame events until the
301 end of the key sequence; Fread_char uses it to put off switch-frame
302 events until a non-ASCII event is acceptable as input. */
303 Lisp_Object unread_switch_frame
;
305 /* A mask of extra modifier bits to put into every keyboard char. */
306 EMACS_INT extra_keyboard_modifiers
;
308 /* Char to use as prefix when a meta character is typed in.
309 This is bound on entry to minibuffer in case ESC is changed there. */
311 Lisp_Object meta_prefix_char
;
313 /* Last size recorded for a current buffer which is not a minibuffer. */
314 static int last_non_minibuf_size
;
316 /* Number of idle seconds before an auto-save and garbage collection. */
317 static Lisp_Object Vauto_save_timeout
;
319 /* Total number of times read_char has returned. */
320 int num_input_events
;
322 /* Total number of times read_char has returned, outside of macros. */
323 EMACS_INT num_nonmacro_input_events
;
325 /* Auto-save automatically when this many characters have been typed
326 since the last time. */
328 static EMACS_INT auto_save_interval
;
330 /* Value of num_nonmacro_input_events as of last auto save. */
334 /* The command being executed by the command loop.
335 Commands may set this, and the value set will be copied into
336 current_kboard->Vlast_command instead of the actual command. */
337 Lisp_Object Vthis_command
;
339 /* This is like Vthis_command, except that commands never set it. */
340 Lisp_Object real_this_command
;
342 /* If the lookup of the command returns a binding, the original
343 command is stored in this-original-command. It is nil otherwise. */
344 Lisp_Object Vthis_original_command
;
346 /* The value of point when the last command was started. */
347 int last_point_position
;
349 /* The buffer that was current when the last command was started. */
350 Lisp_Object last_point_position_buffer
;
352 /* The window that was selected when the last command was started. */
353 Lisp_Object last_point_position_window
;
355 /* The frame in which the last input event occurred, or Qmacro if the
356 last event came from a macro. We use this to determine when to
357 generate switch-frame events. This may be cleared by functions
358 like Fselect_frame, to make sure that a switch-frame event is
359 generated by the next character. */
360 Lisp_Object internal_last_event_frame
;
362 /* A user-visible version of the above, intended to allow users to
363 figure out where the last event came from, if the event doesn't
364 carry that information itself (i.e. if it was a character). */
365 Lisp_Object Vlast_event_frame
;
367 /* The timestamp of the last input event we received from the X server.
368 X Windows wants this for selection ownership. */
369 unsigned long last_event_timestamp
;
371 Lisp_Object Qself_insert_command
;
372 Lisp_Object Qforward_char
;
373 Lisp_Object Qbackward_char
;
374 Lisp_Object Qundefined
;
375 Lisp_Object Qtimer_event_handler
;
377 /* read_key_sequence stores here the command definition of the
378 key sequence that it reads. */
379 Lisp_Object read_key_sequence_cmd
;
381 /* Echo unfinished commands after this many seconds of pause. */
382 Lisp_Object Vecho_keystrokes
;
384 /* Form to evaluate (if non-nil) when Emacs is started. */
385 Lisp_Object Vtop_level
;
387 /* If non-nil, this implements the current input method. */
388 Lisp_Object Vinput_method_function
;
389 Lisp_Object Qinput_method_function
;
391 /* When we call Vinput_method_function,
392 this holds the echo area message that was just erased. */
393 Lisp_Object Vinput_method_previous_message
;
395 /* Non-nil means deactivate the mark at end of this command. */
396 Lisp_Object Vdeactivate_mark
;
397 Lisp_Object Qdeactivate_mark
;
399 /* Menu bar specified in Lucid Emacs fashion. */
401 Lisp_Object Vlucid_menu_bar_dirty_flag
;
402 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
404 Lisp_Object Qecho_area_clear_hook
;
406 /* Hooks to run before and after each command. */
407 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
408 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
409 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
411 /* Parent keymap of terminal-local function-key-map instances. */
412 Lisp_Object Vfunction_key_map
;
414 /* Keymap of key translations that can override keymaps. */
415 Lisp_Object Vkey_translation_map
;
417 /* List of deferred actions to be performed at a later time.
418 The precise format isn't relevant here; we just check whether it is nil. */
419 Lisp_Object Vdeferred_action_list
;
421 /* Function to call to handle deferred actions, when there are any. */
422 Lisp_Object Vdeferred_action_function
;
423 Lisp_Object Qdeferred_action_function
;
425 Lisp_Object Qinput_method_exit_on_first_char
;
426 Lisp_Object Qinput_method_use_echo_area
;
428 /* File in which we write all commands we read. */
431 /* Nonzero if input is available. */
434 extern char *pending_malloc_warning
;
436 /* Circular buffer for pre-read keyboard input. */
438 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
440 /* Pointer to next available character in kbd_buffer.
441 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
442 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
443 next available char is in kbd_buffer[0]. */
444 static struct input_event
*kbd_fetch_ptr
;
446 /* Pointer to next place to store character in kbd_buffer. This
447 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
448 character should go in kbd_buffer[0]. */
449 static struct input_event
* volatile kbd_store_ptr
;
451 /* The above pair of variables forms a "queue empty" flag. When we
452 enqueue a non-hook event, we increment kbd_store_ptr. When we
453 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
454 there is input available if the two pointers are not equal.
456 Why not just have a flag set and cleared by the enqueuing and
457 dequeuing functions? Such a flag could be screwed up by interrupts
458 at inopportune times. */
460 /* If this flag is non-nil, we check mouse_moved to see when the
461 mouse moves, and motion events will appear in the input stream.
462 Otherwise, mouse motion is ignored. */
463 Lisp_Object do_mouse_tracking
;
465 /* Symbols to head events. */
466 Lisp_Object Qmouse_movement
;
467 Lisp_Object Qscroll_bar_movement
;
468 Lisp_Object Qswitch_frame
;
469 Lisp_Object Qdelete_frame
;
470 Lisp_Object Qiconify_frame
;
471 Lisp_Object Qmake_frame_visible
;
472 Lisp_Object Qselect_window
;
473 Lisp_Object Qhelp_echo
;
475 extern Lisp_Object Qremap
;
477 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
478 Lisp_Object Qmouse_fixup_help_message
;
481 /* Symbols to denote kinds of events. */
482 Lisp_Object Qfunction_key
;
483 Lisp_Object Qmouse_click
;
484 #if defined (WINDOWSNT)
485 Lisp_Object Qlanguage_change
;
487 Lisp_Object Qdrag_n_drop
;
488 Lisp_Object Qsave_session
;
490 Lisp_Object Qdbus_event
;
492 Lisp_Object Qconfig_changed_event
;
494 /* Lisp_Object Qmouse_movement; - also an event header */
496 /* Properties of event headers. */
497 Lisp_Object Qevent_kind
;
498 Lisp_Object Qevent_symbol_elements
;
500 /* menu item parts */
501 Lisp_Object Qmenu_enable
;
502 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
503 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
504 extern Lisp_Object Qmenu_item
;
506 /* An event header symbol HEAD may have a property named
507 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
508 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
509 mask of modifiers applied to it. If present, this is used to help
510 speed up parse_modifiers. */
511 Lisp_Object Qevent_symbol_element_mask
;
513 /* An unmodified event header BASE may have a property named
514 Qmodifier_cache, which is an alist mapping modifier masks onto
515 modified versions of BASE. If present, this helps speed up
517 Lisp_Object Qmodifier_cache
;
519 /* Symbols to use for parts of windows. */
520 Lisp_Object Qmode_line
;
521 Lisp_Object Qvertical_line
;
522 Lisp_Object Qvertical_scroll_bar
;
523 Lisp_Object Qmenu_bar
;
524 extern Lisp_Object Qleft_margin
, Qright_margin
;
525 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
526 extern Lisp_Object QCmap
;
528 Lisp_Object
recursive_edit_unwind (), command_loop ();
529 Lisp_Object
Fthis_command_keys ();
530 Lisp_Object Qextended_command_history
;
531 EMACS_TIME
timer_check ();
533 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
535 extern char *x_get_keysym_name ();
537 static void record_menu_key ();
538 static int echo_length ();
540 Lisp_Object Qpolling_period
;
542 /* List of absolute timers. Appears in order of next scheduled event. */
543 Lisp_Object Vtimer_list
;
545 /* List of idle time timers. Appears in order of next scheduled event. */
546 Lisp_Object Vtimer_idle_list
;
548 /* Incremented whenever a timer is run. */
551 extern Lisp_Object Vprint_level
, Vprint_length
;
553 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
555 EMACS_TIME
*input_available_clear_time
;
557 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
558 Default is 1 if INTERRUPT_INPUT is defined. */
561 /* Nonzero while interrupts are temporarily deferred during redisplay. */
562 int interrupts_deferred
;
564 /* Allow m- file to inhibit use of FIONREAD. */
565 #ifdef BROKEN_FIONREAD
569 /* We are unable to use interrupts if FIONREAD is not available,
570 so flush SIGIO so we won't try. */
571 #if !defined (FIONREAD)
577 /* If we support a window system, turn on the code to poll periodically
578 to detect C-g. It isn't actually used when doing interrupt input. */
579 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
580 #define POLL_FOR_INPUT
583 /* After a command is executed, if point is moved into a region that
584 has specific properties (e.g. composition, display), we adjust
585 point to the boundary of the region. But, if a command sets this
586 variable to non-nil, we suppress this point adjustment. This
587 variable is set to nil before reading a command. */
589 Lisp_Object Vdisable_point_adjustment
;
591 /* If non-nil, always disable point adjustment. */
593 Lisp_Object Vglobal_disable_point_adjustment
;
595 /* The time when Emacs started being idle. */
597 static EMACS_TIME timer_idleness_start_time
;
599 /* After Emacs stops being idle, this saves the last value
600 of timer_idleness_start_time from when it was idle. */
602 static EMACS_TIME timer_last_idleness_start_time
;
604 /* If non-nil, events produced by disabled menu items and tool-bar
605 buttons are not ignored. Help functions bind this to allow help on
606 those items and buttons. */
607 Lisp_Object Venable_disabled_menus_and_buttons
;
610 /* Global variable declarations. */
612 /* Flags for readable_events. */
613 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
614 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
615 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
617 /* Function for init_keyboard to call with no args (if nonzero). */
618 void (*keyboard_init_hook
) ();
620 static int read_avail_input
P_ ((int));
621 static void get_input_pending
P_ ((int *, int));
622 static int readable_events
P_ ((int));
623 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
624 Lisp_Object
, int *));
625 static Lisp_Object
read_char_x_menu_prompt ();
626 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
628 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
629 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
630 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
631 enum scroll_bar_part
,
632 Lisp_Object
, Lisp_Object
,
635 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
636 Lisp_Object
, char **,
637 Lisp_Object
*, unsigned));
638 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
639 static void save_getcjmp
P_ ((jmp_buf));
640 static void save_getcjmp ();
641 static void restore_getcjmp
P_ ((jmp_buf));
642 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
643 static void clear_event
P_ ((struct input_event
*));
644 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
645 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
646 static void handle_interrupt
P_ ((void));
647 static void timer_start_idle
P_ ((void));
648 static void timer_stop_idle
P_ ((void));
649 static void timer_resume_idle
P_ ((void));
650 static SIGTYPE handle_user_signal
P_ ((int));
651 static char *find_user_signal_name
P_ ((int));
652 static int store_user_signal_events
P_ ((void));
654 /* Nonzero means don't try to suspend even if the operating system seems
656 static int cannot_suspend
;
658 extern Lisp_Object Qidentity
, Qonly
;
660 /* Install the string STR as the beginning of the string of echoing,
661 so that it serves as a prompt for the next character.
662 Also start echoing. */
668 current_kboard
->echo_string
= str
;
669 current_kboard
->echo_after_prompt
= SCHARS (str
);
673 /* Add C to the echo string, if echoing is going on.
674 C can be a character, which is printed prettily ("M-C-x" and all that
675 jazz), or a symbol, whose name is printed. */
681 if (current_kboard
->immediate_echo
)
683 int size
= KEY_DESCRIPTION_SIZE
+ 100;
684 char *buffer
= (char *) alloca (size
);
686 Lisp_Object echo_string
;
688 echo_string
= current_kboard
->echo_string
;
690 /* If someone has passed us a composite event, use its head symbol. */
695 ptr
= push_key_description (XINT (c
), ptr
, 1);
697 else if (SYMBOLP (c
))
699 Lisp_Object name
= SYMBOL_NAME (c
);
700 int nbytes
= SBYTES (name
);
702 if (size
- (ptr
- buffer
) < nbytes
)
704 int offset
= ptr
- buffer
;
705 size
= max (2 * size
, size
+ nbytes
);
706 buffer
= (char *) alloca (size
);
707 ptr
= buffer
+ offset
;
710 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
711 STRING_MULTIBYTE (name
), 1);
714 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
717 const char *text
= " (Type ? for further options)";
718 int len
= strlen (text
);
720 if (size
- (ptr
- buffer
) < len
)
722 int offset
= ptr
- buffer
;
724 buffer
= (char *) alloca (size
);
725 ptr
= buffer
+ offset
;
728 bcopy (text
, ptr
, len
);
732 /* Replace a dash from echo_dash with a space, otherwise
733 add a space at the end as a separator between keys. */
734 if (STRINGP (echo_string
)
735 && SCHARS (echo_string
) > 1)
737 Lisp_Object last_char
, prev_char
, idx
;
739 idx
= make_number (SCHARS (echo_string
) - 2);
740 prev_char
= Faref (echo_string
, idx
);
742 idx
= make_number (SCHARS (echo_string
) - 1);
743 last_char
= Faref (echo_string
, idx
);
745 /* We test PREV_CHAR to make sure this isn't the echoing
747 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
748 Faset (echo_string
, idx
, make_number (' '));
750 echo_string
= concat2 (echo_string
, build_string (" "));
752 else if (STRINGP (echo_string
))
753 echo_string
= concat2 (echo_string
, build_string (" "));
755 current_kboard
->echo_string
756 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
762 /* Temporarily add a dash to the end of the echo string if it's not
763 empty, so that it serves as a mini-prompt for the very next character. */
768 /* Do nothing if not echoing at all. */
769 if (NILP (current_kboard
->echo_string
))
772 if (!current_kboard
->immediate_echo
773 && SCHARS (current_kboard
->echo_string
) == 0)
776 /* Do nothing if we just printed a prompt. */
777 if (current_kboard
->echo_after_prompt
778 == SCHARS (current_kboard
->echo_string
))
781 /* Do nothing if we have already put a dash at the end. */
782 if (SCHARS (current_kboard
->echo_string
) > 1)
784 Lisp_Object last_char
, prev_char
, idx
;
786 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
787 prev_char
= Faref (current_kboard
->echo_string
, idx
);
789 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
790 last_char
= Faref (current_kboard
->echo_string
, idx
);
792 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
796 /* Put a dash at the end of the buffer temporarily,
797 but make it go away when the next character is added. */
798 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
803 /* Display the current echo string, and begin echoing if not already
809 if (!current_kboard
->immediate_echo
)
812 current_kboard
->immediate_echo
= 1;
814 for (i
= 0; i
< this_command_key_count
; i
++)
818 /* Set before_command_echo_length to the value that would
819 have been saved before the start of this subcommand in
820 command_loop_1, if we had already been echoing then. */
821 if (i
== this_single_command_key_start
)
822 before_command_echo_length
= echo_length ();
824 c
= XVECTOR (this_command_keys
)->contents
[i
];
825 if (! (EVENT_HAS_PARAMETERS (c
)
826 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
830 /* Set before_command_echo_length to the value that would
831 have been saved before the start of this subcommand in
832 command_loop_1, if we had already been echoing then. */
833 if (this_command_key_count
== this_single_command_key_start
)
834 before_command_echo_length
= echo_length ();
836 /* Put a dash at the end to invite the user to type more. */
841 message3_nolog (current_kboard
->echo_string
,
842 SBYTES (current_kboard
->echo_string
),
843 STRING_MULTIBYTE (current_kboard
->echo_string
));
846 /* Record in what buffer we echoed, and from which kboard. */
847 echo_message_buffer
= echo_area_buffer
[0];
848 echo_kboard
= current_kboard
;
850 if (waiting_for_input
&& !NILP (Vquit_flag
))
851 quit_throw_to_read_char ();
854 /* Turn off echoing, for the start of a new command. */
859 current_kboard
->immediate_echo
= 0;
860 current_kboard
->echo_after_prompt
= -1;
861 current_kboard
->echo_string
= Qnil
;
862 ok_to_echo_at_next_pause
= NULL
;
864 echo_message_buffer
= Qnil
;
867 /* Return the length of the current echo string. */
872 return (STRINGP (current_kboard
->echo_string
)
873 ? SCHARS (current_kboard
->echo_string
)
877 /* Truncate the current echo message to its first LEN chars.
878 This and echo_char get used by read_key_sequence when the user
879 switches frames while entering a key sequence. */
882 echo_truncate (nchars
)
885 if (STRINGP (current_kboard
->echo_string
))
886 current_kboard
->echo_string
887 = Fsubstring (current_kboard
->echo_string
,
888 make_number (0), make_number (nchars
));
889 truncate_echo_area (nchars
);
893 /* Functions for manipulating this_command_keys. */
895 add_command_key (key
)
898 #if 0 /* Not needed after we made Freset_this_command_lengths
899 do the job immediately. */
900 /* If reset-this-command-length was called recently, obey it now.
901 See the doc string of that function for an explanation of why. */
902 if (before_command_restore_flag
)
904 this_command_key_count
= before_command_key_count_1
;
905 if (this_command_key_count
< this_single_command_key_start
)
906 this_single_command_key_start
= this_command_key_count
;
907 echo_truncate (before_command_echo_length_1
);
908 before_command_restore_flag
= 0;
912 if (this_command_key_count
>= ASIZE (this_command_keys
))
913 this_command_keys
= larger_vector (this_command_keys
,
914 2 * ASIZE (this_command_keys
),
917 ASET (this_command_keys
, this_command_key_count
, key
);
918 ++this_command_key_count
;
925 int count
= SPECPDL_INDEX ();
928 if (command_loop_level
> 0)
930 specbind (Qstandard_output
, Qt
);
931 specbind (Qstandard_input
, Qt
);
934 #ifdef HAVE_WINDOW_SYSTEM
935 /* The command loop has started an hourglass timer, so we have to
936 cancel it here, otherwise it will fire because the recursive edit
937 can take some time. Do not check for display_hourglass_p here,
938 because it could already be nil. */
942 /* This function may have been called from a debugger called from
943 within redisplay, for instance by Edebugging a function called
944 from fontification-functions. We want to allow redisplay in
945 the debugging session.
947 The recursive edit is left with a `(throw exit ...)'. The `exit'
948 tag is not caught anywhere in redisplay, i.e. when we leave the
949 recursive edit, the original redisplay leading to the recursive
950 edit will be unwound. The outcome should therefore be safe. */
951 specbind (Qinhibit_redisplay
, Qnil
);
954 val
= command_loop ();
956 Fsignal (Qquit
, Qnil
);
957 /* Handle throw from read_minibuf when using minibuffer
958 while it's active but we're in another window. */
960 xsignal1 (Qerror
, val
);
962 return unbind_to (count
, Qnil
);
965 /* When an auto-save happens, record the "time", and don't do again soon. */
970 last_auto_save
= num_nonmacro_input_events
;
973 /* Make an auto save happen as soon as possible at command level. */
976 force_auto_save_soon ()
978 last_auto_save
= - auto_save_interval
- 1;
980 record_asynch_buffer_change ();
983 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
984 doc
: /* Invoke the editor command loop recursively.
985 To get out of the recursive edit, a command can do `(throw 'exit nil)';
986 that tells this function to return.
987 Alternatively, `(throw 'exit t)' makes this function signal an error.
988 This function is called by the editor initialization to begin editing. */)
991 int count
= SPECPDL_INDEX ();
994 /* If we enter while input is blocked, don't lock up here.
995 This may happen through the debugger during redisplay. */
999 command_loop_level
++;
1000 update_mode_lines
= 1;
1002 if (command_loop_level
1003 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1004 buffer
= Fcurrent_buffer ();
1008 /* If we leave recursive_edit_1 below with a `throw' for instance,
1009 like it is done in the splash screen display, we have to
1010 make sure that we restore single_kboard as command_loop_1
1011 would have done if it were left normally. */
1012 if (command_loop_level
> 0)
1013 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1014 record_unwind_protect (recursive_edit_unwind
, buffer
);
1016 recursive_edit_1 ();
1017 return unbind_to (count
, Qnil
);
1021 recursive_edit_unwind (buffer
)
1024 if (BUFFERP (buffer
))
1025 Fset_buffer (buffer
);
1027 command_loop_level
--;
1028 update_mode_lines
= 1;
1033 #if 0 /* These two functions are now replaced with
1034 temporarily_switch_to_single_kboard. */
1038 #if 0 /* Theory: if there's anything in Vunread_command_events,
1039 it will right away be read by read_key_sequence,
1040 and then if we do switch KBOARDS, it will go into the side
1041 queue then. So we don't need to do anything special here -- rms. */
1042 if (CONSP (Vunread_command_events
))
1044 current_kboard
->kbd_queue
1045 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1046 current_kboard
->kbd_queue_has_data
= 1;
1048 Vunread_command_events
= Qnil
;
1053 /* Switch to the single-kboard state, making current_kboard
1054 the only KBOARD from which further input is accepted. */
1057 single_kboard_state ()
1063 /* If we're in single_kboard state for kboard KBOARD,
1067 not_single_kboard_state (kboard
)
1070 if (kboard
== current_kboard
)
1074 /* Maintain a stack of kboards, so other parts of Emacs
1075 can switch temporarily to the kboard of a given frame
1076 and then revert to the previous status. */
1081 struct kboard_stack
*next
;
1084 static struct kboard_stack
*kboard_stack
;
1090 struct kboard_stack
*p
1091 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1093 p
->next
= kboard_stack
;
1094 p
->kboard
= current_kboard
;
1104 struct kboard_stack
*p
= kboard_stack
;
1106 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1108 if (t
->kboard
== p
->kboard
)
1110 current_kboard
= p
->kboard
;
1117 /* The terminal we remembered has been deleted. */
1118 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1121 kboard_stack
= p
->next
;
1125 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1126 from which further input is accepted. If F is non-nil, set its
1127 KBOARD as the current keyboard.
1129 This function uses record_unwind_protect to return to the previous
1132 If Emacs is already in single_kboard mode, and F's keyboard is
1133 locked, then this function will throw an errow. */
1136 temporarily_switch_to_single_kboard (f
)
1139 int was_locked
= single_kboard
;
1142 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1143 /* We can not switch keyboards while in single_kboard mode.
1144 In rare cases, Lisp code may call `recursive-edit' (or
1145 `read-minibuffer' or `y-or-n-p') after it switched to a
1146 locked frame. For example, this is likely to happen
1147 when server.el connects to a new terminal while Emacs is in
1148 single_kboard mode. It is best to throw an error instead
1149 of presenting the user with a frozen screen. */
1150 error ("Terminal %d is locked, cannot read from it",
1151 FRAME_TERMINAL (f
)->id
);
1153 /* This call is unnecessary, but helps
1154 `restore_kboard_configuration' discover if somebody changed
1155 `current_kboard' behind our back. */
1156 push_kboard (current_kboard
);
1159 current_kboard
= FRAME_KBOARD (f
);
1161 record_unwind_protect (restore_kboard_configuration
,
1162 (was_locked
? Qt
: Qnil
));
1165 #if 0 /* This function is not needed anymore. */
1167 record_single_kboard_state ()
1170 push_kboard (current_kboard
);
1171 record_unwind_protect (restore_kboard_configuration
,
1172 (single_kboard
? Qt
: Qnil
));
1177 restore_kboard_configuration (was_locked
)
1178 Lisp_Object was_locked
;
1180 if (NILP (was_locked
))
1184 struct kboard
*prev
= current_kboard
;
1187 /* The pop should not change the kboard. */
1188 if (single_kboard
&& current_kboard
!= prev
)
1195 /* Handle errors that are not handled at inner levels
1196 by printing an error message and returning to the editor command loop. */
1202 Lisp_Object old_level
, old_length
;
1203 char macroerror
[50];
1205 #ifdef HAVE_WINDOW_SYSTEM
1206 if (display_hourglass_p
)
1207 cancel_hourglass ();
1210 if (!NILP (executing_kbd_macro
))
1212 if (executing_kbd_macro_iterations
== 1)
1213 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1215 sprintf (macroerror
, "After %d kbd macro iterations: ",
1216 executing_kbd_macro_iterations
);
1221 Vstandard_output
= Qt
;
1222 Vstandard_input
= Qt
;
1223 Vexecuting_kbd_macro
= Qnil
;
1224 executing_kbd_macro
= Qnil
;
1225 current_kboard
->Vprefix_arg
= Qnil
;
1226 current_kboard
->Vlast_prefix_arg
= Qnil
;
1229 /* Avoid unquittable loop if data contains a circular list. */
1230 old_level
= Vprint_level
;
1231 old_length
= Vprint_length
;
1232 XSETFASTINT (Vprint_level
, 10);
1233 XSETFASTINT (Vprint_length
, 10);
1234 cmd_error_internal (data
, macroerror
);
1235 Vprint_level
= old_level
;
1236 Vprint_length
= old_length
;
1240 Vinhibit_quit
= Qnil
;
1241 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1242 if (command_loop_level
== 0 && minibuf_level
== 0)
1243 any_kboard_state ();
1246 return make_number (0);
1249 /* Take actions on handling an error. DATA is the data that describes
1252 CONTEXT is a C-string containing ASCII characters only which
1253 describes the context in which the error happened. If we need to
1254 generalize CONTEXT to allow multibyte characters, make it a Lisp
1258 cmd_error_internal (data
, context
)
1262 struct frame
*sf
= SELECTED_FRAME ();
1264 /* The immediate context is not interesting for Quits,
1265 since they are asyncronous. */
1266 if (EQ (XCAR (data
), Qquit
))
1267 Vsignaling_function
= Qnil
;
1272 /* Use user's specified output function if any. */
1273 if (!NILP (Vcommand_error_function
))
1274 call3 (Vcommand_error_function
, data
,
1275 context
? build_string (context
) : empty_unibyte_string
,
1276 Vsignaling_function
);
1277 /* If the window system or terminal frame hasn't been initialized
1278 yet, or we're not interactive, write the message to stderr and exit. */
1279 else if (!sf
->glyphs_initialized_p
1280 /* The initial frame is a special non-displaying frame. It
1281 will be current in daemon mode when there are no frames
1282 to display, and in non-daemon mode before the real frame
1283 has finished initializing. If an error is thrown in the
1284 latter case while creating the frame, then the frame
1285 will never be displayed, so the safest thing to do is
1286 write to stderr and quit. In daemon mode, there are
1287 many other potential errors that do not prevent frames
1288 from being created, so continuing as normal is better in
1290 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1293 print_error_message (data
, Qexternal_debugging_output
,
1294 context
, Vsignaling_function
);
1295 Fterpri (Qexternal_debugging_output
);
1296 Fkill_emacs (make_number (-1));
1300 clear_message (1, 0);
1302 message_log_maybe_newline ();
1305 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1308 Vsignaling_function
= Qnil
;
1311 Lisp_Object
command_loop_1 ();
1312 Lisp_Object
command_loop_2 ();
1313 Lisp_Object
top_level_1 ();
1315 /* Entry to editor-command-loop.
1316 This level has the catches for exiting/returning to editor command loop.
1317 It returns nil to exit recursive edit, t to abort it. */
1322 if (command_loop_level
> 0 || minibuf_level
> 0)
1325 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1326 executing_kbd_macro
= Qnil
;
1332 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1333 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1334 /* Reset single_kboard in case top-level set it while
1335 evaluating an -f option, or we are stuck there for some
1337 any_kboard_state ();
1339 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1340 executing_kbd_macro
= Qnil
;
1342 /* End of file in -batch run causes exit here. */
1348 /* Here we catch errors in execution of commands within the
1349 editing loop, and reenter the editing loop.
1350 When there is an error, cmd_error runs and returns a non-nil
1351 value to us. A value of nil means that command_loop_1 itself
1352 returned due to end of file (or end of kbd macro). */
1357 register Lisp_Object val
;
1360 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1361 while (!NILP (val
));
1369 return Feval (Vtop_level
);
1375 /* On entry to the outer level, run the startup file */
1376 if (!NILP (Vtop_level
))
1377 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1378 else if (!NILP (Vpurify_flag
))
1379 message ("Bare impure Emacs (standard Lisp code not loaded)");
1381 message ("Bare Emacs (standard Lisp code not loaded)");
1385 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1386 doc
: /* Exit all recursive editing levels.
1387 This also exits all active minibuffers. */)
1390 #ifdef HAVE_WINDOW_SYSTEM
1391 if (display_hourglass_p
)
1392 cancel_hourglass ();
1395 /* Unblock input if we enter with input blocked. This may happen if
1396 redisplay traps e.g. during tool-bar update with input blocked. */
1397 while (INPUT_BLOCKED_P
)
1400 return Fthrow (Qtop_level
, Qnil
);
1403 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1404 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1407 if (command_loop_level
> 0 || minibuf_level
> 0)
1408 Fthrow (Qexit
, Qnil
);
1410 error ("No recursive edit is in progress");
1414 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1415 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1418 if (command_loop_level
> 0 || minibuf_level
> 0)
1421 error ("No recursive edit is in progress");
1425 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1427 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1428 of this function. */
1431 tracking_off (old_value
)
1432 Lisp_Object old_value
;
1434 do_mouse_tracking
= old_value
;
1435 if (NILP (old_value
))
1437 /* Redisplay may have been preempted because there was input
1438 available, and it assumes it will be called again after the
1439 input has been processed. If the only input available was
1440 the sort that we have just disabled, then we need to call
1442 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1444 redisplay_preserve_echo_area (6);
1445 get_input_pending (&input_pending
,
1446 READABLE_EVENTS_DO_TIMERS_NOW
);
1452 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1453 doc
: /* Evaluate BODY with mouse movement events enabled.
1454 Within a `track-mouse' form, mouse motion generates input events that
1455 you can read with `read-event'.
1456 Normally, mouse motion is ignored.
1457 usage: (track-mouse BODY...) */)
1461 int count
= SPECPDL_INDEX ();
1464 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1466 do_mouse_tracking
= Qt
;
1468 val
= Fprogn (args
);
1469 return unbind_to (count
, val
);
1472 /* If mouse has moved on some frame, return one of those frames.
1476 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1477 after resizing the tool-bar window. */
1479 int ignore_mouse_drag_p
;
1484 Lisp_Object tail
, frame
;
1486 if (ignore_mouse_drag_p
)
1488 /* ignore_mouse_drag_p = 0; */
1492 FOR_EACH_FRAME (tail
, frame
)
1494 if (XFRAME (frame
)->mouse_moved
)
1495 return XFRAME (frame
);
1501 #endif /* HAVE_MOUSE || HAVE_GPM */
1503 /* This is the actual command reading loop,
1504 sans error-handling encapsulation. */
1506 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1508 void safe_run_hooks
P_ ((Lisp_Object
));
1509 static void adjust_point_for_property
P_ ((int, int));
1511 /* Cancel hourglass from protect_unwind.
1513 #ifdef HAVE_WINDOW_SYSTEM
1515 cancel_hourglass_unwind (arg
)
1518 cancel_hourglass ();
1523 extern int nonundocount
; /* Declared in cmds.c. */
1530 Lisp_Object keybuf
[30];
1532 int prev_modiff
= 0;
1533 struct buffer
*prev_buffer
= NULL
;
1534 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1535 int was_locked
= single_kboard
;
1537 int already_adjusted
= 0;
1539 current_kboard
->Vprefix_arg
= Qnil
;
1540 current_kboard
->Vlast_prefix_arg
= Qnil
;
1541 Vdeactivate_mark
= Qnil
;
1542 waiting_for_input
= 0;
1545 this_command_key_count
= 0;
1546 this_command_key_count_reset
= 0;
1547 this_single_command_key_start
= 0;
1549 if (NILP (Vmemory_full
))
1551 /* Make sure this hook runs after commands that get errors and
1552 throw to top level. */
1553 /* Note that the value cell will never directly contain nil
1554 if the symbol is a local variable. */
1555 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1556 safe_run_hooks (Qpost_command_hook
);
1558 /* If displaying a message, resize the echo area window to fit
1559 that message's size exactly. */
1560 if (!NILP (echo_area_buffer
[0]))
1561 resize_echo_area_exactly ();
1563 if (!NILP (Vdeferred_action_list
))
1564 safe_run_hooks (Qdeferred_action_function
);
1567 /* Do this after running Vpost_command_hook, for consistency. */
1568 current_kboard
->Vlast_command
= Vthis_command
;
1569 current_kboard
->Vreal_last_command
= real_this_command
;
1570 if (!CONSP (last_command_event
))
1571 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1575 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1578 /* Make sure the current window's buffer is selected. */
1579 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1580 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1582 /* Display any malloc warning that just came out. Use while because
1583 displaying one warning can cause another. */
1585 while (pending_malloc_warning
)
1586 display_malloc_warning ();
1588 Vdeactivate_mark
= Qnil
;
1590 /* If minibuffer on and echo area in use,
1591 wait a short time and redraw minibuffer. */
1594 && !NILP (echo_area_buffer
[0])
1595 && EQ (minibuf_window
, echo_area_window
)
1596 && NUMBERP (Vminibuffer_message_timeout
))
1598 /* Bind inhibit-quit to t so that C-g gets read in
1599 rather than quitting back to the minibuffer. */
1600 int count
= SPECPDL_INDEX ();
1601 specbind (Qinhibit_quit
, Qt
);
1603 sit_for (Vminibuffer_message_timeout
, 0, 2);
1605 /* Clear the echo area. */
1607 safe_run_hooks (Qecho_area_clear_hook
);
1609 unbind_to (count
, Qnil
);
1611 /* If a C-g came in before, treat it as input now. */
1612 if (!NILP (Vquit_flag
))
1615 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1620 /* Select the frame that the last event came from. Usually,
1621 switch-frame events will take care of this, but if some lisp
1622 code swallows a switch-frame event, we'll fix things up here.
1623 Is this a good idea? */
1624 if (FRAMEP (internal_last_event_frame
)
1625 && !EQ (internal_last_event_frame
, selected_frame
))
1626 Fselect_frame (internal_last_event_frame
, Qnil
);
1628 /* If it has changed current-menubar from previous value,
1629 really recompute the menubar from the value. */
1630 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1631 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1632 call0 (Qrecompute_lucid_menubar
);
1634 before_command_key_count
= this_command_key_count
;
1635 before_command_echo_length
= echo_length ();
1637 Vthis_command
= Qnil
;
1638 real_this_command
= Qnil
;
1639 Vthis_original_command
= Qnil
;
1640 Vthis_command_keys_shift_translated
= Qnil
;
1642 /* Read next key sequence; i gets its length. */
1643 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1646 /* A filter may have run while we were reading the input. */
1647 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1649 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1650 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1654 /* Now we have read a key sequence of length I,
1655 or else I is 0 and we found end of file. */
1657 if (i
== 0) /* End of file -- happens only in */
1658 return Qnil
; /* a kbd macro, at the end. */
1659 /* -1 means read_key_sequence got a menu that was rejected.
1660 Just loop around and read another command. */
1664 this_command_key_count
= 0;
1665 this_command_key_count_reset
= 0;
1666 this_single_command_key_start
= 0;
1670 last_command_event
= keybuf
[i
- 1];
1672 /* If the previous command tried to force a specific window-start,
1673 forget about that, in case this command moves point far away
1674 from that position. But also throw away beg_unchanged and
1675 end_unchanged information in that case, so that redisplay will
1676 update the whole window properly. */
1677 if (!NILP (XWINDOW (selected_window
)->force_start
))
1680 XWINDOW (selected_window
)->force_start
= Qnil
;
1681 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1682 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1685 cmd
= read_key_sequence_cmd
;
1686 if (!NILP (Vexecuting_kbd_macro
))
1688 if (!NILP (Vquit_flag
))
1690 Vexecuting_kbd_macro
= Qt
;
1691 QUIT
; /* Make some noise. */
1692 /* Will return since macro now empty. */
1696 /* Do redisplay processing after this command except in special
1697 cases identified below. */
1698 prev_buffer
= current_buffer
;
1699 prev_modiff
= MODIFF
;
1700 last_point_position
= PT
;
1701 last_point_position_window
= selected_window
;
1702 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1704 /* By default, we adjust point to a boundary of a region that
1705 has such a property that should be treated intangible
1706 (e.g. composition, display). But, some commands will set
1707 this variable differently. */
1708 Vdisable_point_adjustment
= Qnil
;
1710 /* Process filters and timers may have messed with deactivate-mark.
1711 reset it before we execute the command. */
1712 Vdeactivate_mark
= Qnil
;
1714 /* Remap command through active keymaps */
1715 Vthis_original_command
= cmd
;
1719 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1723 /* Execute the command. */
1725 Vthis_command
= cmd
;
1726 real_this_command
= cmd
;
1727 /* Note that the value cell will never directly contain nil
1728 if the symbol is a local variable. */
1729 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1730 safe_run_hooks (Qpre_command_hook
);
1732 already_adjusted
= 0;
1734 if (NILP (Vthis_command
))
1736 /* nil means key is undefined. */
1737 Lisp_Object keys
= Fvector (i
, keybuf
);
1738 keys
= Fkey_description (keys
, Qnil
);
1740 message_with_string ("%s is undefined", keys
, 0);
1741 current_kboard
->defining_kbd_macro
= Qnil
;
1742 update_mode_lines
= 1;
1743 current_kboard
->Vprefix_arg
= Qnil
;
1747 if (NILP (current_kboard
->Vprefix_arg
))
1749 /* In case we jump to directly_done. */
1750 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1752 /* Recognize some common commands in common situations and
1753 do them directly. */
1754 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1755 && NILP (Vthis_command_keys_shift_translated
)
1756 && !CONSP (Vtransient_mark_mode
))
1758 struct Lisp_Char_Table
*dp
1759 = window_display_table (XWINDOW (selected_window
));
1760 lose
= FETCH_CHAR (PT_BYTE
);
1762 if (! NILP (Vpost_command_hook
))
1763 /* Put this before calling adjust_point_for_property
1764 so it will only get called once in any case. */
1766 if (current_buffer
== prev_buffer
1767 && last_point_position
!= PT
1768 && NILP (Vdisable_point_adjustment
)
1769 && NILP (Vglobal_disable_point_adjustment
))
1770 adjust_point_for_property (last_point_position
, 0);
1771 already_adjusted
= 1;
1772 if (PT
== last_point_position
+ 1
1774 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1775 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1776 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1777 && (lose
>= 0x20 && lose
< 0x7f)))
1778 : (lose
>= 0x20 && lose
< 0x7f))
1779 /* To extract the case of continuation on
1780 wide-column characters. */
1781 && ASCII_BYTE_P (lose
)
1782 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1784 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1786 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1788 && !windows_or_buffers_changed
1789 && EQ (current_buffer
->selective_display
, Qnil
)
1790 && !detect_input_pending ()
1791 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1792 && NILP (Vexecuting_kbd_macro
))
1793 direct_output_forward_char (1);
1796 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1797 && NILP (Vthis_command_keys_shift_translated
)
1798 && !CONSP (Vtransient_mark_mode
))
1800 struct Lisp_Char_Table
*dp
1801 = window_display_table (XWINDOW (selected_window
));
1803 lose
= FETCH_CHAR (PT_BYTE
);
1804 if (! NILP (Vpost_command_hook
))
1806 if (current_buffer
== prev_buffer
1807 && last_point_position
!= PT
1808 && NILP (Vdisable_point_adjustment
)
1809 && NILP (Vglobal_disable_point_adjustment
))
1810 adjust_point_for_property (last_point_position
, 0);
1811 already_adjusted
= 1;
1812 if (PT
== last_point_position
- 1
1814 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1815 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1816 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1817 && (lose
>= 0x20 && lose
< 0x7f)))
1818 : (lose
>= 0x20 && lose
< 0x7f))
1819 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1821 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1823 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1825 && !windows_or_buffers_changed
1826 && EQ (current_buffer
->selective_display
, Qnil
)
1827 && !detect_input_pending ()
1828 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1829 && NILP (Vexecuting_kbd_macro
))
1830 direct_output_forward_char (-1);
1833 else if (EQ (Vthis_command
, Qself_insert_command
)
1834 /* Try this optimization only on char keystrokes. */
1835 && NATNUMP (last_command_event
)
1836 && CHAR_VALID_P (XFASTINT (last_command_event
), 0))
1839 = translate_char (Vtranslation_table_for_input
,
1840 XFASTINT (last_command_event
));
1842 if (NILP (Vexecuting_kbd_macro
)
1843 && !EQ (minibuf_window
, selected_window
))
1845 if (!nonundocount
|| nonundocount
>= 20)
1853 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1855 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1857 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1859 || MODIFF
<= SAVE_MODIFF
1860 || windows_or_buffers_changed
1861 || !EQ (current_buffer
->selective_display
, Qnil
)
1862 || detect_input_pending ()
1863 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1864 || !NILP (Vexecuting_kbd_macro
));
1866 value
= internal_self_insert (c
, 0);
1871 frame_make_pointer_invisible ();
1873 if (! NILP (Vpost_command_hook
))
1874 /* Put this before calling adjust_point_for_property
1875 so it will only get called once in any case. */
1878 /* VALUE == 1 when AFTER-CHANGE functions are
1879 installed which is the case most of the time
1880 because FONT-LOCK installs one. */
1881 if (!lose
&& !value
)
1882 direct_output_for_insert (c
);
1887 /* Here for a command that isn't executed directly */
1890 #ifdef HAVE_WINDOW_SYSTEM
1891 int scount
= SPECPDL_INDEX ();
1893 if (display_hourglass_p
1894 && NILP (Vexecuting_kbd_macro
))
1896 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1902 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1904 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1906 #ifdef HAVE_WINDOW_SYSTEM
1907 /* Do not check display_hourglass_p here, because
1908 Fcommand_execute could change it, but we should cancel
1909 hourglass cursor anyway.
1910 But don't cancel the hourglass within a macro
1911 just because a command in the macro finishes. */
1912 if (NILP (Vexecuting_kbd_macro
))
1913 unbind_to (scount
, Qnil
);
1918 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1920 /* Note that the value cell will never directly contain nil
1921 if the symbol is a local variable. */
1922 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1923 safe_run_hooks (Qpost_command_hook
);
1925 /* If displaying a message, resize the echo area window to fit
1926 that message's size exactly. */
1927 if (!NILP (echo_area_buffer
[0]))
1928 resize_echo_area_exactly ();
1930 if (!NILP (Vdeferred_action_list
))
1931 safe_run_hooks (Qdeferred_action_function
);
1933 /* If there is a prefix argument,
1934 1) We don't want Vlast_command to be ``universal-argument''
1935 (that would be dumb), so don't set Vlast_command,
1936 2) we want to leave echoing on so that the prefix will be
1937 echoed as part of this key sequence, so don't call
1939 3) we want to leave this_command_key_count non-zero, so that
1940 read_char will realize that it is re-reading a character, and
1941 not echo it a second time.
1943 If the command didn't actually create a prefix arg,
1944 but is merely a frame event that is transparent to prefix args,
1945 then the above doesn't apply. */
1946 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1948 current_kboard
->Vlast_command
= Vthis_command
;
1949 current_kboard
->Vreal_last_command
= real_this_command
;
1950 if (!CONSP (last_command_event
))
1951 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1953 this_command_key_count
= 0;
1954 this_command_key_count_reset
= 0;
1955 this_single_command_key_start
= 0;
1958 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1960 /* In Emacs 22, setting transient-mark-mode to `only' was a
1961 way of turning it on for just one command. This usage is
1962 obsolete, but support it anyway. */
1963 if (EQ (Vtransient_mark_mode
, Qidentity
))
1964 Vtransient_mark_mode
= Qnil
;
1965 else if (EQ (Vtransient_mark_mode
, Qonly
))
1966 Vtransient_mark_mode
= Qidentity
;
1968 if (!NILP (Vdeactivate_mark
))
1969 call0 (Qdeactivate_mark
);
1970 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1971 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1976 if (current_buffer
== prev_buffer
1977 && last_point_position
!= PT
1978 && NILP (Vdisable_point_adjustment
)
1979 && NILP (Vglobal_disable_point_adjustment
))
1981 if (last_point_position
> BEGV
1982 && last_point_position
< ZV
1983 && (composition_adjust_point (last_point_position
,
1984 last_point_position
)
1985 != last_point_position
))
1986 /* The last point was temporarily set within a grapheme
1987 cluster to prevent automatic composition. To recover
1988 the automatic composition, we must update the
1990 windows_or_buffers_changed
++;
1991 if (!already_adjusted
)
1992 adjust_point_for_property (last_point_position
,
1993 MODIFF
!= prev_modiff
);
1996 /* Install chars successfully executed in kbd macro. */
1998 if (!NILP (current_kboard
->defining_kbd_macro
)
1999 && NILP (current_kboard
->Vprefix_arg
))
2000 finalize_kbd_macro_chars ();
2001 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2003 any_kboard_state ();
2008 extern Lisp_Object Qcomposition
, Qdisplay
;
2010 /* Adjust point to a boundary of a region that has such a property
2011 that should be treated intangible. For the moment, we check
2012 `composition', `display' and `invisible' properties.
2013 LAST_PT is the last position of point. */
2015 extern Lisp_Object Qafter_string
, Qbefore_string
;
2016 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2019 adjust_point_for_property (last_pt
, modified
)
2024 Lisp_Object val
, overlay
, tmp
;
2025 /* When called after buffer modification, we should temporarily
2026 suppress the point adjustment for automatic composition so that a
2027 user can keep inserting another character at point or keep
2028 deleting characters around point. */
2029 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
2032 /* FIXME: cycling is probably not necessary because these properties
2033 can't be usefully combined anyway. */
2034 while (check_composition
|| check_display
|| check_invisible
)
2036 /* FIXME: check `intangible'. */
2037 if (check_composition
2038 && PT
> BEGV
&& PT
< ZV
2039 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
2042 check_display
= check_invisible
= 1;
2044 check_composition
= 0;
2046 && PT
> BEGV
&& PT
< ZV
2047 && !NILP (val
= get_char_property_and_overlay
2048 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2049 && display_prop_intangible_p (val
)
2050 && (!OVERLAYP (overlay
)
2051 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2052 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2053 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2054 && (beg
< PT
/* && end > PT <- It's always the case. */
2055 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2058 SET_PT (PT
< last_pt
2059 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2061 check_composition
= check_invisible
= 1;
2064 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2066 int inv
, ellipsis
= 0;
2069 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2072 /* FIXME: We should stop if we find a spot between
2073 two runs of `invisible' where inserted text would
2074 be visible. This is important when we have two
2075 invisible boundaries that enclose an area: if the
2076 area is empty, we need this test in order to make
2077 it possible to place point in the middle rather
2078 than skip both boundaries. However, this code
2079 also stops anywhere in a non-sticky text-property,
2080 which breaks (e.g.) Org mode. */
2081 && (val
= get_pos_property (make_number (end
),
2083 TEXT_PROP_MEANS_INVISIBLE (val
))
2085 && !NILP (val
= get_char_property_and_overlay
2086 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2087 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2089 ellipsis
= ellipsis
|| inv
> 1
2090 || (OVERLAYP (overlay
)
2091 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2092 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2093 tmp
= Fnext_single_char_property_change
2094 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2095 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2099 && (val
= get_pos_property (make_number (beg
),
2101 TEXT_PROP_MEANS_INVISIBLE (val
))
2103 && !NILP (val
= get_char_property_and_overlay
2104 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2105 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2107 ellipsis
= ellipsis
|| inv
> 1
2108 || (OVERLAYP (overlay
)
2109 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2110 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2111 tmp
= Fprevious_single_char_property_change
2112 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2113 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2116 /* Move away from the inside area. */
2117 if (beg
< PT
&& end
> PT
)
2119 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2120 /* We haven't moved yet (so we don't need to fear
2121 infinite-looping) and we were outside the range
2122 before (so either end of the range still corresponds
2123 to a move in the right direction): pretend we moved
2124 less than we actually did, so that we still have
2125 more freedom below in choosing which end of the range
2127 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2128 /* We either have moved already or the last point
2129 was already in the range: we don't get to choose
2130 which end of the range we have to go to. */
2131 : (PT
< last_pt
? beg
: end
));
2132 check_composition
= check_display
= 1;
2134 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2135 the point to something other than its argument, due to
2136 point-motion hooks, intangibility, etc. */
2137 xassert (PT
== beg
|| PT
== end
);
2140 /* Pretend the area doesn't exist if the buffer is not
2142 if (!modified
&& !ellipsis
&& beg
< end
)
2144 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2145 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2146 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2147 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2148 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2149 /* We've already moved as far as we can. Trying to go
2150 to the other end would mean moving backwards and thus
2151 could lead to an infinite loop. */
2153 else if (val
= get_pos_property (make_number (PT
),
2155 TEXT_PROP_MEANS_INVISIBLE (val
)
2156 && (val
= get_pos_property
2157 (make_number (PT
== beg
? end
: beg
),
2159 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2160 (check_composition
= check_display
= 1,
2161 SET_PT (PT
== beg
? end
: beg
));
2164 check_invisible
= 0;
2168 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2171 safe_run_hooks_1 (hook
)
2174 if (NILP (Vrun_hooks
))
2176 return call1 (Vrun_hooks
, Vinhibit_quit
);
2179 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2182 safe_run_hooks_error (data
)
2185 Lisp_Object args
[3];
2186 args
[0] = build_string ("Error in %s: %s");
2187 args
[1] = Vinhibit_quit
;
2190 return Fset (Vinhibit_quit
, Qnil
);
2193 /* If we get an error while running the hook, cause the hook variable
2194 to be nil. Also inhibit quits, so that C-g won't cause the hook
2195 to mysteriously evaporate. */
2198 safe_run_hooks (hook
)
2201 int count
= SPECPDL_INDEX ();
2202 specbind (Qinhibit_quit
, hook
);
2204 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2206 unbind_to (count
, Qnil
);
2210 /* Number of seconds between polling for input. This is a Lisp
2211 variable that can be bound. */
2213 EMACS_INT polling_period
;
2215 /* Nonzero means polling for input is temporarily suppressed. */
2217 int poll_suppress_count
;
2219 /* Asynchronous timer for polling. */
2221 struct atimer
*poll_timer
;
2224 #ifdef POLL_FOR_INPUT
2226 /* Poll for input, so that we catch a C-g if it comes in. This
2227 function is called from x_make_frame_visible, see comment
2233 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2234 doing anything dangerous. */
2238 if (interrupt_input_blocked
== 0
2239 && !waiting_for_input
)
2240 read_avail_input (0);
2246 /* Timer callback function for poll_timer. TIMER is equal to
2250 poll_for_input (timer
)
2251 struct atimer
*timer
;
2253 if (poll_suppress_count
== 0)
2256 interrupt_input_pending
= 1;
2257 pending_signals
= 1;
2259 poll_for_input_1 ();
2264 #endif /* POLL_FOR_INPUT */
2266 /* Begin signals to poll for input, if they are appropriate.
2267 This function is called unconditionally from various places. */
2272 #ifdef POLL_FOR_INPUT
2273 /* XXX This condition was (read_socket_hook && !interrupt_input),
2274 but read_socket_hook is not global anymore. Let's pretend that
2276 if (!interrupt_input
)
2278 /* Turn alarm handling on unconditionally. It might have
2279 been turned off in process.c. */
2280 turn_on_atimers (1);
2282 /* If poll timer doesn't exist, are we need one with
2283 a different interval, start a new one. */
2284 if (poll_timer
== NULL
2285 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2287 EMACS_TIME interval
;
2290 cancel_atimer (poll_timer
);
2292 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2293 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2294 poll_for_input
, NULL
);
2297 /* Let the timer's callback function poll for input
2298 if this becomes zero. */
2299 --poll_suppress_count
;
2304 /* Nonzero if we are using polling to handle input asynchronously. */
2307 input_polling_used ()
2309 #ifdef POLL_FOR_INPUT
2310 /* XXX This condition was (read_socket_hook && !interrupt_input),
2311 but read_socket_hook is not global anymore. Let's pretend that
2313 return !interrupt_input
;
2319 /* Turn off polling. */
2324 #ifdef POLL_FOR_INPUT
2325 /* XXX This condition was (read_socket_hook && !interrupt_input),
2326 but read_socket_hook is not global anymore. Let's pretend that
2328 if (!interrupt_input
)
2329 ++poll_suppress_count
;
2333 /* Set the value of poll_suppress_count to COUNT
2334 and start or stop polling accordingly. */
2337 set_poll_suppress_count (count
)
2340 #ifdef POLL_FOR_INPUT
2341 if (count
== 0 && poll_suppress_count
!= 0)
2343 poll_suppress_count
= 1;
2346 else if (count
!= 0 && poll_suppress_count
== 0)
2350 poll_suppress_count
= count
;
2354 /* Bind polling_period to a value at least N.
2355 But don't decrease it. */
2358 bind_polling_period (n
)
2361 #ifdef POLL_FOR_INPUT
2362 int new = polling_period
;
2367 stop_other_atimers (poll_timer
);
2369 specbind (Qpolling_period
, make_number (new));
2370 /* Start a new alarm with the new period. */
2375 /* Apply the control modifier to CHARACTER. */
2381 /* Save the upper bits here. */
2382 int upper
= c
& ~0177;
2384 if (! ASCII_BYTE_P (c
))
2385 return c
|= ctrl_modifier
;
2389 /* Everything in the columns containing the upper-case letters
2390 denotes a control character. */
2391 if (c
>= 0100 && c
< 0140)
2395 /* Set the shift modifier for a control char
2396 made from a shifted letter. But only for letters! */
2397 if (oc
>= 'A' && oc
<= 'Z')
2398 c
|= shift_modifier
;
2401 /* The lower-case letters denote control characters too. */
2402 else if (c
>= 'a' && c
<= 'z')
2405 /* Include the bits for control and shift
2406 only if the basic ASCII code can't indicate them. */
2410 /* Replace the high bits. */
2411 c
|= (upper
& ~ctrl_modifier
);
2416 /* Display the help-echo property of the character after the mouse pointer.
2417 Either show it in the echo area, or call show-help-function to display
2418 it by other means (maybe in a tooltip).
2420 If HELP is nil, that means clear the previous help echo.
2422 If HELP is a string, display that string. If HELP is a function,
2423 call it with OBJECT and POS as arguments; the function should
2424 return a help string or nil for none. For all other types of HELP,
2425 evaluate it to obtain a string.
2427 WINDOW is the window in which the help was generated, if any.
2428 It is nil if not in a window.
2430 If OBJECT is a buffer, POS is the position in the buffer where the
2431 `help-echo' text property was found.
2433 If OBJECT is an overlay, that overlay has a `help-echo' property,
2434 and POS is the position in the overlay's buffer under the mouse.
2436 If OBJECT is a string (an overlay string or a string displayed with
2437 the `display' property). POS is the position in that string under
2440 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2441 echo overwrites a keystroke echo currently displayed in the echo
2444 Note: this function may only be called with HELP nil or a string
2445 from X code running asynchronously. */
2448 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2449 Lisp_Object help
, window
, object
, pos
;
2450 int ok_to_overwrite_keystroke_echo
;
2452 if (!NILP (help
) && !STRINGP (help
))
2454 if (FUNCTIONP (help
))
2456 Lisp_Object args
[4];
2461 help
= safe_call (4, args
);
2464 help
= safe_eval (help
);
2466 if (!STRINGP (help
))
2470 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2471 if (!noninteractive
&& STRINGP (help
))
2473 /* The mouse-fixup-help-message Lisp function can call
2474 mouse_position_hook, which resets the mouse_moved flags.
2475 This causes trouble if we are trying to read a mouse motion
2476 event (i.e., if we are inside a `track-mouse' form), so we
2477 restore the mouse_moved flag. */
2478 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2479 help
= call1 (Qmouse_fixup_help_message
, help
);
2485 if (STRINGP (help
) || NILP (help
))
2487 if (!NILP (Vshow_help_function
))
2488 call1 (Vshow_help_function
, help
);
2489 help_echo_showing_p
= STRINGP (help
);
2495 /* Input of single characters from keyboard */
2497 Lisp_Object
print_help ();
2498 static Lisp_Object
kbd_buffer_get_event ();
2499 static void record_char ();
2501 static Lisp_Object help_form_saved_window_configs
;
2503 read_char_help_form_unwind (Lisp_Object arg
)
2505 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2506 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2507 if (!NILP (window_config
))
2508 Fset_window_configuration (window_config
);
2512 #define STOP_POLLING \
2513 do { if (! polling_stopped_here) stop_polling (); \
2514 polling_stopped_here = 1; } while (0)
2516 #define RESUME_POLLING \
2517 do { if (polling_stopped_here) start_polling (); \
2518 polling_stopped_here = 0; } while (0)
2520 /* read a character from the keyboard; call the redisplay if needed */
2521 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2522 -1 means do not do redisplay, but do do autosaving.
2525 /* The arguments MAPS and NMAPS are for menu prompting.
2526 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2528 PREV_EVENT is the previous input event, or nil if we are reading
2529 the first event of a key sequence (or not reading a key sequence).
2530 If PREV_EVENT is t, that is a "magic" value that says
2531 not to run input methods, but in other respects to act as if
2532 not reading a key sequence.
2534 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2535 if we used a mouse menu to read the input, or zero otherwise. If
2536 USED_MOUSE_MENU is null, we don't dereference it.
2538 Value is -2 when we find input on another keyboard. A second call
2539 to read_char will read it.
2541 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2542 specifying the maximum time to wait until. If no input arrives by
2543 that time, stop waiting and return nil.
2545 Value is t if we showed a menu and the user rejected it. */
2548 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2552 Lisp_Object prev_event
;
2553 int *used_mouse_menu
;
2554 EMACS_TIME
*end_time
;
2556 volatile Lisp_Object c
;
2557 int count
, jmpcount
;
2558 jmp_buf local_getcjmp
;
2560 volatile int key_already_recorded
= 0;
2561 Lisp_Object tem
, save
;
2562 volatile Lisp_Object previous_echo_area_message
;
2563 volatile Lisp_Object also_record
;
2564 volatile int reread
;
2565 struct gcpro gcpro1
, gcpro2
;
2566 int polling_stopped_here
= 0;
2567 struct kboard
*orig_kboard
= current_kboard
;
2571 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2572 before_command_key_count
= this_command_key_count
;
2573 before_command_echo_length
= echo_length ();
2576 previous_echo_area_message
= Qnil
;
2578 GCPRO2 (c
, previous_echo_area_message
);
2583 if (CONSP (Vunread_post_input_method_events
))
2585 c
= XCAR (Vunread_post_input_method_events
);
2586 Vunread_post_input_method_events
2587 = XCDR (Vunread_post_input_method_events
);
2589 /* Undo what read_char_x_menu_prompt did when it unread
2590 additional keys returned by Fx_popup_menu. */
2592 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2600 if (unread_command_char
!= -1)
2602 XSETINT (c
, unread_command_char
);
2603 unread_command_char
= -1;
2609 if (CONSP (Vunread_command_events
))
2611 int was_disabled
= 0;
2613 c
= XCAR (Vunread_command_events
);
2614 Vunread_command_events
= XCDR (Vunread_command_events
);
2618 /* Undo what sit-for did when it unread additional keys
2619 inside universal-argument. */
2622 && EQ (XCAR (c
), Qt
))
2628 /* Undo what read_char_x_menu_prompt did when it unread
2629 additional keys returned by Fx_popup_menu. */
2631 && EQ (XCDR (c
), Qdisabled
)
2632 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2638 /* If the queued event is something that used the mouse,
2639 set used_mouse_menu accordingly. */
2641 /* Also check was_disabled so last-nonmenu-event won't return
2642 a bad value when submenus are involved. (Bug#447) */
2643 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2644 *used_mouse_menu
= 1;
2646 goto reread_for_input_method
;
2649 if (CONSP (Vunread_input_method_events
))
2651 c
= XCAR (Vunread_input_method_events
);
2652 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2654 /* Undo what read_char_x_menu_prompt did when it unread
2655 additional keys returned by Fx_popup_menu. */
2657 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2661 goto reread_for_input_method
;
2664 this_command_key_count_reset
= 0;
2666 if (!NILP (Vexecuting_kbd_macro
))
2668 /* We set this to Qmacro; since that's not a frame, nobody will
2669 try to switch frames on us, and the selected window will
2672 Since this event came from a macro, it would be misleading to
2673 leave internal_last_event_frame set to wherever the last
2674 real event came from. Normally, a switch-frame event selects
2675 internal_last_event_frame after each command is read, but
2676 events read from a macro should never cause a new frame to be
2678 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2680 /* Exit the macro if we are at the end.
2681 Also, some things replace the macro with t
2682 to force an early exit. */
2683 if (EQ (Vexecuting_kbd_macro
, Qt
)
2684 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2690 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2691 if (STRINGP (Vexecuting_kbd_macro
)
2692 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2693 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2695 executing_kbd_macro_index
++;
2700 if (!NILP (unread_switch_frame
))
2702 c
= unread_switch_frame
;
2703 unread_switch_frame
= Qnil
;
2705 /* This event should make it into this_command_keys, and get echoed
2706 again, so we do not set `reread'. */
2710 /* if redisplay was requested */
2711 if (commandflag
>= 0)
2713 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2715 /* If there is pending input, process any events which are not
2716 user-visible, such as X selection_request events. */
2718 || detect_input_pending_run_timers (0))
2719 swallow_events (0); /* may clear input_pending */
2721 /* Redisplay if no pending input. */
2722 while (!input_pending
)
2724 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2725 redisplay_preserve_echo_area (5);
2730 /* Normal case: no input arrived during redisplay. */
2733 /* Input arrived and pre-empted redisplay.
2734 Process any events which are not user-visible. */
2736 /* If that cleared input_pending, try again to redisplay. */
2739 /* Prevent the redisplay we just did
2740 from messing up echoing of the input after the prompt. */
2741 if (commandflag
== 0 && echo_current
)
2742 echo_message_buffer
= echo_area_buffer
[0];
2746 /* Message turns off echoing unless more keystrokes turn it on again.
2748 The code in 20.x for the condition was
2750 1. echo_area_glyphs && *echo_area_glyphs
2751 2. && echo_area_glyphs != current_kboard->echobuf
2752 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2754 (1) means there's a current message displayed
2756 (2) means it's not the message from echoing from the current
2759 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2760 is set to a non-null value. This is done in read_char and it is
2761 set to echo_area_glyphs after a call to echo_char. That means
2762 ok_to_echo_at_next_pause is either null or
2763 current_kboard->echobuf with the appropriate current_kboard at
2766 So, condition (3) means in clear text ok_to_echo_at_next_pause
2767 must be either null, or the current message isn't from echoing at
2768 all, or it's from echoing from a different kboard than the
2771 if (/* There currently is something in the echo area. */
2772 !NILP (echo_area_buffer
[0])
2773 && (/* And it's either not from echoing. */
2774 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2775 /* Or it's an echo from a different kboard. */
2776 || echo_kboard
!= current_kboard
2777 /* Or we explicitly allow overwriting whatever there is. */
2778 || ok_to_echo_at_next_pause
== NULL
))
2783 /* Try reading a character via menu prompting in the minibuf.
2784 Try this before the sit-for, because the sit-for
2785 would do the wrong thing if we are supposed to do
2786 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2787 after a mouse event so don't try a minibuf menu. */
2789 if (nmaps
> 0 && INTERACTIVE
2790 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2791 /* Don't bring up a menu if we already have another event. */
2792 && NILP (Vunread_command_events
)
2793 && unread_command_char
< 0
2794 && !detect_input_pending_run_timers (0))
2796 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2798 if (INTEGERP (c
) && XINT (c
) == -2)
2799 return c
; /* wrong_kboard_jmpbuf */
2803 key_already_recorded
= 1;
2808 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2809 We will do that below, temporarily for short sections of code,
2810 when appropriate. local_getcjmp must be in effect
2811 around any call to sit_for or kbd_buffer_get_event;
2812 it *must not* be in effect when we call redisplay. */
2814 jmpcount
= SPECPDL_INDEX ();
2815 if (_setjmp (local_getcjmp
))
2817 /* Handle quits while reading the keyboard. */
2818 /* We must have saved the outer value of getcjmp here,
2819 so restore it now. */
2820 restore_getcjmp (save_jump
);
2821 unbind_to (jmpcount
, Qnil
);
2822 XSETINT (c
, quit_char
);
2823 internal_last_event_frame
= selected_frame
;
2824 Vlast_event_frame
= internal_last_event_frame
;
2825 /* If we report the quit char as an event,
2826 don't do so more than once. */
2827 if (!NILP (Vinhibit_quit
))
2831 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2832 if (kb
!= current_kboard
)
2834 Lisp_Object link
= kb
->kbd_queue
;
2835 /* We shouldn't get here if we were in single-kboard mode! */
2840 while (CONSP (XCDR (link
)))
2842 if (!NILP (XCDR (link
)))
2846 kb
->kbd_queue
= Fcons (c
, Qnil
);
2848 XSETCDR (link
, Fcons (c
, Qnil
));
2849 kb
->kbd_queue_has_data
= 1;
2850 current_kboard
= kb
;
2851 /* This is going to exit from read_char
2852 so we had better get rid of this frame's stuff. */
2854 return make_number (-2); /* wrong_kboard_jmpbuf */
2860 /* Start idle timers if no time limit is supplied. We don't do it
2861 if a time limit is supplied to avoid an infinite recursion in the
2862 situation where an idle timer calls `sit-for'. */
2865 timer_start_idle ();
2867 /* If in middle of key sequence and minibuffer not active,
2868 start echoing if enough time elapses. */
2870 if (minibuf_level
== 0
2872 && !current_kboard
->immediate_echo
2873 && this_command_key_count
> 0
2875 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2876 && NILP (Fzerop (Vecho_keystrokes
))
2877 && (/* No message. */
2878 NILP (echo_area_buffer
[0])
2879 /* Or empty message. */
2880 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2881 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2882 /* Or already echoing from same kboard. */
2883 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2884 /* Or not echoing before and echoing allowed. */
2885 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2887 /* After a mouse event, start echoing right away.
2888 This is because we are probably about to display a menu,
2889 and we don't want to delay before doing so. */
2890 if (EVENT_HAS_PARAMETERS (prev_event
))
2896 save_getcjmp (save_jump
);
2897 restore_getcjmp (local_getcjmp
);
2898 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2899 restore_getcjmp (save_jump
);
2901 && ! CONSP (Vunread_command_events
))
2906 /* Maybe auto save due to number of keystrokes. */
2908 if (commandflag
!= 0
2909 && auto_save_interval
> 0
2910 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2911 && !detect_input_pending_run_timers (0))
2913 Fdo_auto_save (Qnil
, Qnil
);
2914 /* Hooks can actually change some buffers in auto save. */
2918 /* Try reading using an X menu.
2919 This is never confused with reading using the minibuf
2920 because the recursive call of read_char in read_char_minibuf_menu_prompt
2921 does not pass on any keymaps. */
2923 if (nmaps
> 0 && INTERACTIVE
2924 && !NILP (prev_event
)
2925 && EVENT_HAS_PARAMETERS (prev_event
)
2926 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2927 && !EQ (XCAR (prev_event
), Qtool_bar
)
2928 /* Don't bring up a menu if we already have another event. */
2929 && NILP (Vunread_command_events
)
2930 && unread_command_char
< 0)
2932 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2934 /* Now that we have read an event, Emacs is not idle. */
2941 /* Maybe autosave and/or garbage collect due to idleness. */
2943 if (INTERACTIVE
&& NILP (c
))
2945 int delay_level
, buffer_size
;
2947 /* Slow down auto saves logarithmically in size of current buffer,
2948 and garbage collect while we're at it. */
2949 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2950 last_non_minibuf_size
= Z
- BEG
;
2951 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2953 while (buffer_size
> 64)
2954 delay_level
++, buffer_size
-= buffer_size
>> 2;
2955 if (delay_level
< 4) delay_level
= 4;
2956 /* delay_level is 4 for files under around 50k, 7 at 100k,
2957 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2959 /* Auto save if enough time goes by without input. */
2960 if (commandflag
!= 0
2961 && num_nonmacro_input_events
> last_auto_save
2962 && INTEGERP (Vauto_save_timeout
)
2963 && XINT (Vauto_save_timeout
) > 0)
2966 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2968 save_getcjmp (save_jump
);
2969 restore_getcjmp (local_getcjmp
);
2970 tem0
= sit_for (make_number (timeout
), 1, 1);
2971 restore_getcjmp (save_jump
);
2974 && ! CONSP (Vunread_command_events
))
2976 Fdo_auto_save (Qnil
, Qnil
);
2978 /* If we have auto-saved and there is still no input
2979 available, garbage collect if there has been enough
2980 consing going on to make it worthwhile. */
2981 if (!detect_input_pending_run_timers (0)
2982 && consing_since_gc
> gc_cons_threshold
/ 2)
2983 Fgarbage_collect ();
2990 /* Notify the caller if an autosave hook, or a timer, sentinel or
2991 filter in the sit_for calls above have changed the current
2992 kboard. This could happen if they use the minibuffer or start a
2993 recursive edit, like the fancy splash screen in server.el's
2994 filter. If this longjmp wasn't here, read_key_sequence would
2995 interpret the next key sequence using the wrong translation
2996 tables and function keymaps. */
2997 if (NILP (c
) && current_kboard
!= orig_kboard
)
3000 return make_number (-2); /* wrong_kboard_jmpbuf */
3003 /* If this has become non-nil here, it has been set by a timer
3004 or sentinel or filter. */
3005 if (CONSP (Vunread_command_events
))
3007 c
= XCAR (Vunread_command_events
);
3008 Vunread_command_events
= XCDR (Vunread_command_events
);
3011 /* Read something from current KBOARD's side queue, if possible. */
3015 if (current_kboard
->kbd_queue_has_data
)
3017 if (!CONSP (current_kboard
->kbd_queue
))
3019 c
= XCAR (current_kboard
->kbd_queue
);
3020 current_kboard
->kbd_queue
3021 = XCDR (current_kboard
->kbd_queue
);
3022 if (NILP (current_kboard
->kbd_queue
))
3023 current_kboard
->kbd_queue_has_data
= 0;
3024 input_pending
= readable_events (0);
3025 if (EVENT_HAS_PARAMETERS (c
)
3026 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3027 internal_last_event_frame
= XCAR (XCDR (c
));
3028 Vlast_event_frame
= internal_last_event_frame
;
3032 /* If current_kboard's side queue is empty check the other kboards.
3033 If one of them has data that we have not yet seen here,
3034 switch to it and process the data waiting for it.
3036 Note: if the events queued up for another kboard
3037 have already been seen here, and therefore are not a complete command,
3038 the kbd_queue_has_data field is 0, so we skip that kboard here.
3039 That's to avoid an infinite loop switching between kboards here. */
3040 if (NILP (c
) && !single_kboard
)
3043 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3044 if (kb
->kbd_queue_has_data
)
3046 current_kboard
= kb
;
3047 /* This is going to exit from read_char
3048 so we had better get rid of this frame's stuff. */
3050 return make_number (-2); /* wrong_kboard_jmpbuf */
3058 /* Finally, we read from the main queue,
3059 and if that gives us something we can't use yet, we put it on the
3060 appropriate side queue and try again. */
3069 EMACS_GET_TIME (now
);
3070 if (EMACS_TIME_GE (now
, *end_time
))
3074 /* Actually read a character, waiting if necessary. */
3075 save_getcjmp (save_jump
);
3076 restore_getcjmp (local_getcjmp
);
3078 timer_start_idle ();
3079 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3080 restore_getcjmp (save_jump
);
3082 if (! NILP (c
) && (kb
!= current_kboard
))
3084 Lisp_Object link
= kb
->kbd_queue
;
3087 while (CONSP (XCDR (link
)))
3089 if (!NILP (XCDR (link
)))
3093 kb
->kbd_queue
= Fcons (c
, Qnil
);
3095 XSETCDR (link
, Fcons (c
, Qnil
));
3096 kb
->kbd_queue_has_data
= 1;
3100 current_kboard
= kb
;
3101 /* This is going to exit from read_char
3102 so we had better get rid of this frame's stuff. */
3104 return make_number (-2);
3108 /* Terminate Emacs in batch mode if at eof. */
3109 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3110 Fkill_emacs (make_number (1));
3114 /* Add in any extra modifiers, where appropriate. */
3115 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3116 || ((extra_keyboard_modifiers
& 0177) < ' '
3117 && (extra_keyboard_modifiers
& 0177) != 0))
3118 XSETINT (c
, make_ctrl_char (XINT (c
)));
3120 /* Transfer any other modifier bits directly from
3121 extra_keyboard_modifiers to c. Ignore the actual character code
3122 in the low 16 bits of extra_keyboard_modifiers. */
3123 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3134 if (commandflag
>= 0
3135 && !input_pending
&& !detect_input_pending_run_timers (0))
3143 /* Buffer switch events are only for internal wakeups
3144 so don't show them to the user.
3145 Also, don't record a key if we already did. */
3146 if (BUFFERP (c
) || key_already_recorded
)
3149 /* Process special events within read_char
3150 and loop around to read another event. */
3153 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3158 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3159 int was_locked
= single_kboard
;
3160 int count
= SPECPDL_INDEX ();
3161 record_single_kboard_state ();
3164 last_input_event
= c
;
3165 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3167 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3168 /* We stopped being idle for this event; undo that. This
3169 prevents automatic window selection (under
3170 mouse_autoselect_window from acting as a real input event, for
3171 example banishing the mouse under mouse-avoidance-mode. */
3172 timer_resume_idle ();
3174 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3175 /* Resume allowing input from any kboard, if that was true before. */
3177 any_kboard_state ();
3178 unbind_to (count
, Qnil
);
3184 /* Handle things that only apply to characters. */
3187 /* If kbd_buffer_get_event gave us an EOF, return that. */
3191 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3192 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3193 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3194 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3195 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3199 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3200 /* nil in keyboard-translate-table means no translation. */
3206 /* If this event is a mouse click in the menu bar,
3207 return just menu-bar for now. Modify the mouse click event
3208 so we won't do this twice, then queue it up. */
3209 if (EVENT_HAS_PARAMETERS (c
)
3211 && CONSP (EVENT_START (c
))
3212 && CONSP (XCDR (EVENT_START (c
))))
3216 posn
= POSN_POSN (EVENT_START (c
));
3217 /* Handle menu-bar events:
3218 insert the dummy prefix event `menu-bar'. */
3219 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3221 /* Change menu-bar to (menu-bar) as the event "position". */
3222 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3225 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3230 /* Store these characters into recent_keys, the dribble file if any,
3231 and the keyboard macro being defined, if any. */
3233 if (! NILP (also_record
))
3234 record_char (also_record
);
3236 /* Wipe the echo area.
3237 But first, if we are about to use an input method,
3238 save the echo area contents for it to refer to. */
3240 && ! NILP (Vinput_method_function
)
3241 && (unsigned) XINT (c
) >= ' '
3242 && (unsigned) XINT (c
) != 127
3243 && (unsigned) XINT (c
) < 256)
3245 previous_echo_area_message
= Fcurrent_message ();
3246 Vinput_method_previous_message
= previous_echo_area_message
;
3249 /* Now wipe the echo area, except for help events which do their
3250 own stuff with the echo area. */
3252 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3253 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3255 if (!NILP (echo_area_buffer
[0]))
3256 safe_run_hooks (Qecho_area_clear_hook
);
3257 clear_message (1, 0);
3260 reread_for_input_method
:
3262 /* Pass this to the input method, if appropriate. */
3264 && ! NILP (Vinput_method_function
)
3265 /* Don't run the input method within a key sequence,
3266 after the first event of the key sequence. */
3267 && NILP (prev_event
)
3268 && (unsigned) XINT (c
) >= ' '
3269 && (unsigned) XINT (c
) != 127
3270 && (unsigned) XINT (c
) < 256)
3273 int key_count
, key_count_reset
;
3274 struct gcpro gcpro1
;
3275 int count
= SPECPDL_INDEX ();
3277 /* Save the echo status. */
3278 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3279 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3280 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3281 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3284 if (before_command_restore_flag
)
3286 this_command_key_count
= before_command_key_count_1
;
3287 if (this_command_key_count
< this_single_command_key_start
)
3288 this_single_command_key_start
= this_command_key_count
;
3289 echo_truncate (before_command_echo_length_1
);
3290 before_command_restore_flag
= 0;
3294 /* Save the this_command_keys status. */
3295 key_count
= this_command_key_count
;
3296 key_count_reset
= this_command_key_count_reset
;
3299 keys
= Fcopy_sequence (this_command_keys
);
3304 /* Clear out this_command_keys. */
3305 this_command_key_count
= 0;
3306 this_command_key_count_reset
= 0;
3308 /* Now wipe the echo area. */
3309 if (!NILP (echo_area_buffer
[0]))
3310 safe_run_hooks (Qecho_area_clear_hook
);
3311 clear_message (1, 0);
3314 /* If we are not reading a key sequence,
3315 never use the echo area. */
3318 specbind (Qinput_method_use_echo_area
, Qt
);
3321 /* Call the input method. */
3322 tem
= call1 (Vinput_method_function
, c
);
3324 tem
= unbind_to (count
, tem
);
3326 /* Restore the saved echoing state
3327 and this_command_keys state. */
3328 this_command_key_count
= key_count
;
3329 this_command_key_count_reset
= key_count_reset
;
3331 this_command_keys
= keys
;
3334 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3335 current_kboard
->echo_string
= saved_echo_string
;
3336 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3337 if (saved_immediate_echo
)
3342 /* The input method can return no events. */
3345 /* Bring back the previous message, if any. */
3346 if (! NILP (previous_echo_area_message
))
3347 message_with_string ("%s", previous_echo_area_message
, 0);
3350 /* It returned one event or more. */
3352 Vunread_post_input_method_events
3353 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3358 /* Display help if not echoing. */
3359 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3361 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3362 Lisp_Object help
, object
, position
, window
, tem
;
3364 tem
= Fcdr (XCDR (c
));
3367 window
= Fcar (tem
);
3369 object
= Fcar (tem
);
3371 position
= Fcar (tem
);
3373 show_help_echo (help
, window
, object
, position
, 0);
3375 /* We stopped being idle for this event; undo that. */
3377 timer_resume_idle ();
3381 if ((! reread
|| this_command_key_count
== 0
3382 || this_command_key_count_reset
)
3386 /* Don't echo mouse motion events. */
3387 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3388 && NILP (Fzerop (Vecho_keystrokes
))
3389 && ! (EVENT_HAS_PARAMETERS (c
)
3390 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3393 if (! NILP (also_record
))
3394 echo_char (also_record
);
3395 /* Once we reread a character, echoing can happen
3396 the next time we pause to read a new one. */
3397 ok_to_echo_at_next_pause
= current_kboard
;
3400 /* Record this character as part of the current key. */
3401 add_command_key (c
);
3402 if (! NILP (also_record
))
3403 add_command_key (also_record
);
3406 last_input_event
= c
;
3409 /* Process the help character specially if enabled */
3410 if (!NILP (Vhelp_form
) && help_char_p (c
))
3413 count
= SPECPDL_INDEX ();
3415 help_form_saved_window_configs
3416 = Fcons (Fcurrent_window_configuration (Qnil
),
3417 help_form_saved_window_configs
);
3418 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3420 tem0
= Feval (Vhelp_form
);
3422 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3427 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3428 if (EVENT_HAS_PARAMETERS (c
)
3429 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3430 XSETCAR (help_form_saved_window_configs
, Qnil
);
3432 while (BUFFERP (c
));
3433 /* Remove the help from the frame */
3434 unbind_to (count
, Qnil
);
3437 if (EQ (c
, make_number (040)))
3441 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3442 while (BUFFERP (c
));
3451 /* Record a key that came from a mouse menu.
3452 Record it for echoing, for this-command-keys, and so on. */
3458 /* Wipe the echo area. */
3459 clear_message (1, 0);
3464 before_command_key_count
= this_command_key_count
;
3465 before_command_echo_length
= echo_length ();
3468 /* Don't echo mouse motion events. */
3469 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3470 && NILP (Fzerop (Vecho_keystrokes
)))
3474 /* Once we reread a character, echoing can happen
3475 the next time we pause to read a new one. */
3476 ok_to_echo_at_next_pause
= 0;
3479 /* Record this character as part of the current key. */
3480 add_command_key (c
);
3482 /* Re-reading in the middle of a command */
3483 last_input_event
= c
;
3487 /* Return 1 if should recognize C as "the help character". */
3495 if (EQ (c
, Vhelp_char
))
3497 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3498 if (EQ (c
, XCAR (tail
)))
3503 /* Record the input event C in various ways. */
3511 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3513 /* To avoid filling recent_keys with help-echo and mouse-movement
3514 events, we filter out repeated help-echo events, only store the
3515 first and last in a series of mouse-movement events, and don't
3516 store repeated help-echo events which are only separated by
3517 mouse-movement events. */
3519 Lisp_Object ev1
, ev2
, ev3
;
3522 if ((ix1
= recent_keys_index
- 1) < 0)
3523 ix1
= NUM_RECENT_KEYS
- 1;
3524 ev1
= AREF (recent_keys
, ix1
);
3526 if ((ix2
= ix1
- 1) < 0)
3527 ix2
= NUM_RECENT_KEYS
- 1;
3528 ev2
= AREF (recent_keys
, ix2
);
3530 if ((ix3
= ix2
- 1) < 0)
3531 ix3
= NUM_RECENT_KEYS
- 1;
3532 ev3
= AREF (recent_keys
, ix3
);
3534 if (EQ (XCAR (c
), Qhelp_echo
))
3536 /* Don't record `help-echo' in recent_keys unless it shows some help
3537 message, and a different help than the previously recorded
3539 Lisp_Object help
, last_help
;
3541 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3542 if (!STRINGP (help
))
3544 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3545 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3547 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3548 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3549 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3551 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3552 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3553 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3554 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3557 else if (EQ (XCAR (c
), Qmouse_movement
))
3559 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3560 So additional mouse movement events replace the last element. */
3561 Lisp_Object last_window
, window
;
3563 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3564 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3565 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3566 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3567 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3569 ASET (recent_keys
, ix1
, c
);
3575 store_kbd_macro_char (c
);
3580 ASET (recent_keys
, recent_keys_index
, c
);
3581 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3582 recent_keys_index
= 0;
3584 else if (recorded
< 0)
3586 /* We need to remove one or two events from recent_keys.
3587 To do this, we simply put nil at those events and move the
3588 recent_keys_index backwards over those events. Usually,
3589 users will never see those nil events, as they will be
3590 overwritten by the command keys entered to see recent_keys
3593 while (recorded
++ < 0 && total_keys
> 0)
3595 if (total_keys
< NUM_RECENT_KEYS
)
3597 if (--recent_keys_index
< 0)
3598 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3599 ASET (recent_keys
, recent_keys_index
, Qnil
);
3603 num_nonmacro_input_events
++;
3605 /* Write c to the dribble file. If c is a lispy event, write
3606 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3607 If you, dear reader, have a better idea, you've got the source. :-) */
3613 if (XUINT (c
) < 0x100)
3614 putc (XINT (c
), dribble
);
3616 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3620 Lisp_Object dribblee
;
3622 /* If it's a structured event, take the event header. */
3623 dribblee
= EVENT_HEAD (c
);
3625 if (SYMBOLP (dribblee
))
3627 putc ('<', dribble
);
3628 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3629 SBYTES (SYMBOL_NAME (dribblee
)),
3631 putc ('>', dribble
);
3644 struct buffer
*old
= current_buffer
;
3645 Fprinc (object
, Qnil
);
3646 set_buffer_internal (XBUFFER (Vstandard_output
));
3647 call0 (intern ("help-mode"));
3648 set_buffer_internal (old
);
3652 /* Copy out or in the info on where C-g should throw to.
3653 This is used when running Lisp code from within get_char,
3654 in case get_char is called recursively.
3655 See read_process_output. */
3661 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3665 restore_getcjmp (temp
)
3668 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3671 /* Low level keyboard/mouse input.
3672 kbd_buffer_store_event places events in kbd_buffer, and
3673 kbd_buffer_get_event retrieves them. */
3675 /* Return true if there are any events in the queue that read-char
3676 would return. If this returns false, a read-char would block. */
3678 readable_events (flags
)
3682 /* Check whether a D-Bus message has arrived. */
3683 if (xd_pending_messages () > 0)
3685 #endif /* HAVE_DBUS */
3687 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3690 /* If the buffer contains only FOCUS_IN_EVENT events, and
3691 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3692 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3694 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3695 #ifdef USE_TOOLKIT_SCROLL_BARS
3696 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3700 struct input_event
*event
;
3702 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3709 #ifdef USE_TOOLKIT_SCROLL_BARS
3710 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3712 event
->kind
== FOCUS_IN_EVENT
)
3713 #ifdef USE_TOOLKIT_SCROLL_BARS
3714 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3715 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3716 && event
->part
== scroll_bar_handle
3717 && event
->modifiers
== 0)
3722 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3725 while (event
!= kbd_store_ptr
);
3731 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3732 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3733 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3738 if (current_kboard
->kbd_queue_has_data
)
3744 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3745 if (kb
->kbd_queue_has_data
)
3751 /* Set this for debugging, to have a way to get out */
3755 event_to_kboard (event
)
3756 struct input_event
*event
;
3759 frame
= event
->frame_or_window
;
3761 frame
= XCAR (frame
);
3762 else if (WINDOWP (frame
))
3763 frame
= WINDOW_FRAME (XWINDOW (frame
));
3765 /* There are still some events that don't set this field.
3766 For now, just ignore the problem.
3767 Also ignore dead frames here. */
3768 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3771 return FRAME_KBOARD (XFRAME (frame
));
3775 Lisp_Object Vthrow_on_input
;
3777 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3780 kbd_buffer_store_event (event
)
3781 register struct input_event
*event
;
3783 kbd_buffer_store_event_hold (event
, 0);
3786 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3788 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3789 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3790 Else, if EVENT is a quit event, store the quit event
3791 in HOLD_QUIT, and return (thus ignoring further events).
3793 This is used in read_avail_input to postpone the processing
3794 of the quit event until all subsequent input events have been
3795 parsed (and discarded).
3799 kbd_buffer_store_event_hold (event
, hold_quit
)
3800 register struct input_event
*event
;
3801 struct input_event
*hold_quit
;
3803 if (event
->kind
== NO_EVENT
)
3806 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3809 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3811 register int c
= event
->code
& 0377;
3813 if (event
->modifiers
& ctrl_modifier
)
3814 c
= make_ctrl_char (c
);
3816 c
|= (event
->modifiers
3817 & (meta_modifier
| alt_modifier
3818 | hyper_modifier
| super_modifier
));
3822 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3823 struct input_event
*sp
;
3825 if (single_kboard
&& kb
!= current_kboard
)
3828 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3829 Fcons (make_number (c
), Qnil
));
3830 kb
->kbd_queue_has_data
= 1;
3831 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3833 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3836 if (event_to_kboard (sp
) == kb
)
3838 sp
->kind
= NO_EVENT
;
3839 sp
->frame_or_window
= Qnil
;
3848 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3852 /* If this results in a quit_char being returned to Emacs as
3853 input, set Vlast_event_frame properly. If this doesn't
3854 get returned to Emacs as an event, the next event read
3855 will set Vlast_event_frame again, so this is safe to do. */
3859 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3861 focus
= event
->frame_or_window
;
3862 internal_last_event_frame
= focus
;
3863 Vlast_event_frame
= focus
;
3866 last_event_timestamp
= event
->timestamp
;
3867 handle_interrupt ();
3871 if (c
&& c
== stop_character
)
3877 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3878 Just ignore the second one. */
3879 else if (event
->kind
== BUFFER_SWITCH_EVENT
3880 && kbd_fetch_ptr
!= kbd_store_ptr
3881 && ((kbd_store_ptr
== kbd_buffer
3882 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3883 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3886 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3887 kbd_store_ptr
= kbd_buffer
;
3889 /* Don't let the very last slot in the buffer become full,
3890 since that would make the two pointers equal,
3891 and that is indistinguishable from an empty buffer.
3892 Discard the event if it would fill the last slot. */
3893 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3895 *kbd_store_ptr
= *event
;
3899 /* If we're inside while-no-input, and this event qualifies
3900 as input, set quit-flag to cause an interrupt. */
3901 if (!NILP (Vthrow_on_input
)
3902 && event
->kind
!= FOCUS_IN_EVENT
3903 && event
->kind
!= HELP_EVENT
3904 && event
->kind
!= DEICONIFY_EVENT
)
3906 Vquit_flag
= Vthrow_on_input
;
3907 /* If we're inside a function that wants immediate quits,
3909 if (immediate_quit
&& NILP (Vinhibit_quit
))
3919 /* Put an input event back in the head of the event queue. */
3922 kbd_buffer_unget_event (event
)
3923 register struct input_event
*event
;
3925 if (kbd_fetch_ptr
== kbd_buffer
)
3926 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3928 /* Don't let the very last slot in the buffer become full, */
3929 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3932 *kbd_fetch_ptr
= *event
;
3937 /* Generate HELP_EVENT input_events in BUFP which has room for
3938 SIZE events. If there's not enough room in BUFP, ignore this
3941 HELP is the help form.
3943 FRAME is the frame on which the help is generated. OBJECT is the
3944 Lisp object where the help was found (a buffer, a string, an
3945 overlay, or nil if neither from a string nor from a buffer. POS is
3946 the position within OBJECT where the help was found.
3948 Value is the number of input_events generated. */
3951 gen_help_event (help
, frame
, window
, object
, pos
)
3952 Lisp_Object help
, frame
, object
, window
;
3955 struct input_event event
;
3959 event
.kind
= HELP_EVENT
;
3960 event
.frame_or_window
= frame
;
3962 event
.x
= WINDOWP (window
) ? window
: frame
;
3965 kbd_buffer_store_event (&event
);
3969 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3972 kbd_buffer_store_help_event (frame
, help
)
3973 Lisp_Object frame
, help
;
3975 struct input_event event
;
3977 event
.kind
= HELP_EVENT
;
3978 event
.frame_or_window
= frame
;
3983 kbd_buffer_store_event (&event
);
3987 /* Discard any mouse events in the event buffer by setting them to
3990 discard_mouse_events ()
3992 struct input_event
*sp
;
3993 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3995 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3998 if (sp
->kind
== MOUSE_CLICK_EVENT
3999 || sp
->kind
== WHEEL_EVENT
4000 || sp
->kind
== HORIZ_WHEEL_EVENT
4002 || sp
->kind
== GPM_CLICK_EVENT
4004 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
4006 sp
->kind
= NO_EVENT
;
4012 /* Return non-zero if there are any real events waiting in the event
4013 buffer, not counting `NO_EVENT's.
4015 If DISCARD is non-zero, discard NO_EVENT events at the front of
4016 the input queue, possibly leaving the input queue empty if there
4017 are no real input events. */
4020 kbd_buffer_events_waiting (discard
)
4023 struct input_event
*sp
;
4025 for (sp
= kbd_fetch_ptr
;
4026 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4029 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4036 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4040 /* Clear input event EVENT. */
4044 struct input_event
*event
;
4046 event
->kind
= NO_EVENT
;
4050 /* Read one event from the event buffer, waiting if necessary.
4051 The value is a Lisp object representing the event.
4052 The value is nil for an event that should be ignored,
4053 or that was handled here.
4054 We always read and discard one event. */
4057 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4059 int *used_mouse_menu
;
4060 EMACS_TIME
*end_time
;
4066 /* In case we are running as a daemon, only do this before
4067 detaching from the terminal. */
4068 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
4072 *kbp
= current_kboard
;
4076 /* Wait until there is input available. */
4079 /* Break loop if there's an unread command event. Needed in
4080 moused window autoselection which uses a timer to insert such
4082 if (CONSP (Vunread_command_events
))
4085 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4087 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4088 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4092 /* If the quit flag is set, then read_char will return
4093 quit_char, so that counts as "available input." */
4094 if (!NILP (Vquit_flag
))
4095 quit_throw_to_read_char ();
4097 /* One way or another, wait until input is available; then, if
4098 interrupt handlers have not read it, read it now. */
4100 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4104 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4106 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4107 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4112 EMACS_TIME duration
;
4113 EMACS_GET_TIME (duration
);
4114 if (EMACS_TIME_GE (duration
, *end_time
))
4115 return Qnil
; /* finished waiting */
4118 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4119 wait_reading_process_output (EMACS_SECS (duration
),
4120 EMACS_USECS (duration
),
4121 -1, 1, Qnil
, NULL
, 0);
4125 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4127 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4128 /* Pass 1 for EXPECT since we just waited to have input. */
4129 read_avail_input (1);
4132 if (CONSP (Vunread_command_events
))
4135 first
= XCAR (Vunread_command_events
);
4136 Vunread_command_events
= XCDR (Vunread_command_events
);
4137 *kbp
= current_kboard
;
4141 /* At this point, we know that there is a readable event available
4142 somewhere. If the event queue is empty, then there must be a
4143 mouse movement enabled and available. */
4144 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4146 struct input_event
*event
;
4148 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4152 last_event_timestamp
= event
->timestamp
;
4154 *kbp
= event_to_kboard (event
);
4156 *kbp
= current_kboard
; /* Better than returning null ptr? */
4160 /* These two kinds of events get special handling
4161 and don't actually appear to the command loop.
4162 We return nil for them. */
4163 if (event
->kind
== SELECTION_REQUEST_EVENT
4164 || event
->kind
== SELECTION_CLEAR_EVENT
)
4167 struct input_event copy
;
4169 /* Remove it from the buffer before processing it,
4170 since otherwise swallow_events will see it
4171 and process it again. */
4173 kbd_fetch_ptr
= event
+ 1;
4174 input_pending
= readable_events (0);
4175 x_handle_selection_event (©
);
4177 /* We're getting selection request events, but we don't have
4183 #if defined (HAVE_NS)
4184 else if (event
->kind
== NS_TEXT_EVENT
)
4186 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4187 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4189 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4190 kbd_fetch_ptr
= event
+ 1;
4191 if (used_mouse_menu
)
4192 *used_mouse_menu
= 1;
4196 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4197 || defined (HAVE_NS)
4198 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4200 /* Make an event (delete-frame (FRAME)). */
4201 obj
= Fcons (event
->frame_or_window
, Qnil
);
4202 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4203 kbd_fetch_ptr
= event
+ 1;
4206 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4207 || defined (HAVE_NS)
4208 else if (event
->kind
== ICONIFY_EVENT
)
4210 /* Make an event (iconify-frame (FRAME)). */
4211 obj
= Fcons (event
->frame_or_window
, Qnil
);
4212 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4213 kbd_fetch_ptr
= event
+ 1;
4215 else if (event
->kind
== DEICONIFY_EVENT
)
4217 /* Make an event (make-frame-visible (FRAME)). */
4218 obj
= Fcons (event
->frame_or_window
, Qnil
);
4219 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4220 kbd_fetch_ptr
= event
+ 1;
4223 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4225 /* The value doesn't matter here; only the type is tested. */
4226 XSETBUFFER (obj
, current_buffer
);
4227 kbd_fetch_ptr
= event
+ 1;
4229 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4230 || defined(HAVE_NS) || defined (USE_GTK)
4231 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4233 kbd_fetch_ptr
= event
+ 1;
4234 input_pending
= readable_events (0);
4235 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4236 x_activate_menubar (XFRAME (event
->frame_or_window
));
4239 #if defined (WINDOWSNT)
4240 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4242 /* Make an event (language-change (FRAME CHARSET LCID)). */
4243 obj
= Fcons (event
->frame_or_window
, Qnil
);
4244 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4245 kbd_fetch_ptr
= event
+ 1;
4248 else if (event
->kind
== SAVE_SESSION_EVENT
)
4250 obj
= Fcons (Qsave_session
, Qnil
);
4251 kbd_fetch_ptr
= event
+ 1;
4253 /* Just discard these, by returning nil.
4254 With MULTI_KBOARD, these events are used as placeholders
4255 when we need to randomly delete events from the queue.
4256 (They shouldn't otherwise be found in the buffer,
4257 but on some machines it appears they do show up
4258 even without MULTI_KBOARD.) */
4259 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4260 mouse events during a popup-menu call. */
4261 else if (event
->kind
== NO_EVENT
)
4262 kbd_fetch_ptr
= event
+ 1;
4263 else if (event
->kind
== HELP_EVENT
)
4265 Lisp_Object object
, position
, help
, frame
, window
;
4267 frame
= event
->frame_or_window
;
4268 object
= event
->arg
;
4269 position
= make_number (event
->code
);
4272 clear_event (event
);
4274 kbd_fetch_ptr
= event
+ 1;
4275 if (!WINDOWP (window
))
4277 obj
= Fcons (Qhelp_echo
,
4278 list5 (frame
, help
, window
, object
, position
));
4280 else if (event
->kind
== FOCUS_IN_EVENT
)
4282 /* Notification of a FocusIn event. The frame receiving the
4283 focus is in event->frame_or_window. Generate a
4284 switch-frame event if necessary. */
4285 Lisp_Object frame
, focus
;
4287 frame
= event
->frame_or_window
;
4288 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4292 if (!EQ (frame
, internal_last_event_frame
)
4293 && !EQ (frame
, selected_frame
))
4294 obj
= make_lispy_switch_frame (frame
);
4295 internal_last_event_frame
= frame
;
4296 kbd_fetch_ptr
= event
+ 1;
4299 else if (event
->kind
== DBUS_EVENT
)
4301 obj
= make_lispy_event (event
);
4302 kbd_fetch_ptr
= event
+ 1;
4305 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4307 obj
= make_lispy_event (event
);
4308 kbd_fetch_ptr
= event
+ 1;
4312 /* If this event is on a different frame, return a switch-frame this
4313 time, and leave the event in the queue for next time. */
4317 frame
= event
->frame_or_window
;
4319 frame
= XCAR (frame
);
4320 else if (WINDOWP (frame
))
4321 frame
= WINDOW_FRAME (XWINDOW (frame
));
4323 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4327 if (! EQ (frame
, internal_last_event_frame
)
4328 && !EQ (frame
, selected_frame
))
4329 obj
= make_lispy_switch_frame (frame
);
4330 internal_last_event_frame
= frame
;
4332 /* If we didn't decide to make a switch-frame event, go ahead
4333 and build a real event from the queue entry. */
4337 obj
= make_lispy_event (event
);
4339 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4340 || defined(HAVE_NS) || defined (USE_GTK)
4341 /* If this was a menu selection, then set the flag to inhibit
4342 writing to last_nonmenu_event. Don't do this if the event
4343 we're returning is (menu-bar), though; that indicates the
4344 beginning of the menu sequence, and we might as well leave
4345 that as the `event with parameters' for this selection. */
4347 && !EQ (event
->frame_or_window
, event
->arg
)
4348 && (event
->kind
== MENU_BAR_EVENT
4349 || event
->kind
== TOOL_BAR_EVENT
))
4350 *used_mouse_menu
= 1;
4353 /* certain system events are non-key events */
4355 && event
->kind
== NS_NONKEY_EVENT
)
4356 *used_mouse_menu
= 1;
4359 /* Wipe out this event, to catch bugs. */
4360 clear_event (event
);
4361 kbd_fetch_ptr
= event
+ 1;
4365 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4366 /* Try generating a mouse motion event. */
4367 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4369 FRAME_PTR f
= some_mouse_moved ();
4370 Lisp_Object bar_window
;
4371 enum scroll_bar_part part
;
4375 *kbp
= current_kboard
;
4376 /* Note that this uses F to determine which terminal to look at.
4377 If there is no valid info, it does not store anything
4378 so x remains nil. */
4381 /* XXX Can f or mouse_position_hook be NULL here? */
4382 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4383 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4384 &part
, &x
, &y
, &time
);
4388 /* Decide if we should generate a switch-frame event. Don't
4389 generate switch-frame events for motion outside of all Emacs
4395 frame
= FRAME_FOCUS_FRAME (f
);
4397 XSETFRAME (frame
, f
);
4399 if (! EQ (frame
, internal_last_event_frame
)
4400 && !EQ (frame
, selected_frame
))
4401 obj
= make_lispy_switch_frame (frame
);
4402 internal_last_event_frame
= frame
;
4405 /* If we didn't decide to make a switch-frame event, go ahead and
4406 return a mouse-motion event. */
4407 if (!NILP (x
) && NILP (obj
))
4408 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4410 #endif /* HAVE_MOUSE || HAVE GPM */
4412 /* We were promised by the above while loop that there was
4413 something for us to read! */
4416 input_pending
= readable_events (0);
4418 Vlast_event_frame
= internal_last_event_frame
;
4423 /* Process any events that are not user-visible,
4424 then return, without reading any user-visible events. */
4427 swallow_events (do_display
)
4432 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4434 struct input_event
*event
;
4436 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4440 last_event_timestamp
= event
->timestamp
;
4442 /* These two kinds of events get special handling
4443 and don't actually appear to the command loop. */
4444 if (event
->kind
== SELECTION_REQUEST_EVENT
4445 || event
->kind
== SELECTION_CLEAR_EVENT
)
4448 struct input_event copy
;
4450 /* Remove it from the buffer before processing it,
4451 since otherwise swallow_events called recursively could see it
4452 and process it again. */
4454 kbd_fetch_ptr
= event
+ 1;
4455 input_pending
= readable_events (0);
4456 x_handle_selection_event (©
);
4458 /* We're getting selection request events, but we don't have
4467 old_timers_run
= timers_run
;
4468 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4470 if (timers_run
!= old_timers_run
&& do_display
)
4471 redisplay_preserve_echo_area (7);
4474 /* Record the start of when Emacs is idle,
4475 for the sake of running idle-time timers. */
4482 /* If we are already in the idle state, do nothing. */
4483 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4486 EMACS_GET_TIME (timer_idleness_start_time
);
4488 timer_last_idleness_start_time
= timer_idleness_start_time
;
4490 /* Mark all idle-time timers as once again candidates for running. */
4491 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4495 timer
= XCAR (timers
);
4497 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4499 XVECTOR (timer
)->contents
[0] = Qnil
;
4503 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4508 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4511 /* Resume idle timer from last idle start time. */
4514 timer_resume_idle ()
4516 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4519 timer_idleness_start_time
= timer_last_idleness_start_time
;
4522 /* This is only for debugging. */
4523 struct input_event last_timer_event
;
4525 /* List of elisp functions to call, delayed because they were generated in
4526 a context where Elisp could not be safely run (e.g. redisplay, signal,
4527 ...). Each element has the form (FUN . ARGS). */
4528 Lisp_Object pending_funcalls
;
4530 extern Lisp_Object Qapply
;
4532 /* Check whether a timer has fired. To prevent larger problems we simply
4533 disregard elements that are not proper timers. Do not make a circular
4534 timer list for the time being.
4536 Returns the time to wait until the next timer fires. If a
4537 timer is triggering now, return zero.
4538 If no timer is active, return -1.
4540 If a timer is ripe, we run it, with quitting turned off.
4541 In that case we return 0 to indicate that a new timer_check_2 call
4547 EMACS_TIME nexttime
;
4548 EMACS_TIME now
, idleness_now
;
4549 Lisp_Object timers
, idle_timers
, chosen_timer
;
4550 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4552 EMACS_SET_SECS (nexttime
, -1);
4553 EMACS_SET_USECS (nexttime
, -1);
4555 /* Always consider the ordinary timers. */
4556 timers
= Vtimer_list
;
4557 /* Consider the idle timers only if Emacs is idle. */
4558 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4559 idle_timers
= Vtimer_idle_list
;
4562 chosen_timer
= Qnil
;
4563 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4565 /* First run the code that was delayed. */
4566 while (CONSP (pending_funcalls
))
4568 Lisp_Object funcall
= XCAR (pending_funcalls
);
4569 pending_funcalls
= XCDR (pending_funcalls
);
4570 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4573 if (CONSP (timers
) || CONSP (idle_timers
))
4575 EMACS_GET_TIME (now
);
4576 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4577 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4580 while (CONSP (timers
) || CONSP (idle_timers
))
4582 Lisp_Object
*vector
;
4583 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4584 EMACS_TIME timer_time
, idle_timer_time
;
4585 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4587 /* Skip past invalid timers and timers already handled. */
4590 timer
= XCAR (timers
);
4591 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4593 timers
= XCDR (timers
);
4596 vector
= XVECTOR (timer
)->contents
;
4598 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4599 || !INTEGERP (vector
[3])
4600 || ! NILP (vector
[0]))
4602 timers
= XCDR (timers
);
4606 if (!NILP (idle_timers
))
4608 timer
= XCAR (idle_timers
);
4609 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4611 idle_timers
= XCDR (idle_timers
);
4614 vector
= XVECTOR (timer
)->contents
;
4616 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4617 || !INTEGERP (vector
[3])
4618 || ! NILP (vector
[0]))
4620 idle_timers
= XCDR (idle_timers
);
4625 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4626 based on the next ordinary timer.
4627 TIMER_DIFFERENCE is the distance in time from NOW to when
4628 this timer becomes ripe (negative if it's already ripe). */
4631 timer
= XCAR (timers
);
4632 vector
= XVECTOR (timer
)->contents
;
4633 EMACS_SET_SECS (timer_time
,
4634 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4635 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4636 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4639 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4640 based on the next idle timer. */
4641 if (!NILP (idle_timers
))
4643 idle_timer
= XCAR (idle_timers
);
4644 vector
= XVECTOR (idle_timer
)->contents
;
4645 EMACS_SET_SECS (idle_timer_time
,
4646 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4647 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4648 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4651 /* Decide which timer is the next timer,
4652 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4653 Also step down the list where we found that timer. */
4655 if (! NILP (timers
) && ! NILP (idle_timers
))
4658 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4659 if (EMACS_TIME_NEG_P (temp
))
4661 chosen_timer
= timer
;
4662 timers
= XCDR (timers
);
4663 difference
= timer_difference
;
4667 chosen_timer
= idle_timer
;
4668 idle_timers
= XCDR (idle_timers
);
4669 difference
= idle_timer_difference
;
4672 else if (! NILP (timers
))
4674 chosen_timer
= timer
;
4675 timers
= XCDR (timers
);
4676 difference
= timer_difference
;
4680 chosen_timer
= idle_timer
;
4681 idle_timers
= XCDR (idle_timers
);
4682 difference
= idle_timer_difference
;
4684 vector
= XVECTOR (chosen_timer
)->contents
;
4686 /* If timer is ripe, run it if it hasn't been run. */
4687 if (EMACS_TIME_NEG_P (difference
)
4688 || (EMACS_SECS (difference
) == 0
4689 && EMACS_USECS (difference
) == 0))
4691 if (NILP (vector
[0]))
4693 int count
= SPECPDL_INDEX ();
4694 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4696 /* Mark the timer as triggered to prevent problems if the lisp
4697 code fails to reschedule it right. */
4700 specbind (Qinhibit_quit
, Qt
);
4702 call1 (Qtimer_event_handler
, chosen_timer
);
4703 Vdeactivate_mark
= old_deactivate_mark
;
4705 unbind_to (count
, Qnil
);
4707 /* Since we have handled the event,
4708 we don't need to tell the caller to wake up and do it. */
4709 /* But the caller must still wait for the next timer, so
4710 return 0 to indicate that. */
4713 EMACS_SET_SECS (nexttime
, 0);
4714 EMACS_SET_USECS (nexttime
, 0);
4717 /* When we encounter a timer that is still waiting,
4718 return the amount of time to wait before it is ripe. */
4725 /* No timers are pending in the future. */
4726 /* Return 0 if we generated an event, and -1 if not. */
4732 /* Check whether a timer has fired. To prevent larger problems we simply
4733 disregard elements that are not proper timers. Do not make a circular
4734 timer list for the time being.
4736 Returns the time to wait until the next timer fires.
4737 If no timer is active, return -1.
4739 As long as any timer is ripe, we run it.
4741 DO_IT_NOW is now ignored. It used to mean that we should
4742 run the timer directly instead of queueing a timer-event.
4743 Now we always run timers directly. */
4746 timer_check (do_it_now
)
4749 EMACS_TIME nexttime
;
4753 nexttime
= timer_check_2 ();
4755 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4760 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4761 doc
: /* Return the current length of Emacs idleness, or nil.
4762 The value when Emacs is idle is a list of three integers. The first has
4763 the most significant 16 bits of the seconds, while the second has the least
4764 significant 16 bits. The third integer gives the microsecond count.
4766 The value when Emacs is not idle is nil.
4768 The microsecond count is zero on systems that do not provide
4769 resolution finer than a second. */)
4772 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4774 EMACS_TIME now
, idleness_now
;
4776 EMACS_GET_TIME (now
);
4777 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4779 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4780 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4781 make_number (EMACS_USECS (idleness_now
)));
4787 /* Caches for modify_event_symbol. */
4788 static Lisp_Object accent_key_syms
;
4789 static Lisp_Object func_key_syms
;
4790 static Lisp_Object mouse_syms
;
4791 static Lisp_Object wheel_syms
;
4792 static Lisp_Object drag_n_drop_syms
;
4794 /* This is a list of keysym codes for special "accent" characters.
4795 It parallels lispy_accent_keys. */
4797 static const int lispy_accent_codes
[] =
4799 #ifdef XK_dead_circumflex
4804 #ifdef XK_dead_grave
4809 #ifdef XK_dead_tilde
4814 #ifdef XK_dead_diaeresis
4819 #ifdef XK_dead_macron
4824 #ifdef XK_dead_degree
4829 #ifdef XK_dead_acute
4834 #ifdef XK_dead_cedilla
4839 #ifdef XK_dead_breve
4844 #ifdef XK_dead_ogonek
4849 #ifdef XK_dead_caron
4854 #ifdef XK_dead_doubleacute
4855 XK_dead_doubleacute
,
4859 #ifdef XK_dead_abovedot
4864 #ifdef XK_dead_abovering
4874 #ifdef XK_dead_belowdot
4879 #ifdef XK_dead_voiced_sound
4880 XK_dead_voiced_sound
,
4884 #ifdef XK_dead_semivoiced_sound
4885 XK_dead_semivoiced_sound
,
4901 /* This is a list of Lisp names for special "accent" characters.
4902 It parallels lispy_accent_codes. */
4904 static char *lispy_accent_keys
[] =
4922 "dead-voiced-sound",
4923 "dead-semivoiced-sound",
4929 #define FUNCTION_KEY_OFFSET 0x0
4931 char *lispy_function_keys
[] =
4935 0, /* VK_LBUTTON 0x01 */
4936 0, /* VK_RBUTTON 0x02 */
4937 "cancel", /* VK_CANCEL 0x03 */
4938 0, /* VK_MBUTTON 0x04 */
4940 0, 0, 0, /* 0x05 .. 0x07 */
4942 "backspace", /* VK_BACK 0x08 */
4943 "tab", /* VK_TAB 0x09 */
4945 0, 0, /* 0x0A .. 0x0B */
4947 "clear", /* VK_CLEAR 0x0C */
4948 "return", /* VK_RETURN 0x0D */
4950 0, 0, /* 0x0E .. 0x0F */
4952 0, /* VK_SHIFT 0x10 */
4953 0, /* VK_CONTROL 0x11 */
4954 0, /* VK_MENU 0x12 */
4955 "pause", /* VK_PAUSE 0x13 */
4956 "capslock", /* VK_CAPITAL 0x14 */
4957 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4959 "junja", /* VK_JUNJA 0x17 */
4960 "final", /* VK_FINAL 0x18 */
4961 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4963 "escape", /* VK_ESCAPE 0x1B */
4964 "convert", /* VK_CONVERT 0x1C */
4965 "non-convert", /* VK_NONCONVERT 0x1D */
4966 "accept", /* VK_ACCEPT 0x1E */
4967 "mode-change", /* VK_MODECHANGE 0x1F */
4968 0, /* VK_SPACE 0x20 */
4969 "prior", /* VK_PRIOR 0x21 */
4970 "next", /* VK_NEXT 0x22 */
4971 "end", /* VK_END 0x23 */
4972 "home", /* VK_HOME 0x24 */
4973 "left", /* VK_LEFT 0x25 */
4974 "up", /* VK_UP 0x26 */
4975 "right", /* VK_RIGHT 0x27 */
4976 "down", /* VK_DOWN 0x28 */
4977 "select", /* VK_SELECT 0x29 */
4978 "print", /* VK_PRINT 0x2A */
4979 "execute", /* VK_EXECUTE 0x2B */
4980 "snapshot", /* VK_SNAPSHOT 0x2C */
4981 "insert", /* VK_INSERT 0x2D */
4982 "delete", /* VK_DELETE 0x2E */
4983 "help", /* VK_HELP 0x2F */
4985 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4987 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4989 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4991 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4993 0, 0, 0, 0, 0, 0, 0, 0, 0,
4994 0, 0, 0, 0, 0, 0, 0, 0, 0,
4995 0, 0, 0, 0, 0, 0, 0, 0,
4997 "lwindow", /* VK_LWIN 0x5B */
4998 "rwindow", /* VK_RWIN 0x5C */
4999 "apps", /* VK_APPS 0x5D */
5002 "kp-0", /* VK_NUMPAD0 0x60 */
5003 "kp-1", /* VK_NUMPAD1 0x61 */
5004 "kp-2", /* VK_NUMPAD2 0x62 */
5005 "kp-3", /* VK_NUMPAD3 0x63 */
5006 "kp-4", /* VK_NUMPAD4 0x64 */
5007 "kp-5", /* VK_NUMPAD5 0x65 */
5008 "kp-6", /* VK_NUMPAD6 0x66 */
5009 "kp-7", /* VK_NUMPAD7 0x67 */
5010 "kp-8", /* VK_NUMPAD8 0x68 */
5011 "kp-9", /* VK_NUMPAD9 0x69 */
5012 "kp-multiply", /* VK_MULTIPLY 0x6A */
5013 "kp-add", /* VK_ADD 0x6B */
5014 "kp-separator", /* VK_SEPARATOR 0x6C */
5015 "kp-subtract", /* VK_SUBTRACT 0x6D */
5016 "kp-decimal", /* VK_DECIMAL 0x6E */
5017 "kp-divide", /* VK_DIVIDE 0x6F */
5018 "f1", /* VK_F1 0x70 */
5019 "f2", /* VK_F2 0x71 */
5020 "f3", /* VK_F3 0x72 */
5021 "f4", /* VK_F4 0x73 */
5022 "f5", /* VK_F5 0x74 */
5023 "f6", /* VK_F6 0x75 */
5024 "f7", /* VK_F7 0x76 */
5025 "f8", /* VK_F8 0x77 */
5026 "f9", /* VK_F9 0x78 */
5027 "f10", /* VK_F10 0x79 */
5028 "f11", /* VK_F11 0x7A */
5029 "f12", /* VK_F12 0x7B */
5030 "f13", /* VK_F13 0x7C */
5031 "f14", /* VK_F14 0x7D */
5032 "f15", /* VK_F15 0x7E */
5033 "f16", /* VK_F16 0x7F */
5034 "f17", /* VK_F17 0x80 */
5035 "f18", /* VK_F18 0x81 */
5036 "f19", /* VK_F19 0x82 */
5037 "f20", /* VK_F20 0x83 */
5038 "f21", /* VK_F21 0x84 */
5039 "f22", /* VK_F22 0x85 */
5040 "f23", /* VK_F23 0x86 */
5041 "f24", /* VK_F24 0x87 */
5043 0, 0, 0, 0, /* 0x88 .. 0x8B */
5044 0, 0, 0, 0, /* 0x8C .. 0x8F */
5046 "kp-numlock", /* VK_NUMLOCK 0x90 */
5047 "scroll", /* VK_SCROLL 0x91 */
5048 /* Not sure where the following block comes from.
5049 Windows headers have NEC and Fujitsu specific keys in
5050 this block, but nothing generic. */
5051 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
5052 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
5053 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
5054 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5055 "kp-end", /* VK_NUMPAD_END 0x96 */
5056 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5057 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5058 "kp-up", /* VK_NUMPAD_UP 0x99 */
5059 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5060 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5061 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5062 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5064 0, 0, /* 0x9E .. 0x9F */
5067 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5068 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5069 * No other API or message will distinguish left and right keys this way.
5074 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5075 to enable them selectively, and gives access to a few more functions.
5076 See lispy_multimedia_keys below. */
5077 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5078 0, 0, 0, /* 0xAD .. 0xAF Volume */
5079 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5080 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5082 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5083 0, 0, 0, 0, 0, 0, 0, 0, 0,
5085 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5086 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5087 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5090 "ax", /* VK_OEM_AX 0xE1 */
5091 0, /* VK_OEM_102 0xE2 */
5092 "ico-help", /* VK_ICO_HELP 0xE3 */
5093 "ico-00", /* VK_ICO_00 0xE4 */
5094 0, /* VK_PROCESSKEY 0xE5 */
5095 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5096 "packet", /* VK_PACKET 0xE7 */
5098 "reset", /* VK_OEM_RESET 0xE9 */
5099 "jump", /* VK_OEM_JUMP 0xEA */
5100 "oem-pa1", /* VK_OEM_PA1 0xEB */
5101 "oem-pa2", /* VK_OEM_PA2 0xEC */
5102 "oem-pa3", /* VK_OEM_PA3 0xED */
5103 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5104 "cusel", /* VK_OEM_CUSEL 0xEF */
5105 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5106 "finish", /* VK_OEM_FINISH 0xF1 */
5107 "copy", /* VK_OEM_COPY 0xF2 */
5108 "auto", /* VK_OEM_AUTO 0xF3 */
5109 "enlw", /* VK_OEM_ENLW 0xF4 */
5110 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5111 "attn", /* VK_ATTN 0xF6 */
5112 "crsel", /* VK_CRSEL 0xF7 */
5113 "exsel", /* VK_EXSEL 0xF8 */
5114 "ereof", /* VK_EREOF 0xF9 */
5115 "play", /* VK_PLAY 0xFA */
5116 "zoom", /* VK_ZOOM 0xFB */
5117 "noname", /* VK_NONAME 0xFC */
5118 "pa1", /* VK_PA1 0xFD */
5119 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5123 /* Some of these duplicate the "Media keys" on newer keyboards,
5124 but they are delivered to the application in a different way. */
5125 static char *lispy_multimedia_keys
[] =
5133 "browser-favorites",
5170 "toggle-dictate-command",
5176 "media-fast-forward",
5179 "media-channel-down"
5182 #else /* not HAVE_NTGUI */
5184 /* This should be dealt with in XTread_socket now, and that doesn't
5185 depend on the client system having the Kana syms defined. See also
5186 the XK_kana_A case below. */
5189 static char *lispy_kana_keys
[] =
5191 /* X Keysym value */
5192 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5193 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5194 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5195 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5196 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5197 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5198 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5199 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5200 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5201 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5202 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5203 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5204 "kana-i", "kana-u", "kana-e", "kana-o",
5205 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5206 "prolongedsound", "kana-A", "kana-I", "kana-U",
5207 "kana-E", "kana-O", "kana-KA", "kana-KI",
5208 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5209 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5210 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5211 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5212 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5213 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5214 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5215 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5216 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5217 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5218 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5219 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5221 #endif /* XK_kana_A */
5224 #define FUNCTION_KEY_OFFSET 0xff00
5226 /* You'll notice that this table is arranged to be conveniently
5227 indexed by X Windows keysym values. */
5228 static char *lispy_function_keys
[] =
5230 /* X Keysym value */
5232 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5233 "backspace", "tab", "linefeed", "clear",
5235 0, 0, 0, "pause", /* 0xff10...1f */
5236 0, 0, 0, 0, 0, 0, 0, "escape",
5238 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5239 "romaji", "hiragana", "katakana", "hiragana-katakana",
5240 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5241 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5242 "eisu-toggle", /* 0xff30...3f */
5243 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5244 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5246 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5247 "down", "prior", "next", "end",
5248 "begin", 0, 0, 0, 0, 0, 0, 0,
5249 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5260 "break", /* 0xff6b */
5263 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5264 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5265 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5266 0, 0, 0, 0, 0, 0, 0, 0,
5267 "kp-tab", /* 0xff89 */
5269 "kp-enter", /* 0xff8d */
5271 "kp-f1", /* 0xff91 */
5275 "kp-home", /* 0xff95 */
5280 "kp-prior", /* kp-page-up */
5281 "kp-next", /* kp-page-down */
5287 0, 0, 0, 0, 0, 0, 0, 0, 0,
5288 "kp-multiply", /* 0xffaa */
5293 "kp-divide", /* 0xffaf */
5294 "kp-0", /* 0xffb0 */
5295 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5298 "kp-equal", /* 0xffbd */
5299 "f1", /* 0xffbe */ /* IsFunctionKey */
5301 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5302 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5303 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5304 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5305 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5306 0, 0, 0, 0, 0, 0, 0, 0,
5307 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5308 0, 0, 0, 0, 0, 0, 0, "delete"
5311 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5312 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5314 static char *iso_lispy_function_keys
[] =
5316 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5317 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5318 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5319 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5320 "iso-lefttab", /* 0xfe20 */
5321 "iso-move-line-up", "iso-move-line-down",
5322 "iso-partial-line-up", "iso-partial-line-down",
5323 "iso-partial-space-left", "iso-partial-space-right",
5324 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5325 "iso-release-margin-left", "iso-release-margin-right",
5326 "iso-release-both-margins",
5327 "iso-fast-cursor-left", "iso-fast-cursor-right",
5328 "iso-fast-cursor-up", "iso-fast-cursor-down",
5329 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5330 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5333 #endif /* not HAVE_NTGUI */
5335 Lisp_Object Vlispy_mouse_stem
;
5337 static char *lispy_wheel_names
[] =
5339 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5342 /* drag-n-drop events are generated when a set of selected files are
5343 dragged from another application and dropped onto an Emacs window. */
5344 static char *lispy_drag_n_drop_names
[] =
5349 /* Scroll bar parts. */
5350 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5351 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5352 Lisp_Object Qtop
, Qratio
;
5354 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5355 Lisp_Object
*scroll_bar_parts
[] = {
5356 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5357 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5360 /* A vector, indexed by button number, giving the down-going location
5361 of currently depressed buttons, both scroll bar and non-scroll bar.
5363 The elements have the form
5364 (BUTTON-NUMBER MODIFIER-MASK . REST)
5365 where REST is the cdr of a position as it would be reported in the event.
5367 The make_lispy_event function stores positions here to tell the
5368 difference between click and drag events, and to store the starting
5369 location to be included in drag events. */
5371 static Lisp_Object button_down_location
;
5373 /* Information about the most recent up-going button event: Which
5374 button, what location, and what time. */
5376 static int last_mouse_button
;
5377 static int last_mouse_x
;
5378 static int last_mouse_y
;
5379 static unsigned long button_down_time
;
5381 /* The maximum time between clicks to make a double-click, or Qnil to
5382 disable double-click detection, or Qt for no time limit. */
5384 Lisp_Object Vdouble_click_time
;
5386 /* Maximum number of pixels the mouse may be moved between clicks
5387 to make a double-click. */
5389 EMACS_INT double_click_fuzz
;
5391 /* The number of clicks in this multiple-click. */
5393 int double_click_count
;
5395 /* Return position of a mouse click or wheel event */
5398 make_lispy_position (f
, x
, y
, time
)
5404 enum window_part part
;
5405 Lisp_Object posn
= Qnil
;
5406 Lisp_Object extra_info
= Qnil
;
5409 /* Set `window' to the window under frame pixel coordinates (x,y) */
5411 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5412 &part
, &wx
, &wy
, 0);
5416 if (WINDOWP (window
))
5418 /* It's a click in window window at frame coordinates (x,y) */
5419 struct window
*w
= XWINDOW (window
);
5420 Lisp_Object string_info
= Qnil
;
5421 int textpos
= -1, rx
= -1, ry
= -1;
5422 int dx
= -1, dy
= -1;
5423 int width
= -1, height
= -1;
5424 Lisp_Object object
= Qnil
;
5426 /* Set event coordinates to window-relative coordinates
5427 for constructing the Lisp event below. */
5431 if (part
== ON_TEXT
)
5433 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5435 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5437 /* Mode line or header line. Look for a string under
5438 the mouse that may have a `local-map' property. */
5442 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5444 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5445 &object
, &dx
, &dy
, &width
, &height
);
5446 if (STRINGP (string
))
5447 string_info
= Fcons (string
, make_number (charpos
));
5448 if (w
== XWINDOW (selected_window
)
5449 && current_buffer
== XBUFFER (w
->buffer
))
5452 textpos
= XMARKER (w
->pointm
)->charpos
;
5454 else if (part
== ON_VERTICAL_BORDER
)
5456 posn
= Qvertical_line
;
5461 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5466 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5468 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5469 &object
, &dx
, &dy
, &width
, &height
);
5470 if (STRINGP (string
))
5471 string_info
= Fcons (string
, make_number (charpos
));
5472 if (part
== ON_LEFT_MARGIN
)
5475 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5477 else if (part
== ON_LEFT_FRINGE
)
5479 posn
= Qleft_fringe
;
5482 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5484 : window_box_width (w
, LEFT_MARGIN_AREA
));
5487 else if (part
== ON_RIGHT_FRINGE
)
5489 posn
= Qright_fringe
;
5492 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5493 + window_box_width (w
, TEXT_AREA
)
5494 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5495 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5501 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5502 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5507 Lisp_Object string2
, object2
= Qnil
;
5508 struct display_pos p
;
5510 int width2
, height2
;
5511 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5512 &object2
, &dx2
, &dy2
,
5514 textpos
= CHARPOS (p
.pos
);
5515 if (rx
< 0) rx
= wx
;
5516 if (ry
< 0) ry
= wy
;
5517 if (dx
< 0) dx
= dx2
;
5518 if (dy
< 0) dy
= dy2
;
5519 if (width
< 0) width
= width2
;
5520 if (height
< 0) height
= height2
;
5524 posn
= make_number (textpos
);
5525 if (STRINGP (string2
))
5526 string_info
= Fcons (string2
,
5527 make_number (CHARPOS (p
.string_pos
)));
5533 #ifdef HAVE_WINDOW_SYSTEM
5534 if (IMAGEP (object
))
5536 Lisp_Object image_map
, hotspot
;
5537 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5539 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5541 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5542 posn
= XCAR (hotspot
);
5547 extra_info
= Fcons (object
,
5548 Fcons (Fcons (make_number (dx
),
5550 Fcons (Fcons (make_number (width
),
5551 make_number (height
)),
5555 extra_info
= Fcons (string_info
,
5556 Fcons (make_number (textpos
),
5557 Fcons (Fcons (make_number (rx
),
5563 XSETFRAME (window
, f
);
5568 XSETFASTINT (*x
, 0);
5569 XSETFASTINT (*y
, 0);
5572 return Fcons (window
,
5574 Fcons (Fcons (*x
, *y
),
5575 Fcons (make_number (time
),
5579 /* Given a struct input_event, build the lisp event which represents
5580 it. If EVENT is 0, build a mouse movement event from the mouse
5581 movement buffer, which should have a movement event in it.
5583 Note that events must be passed to this function in the order they
5584 are received; this function stores the location of button presses
5585 in order to build drag events when the button is released. */
5588 make_lispy_event (event
)
5589 struct input_event
*event
;
5593 switch (SWITCH_ENUM_CAST (event
->kind
))
5595 /* A simple keystroke. */
5596 case ASCII_KEYSTROKE_EVENT
:
5597 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5599 Lisp_Object lispy_c
;
5600 int c
= event
->code
;
5601 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5604 eassert (c
== event
->code
);
5605 /* Turn ASCII characters into control characters
5607 if (event
->modifiers
& ctrl_modifier
)
5609 c
= make_ctrl_char (c
);
5610 event
->modifiers
&= ~ctrl_modifier
;
5614 /* Add in the other modifier bits. The shift key was taken care
5615 of by the X code. */
5616 c
|= (event
->modifiers
5617 & (meta_modifier
| alt_modifier
5618 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5619 /* Distinguish Shift-SPC from SPC. */
5620 if ((event
->code
) == 040
5621 && event
->modifiers
& shift_modifier
)
5622 c
|= shift_modifier
;
5623 button_down_time
= 0;
5624 XSETFASTINT (lispy_c
, c
);
5629 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5630 except that they are non-key events (last-nonmenu-event is nil). */
5631 case NS_NONKEY_EVENT
:
5634 /* A function key. The symbol may need to have modifier prefixes
5636 case NON_ASCII_KEYSTROKE_EVENT
:
5637 button_down_time
= 0;
5639 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5640 if (event
->code
== lispy_accent_codes
[i
])
5641 return modify_event_symbol (i
,
5643 Qfunction_key
, Qnil
,
5644 lispy_accent_keys
, &accent_key_syms
,
5645 (sizeof (lispy_accent_keys
)
5646 / sizeof (lispy_accent_keys
[0])));
5650 if (event
->code
>= 0x400 && event
->code
< 0x500)
5651 return modify_event_symbol (event
->code
- 0x400,
5652 event
->modifiers
& ~shift_modifier
,
5653 Qfunction_key
, Qnil
,
5654 lispy_kana_keys
, &func_key_syms
,
5655 (sizeof (lispy_kana_keys
)
5656 / sizeof (lispy_kana_keys
[0])));
5657 #endif /* XK_kana_A */
5660 #ifdef ISO_FUNCTION_KEY_OFFSET
5661 if (event
->code
< FUNCTION_KEY_OFFSET
5662 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5663 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5665 Qfunction_key
, Qnil
,
5666 iso_lispy_function_keys
, &func_key_syms
,
5667 (sizeof (iso_lispy_function_keys
)
5668 / sizeof (iso_lispy_function_keys
[0])));
5671 /* Handle system-specific or unknown keysyms. */
5672 if (event
->code
& (1 << 28)
5673 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5674 || (event
->code
- FUNCTION_KEY_OFFSET
5675 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5676 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5678 /* We need to use an alist rather than a vector as the cache
5679 since we can't make a vector long enuf. */
5680 if (NILP (current_kboard
->system_key_syms
))
5681 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5682 return modify_event_symbol (event
->code
,
5685 current_kboard
->Vsystem_key_alist
,
5686 0, ¤t_kboard
->system_key_syms
,
5690 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5692 Qfunction_key
, Qnil
,
5693 lispy_function_keys
, &func_key_syms
,
5694 (sizeof (lispy_function_keys
)
5695 / sizeof (lispy_function_keys
[0])));
5698 case MULTIMEDIA_KEY_EVENT
:
5699 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5700 / sizeof (lispy_multimedia_keys
[0]))
5701 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5703 return modify_event_symbol (event
->code
, event
->modifiers
,
5704 Qfunction_key
, Qnil
,
5705 lispy_multimedia_keys
, &func_key_syms
,
5706 (sizeof (lispy_multimedia_keys
)
5707 / sizeof (lispy_multimedia_keys
[0])));
5713 /* A mouse click. Figure out where it is, decide whether it's
5714 a press, click or drag, and build the appropriate structure. */
5715 case MOUSE_CLICK_EVENT
:
5716 #ifndef USE_TOOLKIT_SCROLL_BARS
5717 case SCROLL_BAR_CLICK_EVENT
:
5720 int button
= event
->code
;
5722 Lisp_Object position
;
5723 Lisp_Object
*start_pos_ptr
;
5724 Lisp_Object start_pos
;
5728 /* Build the position as appropriate for this mouse click. */
5729 if (event
->kind
== MOUSE_CLICK_EVENT
)
5731 struct frame
*f
= XFRAME (event
->frame_or_window
);
5732 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5736 /* Ignore mouse events that were made on frame that
5737 have been deleted. */
5738 if (! FRAME_LIVE_P (f
))
5741 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5742 /* EVENT->x and EVENT->y are frame-relative pixel
5743 coordinates at this place. Under old redisplay, COLUMN
5744 and ROW are set to frame relative glyph coordinates
5745 which are then used to determine whether this click is
5746 in a menu (non-toolkit version). */
5747 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5748 &column
, &row
, NULL
, 1);
5750 /* In the non-toolkit version, clicks on the menu bar
5751 are ordinary button events in the event buffer.
5752 Distinguish them, and invoke the menu.
5754 (In the toolkit version, the toolkit handles the menu bar
5755 and Emacs doesn't know about it until after the user
5756 makes a selection.) */
5757 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5758 && (event
->modifiers
& down_modifier
))
5760 Lisp_Object items
, item
;
5765 /* Activate the menu bar on the down event. If the
5766 up event comes in before the menu code can deal with it,
5768 if (! (event
->modifiers
& down_modifier
))
5772 /* Find the menu bar item under `column'. */
5774 items
= FRAME_MENU_BAR_ITEMS (f
);
5775 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5777 Lisp_Object pos
, string
;
5778 string
= AREF (items
, i
+ 1);
5779 pos
= AREF (items
, i
+ 3);
5782 if (column
>= XINT (pos
)
5783 && column
< XINT (pos
) + SCHARS (string
))
5785 item
= AREF (items
, i
);
5790 /* ELisp manual 2.4b says (x y) are window relative but
5791 code says they are frame-relative. */
5793 = Fcons (event
->frame_or_window
,
5795 Fcons (Fcons (event
->x
, event
->y
),
5796 Fcons (make_number (event
->timestamp
),
5799 return Fcons (item
, Fcons (position
, Qnil
));
5801 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5803 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5806 #ifndef USE_TOOLKIT_SCROLL_BARS
5809 /* It's a scrollbar click. */
5811 Lisp_Object portion_whole
;
5814 window
= event
->frame_or_window
;
5815 portion_whole
= Fcons (event
->x
, event
->y
);
5816 part
= *scroll_bar_parts
[(int) event
->part
];
5820 Fcons (Qvertical_scroll_bar
,
5821 Fcons (portion_whole
,
5822 Fcons (make_number (event
->timestamp
),
5823 Fcons (part
, Qnil
)))));
5825 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5827 if (button
>= ASIZE (button_down_location
))
5829 button_down_location
= larger_vector (button_down_location
,
5831 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5834 start_pos_ptr
= &AREF (button_down_location
, button
);
5835 start_pos
= *start_pos_ptr
;
5836 *start_pos_ptr
= Qnil
;
5839 /* On window-system frames, use the value of
5840 double-click-fuzz as is. On other frames, interpret it
5841 as a multiple of 1/8 characters. */
5845 if (WINDOWP (event
->frame_or_window
))
5846 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5847 else if (FRAMEP (event
->frame_or_window
))
5848 f
= XFRAME (event
->frame_or_window
);
5852 if (FRAME_WINDOW_P (f
))
5853 fuzz
= double_click_fuzz
;
5855 fuzz
= double_click_fuzz
/ 8;
5857 is_double
= (button
== last_mouse_button
5858 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5859 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5860 && button_down_time
!= 0
5861 && (EQ (Vdouble_click_time
, Qt
)
5862 || (INTEGERP (Vdouble_click_time
)
5863 && ((int)(event
->timestamp
- button_down_time
)
5864 < XINT (Vdouble_click_time
)))));
5867 last_mouse_button
= button
;
5868 last_mouse_x
= XINT (event
->x
);
5869 last_mouse_y
= XINT (event
->y
);
5871 /* If this is a button press, squirrel away the location, so
5872 we can decide later whether it was a click or a drag. */
5873 if (event
->modifiers
& down_modifier
)
5877 double_click_count
++;
5878 event
->modifiers
|= ((double_click_count
> 2)
5883 double_click_count
= 1;
5884 button_down_time
= event
->timestamp
;
5885 *start_pos_ptr
= Fcopy_alist (position
);
5886 ignore_mouse_drag_p
= 0;
5889 /* Now we're releasing a button - check the co-ordinates to
5890 see if this was a click or a drag. */
5891 else if (event
->modifiers
& up_modifier
)
5893 /* If we did not see a down before this up, ignore the up.
5894 Probably this happened because the down event chose a
5895 menu item. It would be an annoyance to treat the
5896 release of the button that chose the menu item as a
5899 if (!CONSP (start_pos
))
5902 event
->modifiers
&= ~up_modifier
;
5903 #if 0 /* Formerly we treated an up with no down as a click event. */
5904 if (!CONSP (start_pos
))
5905 event
->modifiers
|= click_modifier
;
5910 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5912 /* The third element of every position
5913 should be the (x,y) pair. */
5914 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5916 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5918 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5919 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5922 if (ignore_mouse_drag_p
)
5924 event
->modifiers
|= click_modifier
;
5925 ignore_mouse_drag_p
= 0;
5927 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5928 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5929 /* Maybe the mouse has moved a lot, caused scrolling, and
5930 eventually ended up at the same screen position (but
5931 not buffer position) in which case it is a drag, not
5933 /* FIXME: OTOH if the buffer position has changed
5934 because of a timer or process filter rather than
5935 because of mouse movement, it should be considered as
5936 a click. But mouse-drag-region completely ignores
5937 this case and it hasn't caused any real problem, so
5938 it's probably OK to ignore it as well. */
5939 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5940 /* Mouse hasn't moved (much). */
5941 event
->modifiers
|= click_modifier
;
5944 button_down_time
= 0;
5945 event
->modifiers
|= drag_modifier
;
5948 /* Don't check is_double; treat this as multiple
5949 if the down-event was multiple. */
5950 if (double_click_count
> 1)
5951 event
->modifiers
|= ((double_click_count
> 2)
5957 /* Every mouse event should either have the down_modifier or
5958 the up_modifier set. */
5962 /* Get the symbol we should use for the mouse click. */
5965 head
= modify_event_symbol (button
,
5967 Qmouse_click
, Vlispy_mouse_stem
,
5970 XVECTOR (mouse_syms
)->size
);
5971 if (event
->modifiers
& drag_modifier
)
5976 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5979 Fcons (make_number (double_click_count
),
5989 case HORIZ_WHEEL_EVENT
:
5991 Lisp_Object position
;
5994 /* Build the position as appropriate for this mouse click. */
5995 struct frame
*f
= XFRAME (event
->frame_or_window
);
5997 /* Ignore wheel events that were made on frame that have been
5999 if (! FRAME_LIVE_P (f
))
6002 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6005 /* Set double or triple modifiers to indicate the wheel speed. */
6007 /* On window-system frames, use the value of
6008 double-click-fuzz as is. On other frames, interpret it
6009 as a multiple of 1/8 characters. */
6015 if (WINDOWP (event
->frame_or_window
))
6016 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
6017 else if (FRAMEP (event
->frame_or_window
))
6018 f
= XFRAME (event
->frame_or_window
);
6022 if (FRAME_WINDOW_P (f
))
6023 fuzz
= double_click_fuzz
;
6025 fuzz
= double_click_fuzz
/ 8;
6027 if (event
->modifiers
& up_modifier
)
6029 /* Emit a wheel-up event. */
6030 event
->modifiers
&= ~up_modifier
;
6033 else if (event
->modifiers
& down_modifier
)
6035 /* Emit a wheel-down event. */
6036 event
->modifiers
&= ~down_modifier
;
6040 /* Every wheel event should either have the down_modifier or
6041 the up_modifier set. */
6044 if (event
->kind
== HORIZ_WHEEL_EVENT
)
6047 is_double
= (last_mouse_button
== - (1 + symbol_num
)
6048 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
6049 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
6050 && button_down_time
!= 0
6051 && (EQ (Vdouble_click_time
, Qt
)
6052 || (INTEGERP (Vdouble_click_time
)
6053 && ((int)(event
->timestamp
- button_down_time
)
6054 < XINT (Vdouble_click_time
)))));
6057 double_click_count
++;
6058 event
->modifiers
|= ((double_click_count
> 2)
6064 double_click_count
= 1;
6065 event
->modifiers
|= click_modifier
;
6068 button_down_time
= event
->timestamp
;
6069 /* Use a negative value to distinguish wheel from mouse button. */
6070 last_mouse_button
= - (1 + symbol_num
);
6071 last_mouse_x
= XINT (event
->x
);
6072 last_mouse_y
= XINT (event
->y
);
6074 /* Get the symbol we should use for the wheel event. */
6075 head
= modify_event_symbol (symbol_num
,
6081 ASIZE (wheel_syms
));
6084 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6087 Fcons (make_number (double_click_count
),
6096 #ifdef USE_TOOLKIT_SCROLL_BARS
6098 /* We don't have down and up events if using toolkit scroll bars,
6099 so make this always a click event. Store in the `part' of
6100 the Lisp event a symbol which maps to the following actions:
6102 `above_handle' page up
6103 `below_handle' page down
6107 `bottom' bottom of buffer
6108 `handle' thumb has been dragged.
6109 `end-scroll' end of interaction with scroll bar
6111 The incoming input_event contains in its `part' member an
6112 index of type `enum scroll_bar_part' which we can use as an
6113 index in scroll_bar_parts to get the appropriate symbol. */
6115 case SCROLL_BAR_CLICK_EVENT
:
6117 Lisp_Object position
, head
, window
, portion_whole
, part
;
6119 window
= event
->frame_or_window
;
6120 portion_whole
= Fcons (event
->x
, event
->y
);
6121 part
= *scroll_bar_parts
[(int) event
->part
];
6125 Fcons (Qvertical_scroll_bar
,
6126 Fcons (portion_whole
,
6127 Fcons (make_number (event
->timestamp
),
6128 Fcons (part
, Qnil
)))));
6130 /* Always treat scroll bar events as clicks. */
6131 event
->modifiers
|= click_modifier
;
6132 event
->modifiers
&= ~up_modifier
;
6134 if (event
->code
>= ASIZE (mouse_syms
))
6135 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6137 /* Get the symbol we should use for the mouse click. */
6138 head
= modify_event_symbol (event
->code
,
6143 XVECTOR (mouse_syms
)->size
);
6144 return Fcons (head
, Fcons (position
, Qnil
));
6147 #endif /* USE_TOOLKIT_SCROLL_BARS */
6149 case DRAG_N_DROP_EVENT
:
6152 Lisp_Object head
, position
;
6155 f
= XFRAME (event
->frame_or_window
);
6158 /* Ignore mouse events that were made on frames that
6159 have been deleted. */
6160 if (! FRAME_LIVE_P (f
))
6163 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6166 head
= modify_event_symbol (0, event
->modifiers
,
6168 lispy_drag_n_drop_names
,
6169 &drag_n_drop_syms
, 1);
6175 #endif /* HAVE_MOUSE */
6177 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6178 || defined(HAVE_NS) || defined (USE_GTK)
6179 case MENU_BAR_EVENT
:
6180 if (EQ (event
->arg
, event
->frame_or_window
))
6181 /* This is the prefix key. We translate this to
6182 `(menu_bar)' because the code in keyboard.c for menu
6183 events, which we use, relies on this. */
6184 return Fcons (Qmenu_bar
, Qnil
);
6188 case SELECT_WINDOW_EVENT
:
6189 /* Make an event (select-window (WINDOW)). */
6190 return Fcons (Qselect_window
,
6191 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6194 case TOOL_BAR_EVENT
:
6195 if (EQ (event
->arg
, event
->frame_or_window
))
6196 /* This is the prefix key. We translate this to
6197 `(tool_bar)' because the code in keyboard.c for tool bar
6198 events, which we use, relies on this. */
6199 return Fcons (Qtool_bar
, Qnil
);
6200 else if (SYMBOLP (event
->arg
))
6201 return apply_modifiers (event
->modifiers
, event
->arg
);
6204 case USER_SIGNAL_EVENT
:
6205 /* A user signal. */
6207 char *name
= find_user_signal_name (event
->code
);
6210 return intern (name
);
6213 case SAVE_SESSION_EVENT
:
6214 return Qsave_session
;
6219 return Fcons (Qdbus_event
, event
->arg
);
6221 #endif /* HAVE_DBUS */
6223 case CONFIG_CHANGED_EVENT
:
6224 return Fcons (Qconfig_changed_event
,
6226 Fcons (event
->frame_or_window
, Qnil
)));
6228 case GPM_CLICK_EVENT
:
6230 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6231 Lisp_Object head
, position
;
6232 Lisp_Object
*start_pos_ptr
;
6233 Lisp_Object start_pos
;
6234 int button
= event
->code
;
6236 if (button
>= ASIZE (button_down_location
))
6238 button_down_location
= larger_vector (button_down_location
,
6240 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6243 start_pos_ptr
= &AREF (button_down_location
, button
);
6244 start_pos
= *start_pos_ptr
;
6246 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6249 if (event
->modifiers
& down_modifier
)
6250 *start_pos_ptr
= Fcopy_alist (position
);
6251 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6253 if (!CONSP (start_pos
))
6255 event
->modifiers
&= ~up_modifier
;
6258 head
= modify_event_symbol (button
,
6260 Qmouse_click
, Vlispy_mouse_stem
,
6263 XVECTOR (mouse_syms
)->size
);
6265 if (event
->modifiers
& drag_modifier
)
6270 else if (event
->modifiers
& double_modifier
)
6273 Fcons (make_number (2),
6275 else if (event
->modifiers
& triple_modifier
)
6278 Fcons (make_number (3),
6285 #endif /* HAVE_GPM */
6287 /* The 'kind' field of the event is something we don't recognize. */
6293 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6296 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6298 Lisp_Object bar_window
;
6299 enum scroll_bar_part part
;
6303 /* Is it a scroll bar movement? */
6304 if (frame
&& ! NILP (bar_window
))
6306 Lisp_Object part_sym
;
6308 part_sym
= *scroll_bar_parts
[(int) part
];
6309 return Fcons (Qscroll_bar_movement
,
6310 (Fcons (Fcons (bar_window
,
6311 Fcons (Qvertical_scroll_bar
,
6312 Fcons (Fcons (x
, y
),
6313 Fcons (make_number (time
),
6319 /* Or is it an ordinary mouse movement? */
6322 Lisp_Object position
;
6324 position
= make_lispy_position (frame
, &x
, &y
, time
);
6326 return Fcons (Qmouse_movement
,
6332 #endif /* HAVE_MOUSE || HAVE GPM */
6334 /* Construct a switch frame event. */
6336 make_lispy_switch_frame (frame
)
6339 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6342 /* Manipulating modifiers. */
6344 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6346 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6347 SYMBOL's name of the end of the modifiers; the string from this
6348 position is the unmodified symbol name.
6350 This doesn't use any caches. */
6353 parse_modifiers_uncached (symbol
, modifier_end
)
6361 CHECK_SYMBOL (symbol
);
6364 name
= SYMBOL_NAME (symbol
);
6366 for (i
= 0; i
+2 <= SBYTES (name
); )
6368 int this_mod_end
= 0;
6371 /* See if the name continues with a modifier word.
6372 Check that the word appears, but don't check what follows it.
6373 Set this_mod and this_mod_end to record what we find. */
6375 switch (SREF (name
, i
))
6377 #define SINGLE_LETTER_MOD(BIT) \
6378 (this_mod_end = i + 1, this_mod = BIT)
6381 SINGLE_LETTER_MOD (alt_modifier
);
6385 SINGLE_LETTER_MOD (ctrl_modifier
);
6389 SINGLE_LETTER_MOD (hyper_modifier
);
6393 SINGLE_LETTER_MOD (meta_modifier
);
6397 SINGLE_LETTER_MOD (shift_modifier
);
6401 SINGLE_LETTER_MOD (super_modifier
);
6404 #undef SINGLE_LETTER_MOD
6406 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6407 if (i + LEN + 1 <= SBYTES (name) \
6408 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6410 this_mod_end = i + LEN; \
6415 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6416 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6417 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6421 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6423 #undef MULTI_LETTER_MOD
6427 /* If we found no modifier, stop looking for them. */
6428 if (this_mod_end
== 0)
6431 /* Check there is a dash after the modifier, so that it
6432 really is a modifier. */
6433 if (this_mod_end
>= SBYTES (name
)
6434 || SREF (name
, this_mod_end
) != '-')
6437 /* This modifier is real; look for another. */
6438 modifiers
|= this_mod
;
6439 i
= this_mod_end
+ 1;
6442 /* Should we include the `click' modifier? */
6443 if (! (modifiers
& (down_modifier
| drag_modifier
6444 | double_modifier
| triple_modifier
))
6445 && i
+ 7 == SBYTES (name
)
6446 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6447 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6448 modifiers
|= click_modifier
;
6450 if (! (modifiers
& (double_modifier
| triple_modifier
))
6451 && i
+ 6 < SBYTES (name
)
6452 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6453 modifiers
|= click_modifier
;
6461 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6462 prepended to the string BASE[0..BASE_LEN-1].
6463 This doesn't use any caches. */
6465 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6468 int base_len
, base_len_byte
;
6470 /* Since BASE could contain nulls, we can't use intern here; we have
6471 to use Fintern, which expects a genuine Lisp_String, and keeps a
6474 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6480 /* Only the event queue may use the `up' modifier; it should always
6481 be turned into a click or drag event before presented to lisp code. */
6482 if (modifiers
& up_modifier
)
6485 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6486 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6487 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6488 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6489 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6490 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6491 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6492 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6493 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6494 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6495 /* The click modifier is denoted by the absence of other modifiers. */
6499 mod_len
= p
- new_mods
;
6503 Lisp_Object new_name
;
6505 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6506 mod_len
+ base_len_byte
);
6507 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6508 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6510 return Fintern (new_name
, Qnil
);
6515 static const char *modifier_names
[] =
6517 "up", "down", "drag", "click", "double", "triple", 0, 0,
6518 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6519 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6521 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6523 static Lisp_Object modifier_symbols
;
6525 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6527 lispy_modifier_list (modifiers
)
6530 Lisp_Object modifier_list
;
6533 modifier_list
= Qnil
;
6534 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6535 if (modifiers
& (1<<i
))
6536 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6539 return modifier_list
;
6543 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6544 where UNMODIFIED is the unmodified form of SYMBOL,
6545 MASK is the set of modifiers present in SYMBOL's name.
6546 This is similar to parse_modifiers_uncached, but uses the cache in
6547 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6548 Qevent_symbol_elements property. */
6550 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6553 parse_modifiers (symbol
)
6556 Lisp_Object elements
;
6558 if (INTEGERP (symbol
))
6559 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6560 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6562 else if (!SYMBOLP (symbol
))
6565 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6566 if (CONSP (elements
))
6571 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6572 Lisp_Object unmodified
;
6575 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6576 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6579 if (modifiers
& ~INTMASK
)
6581 XSETFASTINT (mask
, modifiers
);
6582 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6584 /* Cache the parsing results on SYMBOL. */
6585 Fput (symbol
, Qevent_symbol_element_mask
,
6587 Fput (symbol
, Qevent_symbol_elements
,
6588 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6590 /* Since we know that SYMBOL is modifiers applied to unmodified,
6591 it would be nice to put that in unmodified's cache.
6592 But we can't, since we're not sure that parse_modifiers is
6599 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6600 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6601 doc
: /* Parse the event symbol. For internal use. */)
6605 /* Fill the cache if needed. */
6606 parse_modifiers (symbol
);
6607 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6608 and use the Lispier representation stored on Qevent_symbol_elements
6610 return Fget (symbol
, Qevent_symbol_elements
);
6613 /* Apply the modifiers MODIFIERS to the symbol BASE.
6614 BASE must be unmodified.
6616 This is like apply_modifiers_uncached, but uses BASE's
6617 Qmodifier_cache property, if present. It also builds
6618 Qevent_symbol_elements properties, since it has that info anyway.
6620 apply_modifiers copies the value of BASE's Qevent_kind property to
6621 the modified symbol. */
6623 apply_modifiers (modifiers
, base
)
6627 Lisp_Object cache
, index
, entry
, new_symbol
;
6629 /* Mask out upper bits. We don't know where this value's been. */
6630 modifiers
&= INTMASK
;
6632 if (INTEGERP (base
))
6633 return make_number (XINT (base
) | modifiers
);
6635 /* The click modifier never figures into cache indices. */
6636 cache
= Fget (base
, Qmodifier_cache
);
6637 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6638 entry
= assq_no_quit (index
, cache
);
6641 new_symbol
= XCDR (entry
);
6644 /* We have to create the symbol ourselves. */
6645 new_symbol
= apply_modifiers_uncached (modifiers
,
6646 SDATA (SYMBOL_NAME (base
)),
6647 SCHARS (SYMBOL_NAME (base
)),
6648 SBYTES (SYMBOL_NAME (base
)));
6650 /* Add the new symbol to the base's cache. */
6651 entry
= Fcons (index
, new_symbol
);
6652 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6654 /* We have the parsing info now for free, so we could add it to
6656 XSETFASTINT (index, modifiers);
6657 Fput (new_symbol, Qevent_symbol_element_mask,
6658 Fcons (base, Fcons (index, Qnil)));
6659 Fput (new_symbol, Qevent_symbol_elements,
6660 Fcons (base, lispy_modifier_list (modifiers)));
6661 Sadly, this is only correct if `base' is indeed a base event,
6662 which is not necessarily the case. -stef */
6665 /* Make sure this symbol is of the same kind as BASE.
6667 You'd think we could just set this once and for all when we
6668 intern the symbol above, but reorder_modifiers may call us when
6669 BASE's property isn't set right; we can't assume that just
6670 because it has a Qmodifier_cache property it must have its
6671 Qevent_kind set right as well. */
6672 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6676 kind
= Fget (base
, Qevent_kind
);
6678 Fput (new_symbol
, Qevent_kind
, kind
);
6685 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6686 return a symbol with the modifiers placed in the canonical order.
6687 Canonical order is alphabetical, except for down and drag, which
6688 always come last. The 'click' modifier is never written out.
6690 Fdefine_key calls this to make sure that (for example) C-M-foo
6691 and M-C-foo end up being equivalent in the keymap. */
6694 reorder_modifiers (symbol
)
6697 /* It's hopefully okay to write the code this way, since everything
6698 will soon be in caches, and no consing will be done at all. */
6701 parsed
= parse_modifiers (symbol
);
6702 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6707 /* For handling events, we often want to produce a symbol whose name
6708 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6709 to some base, like the name of a function key or mouse button.
6710 modify_event_symbol produces symbols of this sort.
6712 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6713 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6716 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6717 into symbol names, or a string specifying a name stem used to
6718 construct a symbol name or the form `STEM-N', where N is the decimal
6719 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6720 non-nil; otherwise NAME_TABLE is used.
6722 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6723 persist between calls to modify_event_symbol that it can use to
6724 store a cache of the symbols it's generated for this NAME_TABLE
6725 before. The object stored there may be a vector or an alist.
6727 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6729 MODIFIERS is a set of modifier bits (as given in struct input_events)
6730 whose prefixes should be applied to the symbol name.
6732 SYMBOL_KIND is the value to be placed in the event_kind property of
6733 the returned symbol.
6735 The symbols we create are supposed to have an
6736 `event-symbol-elements' property, which lists the modifiers present
6737 in the symbol's name. */
6740 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6741 name_table
, symbol_table
, table_size
)
6744 Lisp_Object symbol_kind
;
6745 Lisp_Object name_alist_or_stem
;
6747 Lisp_Object
*symbol_table
;
6748 unsigned int table_size
;
6751 Lisp_Object symbol_int
;
6753 /* Get rid of the "vendor-specific" bit here. */
6754 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6756 /* Is this a request for a valid symbol? */
6757 if (symbol_num
< 0 || symbol_num
>= table_size
)
6760 if (CONSP (*symbol_table
))
6761 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6763 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6764 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6765 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6766 we've never used that symbol before. */
6769 if (! VECTORP (*symbol_table
)
6770 || XVECTOR (*symbol_table
)->size
!= table_size
)
6774 XSETFASTINT (size
, table_size
);
6775 *symbol_table
= Fmake_vector (size
, Qnil
);
6778 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6781 /* Have we already used this symbol before? */
6784 /* No; let's create it. */
6785 if (CONSP (name_alist_or_stem
))
6786 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6787 else if (STRINGP (name_alist_or_stem
))
6789 int len
= SBYTES (name_alist_or_stem
);
6790 char *buf
= (char *) alloca (len
+ 50);
6791 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6792 (long) XINT (symbol_int
) + 1);
6793 value
= intern (buf
);
6795 else if (name_table
!= 0 && name_table
[symbol_num
])
6796 value
= intern (name_table
[symbol_num
]);
6798 #ifdef HAVE_WINDOW_SYSTEM
6801 char *name
= x_get_keysym_name (symbol_num
);
6803 value
= intern (name
);
6810 sprintf (buf
, "key-%d", symbol_num
);
6811 value
= intern (buf
);
6814 if (CONSP (*symbol_table
))
6815 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6817 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6819 /* Fill in the cache entries for this symbol; this also
6820 builds the Qevent_symbol_elements property, which the user
6822 apply_modifiers (modifiers
& click_modifier
, value
);
6823 Fput (value
, Qevent_kind
, symbol_kind
);
6826 /* Apply modifiers to that symbol. */
6827 return apply_modifiers (modifiers
, value
);
6830 /* Convert a list that represents an event type,
6831 such as (ctrl meta backspace), into the usual representation of that
6832 event type as a number or a symbol. */
6834 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6835 doc
: /* Convert the event description list EVENT-DESC to an event type.
6836 EVENT-DESC should contain one base event type (a character or symbol)
6837 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6838 drag, down, double or triple). The base must be last.
6839 The return value is an event type (a character or symbol) which
6840 has the same base event type and all the specified modifiers. */)
6842 Lisp_Object event_desc
;
6850 while (CONSP (rest
))
6858 /* Given a symbol, see if it is a modifier name. */
6859 if (SYMBOLP (elt
) && CONSP (rest
))
6860 this = parse_solitary_modifier (elt
);
6864 else if (!NILP (base
))
6865 error ("Two bases given in one event");
6871 /* Let the symbol A refer to the character A. */
6872 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6873 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6875 if (INTEGERP (base
))
6877 /* Turn (shift a) into A. */
6878 if ((modifiers
& shift_modifier
) != 0
6879 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6881 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6882 modifiers
&= ~shift_modifier
;
6885 /* Turn (control a) into C-a. */
6886 if (modifiers
& ctrl_modifier
)
6887 return make_number ((modifiers
& ~ctrl_modifier
)
6888 | make_ctrl_char (XINT (base
)));
6890 return make_number (modifiers
| XINT (base
));
6892 else if (SYMBOLP (base
))
6893 return apply_modifiers (modifiers
, base
);
6896 error ("Invalid base event");
6901 /* Try to recognize SYMBOL as a modifier name.
6902 Return the modifier flag bit, or 0 if not recognized. */
6905 parse_solitary_modifier (Lisp_Object symbol
)
6907 Lisp_Object name
= SYMBOL_NAME (symbol
);
6909 switch (SREF (name
, 0))
6911 #define SINGLE_LETTER_MOD(BIT) \
6912 if (SBYTES (name) == 1) \
6915 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6916 if (LEN == SBYTES (name) \
6917 && ! strncmp (SDATA (name), NAME, LEN)) \
6921 SINGLE_LETTER_MOD (alt_modifier
);
6925 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6929 SINGLE_LETTER_MOD (ctrl_modifier
);
6933 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6934 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6938 SINGLE_LETTER_MOD (hyper_modifier
);
6942 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6946 SINGLE_LETTER_MOD (meta_modifier
);
6950 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6954 SINGLE_LETTER_MOD (shift_modifier
);
6958 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6959 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6960 SINGLE_LETTER_MOD (super_modifier
);
6964 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6965 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6966 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6970 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6973 #undef SINGLE_LETTER_MOD
6974 #undef MULTI_LETTER_MOD
6980 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6981 Such a list is not valid as an event,
6982 but it can be a Lucid-style event type list. */
6985 lucid_event_type_list_p (object
)
6990 if (! CONSP (object
))
6993 if (EQ (XCAR (object
), Qhelp_echo
)
6994 || EQ (XCAR (object
), Qvertical_line
)
6995 || EQ (XCAR (object
), Qmode_line
)
6996 || EQ (XCAR (object
), Qheader_line
))
6999 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
7003 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
7010 /* Store into *addr a value nonzero if terminal input chars are available.
7011 Serves the purpose of ioctl (0, FIONREAD, addr)
7012 but works even if FIONREAD does not exist.
7013 (In fact, this may actually read some input.)
7015 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
7016 timer events that are ripe.
7017 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
7018 events (FOCUS_IN_EVENT).
7019 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
7020 movements and toolkit scroll bar thumb drags. */
7023 get_input_pending (addr
, flags
)
7027 /* First of all, have we already counted some input? */
7028 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
7030 /* If input is being read as it arrives, and we have none, there is none. */
7031 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
7034 /* Try to read some input and see how much we get. */
7036 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
7039 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
7042 gobble_input (expected
)
7046 /* Read D-Bus messages. */
7047 xd_read_queued_messages ();
7048 #endif /* HAVE_DBUS */
7051 if (interrupt_input
)
7054 mask
= sigblock (sigmask (SIGIO
));
7055 read_avail_input (expected
);
7059 #ifdef POLL_FOR_INPUT
7060 /* XXX This condition was (read_socket_hook && !interrupt_input),
7061 but read_socket_hook is not global anymore. Let's pretend that
7063 if (!interrupt_input
&& poll_suppress_count
== 0)
7066 mask
= sigblock (sigmask (SIGALRM
));
7067 read_avail_input (expected
);
7073 read_avail_input (expected
);
7076 /* Put a BUFFER_SWITCH_EVENT in the buffer
7077 so that read_key_sequence will notice the new current buffer. */
7080 record_asynch_buffer_change ()
7082 struct input_event event
;
7086 event
.kind
= BUFFER_SWITCH_EVENT
;
7087 event
.frame_or_window
= Qnil
;
7091 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7092 The purpose of the event is to make read_key_sequence look up the
7093 keymaps again. If we aren't in read_key_sequence, we don't need one,
7094 and the event could cause trouble by messing up (input-pending-p). */
7095 tem
= Fwaiting_for_user_input_p ();
7099 /* We never need these events if we have no asynchronous subprocesses. */
7103 /* Make sure no interrupt happens while storing the event. */
7105 if (interrupt_input
)
7108 mask
= sigblock (sigmask (SIGIO
));
7109 kbd_buffer_store_event (&event
);
7116 kbd_buffer_store_event (&event
);
7121 /* Read any terminal input already buffered up by the system
7122 into the kbd_buffer, but do not wait.
7124 EXPECTED should be nonzero if the caller knows there is some input.
7126 Returns the number of keyboard chars read, or -1 meaning
7127 this is a bad time to try to read input. */
7130 read_avail_input (expected
)
7137 /* Store pending user signal events, if any. */
7138 if (store_user_signal_events ())
7141 /* Loop through the available terminals, and call their input hooks. */
7145 struct terminal
*next
= t
->next_terminal
;
7147 if (t
->read_socket_hook
)
7150 struct input_event hold_quit
;
7152 EVENT_INIT (hold_quit
);
7153 hold_quit
.kind
= NO_EVENT
;
7155 /* No need for FIONREAD or fcntl; just say don't wait. */
7156 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7162 if (nr
== -1) /* Not OK to read input now. */
7166 else if (nr
== -2) /* Non-transient error. */
7168 /* The terminal device terminated; it should be closed. */
7170 /* Kill Emacs if this was our last terminal. */
7171 if (!terminal_list
->next_terminal
)
7172 /* Formerly simply reported no input, but that
7173 sometimes led to a failure of Emacs to terminate.
7174 SIGHUP seems appropriate if we can't reach the
7176 /* ??? Is it really right to send the signal just to
7177 this process rather than to the whole process
7178 group? Perhaps on systems with FIONREAD Emacs is
7179 alone in its group. */
7180 kill (getpid (), SIGHUP
);
7182 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7185 XSETTERMINAL (tmp
, t
);
7186 Fdelete_terminal (tmp
, Qnoelisp
);
7190 if (hold_quit
.kind
!= NO_EVENT
)
7191 kbd_buffer_store_event (&hold_quit
);
7200 frame_make_pointer_visible ();
7206 decode_keyboard_code (struct tty_display_info
*tty
,
7207 struct coding_system
*coding
,
7208 unsigned char *buf
, int nbytes
)
7210 unsigned char *src
= buf
;
7211 const unsigned char *p
;
7216 if (tty
->meta_key
!= 2)
7217 for (i
= 0; i
< nbytes
; i
++)
7219 if (coding
->carryover_bytes
> 0)
7221 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7222 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7223 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7224 nbytes
+= coding
->carryover_bytes
;
7226 coding
->destination
= alloca (nbytes
* 4);
7227 coding
->dst_bytes
= nbytes
* 4;
7228 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7229 if (coding
->produced_char
== 0)
7231 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7233 struct input_event buf
;
7236 buf
.code
= STRING_CHAR_ADVANCE (p
);
7237 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7238 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7239 /* See the comment in tty_read_avail_input. */
7240 buf
.frame_or_window
= tty
->top_frame
;
7242 kbd_buffer_store_event (&buf
);
7246 /* This is the tty way of reading available input.
7248 Note that each terminal device has its own `struct terminal' object,
7249 and so this function is called once for each individual termcap
7250 terminal. The first parameter indicates which terminal to read from. */
7253 tty_read_avail_input (struct terminal
*terminal
,
7255 struct input_event
*hold_quit
)
7257 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7258 the kbd_buffer can really hold. That may prevent loss
7259 of characters on some systems when input is stuffed at us. */
7260 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7262 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7265 if (!terminal
->name
) /* Don't read from a dead terminal. */
7268 if (terminal
->type
!= output_termcap
7269 && terminal
->type
!= output_msdos_raw
)
7272 /* XXX I think the following code should be moved to separate hook
7273 functions in system-dependent files. */
7276 #else /* not WINDOWSNT */
7277 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7281 return 0; /* The terminal is suspended. */
7284 n_to_read
= dos_keysns ();
7288 cbuf
[0] = dos_keyread ();
7291 #else /* not MSDOS */
7296 struct input_event hold_quit
;
7297 int gpm
, fd
= gpm_fd
;
7299 EVENT_INIT (hold_quit
);
7300 hold_quit
.kind
= NO_EVENT
;
7302 /* gpm==1 if event received.
7303 gpm==0 if the GPM daemon has closed the connection, in which case
7304 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7305 we save it in `fd' so close_gpm can remove it from the
7307 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7308 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7309 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7312 /* Presumably the GPM daemon has closed the connection. */
7314 if (hold_quit
.kind
!= NO_EVENT
)
7315 kbd_buffer_store_event (&hold_quit
);
7319 #endif /* HAVE_GPM */
7321 /* Determine how many characters we should *try* to read. */
7323 /* Find out how much input is available. */
7324 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7326 if (! noninteractive
)
7327 return -2; /* Close this terminal. */
7333 if (n_to_read
> sizeof cbuf
)
7334 n_to_read
= sizeof cbuf
;
7335 #else /* no FIONREAD */
7336 #if defined (USG) || defined(CYGWIN)
7337 /* Read some input if available, but don't wait. */
7338 n_to_read
= sizeof cbuf
;
7339 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7345 /* Now read; for one reason or another, this will not block.
7346 NREAD is set to the number of chars read. */
7349 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7350 /* POSIX infers that processes which are not in the session leader's
7351 process group won't get SIGHUP's at logout time. BSDI adheres to
7352 this part standard and returns -1 from read (0) with errno==EIO
7353 when the control tty is taken away.
7354 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7355 if (nread
== -1 && errno
== EIO
)
7356 return -2; /* Close this terminal. */
7357 #if defined (AIX) && defined (_BSD)
7358 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7359 This looks incorrect, but it isn't, because _BSD causes
7360 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7361 and that causes a value other than 0 when there is no input. */
7363 return -2; /* Close this terminal. */
7367 /* We used to retry the read if it was interrupted.
7368 But this does the wrong thing when O_NDELAY causes
7369 an EAGAIN error. Does anybody know of a situation
7370 where a retry is actually needed? */
7372 nread
< 0 && (errno
== EAGAIN
7386 #if defined (USG) || defined (CYGWIN)
7387 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7388 #endif /* USG or CYGWIN */
7389 #endif /* no FIONREAD */
7394 #endif /* not MSDOS */
7395 #endif /* not WINDOWSNT */
7397 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7398 & CODING_REQUIRE_DECODING_MASK
)
7400 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7403 /* Decode the key sequence except for those with meta
7405 for (i
= from
= 0; ; i
++)
7406 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7408 struct input_event buf
;
7410 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7415 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7416 buf
.modifiers
= meta_modifier
;
7417 buf
.code
= cbuf
[i
] & ~0x80;
7418 /* See the comment below. */
7419 buf
.frame_or_window
= tty
->top_frame
;
7421 kbd_buffer_store_event (&buf
);
7427 for (i
= 0; i
< nread
; i
++)
7429 struct input_event buf
;
7431 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7433 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7434 buf
.modifiers
= meta_modifier
;
7435 if (tty
->meta_key
!= 2)
7439 /* Set the frame corresponding to the active tty. Note that the
7440 value of selected_frame is not reliable here, redisplay tends
7441 to temporarily change it. */
7442 buf
.frame_or_window
= tty
->top_frame
;
7445 kbd_buffer_store_event (&buf
);
7446 /* Don't look at input that follows a C-g too closely.
7447 This reduces lossage due to autorepeat on C-g. */
7448 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7449 && buf
.code
== quit_char
)
7457 handle_async_input ()
7459 interrupt_input_pending
= 0;
7461 pending_signals
= pending_atimers
;
7463 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7464 doing anything dangerous. */
7471 nread
= read_avail_input (1);
7472 /* -1 means it's not ok to read the input now.
7473 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7474 0 means there was no keyboard input available. */
7484 process_pending_signals ()
7486 if (interrupt_input_pending
)
7487 handle_async_input ();
7488 do_pending_atimers ();
7491 #ifdef SIGIO /* for entire page */
7492 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7495 input_available_signal (signo
)
7498 /* Must preserve main program's value of errno. */
7499 int old_errno
= errno
;
7500 #if defined (USG) && !defined (POSIX_SIGNALS)
7501 /* USG systems forget handlers when they are used;
7502 must reestablish each time */
7503 signal (signo
, input_available_signal
);
7507 interrupt_input_pending
= 1;
7508 pending_signals
= 1;
7510 SIGNAL_THREAD_CHECK (signo
);
7513 if (input_available_clear_time
)
7514 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7517 handle_async_input ();
7524 /* Send ourselves a SIGIO.
7526 This function exists so that the UNBLOCK_INPUT macro in
7527 blockinput.h can have some way to take care of input we put off
7528 dealing with, without assuming that every file which uses
7529 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7531 reinvoke_input_signal ()
7534 handle_async_input ();
7540 /* User signal events. */
7542 struct user_signal_info
7544 /* Signal number. */
7547 /* Name of the signal. */
7550 /* Number of pending signals. */
7553 struct user_signal_info
*next
;
7556 /* List of user signals. */
7557 static struct user_signal_info
*user_signals
= NULL
;
7560 add_user_signal (sig
, name
)
7564 struct user_signal_info
*p
;
7566 for (p
= user_signals
; p
; p
= p
->next
)
7568 /* Already added. */
7571 p
= xmalloc (sizeof (struct user_signal_info
));
7573 p
->name
= xstrdup (name
);
7575 p
->next
= user_signals
;
7578 signal (sig
, handle_user_signal
);
7582 handle_user_signal (sig
)
7585 int old_errno
= errno
;
7586 struct user_signal_info
*p
;
7588 #if defined (USG) && !defined (POSIX_SIGNALS)
7589 /* USG systems forget handlers when they are used;
7590 must reestablish each time */
7591 signal (sig
, handle_user_signal
);
7594 SIGNAL_THREAD_CHECK (sig
);
7596 for (p
= user_signals
; p
; p
= p
->next
)
7601 if (interrupt_input
)
7602 kill (getpid (), SIGIO
);
7606 /* Tell wait_reading_process_output that it needs to wake
7607 up and look around. */
7608 if (input_available_clear_time
)
7609 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7618 find_user_signal_name (sig
)
7621 struct user_signal_info
*p
;
7623 for (p
= user_signals
; p
; p
= p
->next
)
7631 store_user_signal_events ()
7633 struct user_signal_info
*p
;
7634 struct input_event buf
;
7637 for (p
= user_signals
; p
; p
= p
->next
)
7638 if (p
->npending
> 0)
7644 bzero (&buf
, sizeof buf
);
7645 buf
.kind
= USER_SIGNAL_EVENT
;
7646 buf
.frame_or_window
= selected_frame
;
7648 nstored
+= p
->npending
;
7650 mask
= sigblock (sigmask (p
->sig
));
7654 kbd_buffer_store_event (&buf
);
7657 while (p
->npending
> 0);
7665 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7666 static Lisp_Object menu_bar_one_keymap_changed_items
;
7668 /* These variables hold the vector under construction within
7669 menu_bar_items and its subroutines, and the current index
7670 for storing into that vector. */
7671 static Lisp_Object menu_bar_items_vector
;
7672 static int menu_bar_items_index
;
7674 /* Return a vector of menu items for a menu bar, appropriate
7675 to the current buffer. Each item has three elements in the vector:
7678 OLD is an old vector we can optionally reuse, or nil. */
7681 menu_bar_items (old
)
7684 /* The number of keymaps we're scanning right now, and the number of
7685 keymaps we have allocated space for. */
7688 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7689 in the current keymaps, or nil where it is not a prefix. */
7692 Lisp_Object def
, tail
;
7701 /* In order to build the menus, we need to call the keymap
7702 accessors. They all call QUIT. But this function is called
7703 during redisplay, during which a quit is fatal. So inhibit
7704 quitting while building the menus.
7705 We do this instead of specbind because (1) errors will clear it anyway
7706 and (2) this avoids risk of specpdl overflow. */
7707 oquit
= Vinhibit_quit
;
7711 menu_bar_items_vector
= old
;
7713 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7714 menu_bar_items_index
= 0;
7716 /* Build our list of keymaps.
7717 If we recognize a function key and replace its escape sequence in
7718 keybuf with its symbol, or if the sequence starts with a mouse
7719 click and we need to switch buffers, we jump back here to rebuild
7720 the initial keymaps from the current buffer. */
7724 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7725 if (!NILP (Voverriding_local_map_menu_flag
))
7727 /* Yes, use them (if non-nil) as well as the global map. */
7728 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7730 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7731 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7732 if (!NILP (Voverriding_local_map
))
7733 maps
[nmaps
++] = Voverriding_local_map
;
7737 /* No, so use major and minor mode keymaps and keymap property.
7738 Note that menu-bar bindings in the local-map and keymap
7739 properties may not work reliable, as they are only
7740 recognized when the menu-bar (or mode-line) is updated,
7741 which does not normally happen after every command. */
7744 nminor
= current_minor_maps (NULL
, &tmaps
);
7745 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7747 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7748 maps
[nmaps
++] = tem
;
7749 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7751 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7753 maps
[nmaps
++] = current_global_map
;
7756 /* Look up in each map the dummy prefix key `menu-bar'. */
7760 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7761 if (!NILP (maps
[mapno
]))
7763 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7767 menu_bar_one_keymap_changed_items
= Qnil
;
7768 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7772 /* Move to the end those items that should be at the end. */
7774 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7777 int end
= menu_bar_items_index
;
7779 for (i
= 0; i
< end
; i
+= 4)
7780 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7782 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7783 /* Move the item at index I to the end,
7784 shifting all the others forward. */
7785 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7786 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7787 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7788 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7790 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7791 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7792 (end
- i
- 4) * sizeof (Lisp_Object
));
7793 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7794 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7795 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7796 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7801 /* Add nil, nil, nil, nil at the end. */
7802 i
= menu_bar_items_index
;
7803 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7804 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7805 /* Add this item. */
7806 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7807 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7808 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7809 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7810 menu_bar_items_index
= i
;
7812 Vinhibit_quit
= oquit
;
7813 return menu_bar_items_vector
;
7816 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7817 If there's already an item for KEY, add this DEF to it. */
7819 Lisp_Object item_properties
;
7822 menu_bar_item (key
, item
, dummy1
, dummy2
)
7823 Lisp_Object key
, item
, dummy1
;
7826 struct gcpro gcpro1
;
7830 if (EQ (item
, Qundefined
))
7832 /* If a map has an explicit `undefined' as definition,
7833 discard any previously made menu bar item. */
7835 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7836 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7838 if (menu_bar_items_index
> i
+ 4)
7839 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7840 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7841 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7842 menu_bar_items_index
-= 4;
7846 /* If this keymap has already contributed to this KEY,
7847 don't contribute to it a second time. */
7848 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7849 if (!NILP (tem
) || NILP (item
))
7852 menu_bar_one_keymap_changed_items
7853 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7855 /* We add to menu_bar_one_keymap_changed_items before doing the
7856 parse_menu_item, so that if it turns out it wasn't a menu item,
7857 it still correctly hides any further menu item. */
7859 i
= parse_menu_item (item
, 1);
7864 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7866 /* Find any existing item for this KEY. */
7867 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7868 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7871 /* If we did not find this KEY, add it at the end. */
7872 if (i
== menu_bar_items_index
)
7874 /* If vector is too small, get a bigger one. */
7875 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7876 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7877 /* Add this item. */
7878 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7879 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7880 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7881 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7882 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7883 menu_bar_items_index
= i
;
7885 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7889 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7890 /* If the new and the old items are not both keymaps,
7891 the lookup will only find `item'. */
7892 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7893 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7897 /* This is used as the handler when calling menu_item_eval_property. */
7899 menu_item_eval_property_1 (arg
)
7902 /* If we got a quit from within the menu computation,
7903 quit all the way out of it. This takes care of C-] in the debugger. */
7904 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7905 Fsignal (Qquit
, Qnil
);
7910 /* Evaluate an expression and return the result (or nil if something
7911 went wrong). Used to evaluate dynamic parts of menu items. */
7913 menu_item_eval_property (sexpr
)
7916 int count
= SPECPDL_INDEX ();
7918 specbind (Qinhibit_redisplay
, Qt
);
7919 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7920 menu_item_eval_property_1
);
7921 return unbind_to (count
, val
);
7924 /* This function parses a menu item and leaves the result in the
7925 vector item_properties.
7926 ITEM is a key binding, a possible menu item.
7927 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7929 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7930 parse_menu_item returns true if the item is a menu item and false
7934 parse_menu_item (item
, inmenubar
)
7938 Lisp_Object def
, tem
, item_string
, start
;
7940 Lisp_Object keyhint
;
7949 /* Create item_properties vector if necessary. */
7950 if (NILP (item_properties
))
7952 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7954 /* Initialize optional entries. */
7955 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7956 ASET (item_properties
, i
, Qnil
);
7957 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7959 /* Save the item here to protect it from GC. */
7960 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7962 item_string
= XCAR (item
);
7966 if (STRINGP (item_string
))
7968 /* Old format menu item. */
7969 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7971 /* Maybe help string. */
7972 if (CONSP (item
) && STRINGP (XCAR (item
)))
7974 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7979 /* Maybe an obsolete key binding cache. */
7980 if (CONSP (item
) && CONSP (XCAR (item
))
7981 && (NILP (XCAR (XCAR (item
)))
7982 || VECTORP (XCAR (XCAR (item
)))))
7985 /* This is the real definition--the function to run. */
7986 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7988 /* Get enable property, if any. */
7991 tem
= Fget (item
, Qmenu_enable
);
7992 if (!NILP (Venable_disabled_menus_and_buttons
))
7993 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7994 else if (!NILP (tem
))
7995 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7998 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
8000 /* New format menu item. */
8001 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
8002 start
= XCDR (item
);
8005 /* We have a real binding. */
8006 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
8008 item
= XCDR (start
);
8009 /* Is there an obsolete cache list with key equivalences. */
8010 if (CONSP (item
) && CONSP (XCAR (item
)))
8013 /* Parse properties. */
8014 while (CONSP (item
) && CONSP (XCDR (item
)))
8019 if (EQ (tem
, QCenable
))
8021 if (!NILP (Venable_disabled_menus_and_buttons
))
8022 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
8024 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
8026 else if (EQ (tem
, QCvisible
))
8028 /* If got a visible property and that evaluates to nil
8029 then ignore this item. */
8030 tem
= menu_item_eval_property (XCAR (item
));
8034 else if (EQ (tem
, QChelp
))
8035 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
8036 else if (EQ (tem
, QCfilter
))
8038 else if (EQ (tem
, QCkey_sequence
))
8041 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
8042 /* Be GC protected. Set keyhint to item instead of tem. */
8045 else if (EQ (tem
, QCkeys
))
8048 if (CONSP (tem
) || STRINGP (tem
))
8049 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8051 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
8056 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8058 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8060 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
8066 else if (inmenubar
|| !NILP (start
))
8070 return 0; /* not a menu item */
8072 /* If item string is not a string, evaluate it to get string.
8073 If we don't get a string, skip this item. */
8074 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
8075 if (!(STRINGP (item_string
)))
8077 item_string
= menu_item_eval_property (item_string
);
8078 if (!STRINGP (item_string
))
8080 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
8083 /* If got a filter apply it on definition. */
8084 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8087 def
= menu_item_eval_property (list2 (XCAR (filter
),
8088 list2 (Qquote
, def
)));
8090 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
8093 /* Enable or disable selection of item. */
8094 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
8097 tem
= menu_item_eval_property (tem
);
8098 if (inmenubar
&& NILP (tem
))
8099 return 0; /* Ignore disabled items in menu bar. */
8100 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
8103 /* If we got no definition, this item is just unselectable text which
8104 is OK in a submenu but not in the menubar. */
8106 return (inmenubar
? 0 : 1);
8108 /* See if this is a separate pane or a submenu. */
8109 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8110 tem
= get_keymap (def
, 0, 1);
8111 /* For a subkeymap, just record its details and exit. */
8114 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
8115 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
8119 /* At the top level in the menu bar, do likewise for commands also.
8120 The menu bar does not display equivalent key bindings anyway.
8121 ITEM_PROPERTY_DEF is already set up properly. */
8125 { /* This is a command. See if there is an equivalent key binding. */
8126 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8128 /* The previous code preferred :key-sequence to :keys, so we
8129 preserve this behavior. */
8130 if (STRINGP (keyeq
) && !CONSP (keyhint
))
8131 keyeq
= Fsubstitute_command_keys (keyeq
);
8134 Lisp_Object prefix
= keyeq
;
8135 Lisp_Object keys
= Qnil
;
8139 def
= XCAR (prefix
);
8140 prefix
= XCDR (prefix
);
8143 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8145 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
8147 keys
= XCAR (keyhint
);
8148 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
8150 /* We have a suggested key. Is it bound to the command? */
8153 /* If the command is an alias for another
8154 (such as lmenu.el set it up), check if the
8155 original command matches the cached command. */
8156 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8161 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
8165 tem
= Fkey_description (keys
, Qnil
);
8168 if (STRINGP (XCAR (prefix
)))
8169 tem
= concat2 (XCAR (prefix
), tem
);
8170 if (STRINGP (XCDR (prefix
)))
8171 tem
= concat2 (tem
, XCDR (prefix
));
8173 keyeq
= concat2 (build_string (" "), tem
);
8174 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
8180 /* If we have an equivalent key binding, use that. */
8181 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
8184 /* Include this when menu help is implemented.
8185 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8186 if (!(NILP (tem) || STRINGP (tem)))
8188 tem = menu_item_eval_property (tem);
8191 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8195 /* Handle radio buttons or toggle boxes. */
8196 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8198 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8199 menu_item_eval_property (tem
));
8206 /***********************************************************************
8208 ***********************************************************************/
8210 /* A vector holding tool bar items while they are parsed in function
8211 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8214 static Lisp_Object tool_bar_items_vector
;
8216 /* A vector holding the result of parse_tool_bar_item. Layout is like
8217 the one for a single item in tool_bar_items_vector. */
8219 static Lisp_Object tool_bar_item_properties
;
8221 /* Next free index in tool_bar_items_vector. */
8223 static int ntool_bar_items
;
8225 /* The symbols `tool-bar', `:image' and `:rtl'. */
8227 extern Lisp_Object Qtool_bar
;
8228 Lisp_Object QCimage
;
8231 /* Function prototypes. */
8233 static void init_tool_bar_items
P_ ((Lisp_Object
));
8234 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8235 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8236 static void append_tool_bar_item
P_ ((void));
8239 /* Return a vector of tool bar items for keymaps currently in effect.
8240 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8241 tool bar items found. */
8244 tool_bar_items (reuse
, nitems
)
8255 /* In order to build the menus, we need to call the keymap
8256 accessors. They all call QUIT. But this function is called
8257 during redisplay, during which a quit is fatal. So inhibit
8258 quitting while building the menus. We do this instead of
8259 specbind because (1) errors will clear it anyway and (2) this
8260 avoids risk of specpdl overflow. */
8261 oquit
= Vinhibit_quit
;
8264 /* Initialize tool_bar_items_vector and protect it from GC. */
8265 init_tool_bar_items (reuse
);
8267 /* Build list of keymaps in maps. Set nmaps to the number of maps
8270 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8271 if (!NILP (Voverriding_local_map_menu_flag
))
8273 /* Yes, use them (if non-nil) as well as the global map. */
8274 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8276 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8277 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8278 if (!NILP (Voverriding_local_map
))
8279 maps
[nmaps
++] = Voverriding_local_map
;
8283 /* No, so use major and minor mode keymaps and keymap property.
8284 Note that tool-bar bindings in the local-map and keymap
8285 properties may not work reliable, as they are only
8286 recognized when the tool-bar (or mode-line) is updated,
8287 which does not normally happen after every command. */
8290 nminor
= current_minor_maps (NULL
, &tmaps
);
8291 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8293 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8294 maps
[nmaps
++] = tem
;
8295 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8297 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8300 /* Add global keymap at the end. */
8301 maps
[nmaps
++] = current_global_map
;
8303 /* Process maps in reverse order and look up in each map the prefix
8305 for (i
= nmaps
- 1; i
>= 0; --i
)
8306 if (!NILP (maps
[i
]))
8310 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8312 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8315 Vinhibit_quit
= oquit
;
8316 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8317 return tool_bar_items_vector
;
8321 /* Process the definition of KEY which is DEF. */
8324 process_tool_bar_item (key
, def
, data
, args
)
8325 Lisp_Object key
, def
, data
;
8329 extern Lisp_Object Qundefined
;
8330 struct gcpro gcpro1
, gcpro2
;
8332 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8336 if (EQ (def
, Qundefined
))
8338 /* If a map has an explicit `undefined' as definition,
8339 discard any previously made item. */
8340 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8342 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8344 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8346 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8347 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8348 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8349 * sizeof (Lisp_Object
)));
8350 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8355 else if (parse_tool_bar_item (key
, def
))
8356 /* Append a new tool bar item to tool_bar_items_vector. Accept
8357 more than one definition for the same key. */
8358 append_tool_bar_item ();
8364 /* Parse a tool bar item specification ITEM for key KEY and return the
8365 result in tool_bar_item_properties. Value is zero if ITEM is
8368 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8370 CAPTION is the caption of the item, If it's not a string, it is
8371 evaluated to get a string.
8373 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8374 as binding are currently ignored.
8376 The following properties are recognized:
8380 FORM is evaluated and specifies whether the tool bar item is
8381 enabled or disabled.
8385 FORM is evaluated and specifies whether the tool bar item is visible.
8387 - `:filter FUNCTION'
8389 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8390 result is stored as the new binding.
8392 - `:button (TYPE SELECTED)'
8394 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8395 and specifies whether the button is selected (pressed) or not.
8399 IMAGES is either a single image specification or a vector of four
8400 image specifications. See enum tool_bar_item_images.
8402 - `:help HELP-STRING'.
8404 Gives a help string to display for the tool bar item. */
8407 parse_tool_bar_item (key
, item
)
8408 Lisp_Object key
, item
;
8410 /* Access slot with index IDX of vector tool_bar_item_properties. */
8411 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8413 Lisp_Object filter
= Qnil
;
8414 Lisp_Object caption
;
8417 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8418 Rule out items that aren't lists, don't start with
8419 `menu-item' or whose rest following `tool-bar-item' is not a
8422 || !EQ (XCAR (item
), Qmenu_item
)
8423 || (item
= XCDR (item
),
8427 /* Create tool_bar_item_properties vector if necessary. Reset it to
8429 if (VECTORP (tool_bar_item_properties
))
8431 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8435 tool_bar_item_properties
8436 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8439 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8440 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8442 /* Get the caption of the item. If the caption is not a string,
8443 evaluate it to get a string. If we don't get a string, skip this
8445 caption
= XCAR (item
);
8446 if (!STRINGP (caption
))
8448 caption
= menu_item_eval_property (caption
);
8449 if (!STRINGP (caption
))
8452 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8454 /* Give up if rest following the caption is not a list. */
8459 /* Store the binding. */
8460 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8463 /* Ignore cached key binding, if any. */
8464 if (CONSP (item
) && CONSP (XCAR (item
)))
8467 /* Process the rest of the properties. */
8468 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8470 Lisp_Object key
, value
;
8473 value
= XCAR (XCDR (item
));
8475 if (EQ (key
, QCenable
))
8477 /* `:enable FORM'. */
8478 if (!NILP (Venable_disabled_menus_and_buttons
))
8479 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8481 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8483 else if (EQ (key
, QCvisible
))
8485 /* `:visible FORM'. If got a visible property and that
8486 evaluates to nil then ignore this item. */
8487 if (NILP (menu_item_eval_property (value
)))
8490 else if (EQ (key
, QChelp
))
8491 /* `:help HELP-STRING'. */
8492 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8493 else if (EQ (key
, QCfilter
))
8494 /* ':filter FORM'. */
8496 else if (EQ (key
, QCbutton
) && CONSP (value
))
8498 /* `:button (TYPE . SELECTED)'. */
8499 Lisp_Object type
, selected
;
8501 type
= XCAR (value
);
8502 selected
= XCDR (value
);
8503 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8505 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8506 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8509 else if (EQ (key
, QCimage
)
8511 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8512 /* Value is either a single image specification or a vector
8513 of 4 such specifications for the different button states. */
8514 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8515 else if (EQ (key
, Qrtl
))
8517 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8520 /* If got a filter apply it on binding. */
8522 PROP (TOOL_BAR_ITEM_BINDING
)
8523 = menu_item_eval_property (list2 (filter
,
8525 PROP (TOOL_BAR_ITEM_BINDING
))));
8527 /* See if the binding is a keymap. Give up if it is. */
8528 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8531 /* Enable or disable selection of item. */
8532 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8533 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8534 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8536 /* Handle radio buttons or toggle boxes. */
8537 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8538 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8539 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8547 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8548 that can be reused. */
8551 init_tool_bar_items (reuse
)
8554 if (VECTORP (reuse
))
8555 tool_bar_items_vector
= reuse
;
8557 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8558 ntool_bar_items
= 0;
8562 /* Append parsed tool bar item properties from
8563 tool_bar_item_properties */
8566 append_tool_bar_item ()
8568 Lisp_Object
*to
, *from
;
8570 /* Enlarge tool_bar_items_vector if necessary. */
8571 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8572 >= XVECTOR (tool_bar_items_vector
)->size
)
8573 tool_bar_items_vector
8574 = larger_vector (tool_bar_items_vector
,
8575 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8577 /* Append entries from tool_bar_item_properties to the end of
8578 tool_bar_items_vector. */
8579 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8580 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8581 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8582 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8589 /* Read a character using menus based on maps in the array MAPS.
8590 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8591 Return t if we displayed a menu but the user rejected it.
8593 PREV_EVENT is the previous input event, or nil if we are reading
8594 the first event of a key sequence.
8596 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8597 if we used a mouse menu to read the input, or zero otherwise. If
8598 USED_MOUSE_MENU is null, we don't dereference it.
8600 The prompting is done based on the prompt-string of the map
8601 and the strings associated with various map elements.
8603 This can be done with X menus or with menus put in the minibuf.
8604 These are done in different ways, depending on how the input will be read.
8605 Menus using X are done after auto-saving in read-char, getting the input
8606 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8607 and do auto-saving in the inner call of read_char. */
8610 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8613 Lisp_Object prev_event
;
8614 int *used_mouse_menu
;
8618 if (used_mouse_menu
)
8619 *used_mouse_menu
= 0;
8621 /* Use local over global Menu maps */
8623 if (! menu_prompting
)
8626 /* Optionally disregard all but the global map. */
8627 if (inhibit_local_menu_bar_menus
)
8629 maps
+= (nmaps
- 1);
8634 /* If we got to this point via a mouse click,
8635 use a real menu for mouse selection. */
8636 if (EVENT_HAS_PARAMETERS (prev_event
)
8637 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8638 && !EQ (XCAR (prev_event
), Qtool_bar
))
8640 /* Display the menu and get the selection. */
8641 Lisp_Object
*realmaps
8642 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8646 /* Use the maps that are not nil. */
8647 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8648 if (!NILP (maps
[mapno
]))
8649 realmaps
[nmaps1
++] = maps
[mapno
];
8651 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8656 record_menu_key (XCAR (value
));
8658 /* If we got multiple events, unread all but
8660 There is no way to prevent those unread events
8661 from showing up later in last_nonmenu_event.
8662 So turn symbol and integer events into lists,
8663 to indicate that they came from a mouse menu,
8664 so that when present in last_nonmenu_event
8665 they won't confuse things. */
8666 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8668 record_menu_key (XCAR (tem
));
8669 if (SYMBOLP (XCAR (tem
))
8670 || INTEGERP (XCAR (tem
)))
8671 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8674 /* If we got more than one event, put all but the first
8675 onto this list to be read later.
8676 Return just the first event now. */
8677 Vunread_command_events
8678 = nconc2 (XCDR (value
), Vunread_command_events
);
8679 value
= XCAR (value
);
8681 else if (NILP (value
))
8683 if (used_mouse_menu
)
8684 *used_mouse_menu
= 1;
8687 #endif /* HAVE_MENUS */
8691 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8692 We make this bigger when necessary, and never free it. */
8693 static char *read_char_minibuf_menu_text
;
8694 /* Size of that buffer. */
8695 static int read_char_minibuf_menu_width
;
8698 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8704 register Lisp_Object name
;
8706 /* FIXME: Use the minibuffer's frame width. */
8707 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8710 Lisp_Object rest
, vector
;
8716 if (! menu_prompting
)
8719 /* Get the menu name from the first map that has one (a prompt string). */
8720 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8722 name
= Fkeymap_prompt (maps
[mapno
]);
8727 /* If we don't have any menus, just read a character normally. */
8728 if (!STRINGP (name
))
8731 /* Make sure we have a big enough buffer for the menu text. */
8732 width
= max (width
, SBYTES (name
));
8733 if (read_char_minibuf_menu_text
== 0)
8735 read_char_minibuf_menu_width
= width
+ 4;
8736 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8738 else if (width
+ 4 > read_char_minibuf_menu_width
)
8740 read_char_minibuf_menu_width
= width
+ 4;
8741 read_char_minibuf_menu_text
8742 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8744 menu
= read_char_minibuf_menu_text
;
8746 /* Prompt string always starts with map's prompt, and a space. */
8747 strcpy (menu
, SDATA (name
));
8748 nlength
= SBYTES (name
);
8749 menu
[nlength
++] = ':';
8750 menu
[nlength
++] = ' ';
8753 /* Start prompting at start of first map. */
8757 /* Present the documented bindings, a line at a time. */
8764 Lisp_Object orig_defn_macro
;
8766 /* Loop over elements of map. */
8771 /* If reached end of map, start at beginning of next map. */
8775 /* At end of last map, wrap around to first map if just starting,
8776 or end this line if already have something on it. */
8780 if (notfirst
|| nobindings
) break;
8785 /* Look at the next element of the map. */
8787 elt
= XVECTOR (vector
)->contents
[idx
];
8789 elt
= Fcar_safe (rest
);
8791 if (idx
< 0 && VECTORP (elt
))
8793 /* If we found a dense table in the keymap,
8794 advanced past it, but start scanning its contents. */
8795 rest
= Fcdr_safe (rest
);
8801 /* An ordinary element. */
8802 Lisp_Object event
, tem
;
8806 event
= Fcar_safe (elt
); /* alist */
8807 elt
= Fcdr_safe (elt
);
8811 XSETINT (event
, idx
); /* vector */
8814 /* Ignore the element if it has no prompt string. */
8815 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8817 /* 1 if the char to type matches the string. */
8819 Lisp_Object upcased_event
, downcased_event
;
8820 Lisp_Object desc
= Qnil
;
8822 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8824 upcased_event
= Fupcase (event
);
8825 downcased_event
= Fdowncase (event
);
8826 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8827 || XINT (downcased_event
) == SREF (s
, 0));
8829 desc
= Fsingle_key_description (event
, Qnil
);
8831 #if 0 /* It is redundant to list the equivalent key bindings because
8832 the prefix is what the user has already typed. */
8834 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8836 /* Insert equivalent keybinding. */
8837 s
= concat2 (s
, tem
);
8840 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8841 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8843 /* Insert button prefix. */
8844 Lisp_Object selected
8845 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8846 if (EQ (tem
, QCradio
))
8847 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8849 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8850 s
= concat2 (tem
, s
);
8854 /* If we have room for the prompt string, add it to this line.
8855 If this is the first on the line, always add it. */
8856 if ((SCHARS (s
) + i
+ 2
8857 + (char_matches
? 0 : SCHARS (desc
) + 3))
8863 /* Punctuate between strings. */
8866 strcpy (menu
+ i
, ", ");
8872 /* If the char to type doesn't match the string's
8873 first char, explicitly show what char to type. */
8876 /* Add as much of string as fits. */
8877 thiswidth
= SCHARS (desc
);
8878 if (thiswidth
+ i
> width
)
8879 thiswidth
= width
- i
;
8880 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8882 strcpy (menu
+ i
, " = ");
8886 /* Add as much of string as fits. */
8887 thiswidth
= SCHARS (s
);
8888 if (thiswidth
+ i
> width
)
8889 thiswidth
= width
- i
;
8890 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8896 /* If this element does not fit, end the line now,
8897 and save the element for the next line. */
8898 strcpy (menu
+ i
, "...");
8903 /* Move past this element. */
8904 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8905 /* Handle reaching end of dense table. */
8910 rest
= Fcdr_safe (rest
);
8914 /* Prompt with that and read response. */
8915 message2_nolog (menu
, strlen (menu
),
8916 ! NILP (current_buffer
->enable_multibyte_characters
));
8918 /* Make believe its not a keyboard macro in case the help char
8919 is pressed. Help characters are not recorded because menu prompting
8920 is not used on replay.
8922 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8923 current_kboard
->defining_kbd_macro
= Qnil
;
8925 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8926 while (BUFFERP (obj
));
8927 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8929 if (!INTEGERP (obj
))
8931 else if (XINT (obj
) == -2)
8936 if (! EQ (obj
, menu_prompt_more_char
)
8937 && (!INTEGERP (menu_prompt_more_char
)
8938 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8940 if (!NILP (current_kboard
->defining_kbd_macro
))
8941 store_kbd_macro_char (obj
);
8944 /* Help char - go round again */
8948 /* Reading key sequences. */
8950 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8951 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8952 keymap, or nil otherwise. Return the index of the first keymap in
8953 which KEY has any binding, or NMAPS if no map has a binding.
8955 If KEY is a meta ASCII character, treat it like meta-prefix-char
8956 followed by the corresponding non-meta character. Keymaps in
8957 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8960 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8963 NEXT may be the same array as CURRENT. */
8966 follow_key (key
, nmaps
, current
, defs
, next
)
8968 Lisp_Object
*current
, *defs
, *next
;
8971 int i
, first_binding
;
8973 first_binding
= nmaps
;
8974 for (i
= nmaps
- 1; i
>= 0; i
--)
8976 if (! NILP (current
[i
]))
8978 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8979 if (! NILP (defs
[i
]))
8986 /* Given the set of bindings we've found, produce the next set of maps. */
8987 if (first_binding
< nmaps
)
8988 for (i
= 0; i
< nmaps
; i
++)
8989 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8991 return first_binding
;
8994 /* Structure used to keep track of partial application of key remapping
8995 such as Vfunction_key_map and Vkey_translation_map. */
8996 typedef struct keyremap
8998 /* This is the map originally specified for this use. */
9000 /* This is a submap reached by looking up, in PARENT,
9001 the events from START to END. */
9003 /* Positions [START, END) in the key sequence buffer
9004 are the key that we have scanned so far.
9005 Those events are the ones that we will replace
9006 if PAREHT maps them into a key sequence. */
9010 /* Lookup KEY in MAP.
9011 MAP is a keymap mapping keys to key vectors or functions.
9012 If the mapping is a function and DO_FUNCTION is non-zero, then
9013 the function is called with PROMPT as parameter and its return
9014 value is used as the return value of this function (after checking
9015 that it is indeed a vector). */
9018 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
9019 Lisp_Object map
, key
, prompt
;
9024 next
= access_keymap (map
, key
, 1, 0, 1);
9026 /* Handle symbol with autoload definition. */
9027 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
9028 && CONSP (XSYMBOL (next
)->function
)
9029 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9030 do_autoload (XSYMBOL (next
)->function
, next
);
9032 /* Handle a symbol whose function definition is a keymap
9034 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
9035 && (ARRAYP (XSYMBOL (next
)->function
)
9036 || KEYMAPP (XSYMBOL (next
)->function
)))
9037 next
= XSYMBOL (next
)->function
;
9039 /* If the keymap gives a function, not an
9040 array, then call the function with one arg and use
9041 its value instead. */
9042 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
9047 next
= call1 (next
, prompt
);
9048 /* If the function returned something invalid,
9049 barf--don't ignore it.
9050 (To ignore it safely, we would need to gcpro a bunch of
9051 other variables.) */
9052 if (! (VECTORP (next
) || STRINGP (next
)))
9053 error ("Function %s returns invalid key sequence", tem
);
9058 /* Do one step of the key remapping used for function-key-map and
9059 key-translation-map:
9060 KEYBUF is the buffer holding the input events.
9061 BUFSIZE is its maximum size.
9062 FKEY is a pointer to the keyremap structure to use.
9063 INPUT is the index of the last element in KEYBUF.
9064 DOIT if non-zero says that the remapping can actually take place.
9065 DIFF is used to return the number of keys added/removed by the remapping.
9066 PARENT is the root of the keymap.
9067 PROMPT is the prompt to use if the remapping happens through a function.
9068 The return value is non-zero if the remapping actually took place. */
9071 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9072 Lisp_Object
*keybuf
, prompt
;
9074 int input
, doit
, *diff
, bufsize
;
9076 Lisp_Object next
, key
;
9078 key
= keybuf
[fkey
->end
++];
9080 if (KEYMAPP (fkey
->parent
))
9081 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9085 /* If keybuf[fkey->start..fkey->end] is bound in the
9086 map and we're in a position to do the key remapping, replace it with
9087 the binding and restart with fkey->start at the end. */
9088 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9090 int len
= XFASTINT (Flength (next
));
9093 *diff
= len
- (fkey
->end
- fkey
->start
);
9095 if (input
+ *diff
>= bufsize
)
9096 error ("Key sequence too long");
9098 /* Shift the keys that follow fkey->end. */
9100 for (i
= fkey
->end
; i
< input
; i
++)
9101 keybuf
[i
+ *diff
] = keybuf
[i
];
9103 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9104 keybuf
[i
+ *diff
] = keybuf
[i
];
9105 /* Overwrite the old keys with the new ones. */
9106 for (i
= 0; i
< len
; i
++)
9107 keybuf
[fkey
->start
+ i
]
9108 = Faref (next
, make_number (i
));
9110 fkey
->start
= fkey
->end
+= *diff
;
9111 fkey
->map
= fkey
->parent
;
9116 fkey
->map
= get_keymap (next
, 0, 1);
9118 /* If we no longer have a bound suffix, try a new position for
9120 if (!CONSP (fkey
->map
))
9122 fkey
->end
= ++fkey
->start
;
9123 fkey
->map
= fkey
->parent
;
9128 /* Read a sequence of keys that ends with a non prefix character,
9129 storing it in KEYBUF, a buffer of size BUFSIZE.
9131 Return the length of the key sequence stored.
9132 Return -1 if the user rejected a command menu.
9134 Echo starting immediately unless `prompt' is 0.
9136 Where a key sequence ends depends on the currently active keymaps.
9137 These include any minor mode keymaps active in the current buffer,
9138 the current buffer's local map, and the global map.
9140 If a key sequence has no other bindings, we check Vfunction_key_map
9141 to see if some trailing subsequence might be the beginning of a
9142 function key's sequence. If so, we try to read the whole function
9143 key, and substitute its symbolic name into the key sequence.
9145 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9146 `double-' events into similar click events, if that would make them
9147 bound. We try to turn `triple-' events first into `double-' events,
9150 If we get a mouse click in a mode line, vertical divider, or other
9151 non-text area, we treat the click as if it were prefixed by the
9152 symbol denoting that area - `mode-line', `vertical-line', or
9155 If the sequence starts with a mouse click, we read the key sequence
9156 with respect to the buffer clicked on, not the current buffer.
9158 If the user switches frames in the midst of a key sequence, we put
9159 off the switch-frame event until later; the next call to
9160 read_char will return it.
9162 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9163 from the selected window's buffer. */
9166 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9167 can_return_switch_frame
, fix_current_buffer
)
9168 Lisp_Object
*keybuf
;
9171 int dont_downcase_last
;
9172 int can_return_switch_frame
;
9173 int fix_current_buffer
;
9175 volatile Lisp_Object from_string
;
9176 volatile int count
= SPECPDL_INDEX ();
9178 /* How many keys there are in the current key sequence. */
9181 /* The length of the echo buffer when we started reading, and
9182 the length of this_command_keys when we started reading. */
9183 volatile int echo_start
;
9184 volatile int keys_start
;
9186 /* The number of keymaps we're scanning right now, and the number of
9187 keymaps we have allocated space for. */
9189 volatile int nmaps_allocated
= 0;
9191 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9192 the current keymaps. */
9193 Lisp_Object
*volatile defs
= NULL
;
9195 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9196 in the current keymaps, or nil where it is not a prefix. */
9197 Lisp_Object
*volatile submaps
= NULL
;
9199 /* The local map to start out with at start of key sequence. */
9200 volatile Lisp_Object orig_local_map
;
9202 /* The map from the `keymap' property to start out with at start of
9204 volatile Lisp_Object orig_keymap
;
9206 /* 1 if we have already considered switching to the local-map property
9207 of the place where a mouse click occurred. */
9208 volatile int localized_local_map
= 0;
9210 /* The index in submaps[] of the first keymap that has a binding for
9211 this key sequence. In other words, the lowest i such that
9212 submaps[i] is non-nil. */
9213 volatile int first_binding
;
9214 /* Index of the first key that has no binding.
9215 It is useless to try fkey.start larger than that. */
9216 volatile int first_unbound
;
9218 /* If t < mock_input, then KEYBUF[t] should be read as the next
9221 We use this to recover after recognizing a function key. Once we
9222 realize that a suffix of the current key sequence is actually a
9223 function key's escape sequence, we replace the suffix with the
9224 function key's binding from Vfunction_key_map. Now keybuf
9225 contains a new and different key sequence, so the echo area,
9226 this_command_keys, and the submaps and defs arrays are wrong. In
9227 this situation, we set mock_input to t, set t to 0, and jump to
9228 restart_sequence; the loop will read keys from keybuf up until
9229 mock_input, thus rebuilding the state; and then it will resume
9230 reading characters from the keyboard. */
9231 volatile int mock_input
= 0;
9233 /* If the sequence is unbound in submaps[], then
9234 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9235 and fkey.map is its binding.
9237 These might be > t, indicating that all function key scanning
9238 should hold off until t reaches them. We do this when we've just
9239 recognized a function key, to avoid searching for the function
9240 key's again in Vfunction_key_map. */
9241 volatile keyremap fkey
;
9243 /* Likewise, for key_translation_map and input-decode-map. */
9244 volatile keyremap keytran
, indec
;
9246 /* Non-zero if we are trying to map a key by changing an upper-case
9247 letter to lower case, or a shifted function key to an unshifted
9249 volatile int shift_translated
= 0;
9251 /* If we receive a `switch-frame' or `select-window' event in the middle of
9252 a key sequence, we put it off for later.
9253 While we're reading, we keep the event here. */
9254 volatile Lisp_Object delayed_switch_frame
;
9256 /* See the comment below... */
9257 #if defined (GOBBLE_FIRST_EVENT)
9258 Lisp_Object first_event
;
9261 volatile Lisp_Object original_uppercase
;
9262 volatile int original_uppercase_position
= -1;
9264 /* Gets around Microsoft compiler limitations. */
9267 struct buffer
*starting_buffer
;
9269 /* List of events for which a fake prefix key has been generated. */
9270 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9272 #if defined (GOBBLE_FIRST_EVENT)
9276 struct gcpro gcpro1
;
9278 GCPRO1 (fake_prefixed_keys
);
9279 raw_keybuf_count
= 0;
9281 last_nonmenu_event
= Qnil
;
9283 delayed_switch_frame
= Qnil
;
9288 echo_prompt (prompt
);
9289 else if (cursor_in_echo_area
9290 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9291 && NILP (Fzerop (Vecho_keystrokes
)))
9292 /* This doesn't put in a dash if the echo buffer is empty, so
9293 you don't always see a dash hanging out in the minibuffer. */
9297 /* Record the initial state of the echo area and this_command_keys;
9298 we will need to restore them if we replay a key sequence. */
9300 echo_start
= echo_length ();
9301 keys_start
= this_command_key_count
;
9302 this_single_command_key_start
= keys_start
;
9304 #if defined (GOBBLE_FIRST_EVENT)
9305 /* This doesn't quite work, because some of the things that read_char
9306 does cannot safely be bypassed. It seems too risky to try to make
9309 /* Read the first char of the sequence specially, before setting
9310 up any keymaps, in case a filter runs and switches buffers on us. */
9311 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9313 #endif /* GOBBLE_FIRST_EVENT */
9315 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9316 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9319 /* We jump here when we need to reinitialize fkey and keytran; this
9320 happens if we switch keyboards between rescans. */
9321 replay_entire_sequence
:
9323 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9324 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9325 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9326 indec
.start
= indec
.end
= 0;
9327 fkey
.start
= fkey
.end
= 0;
9328 keytran
.start
= keytran
.end
= 0;
9330 /* We jump here when the key sequence has been thoroughly changed, and
9331 we need to rescan it starting from the beginning. When we jump here,
9332 keybuf[0..mock_input] holds the sequence we should reread. */
9335 starting_buffer
= current_buffer
;
9336 first_unbound
= bufsize
+ 1;
9338 /* Build our list of keymaps.
9339 If we recognize a function key and replace its escape sequence in
9340 keybuf with its symbol, or if the sequence starts with a mouse
9341 click and we need to switch buffers, we jump back here to rebuild
9342 the initial keymaps from the current buffer. */
9345 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9347 if (2 > nmaps_allocated
)
9349 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9350 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9351 nmaps_allocated
= 2;
9353 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9355 else if (!NILP (Voverriding_local_map
))
9357 if (2 > nmaps_allocated
)
9359 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9360 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9361 nmaps_allocated
= 2;
9363 submaps
[nmaps
++] = Voverriding_local_map
;
9371 nminor
= current_minor_maps (0, &maps
);
9372 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9374 if (total
> nmaps_allocated
)
9376 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9377 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9378 nmaps_allocated
= total
;
9381 if (!NILP (orig_keymap
))
9382 submaps
[nmaps
++] = orig_keymap
;
9384 bcopy (maps
, (void *) (submaps
+ nmaps
),
9385 nminor
* sizeof (submaps
[0]));
9389 submaps
[nmaps
++] = orig_local_map
;
9391 submaps
[nmaps
++] = current_global_map
;
9393 /* Find an accurate initial value for first_binding. */
9394 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9395 if (! NILP (submaps
[first_binding
]))
9398 /* Start from the beginning in keybuf. */
9401 /* These are no-ops the first time through, but if we restart, they
9402 revert the echo area and this_command_keys to their original state. */
9403 this_command_key_count
= keys_start
;
9404 if (INTERACTIVE
&& t
< mock_input
)
9405 echo_truncate (echo_start
);
9407 /* If the best binding for the current key sequence is a keymap, or
9408 we may be looking at a function key's escape sequence, keep on
9410 while (first_binding
< nmaps
9411 /* Keep reading as long as there's a prefix binding. */
9412 ? !NILP (submaps
[first_binding
])
9413 /* Don't return in the middle of a possible function key sequence,
9414 if the only bindings we found were via case conversion.
9415 Thus, if ESC O a has a function-key-map translation
9416 and ESC o has a binding, don't return after ESC O,
9417 so that we can translate ESC O plus the next character. */
9418 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9421 int used_mouse_menu
= 0;
9423 /* Where the last real key started. If we need to throw away a
9424 key that has expanded into more than one element of keybuf
9425 (say, a mouse click on the mode line which is being treated
9426 as [mode-line (mouse-...)], then we backtrack to this point
9428 volatile int last_real_key_start
;
9430 /* These variables are analogous to echo_start and keys_start;
9431 while those allow us to restart the entire key sequence,
9432 echo_local_start and keys_local_start allow us to throw away
9434 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9436 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9437 eassert (indec
.start
<= indec
.end
);
9438 eassert (fkey
.start
<= fkey
.end
);
9439 eassert (keytran
.start
<= keytran
.end
);
9440 /* key-translation-map is applied *after* function-key-map
9441 which is itself applied *after* input-decode-map. */
9442 eassert (fkey
.end
<= indec
.start
);
9443 eassert (keytran
.end
<= fkey
.start
);
9445 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9446 first_unbound
< keytran
.start
)
9447 { /* The prefix upto first_unbound has no binding and has
9448 no translation left to do either, so we know it's unbound.
9449 If we don't stop now, we risk staying here indefinitely
9450 (if the user keeps entering fkey or keytran prefixes
9451 like C-c ESC ESC ESC ESC ...) */
9453 for (i
= first_unbound
+ 1; i
< t
; i
++)
9454 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9455 mock_input
= t
- first_unbound
- 1;
9456 indec
.end
= indec
.start
-= first_unbound
+ 1;
9457 indec
.map
= indec
.parent
;
9458 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9459 fkey
.map
= fkey
.parent
;
9460 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9461 keytran
.map
= keytran
.parent
;
9462 goto replay_sequence
;
9466 error ("Key sequence too long");
9469 echo_local_start
= echo_length ();
9470 keys_local_start
= this_command_key_count
;
9471 local_first_binding
= first_binding
;
9474 /* These are no-ops, unless we throw away a keystroke below and
9475 jumped back up to replay_key; in that case, these restore the
9476 variables to their original state, allowing us to replay the
9478 if (INTERACTIVE
&& t
< mock_input
)
9479 echo_truncate (echo_local_start
);
9480 this_command_key_count
= keys_local_start
;
9481 first_binding
= local_first_binding
;
9483 /* By default, assume each event is "real". */
9484 last_real_key_start
= t
;
9486 /* Does mock_input indicate that we are re-reading a key sequence? */
9490 add_command_key (key
);
9491 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9492 && NILP (Fzerop (Vecho_keystrokes
)))
9496 /* If not, we should actually read a character. */
9500 KBOARD
*interrupted_kboard
= current_kboard
;
9501 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9502 key
= read_char (NILP (prompt
), nmaps
,
9503 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9504 &used_mouse_menu
, NULL
);
9505 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9506 /* When switching to a new tty (with a new keyboard),
9507 read_char returns the new buffer, rather than -2
9508 (Bug#5095). This is because `terminal-init-xterm'
9509 calls read-char, which eats the wrong_kboard_jmpbuf
9510 return. Any better way to fix this? -- cyd */
9511 || (interrupted_kboard
!= current_kboard
))
9516 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9517 if (k
== interrupted_kboard
)
9522 /* Don't touch interrupted_kboard when it's been
9524 delayed_switch_frame
= Qnil
;
9525 goto replay_entire_sequence
;
9528 if (!NILP (delayed_switch_frame
))
9530 interrupted_kboard
->kbd_queue
9531 = Fcons (delayed_switch_frame
,
9532 interrupted_kboard
->kbd_queue
);
9533 delayed_switch_frame
= Qnil
;
9537 interrupted_kboard
->kbd_queue
9538 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9540 /* If the side queue is non-empty, ensure it begins with a
9541 switch-frame, so we'll replay it in the right context. */
9542 if (CONSP (interrupted_kboard
->kbd_queue
)
9543 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9544 !(EVENT_HAS_PARAMETERS (key
)
9545 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9549 XSETFRAME (frame
, interrupted_frame
);
9550 interrupted_kboard
->kbd_queue
9551 = Fcons (make_lispy_switch_frame (frame
),
9552 interrupted_kboard
->kbd_queue
);
9555 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9556 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9557 goto replay_entire_sequence
;
9561 /* read_char returns t when it shows a menu and the user rejects it.
9565 unbind_to (count
, Qnil
);
9570 /* read_char returns -1 at the end of a macro.
9571 Emacs 18 handles this by returning immediately with a
9572 zero, so that's what we'll do. */
9573 if (INTEGERP (key
) && XINT (key
) == -1)
9576 /* The Microsoft C compiler can't handle the goto that
9582 /* If the current buffer has been changed from under us, the
9583 keymap may have changed, so replay the sequence. */
9586 timer_resume_idle ();
9589 /* Reset the current buffer from the selected window
9590 in case something changed the former and not the latter.
9591 This is to be more consistent with the behavior
9592 of the command_loop_1. */
9593 if (fix_current_buffer
)
9595 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9597 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9598 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9601 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9602 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9603 goto replay_sequence
;
9606 /* If we have a quit that was typed in another frame, and
9607 quit_throw_to_read_char switched buffers,
9608 replay to get the right keymap. */
9610 && XINT (key
) == quit_char
9611 && current_buffer
!= starting_buffer
)
9614 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9618 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9619 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9620 goto replay_sequence
;
9625 if (EVENT_HAS_PARAMETERS (key
)
9626 /* Either a `switch-frame' or a `select-window' event. */
9627 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9629 /* If we're at the beginning of a key sequence, and the caller
9630 says it's okay, go ahead and return this event. If we're
9631 in the midst of a key sequence, delay it until the end. */
9632 if (t
> 0 || !can_return_switch_frame
)
9634 delayed_switch_frame
= key
;
9640 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9644 /* Clicks in non-text areas get prefixed by the symbol
9645 in their CHAR-ADDRESS field. For example, a click on
9646 the mode line is prefixed by the symbol `mode-line'.
9648 Furthermore, key sequences beginning with mouse clicks
9649 are read using the keymaps of the buffer clicked on, not
9650 the current buffer. So we may have to switch the buffer
9653 When we turn one event into two events, we must make sure
9654 that neither of the two looks like the original--so that,
9655 if we replay the events, they won't be expanded again.
9656 If not for this, such reexpansion could happen either here
9657 or when user programs play with this-command-keys. */
9658 if (EVENT_HAS_PARAMETERS (key
))
9663 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9664 if (EQ (kind
, Qmouse_click
))
9666 Lisp_Object window
, posn
;
9668 window
= POSN_WINDOW (EVENT_START (key
));
9669 posn
= POSN_POSN (EVENT_START (key
));
9672 || (!NILP (fake_prefixed_keys
)
9673 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9675 /* We're looking a second time at an event for which
9676 we generated a fake prefix key. Set
9677 last_real_key_start appropriately. */
9679 last_real_key_start
= t
- 1;
9682 /* Key sequences beginning with mouse clicks are
9683 read using the keymaps in the buffer clicked on,
9684 not the current buffer. If we're at the
9685 beginning of a key sequence, switch buffers. */
9686 if (last_real_key_start
== 0
9688 && BUFFERP (XWINDOW (window
)->buffer
)
9689 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9691 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9695 /* Arrange to go back to the original buffer once we're
9696 done reading the key sequence. Note that we can't
9697 use save_excursion_{save,restore} here, because they
9698 save point as well as the current buffer; we don't
9699 want to save point, because redisplay may change it,
9700 to accommodate a Fset_window_start or something. We
9701 don't want to do this at the top of the function,
9702 because we may get input from a subprocess which
9703 wants to change the selected window and stuff (say,
9705 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9707 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9709 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9710 orig_local_map
= get_local_map (PT
, current_buffer
,
9712 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9713 goto replay_sequence
;
9716 /* For a mouse click, get the local text-property keymap
9717 of the place clicked on, rather than point. */
9718 if (last_real_key_start
== 0
9719 && CONSP (XCDR (key
))
9720 && ! localized_local_map
)
9722 Lisp_Object map_here
, start
, pos
;
9724 localized_local_map
= 1;
9725 start
= EVENT_START (key
);
9727 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9729 pos
= POSN_BUFFER_POSN (start
);
9731 && XINT (pos
) >= BEGV
9732 && XINT (pos
) <= ZV
)
9734 map_here
= get_local_map (XINT (pos
),
9735 current_buffer
, Qlocal_map
);
9736 if (!EQ (map_here
, orig_local_map
))
9738 orig_local_map
= map_here
;
9739 ++localized_local_map
;
9742 map_here
= get_local_map (XINT (pos
),
9743 current_buffer
, Qkeymap
);
9744 if (!EQ (map_here
, orig_keymap
))
9746 orig_keymap
= map_here
;
9747 ++localized_local_map
;
9750 if (localized_local_map
> 1)
9755 goto replay_sequence
;
9761 /* Expand mode-line and scroll-bar events into two events:
9762 use posn as a fake prefix key. */
9764 && (NILP (fake_prefixed_keys
)
9765 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9767 if (t
+ 1 >= bufsize
)
9768 error ("Key sequence too long");
9771 keybuf
[t
+ 1] = key
;
9774 /* Record that a fake prefix key has been generated
9775 for KEY. Don't modify the event; this would
9776 prevent proper action when the event is pushed
9777 back into unread-command-events. */
9778 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9780 /* If on a mode line string with a local keymap,
9781 reconsider the key sequence with that keymap. */
9782 if (string
= POSN_STRING (EVENT_START (key
)),
9783 (CONSP (string
) && STRINGP (XCAR (string
))))
9785 Lisp_Object pos
, map
, map2
;
9787 pos
= XCDR (string
);
9788 string
= XCAR (string
);
9790 && XINT (pos
) < SCHARS (string
))
9792 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9794 orig_local_map
= map
;
9795 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9798 if (!NILP (map
) || !NILP (map2
))
9799 goto replay_sequence
;
9805 else if (NILP (from_string
)
9806 && (string
= POSN_STRING (EVENT_START (key
)),
9807 (CONSP (string
) && STRINGP (XCAR (string
)))))
9809 /* For a click on a string, i.e. overlay string or a
9810 string displayed via the `display' property,
9811 consider `local-map' and `keymap' properties of
9813 Lisp_Object pos
, map
, map2
;
9815 pos
= XCDR (string
);
9816 string
= XCAR (string
);
9818 && XINT (pos
) < SCHARS (string
))
9820 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9822 orig_local_map
= map
;
9823 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9827 if (!NILP (map
) || !NILP (map2
))
9829 from_string
= string
;
9832 goto replay_sequence
;
9837 else if (CONSP (XCDR (key
))
9838 && CONSP (EVENT_START (key
))
9839 && CONSP (XCDR (EVENT_START (key
))))
9843 posn
= POSN_POSN (EVENT_START (key
));
9844 /* Handle menu-bar events:
9845 insert the dummy prefix event `menu-bar'. */
9846 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9848 if (t
+ 1 >= bufsize
)
9849 error ("Key sequence too long");
9853 /* Zap the position in key, so we know that we've
9854 expanded it, and don't try to do so again. */
9855 POSN_SET_POSN (EVENT_START (key
),
9856 Fcons (posn
, Qnil
));
9859 goto replay_sequence
;
9861 else if (CONSP (posn
))
9863 /* We're looking at the second event of a
9864 sequence which we expanded before. Set
9865 last_real_key_start appropriately. */
9866 if (last_real_key_start
== t
&& t
> 0)
9867 last_real_key_start
= t
- 1;
9872 /* We have finally decided that KEY is something we might want
9874 first_binding
= (follow_key (key
,
9875 nmaps
- first_binding
,
9876 submaps
+ first_binding
,
9877 defs
+ first_binding
,
9878 submaps
+ first_binding
)
9881 /* If KEY wasn't bound, we'll try some fallbacks. */
9882 if (first_binding
< nmaps
)
9883 /* This is needed for the following scenario:
9884 event 0: a down-event that gets dropped by calling replay_key.
9885 event 1: some normal prefix like C-h.
9886 After event 0, first_unbound is 0, after event 1 indec.start,
9887 fkey.start, and keytran.start are all 1, so when we see that
9888 C-h is bound, we need to update first_unbound. */
9889 first_unbound
= max (t
+ 1, first_unbound
);
9894 /* Remember the position to put an upper bound on indec.start. */
9895 first_unbound
= min (t
, first_unbound
);
9897 head
= EVENT_HEAD (key
);
9898 if (help_char_p (head
) && t
> 0)
9900 read_key_sequence_cmd
= Vprefix_help_command
;
9902 last_nonmenu_event
= key
;
9903 /* The Microsoft C compiler can't handle the goto that
9911 Lisp_Object breakdown
;
9914 breakdown
= parse_modifiers (head
);
9915 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9916 /* Attempt to reduce an unbound mouse event to a simpler
9917 event that is bound:
9918 Drags reduce to clicks.
9919 Double-clicks reduce to clicks.
9920 Triple-clicks reduce to double-clicks, then to clicks.
9921 Down-clicks are eliminated.
9922 Double-downs reduce to downs, then are eliminated.
9923 Triple-downs reduce to double-downs, then to downs,
9924 then are eliminated. */
9925 if (modifiers
& (down_modifier
| drag_modifier
9926 | double_modifier
| triple_modifier
))
9928 while (modifiers
& (down_modifier
| drag_modifier
9929 | double_modifier
| triple_modifier
))
9931 Lisp_Object new_head
, new_click
;
9932 if (modifiers
& triple_modifier
)
9933 modifiers
^= (double_modifier
| triple_modifier
);
9934 else if (modifiers
& double_modifier
)
9935 modifiers
&= ~double_modifier
;
9936 else if (modifiers
& drag_modifier
)
9937 modifiers
&= ~drag_modifier
;
9940 /* Dispose of this `down' event by simply jumping
9941 back to replay_key, to get another event.
9943 Note that if this event came from mock input,
9944 then just jumping back to replay_key will just
9945 hand it to us again. So we have to wipe out any
9948 We could delete keybuf[t] and shift everything
9949 after that to the left by one spot, but we'd also
9950 have to fix up any variable that points into
9951 keybuf, and shifting isn't really necessary
9954 Adding prefixes for non-textual mouse clicks
9955 creates two characters of mock input, and both
9956 must be thrown away. If we're only looking at
9957 the prefix now, we can just jump back to
9958 replay_key. On the other hand, if we've already
9959 processed the prefix, and now the actual click
9960 itself is giving us trouble, then we've lost the
9961 state of the keymaps we want to backtrack to, and
9962 we need to replay the whole sequence to rebuild
9965 Beyond that, only function key expansion could
9966 create more than two keys, but that should never
9967 generate mouse events, so it's okay to zero
9968 mock_input in that case too.
9970 FIXME: The above paragraph seems just plain
9971 wrong, if you consider things like
9972 xterm-mouse-mode. -stef
9974 Isn't this just the most wonderful code ever? */
9976 /* If mock_input > t + 1, the above simplification
9977 will actually end up dropping keys on the floor.
9978 This is probably OK for now, but even
9979 if mock_input <= t + 1, we need to adjust indec,
9981 Typical case [header-line down-mouse-N]:
9982 mock_input = 2, t = 1, fkey.end = 1,
9983 last_real_key_start = 0. */
9984 if (indec
.end
> last_real_key_start
)
9986 indec
.end
= indec
.start
9987 = min (last_real_key_start
, indec
.start
);
9988 indec
.map
= indec
.parent
;
9989 if (fkey
.end
> last_real_key_start
)
9991 fkey
.end
= fkey
.start
9992 = min (last_real_key_start
, fkey
.start
);
9993 fkey
.map
= fkey
.parent
;
9994 if (keytran
.end
> last_real_key_start
)
9996 keytran
.end
= keytran
.start
9997 = min (last_real_key_start
, keytran
.start
);
9998 keytran
.map
= keytran
.parent
;
10002 if (t
== last_real_key_start
)
10009 mock_input
= last_real_key_start
;
10010 goto replay_sequence
;
10015 = apply_modifiers (modifiers
, XCAR (breakdown
));
10017 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
10019 /* Look for a binding for this new key. follow_key
10020 promises that it didn't munge submaps the
10021 last time we called it, since key was unbound. */
10023 = (follow_key (new_click
,
10024 nmaps
- local_first_binding
,
10025 submaps
+ local_first_binding
,
10026 defs
+ local_first_binding
,
10027 submaps
+ local_first_binding
)
10028 + local_first_binding
);
10030 /* If that click is bound, go for it. */
10031 if (first_binding
< nmaps
)
10036 /* Otherwise, we'll leave key set to the drag event. */
10043 /* Normally, last_nonmenu_event gets the previous key we read.
10044 But when a mouse popup menu is being used,
10045 we don't update last_nonmenu_event; it continues to hold the mouse
10046 event that preceded the first level of menu. */
10047 if (!used_mouse_menu
)
10048 last_nonmenu_event
= key
;
10050 /* Record what part of this_command_keys is the current key sequence. */
10051 this_single_command_key_start
= this_command_key_count
- t
;
10053 /* Look for this sequence in input-decode-map.
10054 Scan from indec.end until we find a bound suffix. */
10055 while (indec
.end
< t
)
10057 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10060 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10061 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10066 mock_input
= diff
+ max (t
, mock_input
);
10067 goto replay_sequence
;
10071 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10072 && indec
.start
>= t
)
10073 /* There is a binding and it's not a prefix.
10074 (and it doesn't have any input-decode-map translation pending).
10075 There is thus no function-key in this sequence.
10076 Moving fkey.start is important in this case to allow keytran.start
10077 to go over the sequence before we return (since we keep the
10078 invariant that keytran.end <= fkey.start). */
10080 if (fkey
.start
< t
)
10081 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10084 /* If the sequence is unbound, see if we can hang a function key
10085 off the end of it. */
10086 /* Continue scan from fkey.end until we find a bound suffix. */
10087 while (fkey
.end
< indec
.start
)
10089 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10092 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10093 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10094 max (t
, mock_input
),
10095 /* If there's a binding (i.e.
10096 first_binding >= nmaps) we don't want
10097 to apply this function-key-mapping. */
10098 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10103 mock_input
= diff
+ max (t
, mock_input
);
10104 /* Adjust the input-decode-map counters. */
10106 indec
.start
+= diff
;
10108 goto replay_sequence
;
10112 /* Look for this sequence in key-translation-map.
10113 Scan from keytran.end until we find a bound suffix. */
10114 while (keytran
.end
< fkey
.start
)
10116 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10119 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10120 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10125 mock_input
= diff
+ max (t
, mock_input
);
10126 /* Adjust the function-key-map and input-decode-map counters. */
10128 indec
.start
+= diff
;
10130 fkey
.start
+= diff
;
10132 goto replay_sequence
;
10136 /* If KEY is not defined in any of the keymaps,
10137 and cannot be part of a function key or translation,
10138 and is an upper case letter
10139 use the corresponding lower-case letter instead. */
10140 if (first_binding
>= nmaps
10141 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10143 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10144 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10145 || (XINT (key
) & shift_modifier
)))
10147 Lisp_Object new_key
;
10149 original_uppercase
= key
;
10150 original_uppercase_position
= t
- 1;
10152 if (XINT (key
) & shift_modifier
)
10153 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10155 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10156 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10158 /* We have to do this unconditionally, regardless of whether
10159 the lower-case char is defined in the keymaps, because they
10160 might get translated through function-key-map. */
10161 keybuf
[t
- 1] = new_key
;
10162 mock_input
= max (t
, mock_input
);
10163 shift_translated
= 1;
10165 goto replay_sequence
;
10167 /* If KEY is not defined in any of the keymaps,
10168 and cannot be part of a function key or translation,
10169 and is a shifted function key,
10170 use the corresponding unshifted function key instead. */
10171 if (first_binding
>= nmaps
10172 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10174 Lisp_Object breakdown
= parse_modifiers (key
);
10176 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10178 if (modifiers
& shift_modifier
10179 /* Treat uppercase keys as shifted. */
10181 && (KEY_TO_CHAR (key
)
10182 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10183 && UPPERCASEP (KEY_TO_CHAR (key
))))
10185 Lisp_Object new_key
10186 = (modifiers
& shift_modifier
10187 ? apply_modifiers (modifiers
& ~shift_modifier
,
10189 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10191 original_uppercase
= key
;
10192 original_uppercase_position
= t
- 1;
10194 /* We have to do this unconditionally, regardless of whether
10195 the lower-case char is defined in the keymaps, because they
10196 might get translated through function-key-map. */
10197 keybuf
[t
- 1] = new_key
;
10198 mock_input
= max (t
, mock_input
);
10199 /* Reset fkey (and consequently keytran) to apply
10200 function-key-map on the result, so that S-backspace is
10201 correctly mapped to DEL (via backspace). OTOH,
10202 input-decode-map doesn't need to go through it again. */
10203 fkey
.start
= fkey
.end
= 0;
10204 keytran
.start
= keytran
.end
= 0;
10205 shift_translated
= 1;
10207 goto replay_sequence
;
10212 read_key_sequence_cmd
= (first_binding
< nmaps
10213 ? defs
[first_binding
]
10216 unread_switch_frame
= delayed_switch_frame
;
10217 unbind_to (count
, Qnil
);
10219 /* Don't downcase the last character if the caller says don't.
10220 Don't downcase it if the result is undefined, either. */
10221 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10223 && t
- 1 == original_uppercase_position
)
10225 keybuf
[t
- 1] = original_uppercase
;
10226 shift_translated
= 0;
10229 if (shift_translated
)
10230 Vthis_command_keys_shift_translated
= Qt
;
10232 /* Occasionally we fabricate events, perhaps by expanding something
10233 according to function-key-map, or by adding a prefix symbol to a
10234 mouse click in the scroll bar or modeline. In this cases, return
10235 the entire generated key sequence, even if we hit an unbound
10236 prefix or a definition before the end. This means that you will
10237 be able to push back the event properly, and also means that
10238 read-key-sequence will always return a logical unit.
10241 for (; t
< mock_input
; t
++)
10243 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10244 && NILP (Fzerop (Vecho_keystrokes
)))
10245 echo_char (keybuf
[t
]);
10246 add_command_key (keybuf
[t
]);
10253 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10254 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10255 The sequence is sufficient to specify a non-prefix command in the
10256 current local and global maps.
10258 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10259 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10260 as a continuation of the previous key.
10262 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10263 convert the last event to lower case. (Normally any upper case event
10264 is converted to lower case if the original event is undefined and the lower
10265 case equivalent is defined.) A non-nil value is appropriate for reading
10266 a key sequence to be defined.
10268 A C-g typed while in this function is treated like any other character,
10269 and `quit-flag' is not set.
10271 If the key sequence starts with a mouse click, then the sequence is read
10272 using the keymaps of the buffer of the window clicked in, not the buffer
10273 of the selected window as normal.
10275 `read-key-sequence' drops unbound button-down events, since you normally
10276 only care about the click or drag events which follow them. If a drag
10277 or multi-click event is unbound, but the corresponding click event would
10278 be bound, `read-key-sequence' turns the event into a click event at the
10279 drag's starting position. This means that you don't have to distinguish
10280 between click and drag, double, or triple events unless you want to.
10282 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10283 lines separating windows, and scroll bars with imaginary keys
10284 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10286 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10287 function will process a switch-frame event if the user switches frames
10288 before typing anything. If the user switches frames in the middle of a
10289 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10290 is nil, then the event will be put off until after the current key sequence.
10292 `read-key-sequence' checks `function-key-map' for function key
10293 sequences, where they wouldn't conflict with ordinary bindings. See
10294 `function-key-map' for more details.
10296 The optional fifth argument COMMAND-LOOP, if non-nil, means
10297 that this key sequence is being read by something that will
10298 read commands one after another. It should be nil if the caller
10299 will read just one key sequence. */)
10300 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10302 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10303 Lisp_Object can_return_switch_frame
, command_loop
;
10305 Lisp_Object keybuf
[30];
10307 struct gcpro gcpro1
;
10308 int count
= SPECPDL_INDEX ();
10310 if (!NILP (prompt
))
10311 CHECK_STRING (prompt
);
10314 specbind (Qinput_method_exit_on_first_char
,
10315 (NILP (command_loop
) ? Qt
: Qnil
));
10316 specbind (Qinput_method_use_echo_area
,
10317 (NILP (command_loop
) ? Qt
: Qnil
));
10319 bzero (keybuf
, sizeof keybuf
);
10320 GCPRO1 (keybuf
[0]);
10321 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10323 if (NILP (continue_echo
))
10325 this_command_key_count
= 0;
10326 this_command_key_count_reset
= 0;
10327 this_single_command_key_start
= 0;
10330 #ifdef HAVE_WINDOW_SYSTEM
10331 if (display_hourglass_p
)
10332 cancel_hourglass ();
10335 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10336 prompt
, ! NILP (dont_downcase_last
),
10337 ! NILP (can_return_switch_frame
), 0);
10339 #if 0 /* The following is fine for code reading a key sequence and
10340 then proceeding with a lenghty computation, but it's not good
10341 for code reading keys in a loop, like an input method. */
10342 #ifdef HAVE_WINDOW_SYSTEM
10343 if (display_hourglass_p
)
10344 start_hourglass ();
10354 return unbind_to (count
, make_event_array (i
, keybuf
));
10357 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10358 Sread_key_sequence_vector
, 1, 5, 0,
10359 doc
: /* Like `read-key-sequence' but always return a vector. */)
10360 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10362 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10363 Lisp_Object can_return_switch_frame
, command_loop
;
10365 Lisp_Object keybuf
[30];
10367 struct gcpro gcpro1
;
10368 int count
= SPECPDL_INDEX ();
10370 if (!NILP (prompt
))
10371 CHECK_STRING (prompt
);
10374 specbind (Qinput_method_exit_on_first_char
,
10375 (NILP (command_loop
) ? Qt
: Qnil
));
10376 specbind (Qinput_method_use_echo_area
,
10377 (NILP (command_loop
) ? Qt
: Qnil
));
10379 bzero (keybuf
, sizeof keybuf
);
10380 GCPRO1 (keybuf
[0]);
10381 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10383 if (NILP (continue_echo
))
10385 this_command_key_count
= 0;
10386 this_command_key_count_reset
= 0;
10387 this_single_command_key_start
= 0;
10390 #ifdef HAVE_WINDOW_SYSTEM
10391 if (display_hourglass_p
)
10392 cancel_hourglass ();
10395 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10396 prompt
, ! NILP (dont_downcase_last
),
10397 ! NILP (can_return_switch_frame
), 0);
10399 #ifdef HAVE_WINDOW_SYSTEM
10400 if (display_hourglass_p
)
10401 start_hourglass ();
10410 return unbind_to (count
, Fvector (i
, keybuf
));
10413 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10414 doc
: /* Execute CMD as an editor command.
10415 CMD must be a symbol that satisfies the `commandp' predicate.
10416 Optional second arg RECORD-FLAG non-nil
10417 means unconditionally put this command in `command-history'.
10418 Otherwise, that is done only if an arg is read using the minibuffer.
10419 The argument KEYS specifies the value to use instead of (this-command-keys)
10420 when reading the arguments; if it is nil, (this-command-keys) is used.
10421 The argument SPECIAL, if non-nil, means that this command is executing
10422 a special event, so ignore the prefix argument and don't clear it. */)
10423 (cmd
, record_flag
, keys
, special
)
10424 Lisp_Object cmd
, record_flag
, keys
, special
;
10426 register Lisp_Object final
;
10427 register Lisp_Object tem
;
10428 Lisp_Object prefixarg
;
10429 extern int debug_on_next_call
;
10431 debug_on_next_call
= 0;
10433 if (NILP (special
))
10435 prefixarg
= current_kboard
->Vprefix_arg
;
10436 Vcurrent_prefix_arg
= prefixarg
;
10437 current_kboard
->Vprefix_arg
= Qnil
;
10444 tem
= Fget (cmd
, Qdisabled
);
10445 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10447 tem
= Fsymbol_value (Qdisabled_command_function
);
10449 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10455 final
= Findirect_function (cmd
, Qnil
);
10457 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10459 struct gcpro gcpro1
, gcpro2
;
10461 GCPRO2 (cmd
, prefixarg
);
10462 do_autoload (final
, cmd
);
10469 if (STRINGP (final
) || VECTORP (final
))
10471 /* If requested, place the macro in the command history. For
10472 other sorts of commands, call-interactively takes care of
10474 if (!NILP (record_flag
))
10477 = Fcons (Fcons (Qexecute_kbd_macro
,
10478 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10481 /* Don't keep command history around forever. */
10482 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10484 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10486 XSETCDR (tem
, Qnil
);
10490 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10493 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10494 /* Don't call Fcall_interactively directly because we want to make
10495 sure the backtrace has an entry for `call-interactively'.
10496 For the same reason, pass `cmd' rather than `final'. */
10497 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10504 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10506 doc
: /* Read function name, then read its arguments and call it.
10508 To pass a numeric argument to the command you are invoking with, specify
10509 the numeric argument to this command.
10511 Noninteractively, the argument PREFIXARG is the prefix argument to
10512 give to the command you invoke, if it asks for an argument. */)
10514 Lisp_Object prefixarg
;
10516 Lisp_Object function
;
10518 int saved_last_point_position
;
10519 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10520 Lisp_Object bindings
, value
;
10521 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10522 #ifdef HAVE_WINDOW_SYSTEM
10523 /* The call to Fcompleting_read wil start and cancel the hourglass,
10524 but if the hourglass was already scheduled, this means that no
10525 hourglass will be shown for the actual M-x command itself.
10526 So we restart it if it is already scheduled. Note that checking
10527 hourglass_shown_p is not enough, normally the hourglass is not shown,
10528 just scheduled to be shown. */
10529 int hstarted
= hourglass_started ();
10532 saved_keys
= Fvector (this_command_key_count
,
10533 XVECTOR (this_command_keys
)->contents
);
10534 saved_last_point_position_buffer
= last_point_position_buffer
;
10535 saved_last_point_position
= last_point_position
;
10537 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10539 if (EQ (prefixarg
, Qminus
))
10540 strcpy (buf
, "- ");
10541 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10542 strcpy (buf
, "C-u ");
10543 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10544 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10545 else if (INTEGERP (prefixarg
))
10546 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10548 /* This isn't strictly correct if execute-extended-command
10549 is bound to anything else. Perhaps it should use
10550 this_command_keys? */
10551 strcat (buf
, "M-x ");
10553 /* Prompt with buf, and then read a string, completing from and
10554 restricting to the set of all defined commands. Don't provide
10555 any initial input. Save the command read on the extended-command
10557 function
= Fcompleting_read (build_string (buf
),
10558 Vobarray
, Qcommandp
,
10559 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10562 #ifdef HAVE_WINDOW_SYSTEM
10563 if (hstarted
) start_hourglass ();
10566 if (STRINGP (function
) && SCHARS (function
) == 0)
10567 error ("No command name given");
10569 /* Set this_command_keys to the concatenation of saved_keys and
10570 function, followed by a RET. */
10575 this_command_key_count
= 0;
10576 this_command_key_count_reset
= 0;
10577 this_single_command_key_start
= 0;
10579 keys
= XVECTOR (saved_keys
)->contents
;
10580 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10581 add_command_key (keys
[i
]);
10583 for (i
= 0; i
< SCHARS (function
); i
++)
10584 add_command_key (Faref (function
, make_number (i
)));
10586 add_command_key (make_number ('\015'));
10589 last_point_position
= saved_last_point_position
;
10590 last_point_position_buffer
= saved_last_point_position_buffer
;
10594 function
= Fintern (function
, Qnil
);
10595 current_kboard
->Vprefix_arg
= prefixarg
;
10596 Vthis_command
= function
;
10597 real_this_command
= function
;
10599 /* If enabled, show which key runs this command. */
10600 if (!NILP (Vsuggest_key_bindings
)
10601 && NILP (Vexecuting_kbd_macro
)
10602 && SYMBOLP (function
))
10603 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10609 GCPRO3 (bindings
, value
, function
);
10610 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10612 /* If the command has a key binding, print it now. */
10613 if (!NILP (bindings
)
10614 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10617 /* But first wait, and skip the message if there is input. */
10618 Lisp_Object waited
;
10620 /* If this command displayed something in the echo area;
10621 wait a few seconds, then display our suggestion message. */
10622 if (NILP (echo_area_buffer
[0]))
10623 waited
= sit_for (make_number (0), 0, 2);
10624 else if (NUMBERP (Vsuggest_key_bindings
))
10625 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10627 waited
= sit_for (make_number (2), 0, 2);
10629 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10631 Lisp_Object binding
;
10633 int message_p
= push_message ();
10634 int count
= SPECPDL_INDEX ();
10636 record_unwind_protect (pop_message_unwind
, Qnil
);
10637 binding
= Fkey_description (bindings
, Qnil
);
10640 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10643 sprintf (newmessage
, "You can run the command `%s' with %s",
10644 SDATA (SYMBOL_NAME (function
)),
10646 message2_nolog (newmessage
,
10647 strlen (newmessage
),
10648 STRING_MULTIBYTE (binding
));
10649 if (NUMBERP (Vsuggest_key_bindings
))
10650 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10652 waited
= sit_for (make_number (2), 0, 2);
10654 if (!NILP (waited
) && message_p
)
10655 restore_message ();
10657 unbind_to (count
, Qnil
);
10661 RETURN_UNGCPRO (value
);
10665 /* Return nonzero if input events are pending. */
10668 detect_input_pending ()
10670 if (!input_pending
)
10671 get_input_pending (&input_pending
, 0);
10673 return input_pending
;
10676 /* Return nonzero if input events other than mouse movements are
10680 detect_input_pending_ignore_squeezables ()
10682 if (!input_pending
)
10683 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10685 return input_pending
;
10688 /* Return nonzero if input events are pending, and run any pending timers. */
10691 detect_input_pending_run_timers (do_display
)
10694 int old_timers_run
= timers_run
;
10696 if (!input_pending
)
10697 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10699 if (old_timers_run
!= timers_run
&& do_display
)
10701 redisplay_preserve_echo_area (8);
10702 /* The following fixes a bug when using lazy-lock with
10703 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10704 from an idle timer function. The symptom of the bug is that
10705 the cursor sometimes doesn't become visible until the next X
10706 event is processed. --gerd. */
10708 Lisp_Object tail
, frame
;
10709 FOR_EACH_FRAME (tail
, frame
)
10710 if (FRAME_RIF (XFRAME (frame
)))
10711 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10715 return input_pending
;
10718 /* This is called in some cases before a possible quit.
10719 It cases the next call to detect_input_pending to recompute input_pending.
10720 So calling this function unnecessarily can't do any harm. */
10723 clear_input_pending ()
10728 /* Return nonzero if there are pending requeued events.
10729 This isn't used yet. The hope is to make wait_reading_process_output
10730 call it, and return if it runs Lisp code that unreads something.
10731 The problem is, kbd_buffer_get_event needs to be fixed to know what
10732 to do in that case. It isn't trivial. */
10735 requeued_events_pending_p ()
10737 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10741 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10742 doc
: /* Return t if command input is currently available with no wait.
10743 Actually, the value is nil only if we can be sure that no input is available;
10744 if there is a doubt, the value is t. */)
10747 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10748 || !NILP (Vunread_post_input_method_events
)
10749 || !NILP (Vunread_input_method_events
))
10752 get_input_pending (&input_pending
,
10753 READABLE_EVENTS_DO_TIMERS_NOW
10754 | READABLE_EVENTS_FILTER_EVENTS
);
10755 return input_pending
> 0 ? Qt
: Qnil
;
10758 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10759 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10762 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10765 if (total_keys
< NUM_RECENT_KEYS
)
10766 return Fvector (total_keys
, keys
);
10769 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10770 bcopy (keys
+ recent_keys_index
,
10771 XVECTOR (val
)->contents
,
10772 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10774 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10775 recent_keys_index
* sizeof (Lisp_Object
));
10780 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10781 doc
: /* Return the key sequence that invoked this command.
10782 However, if the command has called `read-key-sequence', it returns
10783 the last key sequence that has been read.
10784 The value is a string or a vector.
10786 See also `this-command-keys-vector'. */)
10789 return make_event_array (this_command_key_count
,
10790 XVECTOR (this_command_keys
)->contents
);
10793 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10794 doc
: /* Return the key sequence that invoked this command, as a vector.
10795 However, if the command has called `read-key-sequence', it returns
10796 the last key sequence that has been read.
10798 See also `this-command-keys'. */)
10801 return Fvector (this_command_key_count
,
10802 XVECTOR (this_command_keys
)->contents
);
10805 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10806 Sthis_single_command_keys
, 0, 0, 0,
10807 doc
: /* Return the key sequence that invoked this command.
10808 More generally, it returns the last key sequence read, either by
10809 the command loop or by `read-key-sequence'.
10810 Unlike `this-command-keys', this function's value
10811 does not include prefix arguments.
10812 The value is always a vector. */)
10815 return Fvector (this_command_key_count
10816 - this_single_command_key_start
,
10817 (XVECTOR (this_command_keys
)->contents
10818 + this_single_command_key_start
));
10821 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10822 Sthis_single_command_raw_keys
, 0, 0, 0,
10823 doc
: /* Return the raw events that were read for this command.
10824 More generally, it returns the last key sequence read, either by
10825 the command loop or by `read-key-sequence'.
10826 Unlike `this-single-command-keys', this function's value
10827 shows the events before all translations (except for input methods).
10828 The value is always a vector. */)
10831 return Fvector (raw_keybuf_count
,
10832 (XVECTOR (raw_keybuf
)->contents
));
10835 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10836 Sreset_this_command_lengths
, 0, 0, 0,
10837 doc
: /* Make the unread events replace the last command and echo.
10838 Used in `universal-argument-other-key'.
10840 `universal-argument-other-key' rereads the event just typed.
10841 It then gets translated through `function-key-map'.
10842 The translated event has to replace the real events,
10843 both in the value of (this-command-keys) and in echoing.
10844 To achieve this, `universal-argument-other-key' calls
10845 `reset-this-command-lengths', which discards the record of reading
10846 these events the first time. */)
10849 this_command_key_count
= before_command_key_count
;
10850 if (this_command_key_count
< this_single_command_key_start
)
10851 this_single_command_key_start
= this_command_key_count
;
10853 echo_truncate (before_command_echo_length
);
10855 /* Cause whatever we put into unread-command-events
10856 to echo as if it were being freshly read from the keyboard. */
10857 this_command_key_count_reset
= 1;
10862 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10863 Sclear_this_command_keys
, 0, 1, 0,
10864 doc
: /* Clear out the vector that `this-command-keys' returns.
10865 Also clear the record of the last 100 events, unless optional arg
10866 KEEP-RECORD is non-nil. */)
10868 Lisp_Object keep_record
;
10872 this_command_key_count
= 0;
10873 this_command_key_count_reset
= 0;
10875 if (NILP (keep_record
))
10877 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10878 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10880 recent_keys_index
= 0;
10885 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10886 doc
: /* Return the current depth in recursive edits. */)
10890 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10894 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10895 "FOpen dribble file: ",
10896 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10897 If FILE is nil, close any open dribble file. */)
10910 file
= Fexpand_file_name (file
, Qnil
);
10911 dribble
= fopen (SDATA (file
), "w");
10913 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10918 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10919 doc
: /* Discard the contents of the terminal input buffer.
10920 Also end any kbd macro being defined. */)
10923 if (!NILP (current_kboard
->defining_kbd_macro
))
10925 /* Discard the last command from the macro. */
10926 Fcancel_kbd_macro_events ();
10930 update_mode_lines
++;
10932 Vunread_command_events
= Qnil
;
10933 unread_command_char
= -1;
10935 discard_tty_input ();
10937 kbd_fetch_ptr
= kbd_store_ptr
;
10943 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10944 doc
: /* Stop Emacs and return to superior process. You can resume later.
10945 If `cannot-suspend' is non-nil, or if the system doesn't support job
10946 control, run a subshell instead.
10948 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10949 to be read as terminal input by Emacs's parent, after suspension.
10951 Before suspending, run the normal hook `suspend-hook'.
10952 After resumption run the normal hook `suspend-resume-hook'.
10954 Some operating systems cannot stop the Emacs process and resume it later.
10955 On such systems, Emacs starts a subshell instead of suspending. */)
10957 Lisp_Object stuffstring
;
10959 int count
= SPECPDL_INDEX ();
10960 int old_height
, old_width
;
10962 struct gcpro gcpro1
;
10964 if (tty_list
&& tty_list
->next
)
10965 error ("There are other tty frames open; close them before suspending Emacs");
10967 if (!NILP (stuffstring
))
10968 CHECK_STRING (stuffstring
);
10970 /* Run the functions in suspend-hook. */
10971 if (!NILP (Vrun_hooks
))
10972 call1 (Vrun_hooks
, intern ("suspend-hook"));
10974 GCPRO1 (stuffstring
);
10975 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10976 reset_all_sys_modes ();
10977 /* sys_suspend can get an error if it tries to fork a subshell
10978 and the system resources aren't available for that. */
10979 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10981 stuff_buffered_input (stuffstring
);
10982 if (cannot_suspend
)
10986 unbind_to (count
, Qnil
);
10988 /* Check if terminal/window size has changed.
10989 Note that this is not useful when we are running directly
10990 with a window system; but suspend should be disabled in that case. */
10991 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10992 if (width
!= old_width
|| height
!= old_height
)
10993 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10995 /* Run suspend-resume-hook. */
10996 if (!NILP (Vrun_hooks
))
10997 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
11003 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
11004 Then in any case stuff anything Emacs has read ahead and not used. */
11007 stuff_buffered_input (stuffstring
)
11008 Lisp_Object stuffstring
;
11010 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
11011 register unsigned char *p
;
11013 if (STRINGP (stuffstring
))
11015 register int count
;
11017 p
= SDATA (stuffstring
);
11018 count
= SBYTES (stuffstring
);
11019 while (count
-- > 0)
11024 /* Anything we have read ahead, put back for the shell to read. */
11025 /* ?? What should this do when we have multiple keyboards??
11026 Should we ignore anything that was typed in at the "wrong" kboard?
11028 rms: we should stuff everything back into the kboard
11030 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
11033 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11034 kbd_fetch_ptr
= kbd_buffer
;
11035 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
11036 stuff_char (kbd_fetch_ptr
->code
);
11038 clear_event (kbd_fetch_ptr
);
11042 #endif /* SIGTSTP */
11046 set_waiting_for_input (time_to_clear
)
11047 EMACS_TIME
*time_to_clear
;
11049 input_available_clear_time
= time_to_clear
;
11051 /* Tell handle_interrupt to throw back to read_char, */
11052 waiting_for_input
= 1;
11054 /* If handle_interrupt was called before and buffered a C-g,
11055 make it run again now, to avoid timing error. */
11056 if (!NILP (Vquit_flag
))
11057 quit_throw_to_read_char ();
11061 clear_waiting_for_input ()
11063 /* Tell handle_interrupt not to throw back to read_char, */
11064 waiting_for_input
= 0;
11065 input_available_clear_time
= 0;
11068 /* The SIGINT handler.
11070 If we have a frame on the controlling tty, we assume that the
11071 SIGINT was generated by C-g, so we call handle_interrupt.
11072 Otherwise, the handler kills Emacs. */
11075 interrupt_signal (signalnum
) /* If we don't have an argument, */
11076 int signalnum
; /* some compilers complain in signal calls. */
11078 /* Must preserve main program's value of errno. */
11079 int old_errno
= errno
;
11080 struct terminal
*terminal
;
11082 #if defined (USG) && !defined (POSIX_SIGNALS)
11083 /* USG systems forget handlers when they are used;
11084 must reestablish each time */
11085 signal (SIGINT
, interrupt_signal
);
11086 signal (SIGQUIT
, interrupt_signal
);
11089 SIGNAL_THREAD_CHECK (signalnum
);
11091 /* See if we have an active terminal on our controlling tty. */
11092 terminal
= get_named_tty ("/dev/tty");
11095 /* If there are no frames there, let's pretend that we are a
11096 well-behaving UN*X program and quit. */
11097 Fkill_emacs (Qnil
);
11101 /* Otherwise, the SIGINT was probably generated by C-g. */
11103 /* Set internal_last_event_frame to the top frame of the
11104 controlling tty, if we have a frame there. We disable the
11105 interrupt key on secondary ttys, so the SIGINT must have come
11106 from the controlling tty. */
11107 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11109 handle_interrupt ();
11115 /* This routine is called at interrupt level in response to C-g.
11117 It is called from the SIGINT handler or kbd_buffer_store_event.
11119 If `waiting_for_input' is non zero, then unless `echoing' is
11120 nonzero, immediately throw back to read_char.
11122 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11123 eval to throw, when it gets a chance. If quit-flag is already
11124 non-nil, it stops the job right away. */
11127 handle_interrupt ()
11133 /* XXX This code needs to be revised for multi-tty support. */
11134 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
11136 /* If SIGINT isn't blocked, don't let us be interrupted by
11137 another SIGINT, it might be harmful due to non-reentrancy
11138 in I/O functions. */
11139 sigblock (sigmask (SIGINT
));
11142 reset_all_sys_modes ();
11144 #ifdef SIGTSTP /* Support possible in later USG versions */
11146 * On systems which can suspend the current process and return to the original
11147 * shell, this command causes the user to end up back at the shell.
11148 * The "Auto-save" and "Abort" questions are not asked until
11149 * the user elects to return to emacs, at which point he can save the current
11150 * job and either dump core or continue.
11154 /* Perhaps should really fork an inferior shell?
11155 But that would not provide any way to get back
11156 to the original shell, ever. */
11157 printf ("No support for stopping a process on this operating system;\n");
11158 printf ("you can continue or abort.\n");
11159 #endif /* not SIGTSTP */
11161 /* We must remain inside the screen area when the internal terminal
11162 is used. Note that [Enter] is not echoed by dos. */
11163 cursor_to (SELECTED_FRAME (), 0, 0);
11165 /* It doesn't work to autosave while GC is in progress;
11166 the code used for auto-saving doesn't cope with the mark bit. */
11167 if (!gc_in_progress
)
11169 printf ("Auto-save? (y or n) ");
11171 if (((c
= getchar ()) & ~040) == 'Y')
11173 Fdo_auto_save (Qt
, Qnil
);
11175 printf ("\r\nAuto-save done");
11176 #else /* not MSDOS */
11177 printf ("Auto-save done\n");
11178 #endif /* not MSDOS */
11180 while (c
!= '\n') c
= getchar ();
11184 /* During GC, it must be safe to reenable quitting again. */
11185 Vinhibit_quit
= Qnil
;
11188 #endif /* not MSDOS */
11189 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11190 printf ("but will instead do a real quit after garbage collection ends\r\n");
11195 printf ("\r\nAbort? (y or n) ");
11196 #else /* not MSDOS */
11197 printf ("Abort (and dump core)? (y or n) ");
11198 #endif /* not MSDOS */
11200 if (((c
= getchar ()) & ~040) == 'Y')
11202 while (c
!= '\n') c
= getchar ();
11204 printf ("\r\nContinuing...\r\n");
11205 #else /* not MSDOS */
11206 printf ("Continuing...\n");
11207 #endif /* not MSDOS */
11209 init_all_sys_modes ();
11214 /* If executing a function that wants to be interrupted out of
11215 and the user has not deferred quitting by binding `inhibit-quit'
11216 then quit right away. */
11217 if (immediate_quit
&& NILP (Vinhibit_quit
))
11219 struct gl_state_s saved
;
11220 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11222 immediate_quit
= 0;
11225 GCPRO4 (saved
.object
, saved
.global_code
,
11226 saved
.current_syntax_table
, saved
.old_prop
);
11227 Fsignal (Qquit
, Qnil
);
11232 /* Else request quit when it's safe */
11236 /* TODO: The longjmp in this call throws the NS event loop integration off,
11237 and it seems to do fine without this. Probably some attention
11238 needs to be paid to the setting of waiting_for_input in
11239 wait_reading_process_output() under HAVE_NS because of the call
11240 to ns_select there (needed because otherwise events aren't picked up
11241 outside of polling since we don't get SIGIO like X and we don't have a
11242 separate event loop thread like W32. */
11244 if (waiting_for_input
&& !echoing
)
11245 quit_throw_to_read_char ();
11249 /* Handle a C-g by making read_char return C-g. */
11252 quit_throw_to_read_char ()
11255 /* Prevent another signal from doing this before we finish. */
11256 clear_waiting_for_input ();
11259 Vunread_command_events
= Qnil
;
11260 unread_command_char
= -1;
11262 #if 0 /* Currently, sit_for is called from read_char without turning
11263 off polling. And that can call set_waiting_for_input.
11264 It seems to be harmless. */
11265 #ifdef POLL_FOR_INPUT
11266 /* May be > 1 if in recursive minibuffer. */
11267 if (poll_suppress_count
== 0)
11271 if (FRAMEP (internal_last_event_frame
)
11272 && !EQ (internal_last_event_frame
, selected_frame
))
11273 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11276 _longjmp (getcjmp
, 1);
11279 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11280 doc
: /* Set interrupt mode of reading keyboard input.
11281 If INTERRUPT is non-nil, Emacs will use input interrupts;
11282 otherwise Emacs uses CBREAK mode.
11284 See also `current-input-mode'. */)
11286 Lisp_Object interrupt
;
11288 int new_interrupt_input
;
11290 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11291 #ifdef HAVE_X_WINDOWS
11292 if (x_display_list
!= NULL
)
11294 /* When using X, don't give the user a real choice,
11295 because we haven't implemented the mechanisms to support it. */
11296 #ifdef NO_SOCK_SIGIO
11297 new_interrupt_input
= 0;
11298 #else /* not NO_SOCK_SIGIO */
11299 new_interrupt_input
= 1;
11300 #endif /* NO_SOCK_SIGIO */
11303 #endif /* HAVE_X_WINDOWS */
11304 new_interrupt_input
= !NILP (interrupt
);
11305 #else /* not SIGIO */
11306 new_interrupt_input
= 0;
11307 #endif /* not SIGIO */
11309 if (new_interrupt_input
!= interrupt_input
)
11311 #ifdef POLL_FOR_INPUT
11315 /* this causes startup screen to be restored and messes with the mouse */
11316 reset_all_sys_modes ();
11318 interrupt_input
= new_interrupt_input
;
11320 init_all_sys_modes ();
11323 #ifdef POLL_FOR_INPUT
11324 poll_suppress_count
= 1;
11331 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11332 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11333 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11334 C-q in key sequences.
11336 This setting only has an effect on tty terminals and only when
11337 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11339 See also `current-input-mode'. */)
11341 Lisp_Object flow
, terminal
;
11343 struct terminal
*t
= get_terminal (terminal
, 1);
11344 struct tty_display_info
*tty
;
11345 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11347 tty
= t
->display_info
.tty
;
11349 if (tty
->flow_control
!= !NILP (flow
))
11352 /* this causes startup screen to be restored and messes with the mouse */
11353 reset_sys_modes (tty
);
11356 tty
->flow_control
= !NILP (flow
);
11359 init_sys_modes (tty
);
11365 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11366 doc
: /* Enable or disable 8-bit input on TERMINAL.
11367 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11368 bit as the Meta modifier.
11370 If META is nil, Emacs will ignore the top bit, on the assumption it is
11373 Otherwise, Emacs will accept and pass through 8-bit input without
11374 specially interpreting the top bit.
11376 This setting only has an effect on tty terminal devices.
11378 Optional parameter TERMINAL specifies the tty terminal device to use.
11379 It may be a terminal object, a frame, or nil for the terminal used by
11380 the currently selected frame.
11382 See also `current-input-mode'. */)
11384 Lisp_Object meta
, terminal
;
11386 struct terminal
*t
= get_terminal (terminal
, 1);
11387 struct tty_display_info
*tty
;
11390 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11392 tty
= t
->display_info
.tty
;
11396 else if (EQ (meta
, Qt
))
11401 if (tty
->meta_key
!= new_meta
)
11404 /* this causes startup screen to be restored and messes with the mouse */
11405 reset_sys_modes (tty
);
11408 tty
->meta_key
= new_meta
;
11411 init_sys_modes (tty
);
11417 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11418 doc
: /* Specify character used for quitting.
11419 QUIT must be an ASCII character.
11421 This function only has an effect on the controlling tty of the Emacs
11424 See also `current-input-mode'. */)
11428 struct terminal
*t
= get_named_tty ("/dev/tty");
11429 struct tty_display_info
*tty
;
11430 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11432 tty
= t
->display_info
.tty
;
11434 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11435 error ("QUIT must be an ASCII character");
11438 /* this causes startup screen to be restored and messes with the mouse */
11439 reset_sys_modes (tty
);
11442 /* Don't let this value be out of range. */
11443 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11446 init_sys_modes (tty
);
11452 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11453 doc
: /* Set mode of reading keyboard input.
11454 First arg INTERRUPT non-nil means use input interrupts;
11455 nil means use CBREAK mode.
11456 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11457 (no effect except in CBREAK mode).
11458 Third arg META t means accept 8-bit input (for a Meta key).
11459 META nil means ignore the top bit, on the assumption it is parity.
11460 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11461 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11462 See also `current-input-mode'. */)
11463 (interrupt
, flow
, meta
, quit
)
11464 Lisp_Object interrupt
, flow
, meta
, quit
;
11466 Fset_input_interrupt_mode (interrupt
);
11467 Fset_output_flow_control (flow
, Qnil
);
11468 Fset_input_meta_mode (meta
, Qnil
);
11470 Fset_quit_char (quit
);
11474 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11475 doc
: /* Return information about the way Emacs currently reads keyboard input.
11476 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11477 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11478 nil, Emacs is using CBREAK mode.
11479 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11480 terminal; this does not apply if Emacs uses interrupt-driven input.
11481 META is t if accepting 8-bit input with 8th bit as Meta flag.
11482 META nil means ignoring the top bit, on the assumption it is parity.
11483 META is neither t nor nil if accepting 8-bit input and using
11484 all 8 bits as the character code.
11485 QUIT is the character Emacs currently uses to quit.
11486 The elements of this list correspond to the arguments of
11487 `set-input-mode'. */)
11490 Lisp_Object val
[4];
11491 struct frame
*sf
= XFRAME (selected_frame
);
11493 val
[0] = interrupt_input
? Qt
: Qnil
;
11494 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11496 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11497 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11499 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11506 XSETFASTINT (val
[3], quit_char
);
11508 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11511 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11512 doc
: /* Return position information for pixel coordinates X and Y.
11513 By default, X and Y are relative to text area of the selected window.
11514 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11515 If optional fourth arg WHOLE is non-nil, X is relative to the left
11516 edge of the window.
11518 The return value is similar to a mouse click position:
11519 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11520 IMAGE (DX . DY) (WIDTH . HEIGHT))
11521 The `posn-' functions access elements of such lists. */)
11522 (x
, y
, frame_or_window
, whole
)
11523 Lisp_Object x
, y
, frame_or_window
, whole
;
11528 if (NILP (frame_or_window
))
11529 frame_or_window
= selected_window
;
11531 if (WINDOWP (frame_or_window
))
11535 CHECK_LIVE_WINDOW (frame_or_window
);
11537 w
= XWINDOW (frame_or_window
);
11538 XSETINT (x
, (XINT (x
)
11539 + WINDOW_LEFT_EDGE_X (w
)
11541 ? window_box_left_offset (w
, TEXT_AREA
)
11543 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11544 frame_or_window
= w
->frame
;
11547 CHECK_LIVE_FRAME (frame_or_window
);
11549 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11552 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11553 doc
: /* Return position information for buffer POS in WINDOW.
11554 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11556 Return nil if position is not visible in window. Otherwise,
11557 the return value is similar to that returned by `event-start' for
11558 a mouse click at the upper left corner of the glyph corresponding
11559 to the given buffer position:
11560 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11561 IMAGE (DX . DY) (WIDTH . HEIGHT))
11562 The `posn-' functions access elements of such lists. */)
11564 Lisp_Object pos
, window
;
11569 window
= selected_window
;
11571 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11574 Lisp_Object x
= XCAR (tem
);
11575 Lisp_Object y
= XCAR (XCDR (tem
));
11577 /* Point invisible due to hscrolling? */
11580 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11588 * Set up a new kboard object with reasonable initial values.
11594 kb
->Voverriding_terminal_local_map
= Qnil
;
11595 kb
->Vlast_command
= Qnil
;
11596 kb
->Vreal_last_command
= Qnil
;
11597 kb
->Vkeyboard_translate_table
= Qnil
;
11598 kb
->Vlast_repeatable_command
= Qnil
;
11599 kb
->Vprefix_arg
= Qnil
;
11600 kb
->Vlast_prefix_arg
= Qnil
;
11601 kb
->kbd_queue
= Qnil
;
11602 kb
->kbd_queue_has_data
= 0;
11603 kb
->immediate_echo
= 0;
11604 kb
->echo_string
= Qnil
;
11605 kb
->echo_after_prompt
= -1;
11606 kb
->kbd_macro_buffer
= 0;
11607 kb
->kbd_macro_bufsize
= 0;
11608 kb
->defining_kbd_macro
= Qnil
;
11609 kb
->Vlast_kbd_macro
= Qnil
;
11610 kb
->reference_count
= 0;
11611 kb
->Vsystem_key_alist
= Qnil
;
11612 kb
->system_key_syms
= Qnil
;
11613 kb
->Vwindow_system
= Qt
; /* Unset. */
11614 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11615 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11616 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11617 kb
->Vdefault_minibuffer_frame
= Qnil
;
11621 * Destroy the contents of a kboard object, but not the object itself.
11622 * We use this just before deleting it, or if we're going to initialize
11623 * it a second time.
11629 xfree (kb
->kbd_macro_buffer
);
11632 /* Free KB and memory referenced from it. */
11640 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11643 *kbp
= kb
->next_kboard
;
11645 /* Prevent a dangling reference to KB. */
11646 if (kb
== current_kboard
11647 && FRAMEP (selected_frame
)
11648 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11650 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11652 if (current_kboard
== kb
)
11663 /* This is correct before outermost invocation of the editor loop */
11664 command_loop_level
= -1;
11665 immediate_quit
= 0;
11666 quit_char
= Ctl ('g');
11667 Vunread_command_events
= Qnil
;
11668 unread_command_char
= -1;
11669 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11671 recent_keys_index
= 0;
11672 kbd_fetch_ptr
= kbd_buffer
;
11673 kbd_store_ptr
= kbd_buffer
;
11674 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11675 do_mouse_tracking
= Qnil
;
11678 interrupt_input_blocked
= 0;
11679 interrupt_input_pending
= 0;
11681 pending_signals
= 0;
11684 /* This means that command_loop_1 won't try to select anything the first
11686 internal_last_event_frame
= Qnil
;
11687 Vlast_event_frame
= internal_last_event_frame
;
11689 current_kboard
= initial_kboard
;
11690 /* Re-initialize the keyboard again. */
11691 wipe_kboard (current_kboard
);
11692 init_kboard (current_kboard
);
11693 /* A value of nil for Vwindow_system normally means a tty, but we also use
11694 it for the initial terminal since there is no window system there. */
11695 current_kboard
->Vwindow_system
= Qnil
;
11697 if (!noninteractive
)
11699 /* Before multi-tty support, these handlers used to be installed
11700 only if the current session was a tty session. Now an Emacs
11701 session may have multiple display types, so we always handle
11702 SIGINT. There is special code in interrupt_signal to exit
11703 Emacs on SIGINT when there are no termcap frames on the
11704 controlling terminal. */
11705 signal (SIGINT
, interrupt_signal
);
11706 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11707 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11708 SIGQUIT and we can't tell which one it will give us. */
11709 signal (SIGQUIT
, interrupt_signal
);
11710 #endif /* HAVE_TERMIO */
11712 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11714 if (!noninteractive
)
11715 signal (SIGIO
, input_available_signal
);
11718 /* Use interrupt input by default, if it works and noninterrupt input
11719 has deficiencies. */
11721 #ifdef INTERRUPT_INPUT
11722 interrupt_input
= 1;
11724 interrupt_input
= 0;
11730 if (keyboard_init_hook
)
11731 (*keyboard_init_hook
) ();
11733 #ifdef POLL_FOR_INPUT
11735 poll_suppress_count
= 1;
11740 /* This type's only use is in syms_of_keyboard, to initialize the
11741 event header symbols and put properties on them. */
11742 struct event_head
{
11748 struct event_head head_table
[] = {
11749 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11750 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11751 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11752 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11753 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11754 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11755 /* `select-window' should be handled just like `switch-frame'
11756 in read_key_sequence. */
11757 {&Qselect_window
, "select-window", &Qswitch_frame
}
11761 syms_of_keyboard ()
11763 pending_funcalls
= Qnil
;
11764 staticpro (&pending_funcalls
);
11766 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11767 staticpro (&Vlispy_mouse_stem
);
11770 QCimage
= intern_c_string (":image");
11771 staticpro (&QCimage
);
11773 staticpro (&Qhelp_echo
);
11774 Qhelp_echo
= intern_c_string ("help-echo");
11777 Qrtl
= intern_c_string (":rtl");
11779 staticpro (&item_properties
);
11780 item_properties
= Qnil
;
11782 staticpro (&tool_bar_item_properties
);
11783 tool_bar_item_properties
= Qnil
;
11784 staticpro (&tool_bar_items_vector
);
11785 tool_bar_items_vector
= Qnil
;
11787 staticpro (&real_this_command
);
11788 real_this_command
= Qnil
;
11790 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11791 staticpro (&Qtimer_event_handler
);
11793 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11794 staticpro (&Qdisabled_command_function
);
11796 Qself_insert_command
= intern_c_string ("self-insert-command");
11797 staticpro (&Qself_insert_command
);
11799 Qforward_char
= intern_c_string ("forward-char");
11800 staticpro (&Qforward_char
);
11802 Qbackward_char
= intern_c_string ("backward-char");
11803 staticpro (&Qbackward_char
);
11805 Qdisabled
= intern_c_string ("disabled");
11806 staticpro (&Qdisabled
);
11808 Qundefined
= intern_c_string ("undefined");
11809 staticpro (&Qundefined
);
11811 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11812 staticpro (&Qpre_command_hook
);
11814 Qpost_command_hook
= intern_c_string ("post-command-hook");
11815 staticpro (&Qpost_command_hook
);
11817 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11818 staticpro (&Qdeferred_action_function
);
11820 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11821 staticpro (&Qcommand_hook_internal
);
11823 Qfunction_key
= intern_c_string ("function-key");
11824 staticpro (&Qfunction_key
);
11825 Qmouse_click
= intern_c_string ("mouse-click");
11826 staticpro (&Qmouse_click
);
11827 #if defined (WINDOWSNT)
11828 Qlanguage_change
= intern_c_string ("language-change");
11829 staticpro (&Qlanguage_change
);
11831 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11832 staticpro (&Qdrag_n_drop
);
11834 Qsave_session
= intern_c_string ("save-session");
11835 staticpro (&Qsave_session
);
11838 Qdbus_event
= intern_c_string ("dbus-event");
11839 staticpro (&Qdbus_event
);
11842 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11843 staticpro (&Qconfig_changed_event
);
11845 Qmenu_enable
= intern_c_string ("menu-enable");
11846 staticpro (&Qmenu_enable
);
11847 QCenable
= intern_c_string (":enable");
11848 staticpro (&QCenable
);
11849 QCvisible
= intern_c_string (":visible");
11850 staticpro (&QCvisible
);
11851 QChelp
= intern_c_string (":help");
11852 staticpro (&QChelp
);
11853 QCfilter
= intern_c_string (":filter");
11854 staticpro (&QCfilter
);
11855 QCbutton
= intern_c_string (":button");
11856 staticpro (&QCbutton
);
11857 QCkeys
= intern_c_string (":keys");
11858 staticpro (&QCkeys
);
11859 QCkey_sequence
= intern_c_string (":key-sequence");
11860 staticpro (&QCkey_sequence
);
11861 QCtoggle
= intern_c_string (":toggle");
11862 staticpro (&QCtoggle
);
11863 QCradio
= intern_c_string (":radio");
11864 staticpro (&QCradio
);
11866 Qmode_line
= intern_c_string ("mode-line");
11867 staticpro (&Qmode_line
);
11868 Qvertical_line
= intern_c_string ("vertical-line");
11869 staticpro (&Qvertical_line
);
11870 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11871 staticpro (&Qvertical_scroll_bar
);
11872 Qmenu_bar
= intern_c_string ("menu-bar");
11873 staticpro (&Qmenu_bar
);
11875 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11876 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11877 staticpro (&Qmouse_fixup_help_message
);
11880 Qabove_handle
= intern_c_string ("above-handle");
11881 staticpro (&Qabove_handle
);
11882 Qhandle
= intern_c_string ("handle");
11883 staticpro (&Qhandle
);
11884 Qbelow_handle
= intern_c_string ("below-handle");
11885 staticpro (&Qbelow_handle
);
11886 Qup
= intern_c_string ("up");
11888 Qdown
= intern_c_string ("down");
11889 staticpro (&Qdown
);
11890 Qtop
= intern_c_string ("top");
11892 Qbottom
= intern_c_string ("bottom");
11893 staticpro (&Qbottom
);
11894 Qend_scroll
= intern_c_string ("end-scroll");
11895 staticpro (&Qend_scroll
);
11896 Qratio
= intern_c_string ("ratio");
11897 staticpro (&Qratio
);
11899 Qevent_kind
= intern_c_string ("event-kind");
11900 staticpro (&Qevent_kind
);
11901 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11902 staticpro (&Qevent_symbol_elements
);
11903 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11904 staticpro (&Qevent_symbol_element_mask
);
11905 Qmodifier_cache
= intern_c_string ("modifier-cache");
11906 staticpro (&Qmodifier_cache
);
11908 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11909 staticpro (&Qrecompute_lucid_menubar
);
11910 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11911 staticpro (&Qactivate_menubar_hook
);
11913 Qpolling_period
= intern_c_string ("polling-period");
11914 staticpro (&Qpolling_period
);
11916 Qinput_method_function
= intern_c_string ("input-method-function");
11917 staticpro (&Qinput_method_function
);
11919 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11920 staticpro (&Qinput_method_exit_on_first_char
);
11921 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11922 staticpro (&Qinput_method_use_echo_area
);
11924 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11925 Fset (Qinput_method_use_echo_area
, Qnil
);
11927 last_point_position_buffer
= Qnil
;
11928 last_point_position_window
= Qnil
;
11931 struct event_head
*p
;
11933 for (p
= head_table
;
11934 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11937 *p
->var
= intern_c_string (p
->name
);
11938 staticpro (p
->var
);
11939 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11940 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11944 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11945 staticpro (&button_down_location
);
11946 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11947 staticpro (&mouse_syms
);
11948 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11949 / sizeof (lispy_wheel_names
[0])),
11951 staticpro (&wheel_syms
);
11955 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11957 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11958 for (i
= 0; i
< len
; i
++)
11959 if (modifier_names
[i
])
11960 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11961 staticpro (&modifier_symbols
);
11964 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11965 staticpro (&recent_keys
);
11967 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11968 staticpro (&this_command_keys
);
11970 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11971 staticpro (&raw_keybuf
);
11973 Qextended_command_history
= intern_c_string ("extended-command-history");
11974 Fset (Qextended_command_history
, Qnil
);
11975 staticpro (&Qextended_command_history
);
11977 accent_key_syms
= Qnil
;
11978 staticpro (&accent_key_syms
);
11980 func_key_syms
= Qnil
;
11981 staticpro (&func_key_syms
);
11983 drag_n_drop_syms
= Qnil
;
11984 staticpro (&drag_n_drop_syms
);
11986 unread_switch_frame
= Qnil
;
11987 staticpro (&unread_switch_frame
);
11989 internal_last_event_frame
= Qnil
;
11990 staticpro (&internal_last_event_frame
);
11992 read_key_sequence_cmd
= Qnil
;
11993 staticpro (&read_key_sequence_cmd
);
11995 menu_bar_one_keymap_changed_items
= Qnil
;
11996 staticpro (&menu_bar_one_keymap_changed_items
);
11998 menu_bar_items_vector
= Qnil
;
11999 staticpro (&menu_bar_items_vector
);
12001 help_form_saved_window_configs
= Qnil
;
12002 staticpro (&help_form_saved_window_configs
);
12004 defsubr (&Scurrent_idle_time
);
12005 defsubr (&Sevent_symbol_parse_modifiers
);
12006 defsubr (&Sevent_convert_list
);
12007 defsubr (&Sread_key_sequence
);
12008 defsubr (&Sread_key_sequence_vector
);
12009 defsubr (&Srecursive_edit
);
12010 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
12011 defsubr (&Strack_mouse
);
12013 defsubr (&Sinput_pending_p
);
12014 defsubr (&Scommand_execute
);
12015 defsubr (&Srecent_keys
);
12016 defsubr (&Sthis_command_keys
);
12017 defsubr (&Sthis_command_keys_vector
);
12018 defsubr (&Sthis_single_command_keys
);
12019 defsubr (&Sthis_single_command_raw_keys
);
12020 defsubr (&Sreset_this_command_lengths
);
12021 defsubr (&Sclear_this_command_keys
);
12022 defsubr (&Ssuspend_emacs
);
12023 defsubr (&Sabort_recursive_edit
);
12024 defsubr (&Sexit_recursive_edit
);
12025 defsubr (&Srecursion_depth
);
12026 defsubr (&Stop_level
);
12027 defsubr (&Sdiscard_input
);
12028 defsubr (&Sopen_dribble_file
);
12029 defsubr (&Sset_input_interrupt_mode
);
12030 defsubr (&Sset_output_flow_control
);
12031 defsubr (&Sset_input_meta_mode
);
12032 defsubr (&Sset_quit_char
);
12033 defsubr (&Sset_input_mode
);
12034 defsubr (&Scurrent_input_mode
);
12035 defsubr (&Sexecute_extended_command
);
12036 defsubr (&Sposn_at_point
);
12037 defsubr (&Sposn_at_x_y
);
12039 DEFVAR_LISP ("last-command-event", &last_command_event
,
12040 doc
: /* Last input event that was part of a command. */);
12042 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
12043 doc
: /* Last input event in a command, except for mouse menu events.
12044 Mouse menus give back keys that don't look like mouse events;
12045 this variable holds the actual mouse event that led to the menu,
12046 so that you can determine whether the command was run by mouse or not. */);
12048 DEFVAR_LISP ("last-input-event", &last_input_event
,
12049 doc
: /* Last input event. */);
12051 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12052 doc
: /* List of events to be read as the command input.
12053 These events are processed first, before actual keyboard input.
12054 Events read from this list are not normally added to `this-command-keys',
12055 as they will already have been added once as they were read for the first time.
12056 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12057 Vunread_command_events
= Qnil
;
12059 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12060 doc
: /* If not -1, an object to be read as next command input event. */);
12062 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12063 doc
: /* List of events to be processed as input by input methods.
12064 These events are processed before `unread-command-events'
12065 and actual keyboard input, but are not given to `input-method-function'. */);
12066 Vunread_post_input_method_events
= Qnil
;
12068 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12069 doc
: /* List of events to be processed as input by input methods.
12070 These events are processed after `unread-command-events', but
12071 before actual keyboard input.
12072 If there's an active input method, the events are given to
12073 `input-method-function'. */);
12074 Vunread_input_method_events
= Qnil
;
12076 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12077 doc
: /* Meta-prefix character code.
12078 Meta-foo as command input turns into this character followed by foo. */);
12079 XSETINT (meta_prefix_char
, 033);
12081 DEFVAR_KBOARD ("last-command", Vlast_command
,
12082 doc
: /* The last command executed.
12083 Normally a symbol with a function definition, but can be whatever was found
12084 in the keymap, or whatever the variable `this-command' was set to by that
12087 The value `mode-exit' is special; it means that the previous command
12088 read an event that told it to exit, and it did so and unread that event.
12089 In other words, the present command is the event that made the previous
12092 The value `kill-region' is special; it means that the previous command
12093 was a kill command.
12095 `last-command' has a separate binding for each terminal device.
12096 See Info node `(elisp)Multiple displays'. */);
12098 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12099 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12101 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12102 doc
: /* Last command that may be repeated.
12103 The last command executed that was not bound to an input event.
12104 This is the command `repeat' will try to repeat. */);
12106 DEFVAR_LISP ("this-command", &Vthis_command
,
12107 doc
: /* The command now being executed.
12108 The command can set this variable; whatever is put here
12109 will be in `last-command' during the following command. */);
12110 Vthis_command
= Qnil
;
12112 DEFVAR_LISP ("this-command-keys-shift-translated",
12113 &Vthis_command_keys_shift_translated
,
12114 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12115 Shift-translation occurs when there is no binding for the key sequence
12116 as entered, but a binding was found by changing an upper-case letter
12117 to lower-case, or a shifted function key to an unshifted one. */);
12118 Vthis_command_keys_shift_translated
= Qnil
;
12120 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12121 doc
: /* The command bound to the current key sequence before remapping.
12122 It equals `this-command' if the original command was not remapped through
12123 any of the active keymaps. Otherwise, the value of `this-command' is the
12124 result of looking up the original command in the active keymaps. */);
12125 Vthis_original_command
= Qnil
;
12127 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12128 doc
: /* *Number of input events between auto-saves.
12129 Zero means disable autosaving due to number of characters typed. */);
12130 auto_save_interval
= 300;
12132 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12133 doc
: /* *Number of seconds idle time before auto-save.
12134 Zero or nil means disable auto-saving due to idleness.
12135 After auto-saving due to this many seconds of idle time,
12136 Emacs also does a garbage collection if that seems to be warranted. */);
12137 XSETFASTINT (Vauto_save_timeout
, 30);
12139 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12140 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12141 The value may be integer or floating point. */);
12142 Vecho_keystrokes
= make_number (1);
12144 DEFVAR_INT ("polling-period", &polling_period
,
12145 doc
: /* *Interval between polling for input during Lisp execution.
12146 The reason for polling is to make C-g work to stop a running program.
12147 Polling is needed only when using X windows and SIGIO does not work.
12148 Polling is automatically disabled in all other cases. */);
12149 polling_period
= 2;
12151 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12152 doc
: /* *Maximum time between mouse clicks to make a double-click.
12153 Measured in milliseconds. The value nil means disable double-click
12154 recognition; t means double-clicks have no time limit and are detected
12155 by position only. */);
12156 Vdouble_click_time
= make_number (500);
12158 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12159 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12160 On window-system frames, value is the number of pixels the mouse may have
12161 moved horizontally or vertically between two clicks to make a double-click.
12162 On non window-system frames, value is interpreted in units of 1/8 characters
12165 This variable is also the threshold for motion of the mouse
12166 to count as a drag. */);
12167 double_click_fuzz
= 3;
12169 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12170 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12171 inhibit_local_menu_bar_menus
= 0;
12173 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12174 doc
: /* Number of complete key sequences read as input so far.
12175 This includes key sequences read from keyboard macros.
12176 The number is effectively the number of interactive command invocations. */);
12177 num_input_keys
= 0;
12179 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12180 doc
: /* Number of input events read from the keyboard so far.
12181 This does not include events generated by keyboard macros. */);
12182 num_nonmacro_input_events
= 0;
12184 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12185 doc
: /* The frame in which the most recently read event occurred.
12186 If the last event came from a keyboard macro, this is set to `macro'. */);
12187 Vlast_event_frame
= Qnil
;
12189 /* This variable is set up in sysdep.c. */
12190 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12191 doc
: /* The ERASE character as set by the user with stty. */);
12193 DEFVAR_LISP ("help-char", &Vhelp_char
,
12194 doc
: /* Character to recognize as meaning Help.
12195 When it is read, do `(eval help-form)', and display result if it's a string.
12196 If the value of `help-form' is nil, this char can be read normally. */);
12197 XSETINT (Vhelp_char
, Ctl ('H'));
12199 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12200 doc
: /* List of input events to recognize as meaning Help.
12201 These work just like the value of `help-char' (see that). */);
12202 Vhelp_event_list
= Qnil
;
12204 DEFVAR_LISP ("help-form", &Vhelp_form
,
12205 doc
: /* Form to execute when character `help-char' is read.
12206 If the form returns a string, that string is displayed.
12207 If `help-form' is nil, the help char is not recognized. */);
12210 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12211 doc
: /* Command to run when `help-char' character follows a prefix key.
12212 This command is used only when there is no actual binding
12213 for that character after that prefix key. */);
12214 Vprefix_help_command
= Qnil
;
12216 DEFVAR_LISP ("top-level", &Vtop_level
,
12217 doc
: /* Form to evaluate when Emacs starts up.
12218 Useful to set before you dump a modified Emacs. */);
12221 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12222 doc
: /* Translate table for local keyboard input, or nil.
12223 If non-nil, the value should be a char-table. Each character read
12224 from the keyboard is looked up in this char-table. If the value found
12225 there is non-nil, then it is used instead of the actual input character.
12227 The value can also be a string or vector, but this is considered obsolete.
12228 If it is a string or vector of length N, character codes N and up are left
12229 untranslated. In a vector, an element which is nil means "no translation".
12231 This is applied to the characters supplied to input methods, not their
12232 output. See also `translation-table-for-input'.
12234 This variable has a separate binding for each terminal. See Info node
12235 `(elisp)Multiple displays'. */);
12237 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12238 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12239 \(Even if the operating system has support for stopping a process.\) */);
12240 cannot_suspend
= 0;
12242 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12243 doc
: /* Non-nil means prompt with menus when appropriate.
12244 This is done when reading from a keymap that has a prompt string,
12245 for elements that have prompt strings.
12246 The menu is displayed on the screen
12247 if X menus were enabled at configuration
12248 time and the previous event was a mouse click prefix key.
12249 Otherwise, menu prompting uses the echo area. */);
12250 menu_prompting
= 1;
12252 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12253 doc
: /* Character to see next line of menu prompt.
12254 Type this character while in a menu prompt to rotate around the lines of it. */);
12255 XSETINT (menu_prompt_more_char
, ' ');
12257 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12258 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12259 Emacs applies the modifiers of the character stored here to each keyboard
12260 character it reads. For example, after evaluating the expression
12261 (setq extra-keyboard-modifiers ?\\C-x)
12262 all input characters will have the control modifier applied to them.
12264 Note that the character ?\\C-@, equivalent to the integer zero, does
12265 not count as a control character; rather, it counts as a character
12266 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12267 cancels any modification. */);
12268 extra_keyboard_modifiers
= 0;
12270 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12271 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12272 The command loop sets this to nil before each command,
12273 and tests the value when the command returns.
12274 Buffer modification stores t in this variable. */);
12275 Vdeactivate_mark
= Qnil
;
12276 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12277 staticpro (&Qdeactivate_mark
);
12279 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12280 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12281 Vcommand_hook_internal
= Qnil
;
12283 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12284 doc
: /* Normal hook run before each command is executed.
12285 If an unhandled error happens in running this hook,
12286 the hook value is set to nil, since otherwise the error
12287 might happen repeatedly and make Emacs nonfunctional. */);
12288 Vpre_command_hook
= Qnil
;
12290 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12291 doc
: /* Normal hook run after each command is executed.
12292 If an unhandled error happens in running this hook,
12293 the hook value is set to nil, since otherwise the error
12294 might happen repeatedly and make Emacs nonfunctional. */);
12295 Vpost_command_hook
= Qnil
;
12298 DEFVAR_LISP ("echo-area-clear-hook", ...,
12299 doc
: /* Normal hook run when clearing the echo area. */);
12301 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12302 staticpro (&Qecho_area_clear_hook
);
12303 Fset (Qecho_area_clear_hook
, Qnil
);
12305 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12306 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12307 Vlucid_menu_bar_dirty_flag
= Qnil
;
12309 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12310 doc
: /* List of menu bar items to move to the end of the menu bar.
12311 The elements of the list are event types that may have menu bar bindings. */);
12312 Vmenu_bar_final_items
= Qnil
;
12314 DEFVAR_KBOARD ("overriding-terminal-local-map",
12315 Voverriding_terminal_local_map
,
12316 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12317 If this variable is non-nil, it is used as a keymap instead of the
12318 buffer's local map, and the minor mode keymaps and text property keymaps.
12319 It also replaces `overriding-local-map'.
12321 This variable is intended to let commands such as `universal-argument'
12322 set up a different keymap for reading the next command.
12324 `overriding-terminal-local-map' has a separate binding for each
12326 See Info node `(elisp)Multiple displays'. */);
12328 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12329 doc
: /* Keymap that overrides all other local keymaps.
12330 If this variable is non-nil, it is used as a keymap--replacing the
12331 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12332 Voverriding_local_map
= Qnil
;
12334 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12335 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12336 Otherwise, the menu bar continues to reflect the buffer's local map
12337 and the minor mode maps regardless of `overriding-local-map'. */);
12338 Voverriding_local_map_menu_flag
= Qnil
;
12340 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12341 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12342 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12344 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12345 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12347 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12348 doc
: /* Alist of system-specific X windows key symbols.
12349 Each element should have the form (N . SYMBOL) where N is the
12350 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12351 and SYMBOL is its name.
12353 `system-key-alist' has a separate binding for each terminal device.
12354 See Info node `(elisp)Multiple displays'. */);
12356 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12357 doc
: /* Keymap that translates key sequences to key sequences during input.
12358 This is used mainly for mapping key sequences into some preferred
12359 key events (symbols).
12361 The `read-key-sequence' function replaces any subsequence bound by
12362 `local-function-key-map' with its binding. More precisely, when the
12363 active keymaps have no binding for the current key sequence but
12364 `local-function-key-map' binds a suffix of the sequence to a vector or
12365 string, `read-key-sequence' replaces the matching suffix with its
12366 binding, and continues with the new sequence.
12368 If the binding is a function, it is called with one argument (the prompt)
12369 and its return value (a key sequence) is used.
12371 The events that come from bindings in `local-function-key-map' are not
12372 themselves looked up in `local-function-key-map'.
12374 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12375 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12376 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12377 typing `ESC O P x' would return [f1 x].
12379 `local-function-key-map' has a separate binding for each terminal
12380 device. See Info node `(elisp)Multiple displays'. If you need to
12381 define a binding on all terminals, change `function-key-map'
12382 instead. Initially, `local-function-key-map' is an empty keymap that
12383 has `function-key-map' as its parent on all terminal devices. */);
12385 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12386 doc
: /* Keymap that decodes input escape sequences.
12387 This is used mainly for mapping ASCII function key sequences into
12388 real Emacs function key events (symbols).
12390 The `read-key-sequence' function replaces any subsequence bound by
12391 `input-decode-map' with its binding. Contrary to `function-key-map',
12392 this map applies its rebinding regardless of the presence of an ordinary
12393 binding. So it is more like `key-translation-map' except that it applies
12394 before `function-key-map' rather than after.
12396 If the binding is a function, it is called with one argument (the prompt)
12397 and its return value (a key sequence) is used.
12399 The events that come from bindings in `input-decode-map' are not
12400 themselves looked up in `input-decode-map'.
12402 This variable is keyboard-local. */);
12404 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12405 doc
: /* The parent keymap of all `local-function-key-map' instances.
12406 Function key definitions that apply to all terminal devices should go
12407 here. If a mapping is defined in both the current
12408 `local-function-key-map' binding and this variable, then the local
12409 definition will take precendence. */);
12410 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12412 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12413 doc
: /* Keymap of key translations that can override keymaps.
12414 This keymap works like `function-key-map', but comes after that,
12415 and its non-prefix bindings override ordinary bindings.
12416 Another difference is that it is global rather than keyboard-local. */);
12417 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12419 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12420 doc
: /* List of deferred actions to be performed at a later time.
12421 The precise format isn't relevant here; we just check whether it is nil. */);
12422 Vdeferred_action_list
= Qnil
;
12424 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12425 doc
: /* Function to call to handle deferred actions, after each command.
12426 This function is called with no arguments after each command
12427 whenever `deferred-action-list' is non-nil. */);
12428 Vdeferred_action_function
= Qnil
;
12430 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12431 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12432 The value can be a length of time to show the message for.
12433 If the value is non-nil and not a number, we wait 2 seconds. */);
12434 Vsuggest_key_bindings
= Qt
;
12436 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12437 doc
: /* List of active absolute time timers in order of increasing time. */);
12438 Vtimer_list
= Qnil
;
12440 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12441 doc
: /* List of active idle-time timers in order of increasing time. */);
12442 Vtimer_idle_list
= Qnil
;
12444 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12445 doc
: /* If non-nil, the function that implements the current input method.
12446 It's called with one argument, a printing character that was just read.
12447 \(That means a character with code 040...0176.)
12448 Typically this function uses `read-event' to read additional events.
12449 When it does so, it should first bind `input-method-function' to nil
12450 so it will not be called recursively.
12452 The function should return a list of zero or more events
12453 to be used as input. If it wants to put back some events
12454 to be reconsidered, separately, by the input method,
12455 it can add them to the beginning of `unread-command-events'.
12457 The input method function can find in `input-method-previous-message'
12458 the previous echo area message.
12460 The input method function should refer to the variables
12461 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12462 for guidance on what to do. */);
12463 Vinput_method_function
= Qnil
;
12465 DEFVAR_LISP ("input-method-previous-message",
12466 &Vinput_method_previous_message
,
12467 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12468 This variable exists because `read-event' clears the echo area
12469 before running the input method. It is nil if there was no message. */);
12470 Vinput_method_previous_message
= Qnil
;
12472 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12473 doc
: /* If non-nil, the function that implements the display of help.
12474 It's called with one argument, the help string to display. */);
12475 Vshow_help_function
= Qnil
;
12477 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12478 doc
: /* If non-nil, suppress point adjustment after executing a command.
12480 After a command is executed, if point is moved into a region that has
12481 special properties (e.g. composition, display), we adjust point to
12482 the boundary of the region. But, when a command sets this variable to
12483 non-nil, we suppress the point adjustment.
12485 This variable is set to nil before reading a command, and is checked
12486 just after executing the command. */);
12487 Vdisable_point_adjustment
= Qnil
;
12489 DEFVAR_LISP ("global-disable-point-adjustment",
12490 &Vglobal_disable_point_adjustment
,
12491 doc
: /* *If non-nil, always suppress point adjustment.
12493 The default value is nil, in which case, point adjustment are
12494 suppressed only after special commands that set
12495 `disable-point-adjustment' (which see) to non-nil. */);
12496 Vglobal_disable_point_adjustment
= Qnil
;
12498 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12499 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12500 If the value is not a number, such messages don't time out. */);
12501 Vminibuffer_message_timeout
= make_number (2);
12503 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12504 doc
: /* If non-nil, any keyboard input throws to this symbol.
12505 The value of that variable is passed to `quit-flag' and later causes a
12506 peculiar kind of quitting. */);
12507 Vthrow_on_input
= Qnil
;
12509 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12510 doc
: /* If non-nil, function to output error messages.
12511 The arguments are the error data, a list of the form
12512 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12513 such as just as `condition-case' would bind its variable to,
12514 the context (a string which normally goes at the start of the message),
12515 and the Lisp function within which the error was signaled. */);
12516 Vcommand_error_function
= Qnil
;
12518 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12519 &Venable_disabled_menus_and_buttons
,
12520 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12522 Help functions bind this to allow help on disabled menu items
12523 and tool-bar buttons. */);
12524 Venable_disabled_menus_and_buttons
= Qnil
;
12526 /* Create the initial keyboard. */
12527 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12528 init_kboard (initial_kboard
);
12529 /* Vwindow_system is left at t for now. */
12530 initial_kboard
->next_kboard
= all_kboards
;
12531 all_kboards
= initial_kboard
;
12535 keys_of_keyboard ()
12537 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12538 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12539 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12540 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12541 initial_define_key (meta_map
, 'x', "execute-extended-command");
12543 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12544 "handle-delete-frame");
12545 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12546 "ns-put-working-text");
12547 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12548 "ns-unput-working-text");
12549 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12550 current-prefix-arg, as is done in `handle-switch-frame'.
12551 But `handle-switch-frame is not run from the special-map.
12552 Commands from that map are run in a special way that automatically
12553 preserves the prefix-arg. Restoring the prefix arg here is not just
12554 redundant but harmful:
12556 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12557 - after the first prompt, the exit-minibuffer-hook is run which may
12558 iconify a frame and thus push a `iconify-frame' event.
12559 - after running exit-minibuffer-hook, current-prefix-arg is
12560 restored to the non-nil value it had before the prompt.
12561 - we enter the second prompt.
12562 current-prefix-arg is non-nil, prefix-arg is nil.
12563 - before running the first real event, we run the special iconify-frame
12564 event, but we pass the `special' arg to execute-command so
12565 current-prefix-arg and prefix-arg are left untouched.
12566 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12567 - the next key event will have a spuriously non-nil current-prefix-arg. */
12568 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12570 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12572 /* Handling it at such a low-level causes read_key_sequence to get
12573 * confused because it doesn't realize that the current_buffer was
12574 * changed by read_char.
12576 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12577 * "handle-select-window"); */
12578 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12579 "handle-save-session");
12582 /* Define a special event which is raised for dbus callback
12584 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12585 "dbus-handle-event");
12588 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12592 /* Mark the pointers in the kboard objects.
12593 Called by the Fgarbage_collector. */
12599 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12601 if (kb
->kbd_macro_buffer
)
12602 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12604 mark_object (kb
->Voverriding_terminal_local_map
);
12605 mark_object (kb
->Vlast_command
);
12606 mark_object (kb
->Vreal_last_command
);
12607 mark_object (kb
->Vkeyboard_translate_table
);
12608 mark_object (kb
->Vlast_repeatable_command
);
12609 mark_object (kb
->Vprefix_arg
);
12610 mark_object (kb
->Vlast_prefix_arg
);
12611 mark_object (kb
->kbd_queue
);
12612 mark_object (kb
->defining_kbd_macro
);
12613 mark_object (kb
->Vlast_kbd_macro
);
12614 mark_object (kb
->Vsystem_key_alist
);
12615 mark_object (kb
->system_key_syms
);
12616 mark_object (kb
->Vwindow_system
);
12617 mark_object (kb
->Vinput_decode_map
);
12618 mark_object (kb
->Vlocal_function_key_map
);
12619 mark_object (kb
->Vdefault_minibuffer_frame
);
12620 mark_object (kb
->echo_string
);
12623 struct input_event
*event
;
12624 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12626 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12627 event
= kbd_buffer
;
12628 if (event
->kind
!= SELECTION_REQUEST_EVENT
12629 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12631 mark_object (event
->x
);
12632 mark_object (event
->y
);
12634 mark_object (event
->frame_or_window
);
12635 mark_object (event
->arg
);
12640 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12641 (do not change this comment) */