1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
68 /* This is to get the definitions of the XK_ symbols. */
75 #endif /* HAVE_NTGUI */
85 /* Variables for blockinput.h: */
87 /* Non-zero if interrupt input is blocked right now. */
88 volatile int interrupt_input_blocked
;
90 /* Nonzero means an input interrupt has arrived
91 during the current critical section. */
92 int interrupt_input_pending
;
94 /* This var should be (interrupt_input_pending || pending_atimers).
95 The QUIT macro checks this instead of interrupt_input_pending and
96 pending_atimers separately, to reduce code size. So, any code that
97 changes interrupt_input_pending or pending_atimers should update
103 #define KBD_BUFFER_SIZE 4096
105 KBOARD
*initial_kboard
;
106 KBOARD
*current_kboard
;
110 /* Non-nil disable property on a command means
111 do not execute it; call disabled-command-function's value instead. */
112 Lisp_Object Qdisabled
, Qdisabled_command_function
;
114 #define NUM_RECENT_KEYS (300)
115 int recent_keys_index
; /* Index for storing next element into recent_keys */
116 int total_keys
; /* Total number of elements stored into recent_keys */
117 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 int this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 Lisp_Object raw_keybuf
;
134 int raw_keybuf_count
;
136 /* Non-nil if the present key sequence was obtained by shift translation. */
137 Lisp_Object Vthis_command_keys_shift_translated
;
139 #define GROW_RAW_KEYBUF \
140 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
141 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
143 /* Number of elements of this_command_keys
144 that precede this key sequence. */
145 int this_single_command_key_start
;
147 /* Record values of this_command_key_count and echo_length ()
148 before this command was read. */
149 static int before_command_key_count
;
150 static int before_command_echo_length
;
152 extern int minbuf_level
;
154 extern int message_enable_multibyte
;
156 /* If non-nil, the function that implements the display of help.
157 It's called with one argument, the help string to display. */
159 Lisp_Object Vshow_help_function
;
161 /* Nonzero means do menu prompting. */
163 static int menu_prompting
;
165 /* Character to see next line of menu prompt. */
167 static Lisp_Object menu_prompt_more_char
;
169 /* For longjmp to where kbd input is being done. */
171 static jmp_buf getcjmp
;
173 /* True while doing kbd input. */
174 int waiting_for_input
;
176 /* True while displaying for echoing. Delays C-g throwing. */
180 /* Non-null means we can start echoing at the next input pause even
181 though there is something in the echo area. */
183 static struct kboard
*ok_to_echo_at_next_pause
;
185 /* The kboard last echoing, or null for none. Reset to 0 in
186 cancel_echoing. If non-null, and a current echo area message
187 exists, and echo_message_buffer is eq to the current message
188 buffer, we know that the message comes from echo_kboard. */
190 struct kboard
*echo_kboard
;
192 /* The buffer used for echoing. Set in echo_now, reset in
195 Lisp_Object echo_message_buffer
;
197 /* Nonzero means disregard local maps for the menu bar. */
198 static int inhibit_local_menu_bar_menus
;
200 /* Nonzero means C-g should cause immediate error-signal. */
203 /* The user's hook function for outputting an error message. */
204 Lisp_Object Vcommand_error_function
;
206 /* The user's ERASE setting. */
207 Lisp_Object Vtty_erase_char
;
209 /* Character to recognize as the help char. */
210 Lisp_Object Vhelp_char
;
212 /* List of other event types to recognize as meaning "help". */
213 Lisp_Object Vhelp_event_list
;
215 /* Form to execute when help char is typed. */
216 Lisp_Object Vhelp_form
;
218 /* Command to run when the help character follows a prefix key. */
219 Lisp_Object Vprefix_help_command
;
221 /* List of items that should move to the end of the menu bar. */
222 Lisp_Object Vmenu_bar_final_items
;
224 /* Non-nil means show the equivalent key-binding for
225 any M-x command that has one.
226 The value can be a length of time to show the message for.
227 If the value is non-nil and not a number, we wait 2 seconds. */
228 Lisp_Object Vsuggest_key_bindings
;
230 /* How long to display an echo-area message when the minibuffer is active.
231 If the value is not a number, such messages don't time out. */
232 Lisp_Object Vminibuffer_message_timeout
;
234 /* Character that causes a quit. Normally C-g.
236 If we are running on an ordinary terminal, this must be an ordinary
237 ASCII char, since we want to make it our interrupt character.
239 If we are not running on an ordinary terminal, it still needs to be
240 an ordinary ASCII char. This character needs to be recognized in
241 the input interrupt handler. At this point, the keystroke is
242 represented as a struct input_event, while the desired quit
243 character is specified as a lispy event. The mapping from struct
244 input_events to lispy events cannot run in an interrupt handler,
245 and the reverse mapping is difficult for anything but ASCII
248 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
252 extern Lisp_Object current_global_map
;
253 extern int minibuf_level
;
255 /* If non-nil, this is a map that overrides all other local maps. */
256 Lisp_Object Voverriding_local_map
;
258 /* If non-nil, Voverriding_local_map applies to the menu bar. */
259 Lisp_Object Voverriding_local_map_menu_flag
;
261 /* Keymap that defines special misc events that should
262 be processed immediately at a low level. */
263 Lisp_Object Vspecial_event_map
;
265 /* Current depth in recursive edits. */
266 int command_loop_level
;
268 /* Total number of times command_loop has read a key sequence. */
269 EMACS_INT num_input_keys
;
271 /* Last input event read as a command. */
272 Lisp_Object last_command_event
;
274 /* Last input character read as a command, not counting menus
275 reached by the mouse. */
276 Lisp_Object last_nonmenu_event
;
278 /* Last input event read for any purpose. */
279 Lisp_Object last_input_event
;
281 /* If not Qnil, a list of objects to be read as subsequent command input. */
282 Lisp_Object Vunread_command_events
;
284 /* If not Qnil, a list of objects to be read as subsequent command input
285 including input method processing. */
286 Lisp_Object Vunread_input_method_events
;
288 /* If not Qnil, a list of objects to be read as subsequent command input
289 but NOT including input method processing. */
290 Lisp_Object Vunread_post_input_method_events
;
292 /* If not -1, an event to be read as subsequent command input. */
293 EMACS_INT unread_command_char
;
295 /* If not Qnil, this is a switch-frame event which we decided to put
296 off until the end of a key sequence. This should be read as the
297 next command input, after any unread_command_events.
299 read_key_sequence uses this to delay switch-frame events until the
300 end of the key sequence; Fread_char uses it to put off switch-frame
301 events until a non-ASCII event is acceptable as input. */
302 Lisp_Object unread_switch_frame
;
304 /* A mask of extra modifier bits to put into every keyboard char. */
305 EMACS_INT extra_keyboard_modifiers
;
307 /* Char to use as prefix when a meta character is typed in.
308 This is bound on entry to minibuffer in case ESC is changed there. */
310 Lisp_Object meta_prefix_char
;
312 /* Last size recorded for a current buffer which is not a minibuffer. */
313 static int last_non_minibuf_size
;
315 /* Number of idle seconds before an auto-save and garbage collection. */
316 static Lisp_Object Vauto_save_timeout
;
318 /* Total number of times read_char has returned. */
319 int num_input_events
;
321 /* Total number of times read_char has returned, outside of macros. */
322 EMACS_INT num_nonmacro_input_events
;
324 /* Auto-save automatically when this many characters have been typed
325 since the last time. */
327 static EMACS_INT auto_save_interval
;
329 /* Value of num_nonmacro_input_events as of last auto save. */
333 /* The command being executed by the command loop.
334 Commands may set this, and the value set will be copied into
335 current_kboard->Vlast_command instead of the actual command. */
336 Lisp_Object Vthis_command
;
338 /* This is like Vthis_command, except that commands never set it. */
339 Lisp_Object real_this_command
;
341 /* If the lookup of the command returns a binding, the original
342 command is stored in this-original-command. It is nil otherwise. */
343 Lisp_Object Vthis_original_command
;
345 /* The value of point when the last command was started. */
346 int last_point_position
;
348 /* The buffer that was current when the last command was started. */
349 Lisp_Object last_point_position_buffer
;
351 /* The window that was selected when the last command was started. */
352 Lisp_Object last_point_position_window
;
354 /* The frame in which the last input event occurred, or Qmacro if the
355 last event came from a macro. We use this to determine when to
356 generate switch-frame events. This may be cleared by functions
357 like Fselect_frame, to make sure that a switch-frame event is
358 generated by the next character. */
359 Lisp_Object internal_last_event_frame
;
361 /* A user-visible version of the above, intended to allow users to
362 figure out where the last event came from, if the event doesn't
363 carry that information itself (i.e. if it was a character). */
364 Lisp_Object Vlast_event_frame
;
366 /* The timestamp of the last input event we received from the X server.
367 X Windows wants this for selection ownership. */
368 unsigned long last_event_timestamp
;
370 Lisp_Object Qself_insert_command
;
371 Lisp_Object Qforward_char
;
372 Lisp_Object Qbackward_char
;
373 Lisp_Object Qundefined
;
374 Lisp_Object Qtimer_event_handler
;
376 /* read_key_sequence stores here the command definition of the
377 key sequence that it reads. */
378 Lisp_Object read_key_sequence_cmd
;
380 /* Echo unfinished commands after this many seconds of pause. */
381 Lisp_Object Vecho_keystrokes
;
383 /* Form to evaluate (if non-nil) when Emacs is started. */
384 Lisp_Object Vtop_level
;
386 /* If non-nil, this implements the current input method. */
387 Lisp_Object Vinput_method_function
;
388 Lisp_Object Qinput_method_function
;
390 /* When we call Vinput_method_function,
391 this holds the echo area message that was just erased. */
392 Lisp_Object Vinput_method_previous_message
;
394 /* Non-nil means deactivate the mark at end of this command. */
395 Lisp_Object Vdeactivate_mark
;
396 Lisp_Object Qdeactivate_mark
;
398 /* Menu bar specified in Lucid Emacs fashion. */
400 Lisp_Object Vlucid_menu_bar_dirty_flag
;
401 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
403 Lisp_Object Qecho_area_clear_hook
;
405 /* Hooks to run before and after each command. */
406 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
407 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
408 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
410 /* Parent keymap of terminal-local function-key-map instances. */
411 Lisp_Object Vfunction_key_map
;
413 /* Keymap of key translations that can override keymaps. */
414 Lisp_Object Vkey_translation_map
;
416 /* List of deferred actions to be performed at a later time.
417 The precise format isn't relevant here; we just check whether it is nil. */
418 Lisp_Object Vdeferred_action_list
;
420 /* Function to call to handle deferred actions, when there are any. */
421 Lisp_Object Vdeferred_action_function
;
422 Lisp_Object Qdeferred_action_function
;
424 Lisp_Object Qinput_method_exit_on_first_char
;
425 Lisp_Object Qinput_method_use_echo_area
;
427 /* File in which we write all commands we read. */
430 /* Nonzero if input is available. */
433 extern char *pending_malloc_warning
;
435 /* Circular buffer for pre-read keyboard input. */
437 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
439 /* Pointer to next available character in kbd_buffer.
440 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
441 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
442 next available char is in kbd_buffer[0]. */
443 static struct input_event
*kbd_fetch_ptr
;
445 /* Pointer to next place to store character in kbd_buffer. This
446 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
447 character should go in kbd_buffer[0]. */
448 static struct input_event
* volatile kbd_store_ptr
;
450 /* The above pair of variables forms a "queue empty" flag. When we
451 enqueue a non-hook event, we increment kbd_store_ptr. When we
452 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
453 there is input available if the two pointers are not equal.
455 Why not just have a flag set and cleared by the enqueuing and
456 dequeuing functions? Such a flag could be screwed up by interrupts
457 at inopportune times. */
459 /* If this flag is non-nil, we check mouse_moved to see when the
460 mouse moves, and motion events will appear in the input stream.
461 Otherwise, mouse motion is ignored. */
462 Lisp_Object do_mouse_tracking
;
464 /* Symbols to head events. */
465 Lisp_Object Qmouse_movement
;
466 Lisp_Object Qscroll_bar_movement
;
467 Lisp_Object Qswitch_frame
;
468 Lisp_Object Qdelete_frame
;
469 Lisp_Object Qiconify_frame
;
470 Lisp_Object Qmake_frame_visible
;
471 Lisp_Object Qselect_window
;
472 Lisp_Object Qhelp_echo
;
474 extern Lisp_Object Qremap
;
476 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
477 Lisp_Object Qmouse_fixup_help_message
;
480 /* Symbols to denote kinds of events. */
481 Lisp_Object Qfunction_key
;
482 Lisp_Object Qmouse_click
;
483 #if defined (WINDOWSNT)
484 Lisp_Object Qlanguage_change
;
486 Lisp_Object Qdrag_n_drop
;
487 Lisp_Object Qsave_session
;
489 Lisp_Object Qdbus_event
;
491 /* Lisp_Object Qmouse_movement; - also an event header */
493 /* Properties of event headers. */
494 Lisp_Object Qevent_kind
;
495 Lisp_Object Qevent_symbol_elements
;
497 /* menu item parts */
498 Lisp_Object Qmenu_alias
;
499 Lisp_Object Qmenu_enable
;
500 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
501 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
502 extern Lisp_Object Vdefine_key_rebound_commands
;
503 extern Lisp_Object Qmenu_item
;
505 /* An event header symbol HEAD may have a property named
506 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
507 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
508 mask of modifiers applied to it. If present, this is used to help
509 speed up parse_modifiers. */
510 Lisp_Object Qevent_symbol_element_mask
;
512 /* An unmodified event header BASE may have a property named
513 Qmodifier_cache, which is an alist mapping modifier masks onto
514 modified versions of BASE. If present, this helps speed up
516 Lisp_Object Qmodifier_cache
;
518 /* Symbols to use for parts of windows. */
519 Lisp_Object Qmode_line
;
520 Lisp_Object Qvertical_line
;
521 Lisp_Object Qvertical_scroll_bar
;
522 Lisp_Object Qmenu_bar
;
523 extern Lisp_Object Qleft_margin
, Qright_margin
;
524 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
525 extern Lisp_Object QCmap
;
527 Lisp_Object
recursive_edit_unwind (), command_loop ();
528 Lisp_Object
Fthis_command_keys ();
529 Lisp_Object Qextended_command_history
;
530 EMACS_TIME
timer_check ();
532 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
534 extern char *x_get_keysym_name ();
536 static void record_menu_key ();
537 static int echo_length ();
539 Lisp_Object Qpolling_period
;
541 /* List of absolute timers. Appears in order of next scheduled event. */
542 Lisp_Object Vtimer_list
;
544 /* List of idle time timers. Appears in order of next scheduled event. */
545 Lisp_Object Vtimer_idle_list
;
547 /* Incremented whenever a timer is run. */
550 extern Lisp_Object Vprint_level
, Vprint_length
;
552 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
554 EMACS_TIME
*input_available_clear_time
;
556 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
557 Default is 1 if INTERRUPT_INPUT is defined. */
560 /* Nonzero while interrupts are temporarily deferred during redisplay. */
561 int interrupts_deferred
;
563 /* Allow m- file to inhibit use of FIONREAD. */
564 #ifdef BROKEN_FIONREAD
568 /* We are unable to use interrupts if FIONREAD is not available,
569 so flush SIGIO so we won't try. */
570 #if !defined (FIONREAD)
576 /* If we support a window system, turn on the code to poll periodically
577 to detect C-g. It isn't actually used when doing interrupt input. */
578 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
579 #define POLL_FOR_INPUT
582 /* After a command is executed, if point is moved into a region that
583 has specific properties (e.g. composition, display), we adjust
584 point to the boundary of the region. But, if a command sets this
585 variable to non-nil, we suppress this point adjustment. This
586 variable is set to nil before reading a command. */
588 Lisp_Object Vdisable_point_adjustment
;
590 /* If non-nil, always disable point adjustment. */
592 Lisp_Object Vglobal_disable_point_adjustment
;
594 /* The time when Emacs started being idle. */
596 static EMACS_TIME timer_idleness_start_time
;
598 /* After Emacs stops being idle, this saves the last value
599 of timer_idleness_start_time from when it was idle. */
601 static EMACS_TIME timer_last_idleness_start_time
;
603 /* If non-nil, events produced by disabled menu items and tool-bar
604 buttons are not ignored. Help functions bind this to allow help on
605 those items and buttons. */
606 Lisp_Object Venable_disabled_menus_and_buttons
;
609 /* Global variable declarations. */
611 /* Flags for readable_events. */
612 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
613 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
614 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
616 /* Function for init_keyboard to call with no args (if nonzero). */
617 void (*keyboard_init_hook
) ();
619 static int read_avail_input
P_ ((int));
620 static void get_input_pending
P_ ((int *, int));
621 static int readable_events
P_ ((int));
622 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
623 Lisp_Object
, int *));
624 static Lisp_Object
read_char_x_menu_prompt ();
625 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
627 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
628 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
629 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
630 enum scroll_bar_part
,
631 Lisp_Object
, Lisp_Object
,
634 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
635 Lisp_Object
, char **,
636 Lisp_Object
*, unsigned));
637 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
638 static void save_getcjmp
P_ ((jmp_buf));
639 static void save_getcjmp ();
640 static void restore_getcjmp
P_ ((jmp_buf));
641 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
642 static void clear_event
P_ ((struct input_event
*));
643 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
644 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
645 static void handle_interrupt
P_ ((void));
646 static void timer_start_idle
P_ ((void));
647 static void timer_stop_idle
P_ ((void));
648 static void timer_resume_idle
P_ ((void));
649 static SIGTYPE handle_user_signal
P_ ((int));
650 static char *find_user_signal_name
P_ ((int));
651 static int store_user_signal_events
P_ ((void));
653 /* Nonzero means don't try to suspend even if the operating system seems
655 static int cannot_suspend
;
657 extern Lisp_Object Qidentity
, Qonly
;
659 /* Install the string STR as the beginning of the string of echoing,
660 so that it serves as a prompt for the next character.
661 Also start echoing. */
667 current_kboard
->echo_string
= str
;
668 current_kboard
->echo_after_prompt
= SCHARS (str
);
672 /* Add C to the echo string, if echoing is going on.
673 C can be a character, which is printed prettily ("M-C-x" and all that
674 jazz), or a symbol, whose name is printed. */
680 if (current_kboard
->immediate_echo
)
682 int size
= KEY_DESCRIPTION_SIZE
+ 100;
683 char *buffer
= (char *) alloca (size
);
685 Lisp_Object echo_string
;
687 echo_string
= current_kboard
->echo_string
;
689 /* If someone has passed us a composite event, use its head symbol. */
694 ptr
= push_key_description (XINT (c
), ptr
, 1);
696 else if (SYMBOLP (c
))
698 Lisp_Object name
= SYMBOL_NAME (c
);
699 int nbytes
= SBYTES (name
);
701 if (size
- (ptr
- buffer
) < nbytes
)
703 int offset
= ptr
- buffer
;
704 size
= max (2 * size
, size
+ nbytes
);
705 buffer
= (char *) alloca (size
);
706 ptr
= buffer
+ offset
;
709 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
710 STRING_MULTIBYTE (name
), 1);
713 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
716 const char *text
= " (Type ? for further options)";
717 int len
= strlen (text
);
719 if (size
- (ptr
- buffer
) < len
)
721 int offset
= ptr
- buffer
;
723 buffer
= (char *) alloca (size
);
724 ptr
= buffer
+ offset
;
727 bcopy (text
, ptr
, len
);
731 /* Replace a dash from echo_dash with a space, otherwise
732 add a space at the end as a separator between keys. */
733 if (STRINGP (echo_string
)
734 && SCHARS (echo_string
) > 1)
736 Lisp_Object last_char
, prev_char
, idx
;
738 idx
= make_number (SCHARS (echo_string
) - 2);
739 prev_char
= Faref (echo_string
, idx
);
741 idx
= make_number (SCHARS (echo_string
) - 1);
742 last_char
= Faref (echo_string
, idx
);
744 /* We test PREV_CHAR to make sure this isn't the echoing
746 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
747 Faset (echo_string
, idx
, make_number (' '));
749 echo_string
= concat2 (echo_string
, build_string (" "));
751 else if (STRINGP (echo_string
))
752 echo_string
= concat2 (echo_string
, build_string (" "));
754 current_kboard
->echo_string
755 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
761 /* Temporarily add a dash to the end of the echo string if it's not
762 empty, so that it serves as a mini-prompt for the very next character. */
767 /* Do nothing if not echoing at all. */
768 if (NILP (current_kboard
->echo_string
))
771 if (!current_kboard
->immediate_echo
772 && SCHARS (current_kboard
->echo_string
) == 0)
775 /* Do nothing if we just printed a prompt. */
776 if (current_kboard
->echo_after_prompt
777 == SCHARS (current_kboard
->echo_string
))
780 /* Do nothing if we have already put a dash at the end. */
781 if (SCHARS (current_kboard
->echo_string
) > 1)
783 Lisp_Object last_char
, prev_char
, idx
;
785 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
786 prev_char
= Faref (current_kboard
->echo_string
, idx
);
788 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
789 last_char
= Faref (current_kboard
->echo_string
, idx
);
791 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
795 /* Put a dash at the end of the buffer temporarily,
796 but make it go away when the next character is added. */
797 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
802 /* Display the current echo string, and begin echoing if not already
808 if (!current_kboard
->immediate_echo
)
811 current_kboard
->immediate_echo
= 1;
813 for (i
= 0; i
< this_command_key_count
; i
++)
817 /* Set before_command_echo_length to the value that would
818 have been saved before the start of this subcommand in
819 command_loop_1, if we had already been echoing then. */
820 if (i
== this_single_command_key_start
)
821 before_command_echo_length
= echo_length ();
823 c
= XVECTOR (this_command_keys
)->contents
[i
];
824 if (! (EVENT_HAS_PARAMETERS (c
)
825 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
829 /* Set before_command_echo_length to the value that would
830 have been saved before the start of this subcommand in
831 command_loop_1, if we had already been echoing then. */
832 if (this_command_key_count
== this_single_command_key_start
)
833 before_command_echo_length
= echo_length ();
835 /* Put a dash at the end to invite the user to type more. */
840 message3_nolog (current_kboard
->echo_string
,
841 SBYTES (current_kboard
->echo_string
),
842 STRING_MULTIBYTE (current_kboard
->echo_string
));
845 /* Record in what buffer we echoed, and from which kboard. */
846 echo_message_buffer
= echo_area_buffer
[0];
847 echo_kboard
= current_kboard
;
849 if (waiting_for_input
&& !NILP (Vquit_flag
))
850 quit_throw_to_read_char ();
853 /* Turn off echoing, for the start of a new command. */
858 current_kboard
->immediate_echo
= 0;
859 current_kboard
->echo_after_prompt
= -1;
860 current_kboard
->echo_string
= Qnil
;
861 ok_to_echo_at_next_pause
= NULL
;
863 echo_message_buffer
= Qnil
;
866 /* Return the length of the current echo string. */
871 return (STRINGP (current_kboard
->echo_string
)
872 ? SCHARS (current_kboard
->echo_string
)
876 /* Truncate the current echo message to its first LEN chars.
877 This and echo_char get used by read_key_sequence when the user
878 switches frames while entering a key sequence. */
881 echo_truncate (nchars
)
884 if (STRINGP (current_kboard
->echo_string
))
885 current_kboard
->echo_string
886 = Fsubstring (current_kboard
->echo_string
,
887 make_number (0), make_number (nchars
));
888 truncate_echo_area (nchars
);
892 /* Functions for manipulating this_command_keys. */
894 add_command_key (key
)
897 #if 0 /* Not needed after we made Freset_this_command_lengths
898 do the job immediately. */
899 /* If reset-this-command-length was called recently, obey it now.
900 See the doc string of that function for an explanation of why. */
901 if (before_command_restore_flag
)
903 this_command_key_count
= before_command_key_count_1
;
904 if (this_command_key_count
< this_single_command_key_start
)
905 this_single_command_key_start
= this_command_key_count
;
906 echo_truncate (before_command_echo_length_1
);
907 before_command_restore_flag
= 0;
911 if (this_command_key_count
>= ASIZE (this_command_keys
))
912 this_command_keys
= larger_vector (this_command_keys
,
913 2 * ASIZE (this_command_keys
),
916 ASET (this_command_keys
, this_command_key_count
, key
);
917 ++this_command_key_count
;
924 int count
= SPECPDL_INDEX ();
927 if (command_loop_level
> 0)
929 specbind (Qstandard_output
, Qt
);
930 specbind (Qstandard_input
, Qt
);
933 #ifdef HAVE_WINDOW_SYSTEM
934 /* The command loop has started an hourglass timer, so we have to
935 cancel it here, otherwise it will fire because the recursive edit
936 can take some time. Do not check for display_hourglass_p here,
937 because it could already be nil. */
941 /* This function may have been called from a debugger called from
942 within redisplay, for instance by Edebugging a function called
943 from fontification-functions. We want to allow redisplay in
944 the debugging session.
946 The recursive edit is left with a `(throw exit ...)'. The `exit'
947 tag is not caught anywhere in redisplay, i.e. when we leave the
948 recursive edit, the original redisplay leading to the recursive
949 edit will be unwound. The outcome should therefore be safe. */
950 specbind (Qinhibit_redisplay
, Qnil
);
953 val
= command_loop ();
955 Fsignal (Qquit
, Qnil
);
956 /* Handle throw from read_minibuf when using minibuffer
957 while it's active but we're in another window. */
959 xsignal1 (Qerror
, val
);
961 return unbind_to (count
, Qnil
);
964 /* When an auto-save happens, record the "time", and don't do again soon. */
969 last_auto_save
= num_nonmacro_input_events
;
972 /* Make an auto save happen as soon as possible at command level. */
975 force_auto_save_soon ()
977 last_auto_save
= - auto_save_interval
- 1;
979 record_asynch_buffer_change ();
982 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
983 doc
: /* Invoke the editor command loop recursively.
984 To get out of the recursive edit, a command can do `(throw 'exit nil)';
985 that tells this function to return.
986 Alternatively, `(throw 'exit t)' makes this function signal an error.
987 This function is called by the editor initialization to begin editing. */)
990 int count
= SPECPDL_INDEX ();
993 /* If we enter while input is blocked, don't lock up here.
994 This may happen through the debugger during redisplay. */
998 command_loop_level
++;
999 update_mode_lines
= 1;
1001 if (command_loop_level
1002 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1003 buffer
= Fcurrent_buffer ();
1007 /* If we leave recursive_edit_1 below with a `throw' for instance,
1008 like it is done in the splash screen display, we have to
1009 make sure that we restore single_kboard as command_loop_1
1010 would have done if it were left normally. */
1011 if (command_loop_level
> 0)
1012 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1013 record_unwind_protect (recursive_edit_unwind
, buffer
);
1015 recursive_edit_1 ();
1016 return unbind_to (count
, Qnil
);
1020 recursive_edit_unwind (buffer
)
1023 if (BUFFERP (buffer
))
1024 Fset_buffer (buffer
);
1026 command_loop_level
--;
1027 update_mode_lines
= 1;
1032 #if 0 /* These two functions are now replaced with
1033 temporarily_switch_to_single_kboard. */
1037 #if 0 /* Theory: if there's anything in Vunread_command_events,
1038 it will right away be read by read_key_sequence,
1039 and then if we do switch KBOARDS, it will go into the side
1040 queue then. So we don't need to do anything special here -- rms. */
1041 if (CONSP (Vunread_command_events
))
1043 current_kboard
->kbd_queue
1044 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1045 current_kboard
->kbd_queue_has_data
= 1;
1047 Vunread_command_events
= Qnil
;
1052 /* Switch to the single-kboard state, making current_kboard
1053 the only KBOARD from which further input is accepted. */
1056 single_kboard_state ()
1062 /* If we're in single_kboard state for kboard KBOARD,
1066 not_single_kboard_state (kboard
)
1069 if (kboard
== current_kboard
)
1073 /* Maintain a stack of kboards, so other parts of Emacs
1074 can switch temporarily to the kboard of a given frame
1075 and then revert to the previous status. */
1080 struct kboard_stack
*next
;
1083 static struct kboard_stack
*kboard_stack
;
1089 struct kboard_stack
*p
1090 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1092 p
->next
= kboard_stack
;
1093 p
->kboard
= current_kboard
;
1103 struct kboard_stack
*p
= kboard_stack
;
1105 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1107 if (t
->kboard
== p
->kboard
)
1109 current_kboard
= p
->kboard
;
1116 /* The terminal we remembered has been deleted. */
1117 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1120 kboard_stack
= p
->next
;
1124 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1125 from which further input is accepted. If F is non-nil, set its
1126 KBOARD as the current keyboard.
1128 This function uses record_unwind_protect to return to the previous
1131 If Emacs is already in single_kboard mode, and F's keyboard is
1132 locked, then this function will throw an errow. */
1135 temporarily_switch_to_single_kboard (f
)
1138 int was_locked
= single_kboard
;
1141 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1142 /* We can not switch keyboards while in single_kboard mode.
1143 In rare cases, Lisp code may call `recursive-edit' (or
1144 `read-minibuffer' or `y-or-n-p') after it switched to a
1145 locked frame. For example, this is likely to happen
1146 when server.el connects to a new terminal while Emacs is in
1147 single_kboard mode. It is best to throw an error instead
1148 of presenting the user with a frozen screen. */
1149 error ("Terminal %d is locked, cannot read from it",
1150 FRAME_TERMINAL (f
)->id
);
1152 /* This call is unnecessary, but helps
1153 `restore_kboard_configuration' discover if somebody changed
1154 `current_kboard' behind our back. */
1155 push_kboard (current_kboard
);
1158 current_kboard
= FRAME_KBOARD (f
);
1160 record_unwind_protect (restore_kboard_configuration
,
1161 (was_locked
? Qt
: Qnil
));
1164 #if 0 /* This function is not needed anymore. */
1166 record_single_kboard_state ()
1169 push_kboard (current_kboard
);
1170 record_unwind_protect (restore_kboard_configuration
,
1171 (single_kboard
? Qt
: Qnil
));
1176 restore_kboard_configuration (was_locked
)
1177 Lisp_Object was_locked
;
1179 if (NILP (was_locked
))
1183 struct kboard
*prev
= current_kboard
;
1186 /* The pop should not change the kboard. */
1187 if (single_kboard
&& current_kboard
!= prev
)
1194 /* Handle errors that are not handled at inner levels
1195 by printing an error message and returning to the editor command loop. */
1201 Lisp_Object old_level
, old_length
;
1202 char macroerror
[50];
1204 #ifdef HAVE_WINDOW_SYSTEM
1205 if (display_hourglass_p
)
1206 cancel_hourglass ();
1209 if (!NILP (executing_kbd_macro
))
1211 if (executing_kbd_macro_iterations
== 1)
1212 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1214 sprintf (macroerror
, "After %d kbd macro iterations: ",
1215 executing_kbd_macro_iterations
);
1220 Vstandard_output
= Qt
;
1221 Vstandard_input
= Qt
;
1222 Vexecuting_kbd_macro
= Qnil
;
1223 executing_kbd_macro
= Qnil
;
1224 current_kboard
->Vprefix_arg
= Qnil
;
1225 current_kboard
->Vlast_prefix_arg
= Qnil
;
1228 /* Avoid unquittable loop if data contains a circular list. */
1229 old_level
= Vprint_level
;
1230 old_length
= Vprint_length
;
1231 XSETFASTINT (Vprint_level
, 10);
1232 XSETFASTINT (Vprint_length
, 10);
1233 cmd_error_internal (data
, macroerror
);
1234 Vprint_level
= old_level
;
1235 Vprint_length
= old_length
;
1239 Vinhibit_quit
= Qnil
;
1240 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1241 if (command_loop_level
== 0 && minibuf_level
== 0)
1242 any_kboard_state ();
1245 return make_number (0);
1248 /* Take actions on handling an error. DATA is the data that describes
1251 CONTEXT is a C-string containing ASCII characters only which
1252 describes the context in which the error happened. If we need to
1253 generalize CONTEXT to allow multibyte characters, make it a Lisp
1257 cmd_error_internal (data
, context
)
1261 struct frame
*sf
= SELECTED_FRAME ();
1263 /* The immediate context is not interesting for Quits,
1264 since they are asyncronous. */
1265 if (EQ (XCAR (data
), Qquit
))
1266 Vsignaling_function
= Qnil
;
1271 /* Use user's specified output function if any. */
1272 if (!NILP (Vcommand_error_function
))
1273 call3 (Vcommand_error_function
, data
,
1274 context
? build_string (context
) : empty_unibyte_string
,
1275 Vsignaling_function
);
1276 /* If the window system or terminal frame hasn't been initialized
1277 yet, or we're not interactive, write the message to stderr and exit. */
1278 else if (!sf
->glyphs_initialized_p
1279 /* The initial frame is a special non-displaying frame. It
1280 will be current in daemon mode when there are no frames
1281 to display, and in non-daemon mode before the real frame
1282 has finished initializing. If an error is thrown in the
1283 latter case while creating the frame, then the frame
1284 will never be displayed, so the safest thing to do is
1285 write to stderr and quit. In daemon mode, there are
1286 many other potential errors that do not prevent frames
1287 from being created, so continuing as normal is better in
1289 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1292 print_error_message (data
, Qexternal_debugging_output
,
1293 context
, Vsignaling_function
);
1294 Fterpri (Qexternal_debugging_output
);
1295 Fkill_emacs (make_number (-1));
1299 clear_message (1, 0);
1301 message_log_maybe_newline ();
1304 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1307 Vsignaling_function
= Qnil
;
1310 Lisp_Object
command_loop_1 ();
1311 Lisp_Object
command_loop_2 ();
1312 Lisp_Object
top_level_1 ();
1314 /* Entry to editor-command-loop.
1315 This level has the catches for exiting/returning to editor command loop.
1316 It returns nil to exit recursive edit, t to abort it. */
1321 if (command_loop_level
> 0 || minibuf_level
> 0)
1324 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1325 executing_kbd_macro
= Qnil
;
1331 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1332 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1333 /* Reset single_kboard in case top-level set it while
1334 evaluating an -f option, or we are stuck there for some
1336 any_kboard_state ();
1338 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1339 executing_kbd_macro
= Qnil
;
1341 /* End of file in -batch run causes exit here. */
1347 /* Here we catch errors in execution of commands within the
1348 editing loop, and reenter the editing loop.
1349 When there is an error, cmd_error runs and returns a non-nil
1350 value to us. A value of nil means that command_loop_1 itself
1351 returned due to end of file (or end of kbd macro). */
1356 register Lisp_Object val
;
1359 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1360 while (!NILP (val
));
1368 return Feval (Vtop_level
);
1374 /* On entry to the outer level, run the startup file */
1375 if (!NILP (Vtop_level
))
1376 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1377 else if (!NILP (Vpurify_flag
))
1378 message ("Bare impure Emacs (standard Lisp code not loaded)");
1380 message ("Bare Emacs (standard Lisp code not loaded)");
1384 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1385 doc
: /* Exit all recursive editing levels.
1386 This also exits all active minibuffers. */)
1389 #ifdef HAVE_WINDOW_SYSTEM
1390 if (display_hourglass_p
)
1391 cancel_hourglass ();
1394 /* Unblock input if we enter with input blocked. This may happen if
1395 redisplay traps e.g. during tool-bar update with input blocked. */
1396 while (INPUT_BLOCKED_P
)
1399 return Fthrow (Qtop_level
, Qnil
);
1402 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1403 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1406 if (command_loop_level
> 0 || minibuf_level
> 0)
1407 Fthrow (Qexit
, Qnil
);
1409 error ("No recursive edit is in progress");
1413 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1414 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1417 if (command_loop_level
> 0 || minibuf_level
> 0)
1420 error ("No recursive edit is in progress");
1424 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1426 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1427 of this function. */
1430 tracking_off (old_value
)
1431 Lisp_Object old_value
;
1433 do_mouse_tracking
= old_value
;
1434 if (NILP (old_value
))
1436 /* Redisplay may have been preempted because there was input
1437 available, and it assumes it will be called again after the
1438 input has been processed. If the only input available was
1439 the sort that we have just disabled, then we need to call
1441 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1443 redisplay_preserve_echo_area (6);
1444 get_input_pending (&input_pending
,
1445 READABLE_EVENTS_DO_TIMERS_NOW
);
1451 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1452 doc
: /* Evaluate BODY with mouse movement events enabled.
1453 Within a `track-mouse' form, mouse motion generates input events that
1454 you can read with `read-event'.
1455 Normally, mouse motion is ignored.
1456 usage: (track-mouse BODY...) */)
1460 int count
= SPECPDL_INDEX ();
1463 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1465 do_mouse_tracking
= Qt
;
1467 val
= Fprogn (args
);
1468 return unbind_to (count
, val
);
1471 /* If mouse has moved on some frame, return one of those frames.
1475 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1476 after resizing the tool-bar window. */
1478 int ignore_mouse_drag_p
;
1483 Lisp_Object tail
, frame
;
1485 if (ignore_mouse_drag_p
)
1487 /* ignore_mouse_drag_p = 0; */
1491 FOR_EACH_FRAME (tail
, frame
)
1493 if (XFRAME (frame
)->mouse_moved
)
1494 return XFRAME (frame
);
1500 #endif /* HAVE_MOUSE || HAVE_GPM */
1502 /* This is the actual command reading loop,
1503 sans error-handling encapsulation. */
1505 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1507 void safe_run_hooks
P_ ((Lisp_Object
));
1508 static void adjust_point_for_property
P_ ((int, int));
1510 /* Cancel hourglass from protect_unwind.
1512 #ifdef HAVE_WINDOW_SYSTEM
1514 cancel_hourglass_unwind (arg
)
1517 cancel_hourglass ();
1522 extern int nonundocount
; /* Declared in cmds.c. */
1529 Lisp_Object keybuf
[30];
1531 int prev_modiff
= 0;
1532 struct buffer
*prev_buffer
= NULL
;
1533 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1534 int was_locked
= single_kboard
;
1536 int already_adjusted
= 0;
1538 current_kboard
->Vprefix_arg
= Qnil
;
1539 current_kboard
->Vlast_prefix_arg
= Qnil
;
1540 Vdeactivate_mark
= Qnil
;
1541 waiting_for_input
= 0;
1544 this_command_key_count
= 0;
1545 this_command_key_count_reset
= 0;
1546 this_single_command_key_start
= 0;
1548 if (NILP (Vmemory_full
))
1550 /* Make sure this hook runs after commands that get errors and
1551 throw to top level. */
1552 /* Note that the value cell will never directly contain nil
1553 if the symbol is a local variable. */
1554 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1555 safe_run_hooks (Qpost_command_hook
);
1557 /* If displaying a message, resize the echo area window to fit
1558 that message's size exactly. */
1559 if (!NILP (echo_area_buffer
[0]))
1560 resize_echo_area_exactly ();
1562 if (!NILP (Vdeferred_action_list
))
1563 safe_run_hooks (Qdeferred_action_function
);
1566 /* Do this after running Vpost_command_hook, for consistency. */
1567 current_kboard
->Vlast_command
= Vthis_command
;
1568 current_kboard
->Vreal_last_command
= real_this_command
;
1569 if (!CONSP (last_command_event
))
1570 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1574 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1577 /* Make sure the current window's buffer is selected. */
1578 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1579 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1581 /* Display any malloc warning that just came out. Use while because
1582 displaying one warning can cause another. */
1584 while (pending_malloc_warning
)
1585 display_malloc_warning ();
1587 Vdeactivate_mark
= Qnil
;
1589 /* If minibuffer on and echo area in use,
1590 wait a short time and redraw minibuffer. */
1593 && !NILP (echo_area_buffer
[0])
1594 && EQ (minibuf_window
, echo_area_window
)
1595 && NUMBERP (Vminibuffer_message_timeout
))
1597 /* Bind inhibit-quit to t so that C-g gets read in
1598 rather than quitting back to the minibuffer. */
1599 int count
= SPECPDL_INDEX ();
1600 specbind (Qinhibit_quit
, Qt
);
1602 sit_for (Vminibuffer_message_timeout
, 0, 2);
1604 /* Clear the echo area. */
1606 safe_run_hooks (Qecho_area_clear_hook
);
1608 unbind_to (count
, Qnil
);
1610 /* If a C-g came in before, treat it as input now. */
1611 if (!NILP (Vquit_flag
))
1614 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1619 /* Select the frame that the last event came from. Usually,
1620 switch-frame events will take care of this, but if some lisp
1621 code swallows a switch-frame event, we'll fix things up here.
1622 Is this a good idea? */
1623 if (FRAMEP (internal_last_event_frame
)
1624 && !EQ (internal_last_event_frame
, selected_frame
))
1625 Fselect_frame (internal_last_event_frame
, Qnil
);
1627 /* If it has changed current-menubar from previous value,
1628 really recompute the menubar from the value. */
1629 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1630 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1631 call0 (Qrecompute_lucid_menubar
);
1633 before_command_key_count
= this_command_key_count
;
1634 before_command_echo_length
= echo_length ();
1636 Vthis_command
= Qnil
;
1637 real_this_command
= Qnil
;
1638 Vthis_original_command
= Qnil
;
1639 Vthis_command_keys_shift_translated
= Qnil
;
1641 /* Read next key sequence; i gets its length. */
1642 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1645 /* A filter may have run while we were reading the input. */
1646 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1648 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1649 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1653 /* Now we have read a key sequence of length I,
1654 or else I is 0 and we found end of file. */
1656 if (i
== 0) /* End of file -- happens only in */
1657 return Qnil
; /* a kbd macro, at the end. */
1658 /* -1 means read_key_sequence got a menu that was rejected.
1659 Just loop around and read another command. */
1663 this_command_key_count
= 0;
1664 this_command_key_count_reset
= 0;
1665 this_single_command_key_start
= 0;
1669 last_command_event
= keybuf
[i
- 1];
1671 /* If the previous command tried to force a specific window-start,
1672 forget about that, in case this command moves point far away
1673 from that position. But also throw away beg_unchanged and
1674 end_unchanged information in that case, so that redisplay will
1675 update the whole window properly. */
1676 if (!NILP (XWINDOW (selected_window
)->force_start
))
1679 XWINDOW (selected_window
)->force_start
= Qnil
;
1680 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1681 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1684 cmd
= read_key_sequence_cmd
;
1685 if (!NILP (Vexecuting_kbd_macro
))
1687 if (!NILP (Vquit_flag
))
1689 Vexecuting_kbd_macro
= Qt
;
1690 QUIT
; /* Make some noise. */
1691 /* Will return since macro now empty. */
1695 /* Do redisplay processing after this command except in special
1696 cases identified below. */
1697 prev_buffer
= current_buffer
;
1698 prev_modiff
= MODIFF
;
1699 last_point_position
= PT
;
1700 last_point_position_window
= selected_window
;
1701 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1703 /* By default, we adjust point to a boundary of a region that
1704 has such a property that should be treated intangible
1705 (e.g. composition, display). But, some commands will set
1706 this variable differently. */
1707 Vdisable_point_adjustment
= Qnil
;
1709 /* Process filters and timers may have messed with deactivate-mark.
1710 reset it before we execute the command. */
1711 Vdeactivate_mark
= Qnil
;
1713 /* Remap command through active keymaps */
1714 Vthis_original_command
= cmd
;
1718 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1722 /* Execute the command. */
1724 Vthis_command
= cmd
;
1725 real_this_command
= cmd
;
1726 /* Note that the value cell will never directly contain nil
1727 if the symbol is a local variable. */
1728 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1729 safe_run_hooks (Qpre_command_hook
);
1731 already_adjusted
= 0;
1733 if (NILP (Vthis_command
))
1735 /* nil means key is undefined. */
1736 Lisp_Object keys
= Fvector (i
, keybuf
);
1737 keys
= Fkey_description (keys
, Qnil
);
1739 message_with_string ("%s is undefined", keys
, 0);
1740 current_kboard
->defining_kbd_macro
= Qnil
;
1741 update_mode_lines
= 1;
1742 current_kboard
->Vprefix_arg
= Qnil
;
1746 if (NILP (current_kboard
->Vprefix_arg
))
1748 /* In case we jump to directly_done. */
1749 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1751 /* Recognize some common commands in common situations and
1752 do them directly. */
1753 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1754 && NILP (Vthis_command_keys_shift_translated
)
1755 && !CONSP (Vtransient_mark_mode
))
1757 struct Lisp_Char_Table
*dp
1758 = window_display_table (XWINDOW (selected_window
));
1759 lose
= FETCH_CHAR (PT_BYTE
);
1761 if (! NILP (Vpost_command_hook
))
1762 /* Put this before calling adjust_point_for_property
1763 so it will only get called once in any case. */
1765 if (current_buffer
== prev_buffer
1766 && last_point_position
!= PT
1767 && NILP (Vdisable_point_adjustment
)
1768 && NILP (Vglobal_disable_point_adjustment
))
1769 adjust_point_for_property (last_point_position
, 0);
1770 already_adjusted
= 1;
1771 if (PT
== last_point_position
+ 1
1773 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1774 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1775 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1776 && (lose
>= 0x20 && lose
< 0x7f)))
1777 : (lose
>= 0x20 && lose
< 0x7f))
1778 /* To extract the case of continuation on
1779 wide-column characters. */
1780 && ASCII_BYTE_P (lose
)
1781 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1783 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1785 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1787 && !windows_or_buffers_changed
1788 && EQ (current_buffer
->selective_display
, Qnil
)
1789 && !detect_input_pending ()
1790 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1791 && NILP (Vexecuting_kbd_macro
))
1792 direct_output_forward_char (1);
1795 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1796 && NILP (Vthis_command_keys_shift_translated
)
1797 && !CONSP (Vtransient_mark_mode
))
1799 struct Lisp_Char_Table
*dp
1800 = window_display_table (XWINDOW (selected_window
));
1802 lose
= FETCH_CHAR (PT_BYTE
);
1803 if (! NILP (Vpost_command_hook
))
1805 if (current_buffer
== prev_buffer
1806 && last_point_position
!= PT
1807 && NILP (Vdisable_point_adjustment
)
1808 && NILP (Vglobal_disable_point_adjustment
))
1809 adjust_point_for_property (last_point_position
, 0);
1810 already_adjusted
= 1;
1811 if (PT
== last_point_position
- 1
1813 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1814 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1815 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1816 && (lose
>= 0x20 && lose
< 0x7f)))
1817 : (lose
>= 0x20 && lose
< 0x7f))
1818 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1820 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1822 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1824 && !windows_or_buffers_changed
1825 && EQ (current_buffer
->selective_display
, Qnil
)
1826 && !detect_input_pending ()
1827 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1828 && NILP (Vexecuting_kbd_macro
))
1829 direct_output_forward_char (-1);
1832 else if (EQ (Vthis_command
, Qself_insert_command
)
1833 /* Try this optimization only on char keystrokes. */
1834 && NATNUMP (last_command_event
)
1835 && CHAR_VALID_P (XFASTINT (last_command_event
), 0))
1838 = translate_char (Vtranslation_table_for_input
,
1839 XFASTINT (last_command_event
));
1841 if (NILP (Vexecuting_kbd_macro
)
1842 && !EQ (minibuf_window
, selected_window
))
1844 if (!nonundocount
|| nonundocount
>= 20)
1852 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1854 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1856 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1858 || MODIFF
<= SAVE_MODIFF
1859 || windows_or_buffers_changed
1860 || !EQ (current_buffer
->selective_display
, Qnil
)
1861 || detect_input_pending ()
1862 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1863 || !NILP (Vexecuting_kbd_macro
));
1865 value
= internal_self_insert (c
, 0);
1870 frame_make_pointer_invisible ();
1872 if (! NILP (Vpost_command_hook
))
1873 /* Put this before calling adjust_point_for_property
1874 so it will only get called once in any case. */
1877 /* VALUE == 1 when AFTER-CHANGE functions are
1878 installed which is the case most of the time
1879 because FONT-LOCK installs one. */
1880 if (!lose
&& !value
)
1881 direct_output_for_insert (c
);
1886 /* Here for a command that isn't executed directly */
1889 #ifdef HAVE_WINDOW_SYSTEM
1890 int scount
= SPECPDL_INDEX ();
1892 if (display_hourglass_p
1893 && NILP (Vexecuting_kbd_macro
))
1895 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1901 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1903 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1905 #ifdef HAVE_WINDOW_SYSTEM
1906 /* Do not check display_hourglass_p here, because
1907 Fcommand_execute could change it, but we should cancel
1908 hourglass cursor anyway.
1909 But don't cancel the hourglass within a macro
1910 just because a command in the macro finishes. */
1911 if (NILP (Vexecuting_kbd_macro
))
1912 unbind_to (scount
, Qnil
);
1917 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1919 /* Note that the value cell will never directly contain nil
1920 if the symbol is a local variable. */
1921 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1922 safe_run_hooks (Qpost_command_hook
);
1924 /* If displaying a message, resize the echo area window to fit
1925 that message's size exactly. */
1926 if (!NILP (echo_area_buffer
[0]))
1927 resize_echo_area_exactly ();
1929 if (!NILP (Vdeferred_action_list
))
1930 safe_run_hooks (Qdeferred_action_function
);
1932 /* If there is a prefix argument,
1933 1) We don't want Vlast_command to be ``universal-argument''
1934 (that would be dumb), so don't set Vlast_command,
1935 2) we want to leave echoing on so that the prefix will be
1936 echoed as part of this key sequence, so don't call
1938 3) we want to leave this_command_key_count non-zero, so that
1939 read_char will realize that it is re-reading a character, and
1940 not echo it a second time.
1942 If the command didn't actually create a prefix arg,
1943 but is merely a frame event that is transparent to prefix args,
1944 then the above doesn't apply. */
1945 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1947 current_kboard
->Vlast_command
= Vthis_command
;
1948 current_kboard
->Vreal_last_command
= real_this_command
;
1949 if (!CONSP (last_command_event
))
1950 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1952 this_command_key_count
= 0;
1953 this_command_key_count_reset
= 0;
1954 this_single_command_key_start
= 0;
1957 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1959 /* In Emacs 22, setting transient-mark-mode to `only' was a
1960 way of turning it on for just one command. This usage is
1961 obsolete, but support it anyway. */
1962 if (EQ (Vtransient_mark_mode
, Qidentity
))
1963 Vtransient_mark_mode
= Qnil
;
1964 else if (EQ (Vtransient_mark_mode
, Qonly
))
1965 Vtransient_mark_mode
= Qidentity
;
1967 if (!NILP (Vdeactivate_mark
))
1968 call0 (Qdeactivate_mark
);
1969 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1970 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1975 if (current_buffer
== prev_buffer
1976 && last_point_position
!= PT
1977 && NILP (Vdisable_point_adjustment
)
1978 && NILP (Vglobal_disable_point_adjustment
)
1979 && !already_adjusted
)
1980 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1982 /* Install chars successfully executed in kbd macro. */
1984 if (!NILP (current_kboard
->defining_kbd_macro
)
1985 && NILP (current_kboard
->Vprefix_arg
))
1986 finalize_kbd_macro_chars ();
1987 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1989 any_kboard_state ();
1994 extern Lisp_Object Qcomposition
, Qdisplay
;
1996 /* Adjust point to a boundary of a region that has such a property
1997 that should be treated intangible. For the moment, we check
1998 `composition', `display' and `invisible' properties.
1999 LAST_PT is the last position of point. */
2001 extern Lisp_Object Qafter_string
, Qbefore_string
;
2002 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2005 adjust_point_for_property (last_pt
, modified
)
2010 Lisp_Object val
, overlay
, tmp
;
2011 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2014 /* FIXME: cycling is probably not necessary because these properties
2015 can't be usefully combined anyway. */
2016 while (check_composition
|| check_display
|| check_invisible
)
2018 /* FIXME: check `intangible'. */
2019 if (check_composition
2020 && PT
> BEGV
&& PT
< ZV
2021 && (beg
= composition_adjust_point (last_pt
)) != PT
)
2024 check_display
= check_invisible
= 1;
2026 check_composition
= 0;
2028 && PT
> BEGV
&& PT
< ZV
2029 && !NILP (val
= get_char_property_and_overlay
2030 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2031 && display_prop_intangible_p (val
)
2032 && (!OVERLAYP (overlay
)
2033 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2034 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2035 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2036 && (beg
< PT
/* && end > PT <- It's always the case. */
2037 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2040 SET_PT (PT
< last_pt
2041 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2043 check_composition
= check_invisible
= 1;
2046 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2048 int inv
, ellipsis
= 0;
2051 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2054 /* FIXME: We should stop if we find a spot between
2055 two runs of `invisible' where inserted text would
2056 be visible. This is important when we have two
2057 invisible boundaries that enclose an area: if the
2058 area is empty, we need this test in order to make
2059 it possible to place point in the middle rather
2060 than skip both boundaries. However, this code
2061 also stops anywhere in a non-sticky text-property,
2062 which breaks (e.g.) Org mode. */
2063 && (val
= get_pos_property (make_number (end
),
2065 TEXT_PROP_MEANS_INVISIBLE (val
))
2067 && !NILP (val
= get_char_property_and_overlay
2068 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2069 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2071 ellipsis
= ellipsis
|| inv
> 1
2072 || (OVERLAYP (overlay
)
2073 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2074 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2075 tmp
= Fnext_single_char_property_change
2076 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2077 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2081 && (val
= get_pos_property (make_number (beg
),
2083 TEXT_PROP_MEANS_INVISIBLE (val
))
2085 && !NILP (val
= get_char_property_and_overlay
2086 (make_number (beg
- 1), 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
= Fprevious_single_char_property_change
2094 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2095 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2098 /* Move away from the inside area. */
2099 if (beg
< PT
&& end
> PT
)
2101 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2102 /* We haven't moved yet (so we don't need to fear
2103 infinite-looping) and we were outside the range
2104 before (so either end of the range still corresponds
2105 to a move in the right direction): pretend we moved
2106 less than we actually did, so that we still have
2107 more freedom below in choosing which end of the range
2109 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2110 /* We either have moved already or the last point
2111 was already in the range: we don't get to choose
2112 which end of the range we have to go to. */
2113 : (PT
< last_pt
? beg
: end
));
2114 check_composition
= check_display
= 1;
2116 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2117 the point to something other than its argument, due to
2118 point-motion hooks, intangibility, etc. */
2119 xassert (PT
== beg
|| PT
== end
);
2122 /* Pretend the area doesn't exist if the buffer is not
2124 if (!modified
&& !ellipsis
&& beg
< end
)
2126 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2127 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2128 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2129 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2130 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2131 /* We've already moved as far as we can. Trying to go
2132 to the other end would mean moving backwards and thus
2133 could lead to an infinite loop. */
2135 else if (val
= get_pos_property (make_number (PT
),
2137 TEXT_PROP_MEANS_INVISIBLE (val
)
2138 && (val
= get_pos_property
2139 (make_number (PT
== beg
? end
: beg
),
2141 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2142 (check_composition
= check_display
= 1,
2143 SET_PT (PT
== beg
? end
: beg
));
2146 check_invisible
= 0;
2150 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2153 safe_run_hooks_1 (hook
)
2156 if (NILP (Vrun_hooks
))
2158 return call1 (Vrun_hooks
, Vinhibit_quit
);
2161 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2164 safe_run_hooks_error (data
)
2167 Lisp_Object args
[3];
2168 args
[0] = build_string ("Error in %s: %s");
2169 args
[1] = Vinhibit_quit
;
2172 return Fset (Vinhibit_quit
, Qnil
);
2175 /* If we get an error while running the hook, cause the hook variable
2176 to be nil. Also inhibit quits, so that C-g won't cause the hook
2177 to mysteriously evaporate. */
2180 safe_run_hooks (hook
)
2183 int count
= SPECPDL_INDEX ();
2184 specbind (Qinhibit_quit
, hook
);
2186 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2188 unbind_to (count
, Qnil
);
2192 /* Number of seconds between polling for input. This is a Lisp
2193 variable that can be bound. */
2195 EMACS_INT polling_period
;
2197 /* Nonzero means polling for input is temporarily suppressed. */
2199 int poll_suppress_count
;
2201 /* Asynchronous timer for polling. */
2203 struct atimer
*poll_timer
;
2206 #ifdef POLL_FOR_INPUT
2208 /* Poll for input, so that we catch a C-g if it comes in. This
2209 function is called from x_make_frame_visible, see comment
2215 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2216 doing anything dangerous. */
2220 if (interrupt_input_blocked
== 0
2221 && !waiting_for_input
)
2222 read_avail_input (0);
2228 /* Timer callback function for poll_timer. TIMER is equal to
2232 poll_for_input (timer
)
2233 struct atimer
*timer
;
2235 if (poll_suppress_count
== 0)
2238 interrupt_input_pending
= 1;
2239 pending_signals
= 1;
2241 poll_for_input_1 ();
2246 #endif /* POLL_FOR_INPUT */
2248 /* Begin signals to poll for input, if they are appropriate.
2249 This function is called unconditionally from various places. */
2254 #ifdef POLL_FOR_INPUT
2255 /* XXX This condition was (read_socket_hook && !interrupt_input),
2256 but read_socket_hook is not global anymore. Let's pretend that
2258 if (!interrupt_input
)
2260 /* Turn alarm handling on unconditionally. It might have
2261 been turned off in process.c. */
2262 turn_on_atimers (1);
2264 /* If poll timer doesn't exist, are we need one with
2265 a different interval, start a new one. */
2266 if (poll_timer
== NULL
2267 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2269 EMACS_TIME interval
;
2272 cancel_atimer (poll_timer
);
2274 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2275 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2276 poll_for_input
, NULL
);
2279 /* Let the timer's callback function poll for input
2280 if this becomes zero. */
2281 --poll_suppress_count
;
2286 /* Nonzero if we are using polling to handle input asynchronously. */
2289 input_polling_used ()
2291 #ifdef POLL_FOR_INPUT
2292 /* XXX This condition was (read_socket_hook && !interrupt_input),
2293 but read_socket_hook is not global anymore. Let's pretend that
2295 return !interrupt_input
;
2301 /* Turn off polling. */
2306 #ifdef POLL_FOR_INPUT
2307 /* XXX This condition was (read_socket_hook && !interrupt_input),
2308 but read_socket_hook is not global anymore. Let's pretend that
2310 if (!interrupt_input
)
2311 ++poll_suppress_count
;
2315 /* Set the value of poll_suppress_count to COUNT
2316 and start or stop polling accordingly. */
2319 set_poll_suppress_count (count
)
2322 #ifdef POLL_FOR_INPUT
2323 if (count
== 0 && poll_suppress_count
!= 0)
2325 poll_suppress_count
= 1;
2328 else if (count
!= 0 && poll_suppress_count
== 0)
2332 poll_suppress_count
= count
;
2336 /* Bind polling_period to a value at least N.
2337 But don't decrease it. */
2340 bind_polling_period (n
)
2343 #ifdef POLL_FOR_INPUT
2344 int new = polling_period
;
2349 stop_other_atimers (poll_timer
);
2351 specbind (Qpolling_period
, make_number (new));
2352 /* Start a new alarm with the new period. */
2357 /* Apply the control modifier to CHARACTER. */
2363 /* Save the upper bits here. */
2364 int upper
= c
& ~0177;
2366 if (! ASCII_BYTE_P (c
))
2367 return c
|= ctrl_modifier
;
2371 /* Everything in the columns containing the upper-case letters
2372 denotes a control character. */
2373 if (c
>= 0100 && c
< 0140)
2377 /* Set the shift modifier for a control char
2378 made from a shifted letter. But only for letters! */
2379 if (oc
>= 'A' && oc
<= 'Z')
2380 c
|= shift_modifier
;
2383 /* The lower-case letters denote control characters too. */
2384 else if (c
>= 'a' && c
<= 'z')
2387 /* Include the bits for control and shift
2388 only if the basic ASCII code can't indicate them. */
2392 /* Replace the high bits. */
2393 c
|= (upper
& ~ctrl_modifier
);
2398 /* Display the help-echo property of the character after the mouse pointer.
2399 Either show it in the echo area, or call show-help-function to display
2400 it by other means (maybe in a tooltip).
2402 If HELP is nil, that means clear the previous help echo.
2404 If HELP is a string, display that string. If HELP is a function,
2405 call it with OBJECT and POS as arguments; the function should
2406 return a help string or nil for none. For all other types of HELP,
2407 evaluate it to obtain a string.
2409 WINDOW is the window in which the help was generated, if any.
2410 It is nil if not in a window.
2412 If OBJECT is a buffer, POS is the position in the buffer where the
2413 `help-echo' text property was found.
2415 If OBJECT is an overlay, that overlay has a `help-echo' property,
2416 and POS is the position in the overlay's buffer under the mouse.
2418 If OBJECT is a string (an overlay string or a string displayed with
2419 the `display' property). POS is the position in that string under
2422 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2423 echo overwrites a keystroke echo currently displayed in the echo
2426 Note: this function may only be called with HELP nil or a string
2427 from X code running asynchronously. */
2430 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2431 Lisp_Object help
, window
, object
, pos
;
2432 int ok_to_overwrite_keystroke_echo
;
2434 if (!NILP (help
) && !STRINGP (help
))
2436 if (FUNCTIONP (help
))
2438 Lisp_Object args
[4];
2443 help
= safe_call (4, args
);
2446 help
= safe_eval (help
);
2448 if (!STRINGP (help
))
2452 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2453 if (!noninteractive
&& STRINGP (help
))
2455 /* The mouse-fixup-help-message Lisp function can call
2456 mouse_position_hook, which resets the mouse_moved flags.
2457 This causes trouble if we are trying to read a mouse motion
2458 event (i.e., if we are inside a `track-mouse' form), so we
2459 restore the mouse_moved flag. */
2460 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2461 help
= call1 (Qmouse_fixup_help_message
, help
);
2467 if (STRINGP (help
) || NILP (help
))
2469 if (!NILP (Vshow_help_function
))
2470 call1 (Vshow_help_function
, help
);
2471 help_echo_showing_p
= STRINGP (help
);
2477 /* Input of single characters from keyboard */
2479 Lisp_Object
print_help ();
2480 static Lisp_Object
kbd_buffer_get_event ();
2481 static void record_char ();
2483 static Lisp_Object help_form_saved_window_configs
;
2485 read_char_help_form_unwind (Lisp_Object arg
)
2487 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2488 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2489 if (!NILP (window_config
))
2490 Fset_window_configuration (window_config
);
2494 #define STOP_POLLING \
2495 do { if (! polling_stopped_here) stop_polling (); \
2496 polling_stopped_here = 1; } while (0)
2498 #define RESUME_POLLING \
2499 do { if (polling_stopped_here) start_polling (); \
2500 polling_stopped_here = 0; } while (0)
2502 /* read a character from the keyboard; call the redisplay if needed */
2503 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2504 -1 means do not do redisplay, but do do autosaving.
2507 /* The arguments MAPS and NMAPS are for menu prompting.
2508 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2510 PREV_EVENT is the previous input event, or nil if we are reading
2511 the first event of a key sequence (or not reading a key sequence).
2512 If PREV_EVENT is t, that is a "magic" value that says
2513 not to run input methods, but in other respects to act as if
2514 not reading a key sequence.
2516 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2517 if we used a mouse menu to read the input, or zero otherwise. If
2518 USED_MOUSE_MENU is null, we don't dereference it.
2520 Value is -2 when we find input on another keyboard. A second call
2521 to read_char will read it.
2523 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2524 specifying the maximum time to wait until. If no input arrives by
2525 that time, stop waiting and return nil.
2527 Value is t if we showed a menu and the user rejected it. */
2530 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2534 Lisp_Object prev_event
;
2535 int *used_mouse_menu
;
2536 EMACS_TIME
*end_time
;
2538 volatile Lisp_Object c
;
2539 int count
, jmpcount
;
2540 jmp_buf local_getcjmp
;
2542 volatile int key_already_recorded
= 0;
2543 Lisp_Object tem
, save
;
2544 volatile Lisp_Object previous_echo_area_message
;
2545 volatile Lisp_Object also_record
;
2546 volatile int reread
;
2547 struct gcpro gcpro1
, gcpro2
;
2548 int polling_stopped_here
= 0;
2549 struct kboard
*orig_kboard
= current_kboard
;
2553 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2554 before_command_key_count
= this_command_key_count
;
2555 before_command_echo_length
= echo_length ();
2558 previous_echo_area_message
= Qnil
;
2560 GCPRO2 (c
, previous_echo_area_message
);
2565 if (CONSP (Vunread_post_input_method_events
))
2567 c
= XCAR (Vunread_post_input_method_events
);
2568 Vunread_post_input_method_events
2569 = XCDR (Vunread_post_input_method_events
);
2571 /* Undo what read_char_x_menu_prompt did when it unread
2572 additional keys returned by Fx_popup_menu. */
2574 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2582 if (unread_command_char
!= -1)
2584 XSETINT (c
, unread_command_char
);
2585 unread_command_char
= -1;
2591 if (CONSP (Vunread_command_events
))
2593 int was_disabled
= 0;
2595 c
= XCAR (Vunread_command_events
);
2596 Vunread_command_events
= XCDR (Vunread_command_events
);
2600 /* Undo what sit-for did when it unread additional keys
2601 inside universal-argument. */
2604 && EQ (XCAR (c
), Qt
))
2610 /* Undo what read_char_x_menu_prompt did when it unread
2611 additional keys returned by Fx_popup_menu. */
2613 && EQ (XCDR (c
), Qdisabled
)
2614 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2620 /* If the queued event is something that used the mouse,
2621 set used_mouse_menu accordingly. */
2623 /* Also check was_disabled so last-nonmenu-event won't return
2624 a bad value when submenus are involved. (Bug#447) */
2625 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2626 *used_mouse_menu
= 1;
2628 goto reread_for_input_method
;
2631 if (CONSP (Vunread_input_method_events
))
2633 c
= XCAR (Vunread_input_method_events
);
2634 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2636 /* Undo what read_char_x_menu_prompt did when it unread
2637 additional keys returned by Fx_popup_menu. */
2639 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2643 goto reread_for_input_method
;
2646 this_command_key_count_reset
= 0;
2648 if (!NILP (Vexecuting_kbd_macro
))
2650 /* We set this to Qmacro; since that's not a frame, nobody will
2651 try to switch frames on us, and the selected window will
2654 Since this event came from a macro, it would be misleading to
2655 leave internal_last_event_frame set to wherever the last
2656 real event came from. Normally, a switch-frame event selects
2657 internal_last_event_frame after each command is read, but
2658 events read from a macro should never cause a new frame to be
2660 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2662 /* Exit the macro if we are at the end.
2663 Also, some things replace the macro with t
2664 to force an early exit. */
2665 if (EQ (Vexecuting_kbd_macro
, Qt
)
2666 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2672 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2673 if (STRINGP (Vexecuting_kbd_macro
)
2674 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2675 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2677 executing_kbd_macro_index
++;
2682 if (!NILP (unread_switch_frame
))
2684 c
= unread_switch_frame
;
2685 unread_switch_frame
= Qnil
;
2687 /* This event should make it into this_command_keys, and get echoed
2688 again, so we do not set `reread'. */
2692 /* if redisplay was requested */
2693 if (commandflag
>= 0)
2695 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2697 /* If there is pending input, process any events which are not
2698 user-visible, such as X selection_request events. */
2700 || detect_input_pending_run_timers (0))
2701 swallow_events (0); /* may clear input_pending */
2703 /* Redisplay if no pending input. */
2704 while (!input_pending
)
2706 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2707 redisplay_preserve_echo_area (5);
2712 /* Normal case: no input arrived during redisplay. */
2715 /* Input arrived and pre-empted redisplay.
2716 Process any events which are not user-visible. */
2718 /* If that cleared input_pending, try again to redisplay. */
2721 /* Prevent the redisplay we just did
2722 from messing up echoing of the input after the prompt. */
2723 if (commandflag
== 0 && echo_current
)
2724 echo_message_buffer
= echo_area_buffer
[0];
2728 /* Message turns off echoing unless more keystrokes turn it on again.
2730 The code in 20.x for the condition was
2732 1. echo_area_glyphs && *echo_area_glyphs
2733 2. && echo_area_glyphs != current_kboard->echobuf
2734 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2736 (1) means there's a current message displayed
2738 (2) means it's not the message from echoing from the current
2741 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2742 is set to a non-null value. This is done in read_char and it is
2743 set to echo_area_glyphs after a call to echo_char. That means
2744 ok_to_echo_at_next_pause is either null or
2745 current_kboard->echobuf with the appropriate current_kboard at
2748 So, condition (3) means in clear text ok_to_echo_at_next_pause
2749 must be either null, or the current message isn't from echoing at
2750 all, or it's from echoing from a different kboard than the
2753 if (/* There currently is something in the echo area. */
2754 !NILP (echo_area_buffer
[0])
2755 && (/* And it's either not from echoing. */
2756 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2757 /* Or it's an echo from a different kboard. */
2758 || echo_kboard
!= current_kboard
2759 /* Or we explicitly allow overwriting whatever there is. */
2760 || ok_to_echo_at_next_pause
== NULL
))
2765 /* Try reading a character via menu prompting in the minibuf.
2766 Try this before the sit-for, because the sit-for
2767 would do the wrong thing if we are supposed to do
2768 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2769 after a mouse event so don't try a minibuf menu. */
2771 if (nmaps
> 0 && INTERACTIVE
2772 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2773 /* Don't bring up a menu if we already have another event. */
2774 && NILP (Vunread_command_events
)
2775 && unread_command_char
< 0
2776 && !detect_input_pending_run_timers (0))
2778 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2780 if (INTEGERP (c
) && XINT (c
) == -2)
2781 return c
; /* wrong_kboard_jmpbuf */
2785 key_already_recorded
= 1;
2790 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2791 We will do that below, temporarily for short sections of code,
2792 when appropriate. local_getcjmp must be in effect
2793 around any call to sit_for or kbd_buffer_get_event;
2794 it *must not* be in effect when we call redisplay. */
2796 jmpcount
= SPECPDL_INDEX ();
2797 if (_setjmp (local_getcjmp
))
2799 /* Handle quits while reading the keyboard. */
2800 /* We must have saved the outer value of getcjmp here,
2801 so restore it now. */
2802 restore_getcjmp (save_jump
);
2803 unbind_to (jmpcount
, Qnil
);
2804 XSETINT (c
, quit_char
);
2805 internal_last_event_frame
= selected_frame
;
2806 Vlast_event_frame
= internal_last_event_frame
;
2807 /* If we report the quit char as an event,
2808 don't do so more than once. */
2809 if (!NILP (Vinhibit_quit
))
2813 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2814 if (kb
!= current_kboard
)
2816 Lisp_Object link
= kb
->kbd_queue
;
2817 /* We shouldn't get here if we were in single-kboard mode! */
2822 while (CONSP (XCDR (link
)))
2824 if (!NILP (XCDR (link
)))
2828 kb
->kbd_queue
= Fcons (c
, Qnil
);
2830 XSETCDR (link
, Fcons (c
, Qnil
));
2831 kb
->kbd_queue_has_data
= 1;
2832 current_kboard
= kb
;
2833 /* This is going to exit from read_char
2834 so we had better get rid of this frame's stuff. */
2836 return make_number (-2); /* wrong_kboard_jmpbuf */
2842 /* Start idle timers if no time limit is supplied. We don't do it
2843 if a time limit is supplied to avoid an infinite recursion in the
2844 situation where an idle timer calls `sit-for'. */
2847 timer_start_idle ();
2849 /* If in middle of key sequence and minibuffer not active,
2850 start echoing if enough time elapses. */
2852 if (minibuf_level
== 0
2854 && !current_kboard
->immediate_echo
2855 && this_command_key_count
> 0
2857 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2858 && NILP (Fzerop (Vecho_keystrokes
))
2859 && (/* No message. */
2860 NILP (echo_area_buffer
[0])
2861 /* Or empty message. */
2862 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2863 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2864 /* Or already echoing from same kboard. */
2865 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2866 /* Or not echoing before and echoing allowed. */
2867 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2869 /* After a mouse event, start echoing right away.
2870 This is because we are probably about to display a menu,
2871 and we don't want to delay before doing so. */
2872 if (EVENT_HAS_PARAMETERS (prev_event
))
2878 save_getcjmp (save_jump
);
2879 restore_getcjmp (local_getcjmp
);
2880 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2881 restore_getcjmp (save_jump
);
2883 && ! CONSP (Vunread_command_events
))
2888 /* Maybe auto save due to number of keystrokes. */
2890 if (commandflag
!= 0
2891 && auto_save_interval
> 0
2892 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2893 && !detect_input_pending_run_timers (0))
2895 Fdo_auto_save (Qnil
, Qnil
);
2896 /* Hooks can actually change some buffers in auto save. */
2900 /* Try reading using an X menu.
2901 This is never confused with reading using the minibuf
2902 because the recursive call of read_char in read_char_minibuf_menu_prompt
2903 does not pass on any keymaps. */
2905 if (nmaps
> 0 && INTERACTIVE
2906 && !NILP (prev_event
)
2907 && EVENT_HAS_PARAMETERS (prev_event
)
2908 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2909 && !EQ (XCAR (prev_event
), Qtool_bar
)
2910 /* Don't bring up a menu if we already have another event. */
2911 && NILP (Vunread_command_events
)
2912 && unread_command_char
< 0)
2914 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2916 /* Now that we have read an event, Emacs is not idle. */
2923 /* Maybe autosave and/or garbage collect due to idleness. */
2925 if (INTERACTIVE
&& NILP (c
))
2927 int delay_level
, buffer_size
;
2929 /* Slow down auto saves logarithmically in size of current buffer,
2930 and garbage collect while we're at it. */
2931 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2932 last_non_minibuf_size
= Z
- BEG
;
2933 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2935 while (buffer_size
> 64)
2936 delay_level
++, buffer_size
-= buffer_size
>> 2;
2937 if (delay_level
< 4) delay_level
= 4;
2938 /* delay_level is 4 for files under around 50k, 7 at 100k,
2939 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2941 /* Auto save if enough time goes by without input. */
2942 if (commandflag
!= 0
2943 && num_nonmacro_input_events
> last_auto_save
2944 && INTEGERP (Vauto_save_timeout
)
2945 && XINT (Vauto_save_timeout
) > 0)
2948 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2950 save_getcjmp (save_jump
);
2951 restore_getcjmp (local_getcjmp
);
2952 tem0
= sit_for (make_number (timeout
), 1, 1);
2953 restore_getcjmp (save_jump
);
2956 && ! CONSP (Vunread_command_events
))
2958 Fdo_auto_save (Qnil
, Qnil
);
2960 /* If we have auto-saved and there is still no input
2961 available, garbage collect if there has been enough
2962 consing going on to make it worthwhile. */
2963 if (!detect_input_pending_run_timers (0)
2964 && consing_since_gc
> gc_cons_threshold
/ 2)
2965 Fgarbage_collect ();
2972 /* Notify the caller if an autosave hook, or a timer, sentinel or
2973 filter in the sit_for calls above have changed the current
2974 kboard. This could happen if they use the minibuffer or start a
2975 recursive edit, like the fancy splash screen in server.el's
2976 filter. If this longjmp wasn't here, read_key_sequence would
2977 interpret the next key sequence using the wrong translation
2978 tables and function keymaps. */
2979 if (NILP (c
) && current_kboard
!= orig_kboard
)
2982 return make_number (-2); /* wrong_kboard_jmpbuf */
2985 /* If this has become non-nil here, it has been set by a timer
2986 or sentinel or filter. */
2987 if (CONSP (Vunread_command_events
))
2989 c
= XCAR (Vunread_command_events
);
2990 Vunread_command_events
= XCDR (Vunread_command_events
);
2993 /* Read something from current KBOARD's side queue, if possible. */
2997 if (current_kboard
->kbd_queue_has_data
)
2999 if (!CONSP (current_kboard
->kbd_queue
))
3001 c
= XCAR (current_kboard
->kbd_queue
);
3002 current_kboard
->kbd_queue
3003 = XCDR (current_kboard
->kbd_queue
);
3004 if (NILP (current_kboard
->kbd_queue
))
3005 current_kboard
->kbd_queue_has_data
= 0;
3006 input_pending
= readable_events (0);
3007 if (EVENT_HAS_PARAMETERS (c
)
3008 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3009 internal_last_event_frame
= XCAR (XCDR (c
));
3010 Vlast_event_frame
= internal_last_event_frame
;
3014 /* If current_kboard's side queue is empty check the other kboards.
3015 If one of them has data that we have not yet seen here,
3016 switch to it and process the data waiting for it.
3018 Note: if the events queued up for another kboard
3019 have already been seen here, and therefore are not a complete command,
3020 the kbd_queue_has_data field is 0, so we skip that kboard here.
3021 That's to avoid an infinite loop switching between kboards here. */
3022 if (NILP (c
) && !single_kboard
)
3025 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3026 if (kb
->kbd_queue_has_data
)
3028 current_kboard
= kb
;
3029 /* This is going to exit from read_char
3030 so we had better get rid of this frame's stuff. */
3032 return make_number (-2); /* wrong_kboard_jmpbuf */
3040 /* Finally, we read from the main queue,
3041 and if that gives us something we can't use yet, we put it on the
3042 appropriate side queue and try again. */
3051 EMACS_GET_TIME (now
);
3052 if (EMACS_TIME_GE (now
, *end_time
))
3056 /* Actually read a character, waiting if necessary. */
3057 save_getcjmp (save_jump
);
3058 restore_getcjmp (local_getcjmp
);
3060 timer_start_idle ();
3061 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3062 restore_getcjmp (save_jump
);
3064 if (! NILP (c
) && (kb
!= current_kboard
))
3066 Lisp_Object link
= kb
->kbd_queue
;
3069 while (CONSP (XCDR (link
)))
3071 if (!NILP (XCDR (link
)))
3075 kb
->kbd_queue
= Fcons (c
, Qnil
);
3077 XSETCDR (link
, Fcons (c
, Qnil
));
3078 kb
->kbd_queue_has_data
= 1;
3082 current_kboard
= kb
;
3083 /* This is going to exit from read_char
3084 so we had better get rid of this frame's stuff. */
3086 return make_number (-2);
3090 /* Terminate Emacs in batch mode if at eof. */
3091 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3092 Fkill_emacs (make_number (1));
3096 /* Add in any extra modifiers, where appropriate. */
3097 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3098 || ((extra_keyboard_modifiers
& 0177) < ' '
3099 && (extra_keyboard_modifiers
& 0177) != 0))
3100 XSETINT (c
, make_ctrl_char (XINT (c
)));
3102 /* Transfer any other modifier bits directly from
3103 extra_keyboard_modifiers to c. Ignore the actual character code
3104 in the low 16 bits of extra_keyboard_modifiers. */
3105 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3116 if (commandflag
>= 0
3117 && !input_pending
&& !detect_input_pending_run_timers (0))
3125 /* Buffer switch events are only for internal wakeups
3126 so don't show them to the user.
3127 Also, don't record a key if we already did. */
3128 if (BUFFERP (c
) || key_already_recorded
)
3131 /* Process special events within read_char
3132 and loop around to read another event. */
3135 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3140 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3141 int was_locked
= single_kboard
;
3142 int count
= SPECPDL_INDEX ();
3143 record_single_kboard_state ();
3146 last_input_event
= c
;
3147 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3149 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3150 /* We stopped being idle for this event; undo that. This
3151 prevents automatic window selection (under
3152 mouse_autoselect_window from acting as a real input event, for
3153 example banishing the mouse under mouse-avoidance-mode. */
3154 timer_resume_idle ();
3156 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3157 /* Resume allowing input from any kboard, if that was true before. */
3159 any_kboard_state ();
3160 unbind_to (count
, Qnil
);
3166 /* Handle things that only apply to characters. */
3169 /* If kbd_buffer_get_event gave us an EOF, return that. */
3173 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3174 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3175 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3176 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3177 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3181 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3182 /* nil in keyboard-translate-table means no translation. */
3188 /* If this event is a mouse click in the menu bar,
3189 return just menu-bar for now. Modify the mouse click event
3190 so we won't do this twice, then queue it up. */
3191 if (EVENT_HAS_PARAMETERS (c
)
3193 && CONSP (EVENT_START (c
))
3194 && CONSP (XCDR (EVENT_START (c
))))
3198 posn
= POSN_POSN (EVENT_START (c
));
3199 /* Handle menu-bar events:
3200 insert the dummy prefix event `menu-bar'. */
3201 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3203 /* Change menu-bar to (menu-bar) as the event "position". */
3204 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3207 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3212 /* Store these characters into recent_keys, the dribble file if any,
3213 and the keyboard macro being defined, if any. */
3215 if (! NILP (also_record
))
3216 record_char (also_record
);
3218 /* Wipe the echo area.
3219 But first, if we are about to use an input method,
3220 save the echo area contents for it to refer to. */
3222 && ! NILP (Vinput_method_function
)
3223 && (unsigned) XINT (c
) >= ' '
3224 && (unsigned) XINT (c
) != 127
3225 && (unsigned) XINT (c
) < 256)
3227 previous_echo_area_message
= Fcurrent_message ();
3228 Vinput_method_previous_message
= previous_echo_area_message
;
3231 /* Now wipe the echo area, except for help events which do their
3232 own stuff with the echo area. */
3234 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3235 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3237 if (!NILP (echo_area_buffer
[0]))
3238 safe_run_hooks (Qecho_area_clear_hook
);
3239 clear_message (1, 0);
3242 reread_for_input_method
:
3244 /* Pass this to the input method, if appropriate. */
3246 && ! NILP (Vinput_method_function
)
3247 /* Don't run the input method within a key sequence,
3248 after the first event of the key sequence. */
3249 && NILP (prev_event
)
3250 && (unsigned) XINT (c
) >= ' '
3251 && (unsigned) XINT (c
) != 127
3252 && (unsigned) XINT (c
) < 256)
3255 int key_count
, key_count_reset
;
3256 struct gcpro gcpro1
;
3257 int count
= SPECPDL_INDEX ();
3259 /* Save the echo status. */
3260 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3261 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3262 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3263 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3266 if (before_command_restore_flag
)
3268 this_command_key_count
= before_command_key_count_1
;
3269 if (this_command_key_count
< this_single_command_key_start
)
3270 this_single_command_key_start
= this_command_key_count
;
3271 echo_truncate (before_command_echo_length_1
);
3272 before_command_restore_flag
= 0;
3276 /* Save the this_command_keys status. */
3277 key_count
= this_command_key_count
;
3278 key_count_reset
= this_command_key_count_reset
;
3281 keys
= Fcopy_sequence (this_command_keys
);
3286 /* Clear out this_command_keys. */
3287 this_command_key_count
= 0;
3288 this_command_key_count_reset
= 0;
3290 /* Now wipe the echo area. */
3291 if (!NILP (echo_area_buffer
[0]))
3292 safe_run_hooks (Qecho_area_clear_hook
);
3293 clear_message (1, 0);
3296 /* If we are not reading a key sequence,
3297 never use the echo area. */
3300 specbind (Qinput_method_use_echo_area
, Qt
);
3303 /* Call the input method. */
3304 tem
= call1 (Vinput_method_function
, c
);
3306 tem
= unbind_to (count
, tem
);
3308 /* Restore the saved echoing state
3309 and this_command_keys state. */
3310 this_command_key_count
= key_count
;
3311 this_command_key_count_reset
= key_count_reset
;
3313 this_command_keys
= keys
;
3316 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3317 current_kboard
->echo_string
= saved_echo_string
;
3318 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3319 if (saved_immediate_echo
)
3324 /* The input method can return no events. */
3327 /* Bring back the previous message, if any. */
3328 if (! NILP (previous_echo_area_message
))
3329 message_with_string ("%s", previous_echo_area_message
, 0);
3332 /* It returned one event or more. */
3334 Vunread_post_input_method_events
3335 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3340 /* Display help if not echoing. */
3341 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3343 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3344 Lisp_Object help
, object
, position
, window
, tem
;
3346 tem
= Fcdr (XCDR (c
));
3349 window
= Fcar (tem
);
3351 object
= Fcar (tem
);
3353 position
= Fcar (tem
);
3355 show_help_echo (help
, window
, object
, position
, 0);
3357 /* We stopped being idle for this event; undo that. */
3359 timer_resume_idle ();
3363 if ((! reread
|| this_command_key_count
== 0
3364 || this_command_key_count_reset
)
3368 /* Don't echo mouse motion events. */
3369 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3370 && NILP (Fzerop (Vecho_keystrokes
))
3371 && ! (EVENT_HAS_PARAMETERS (c
)
3372 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3375 if (! NILP (also_record
))
3376 echo_char (also_record
);
3377 /* Once we reread a character, echoing can happen
3378 the next time we pause to read a new one. */
3379 ok_to_echo_at_next_pause
= current_kboard
;
3382 /* Record this character as part of the current key. */
3383 add_command_key (c
);
3384 if (! NILP (also_record
))
3385 add_command_key (also_record
);
3388 last_input_event
= c
;
3391 /* Process the help character specially if enabled */
3392 if (!NILP (Vhelp_form
) && help_char_p (c
))
3395 count
= SPECPDL_INDEX ();
3397 help_form_saved_window_configs
3398 = Fcons (Fcurrent_window_configuration (Qnil
),
3399 help_form_saved_window_configs
);
3400 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3402 tem0
= Feval (Vhelp_form
);
3404 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3409 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3410 if (EVENT_HAS_PARAMETERS (c
)
3411 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3412 XSETCAR (help_form_saved_window_configs
, Qnil
);
3414 while (BUFFERP (c
));
3415 /* Remove the help from the frame */
3416 unbind_to (count
, Qnil
);
3419 if (EQ (c
, make_number (040)))
3423 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3424 while (BUFFERP (c
));
3433 /* Record a key that came from a mouse menu.
3434 Record it for echoing, for this-command-keys, and so on. */
3440 /* Wipe the echo area. */
3441 clear_message (1, 0);
3446 before_command_key_count
= this_command_key_count
;
3447 before_command_echo_length
= echo_length ();
3450 /* Don't echo mouse motion events. */
3451 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3452 && NILP (Fzerop (Vecho_keystrokes
)))
3456 /* Once we reread a character, echoing can happen
3457 the next time we pause to read a new one. */
3458 ok_to_echo_at_next_pause
= 0;
3461 /* Record this character as part of the current key. */
3462 add_command_key (c
);
3464 /* Re-reading in the middle of a command */
3465 last_input_event
= c
;
3469 /* Return 1 if should recognize C as "the help character". */
3477 if (EQ (c
, Vhelp_char
))
3479 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3480 if (EQ (c
, XCAR (tail
)))
3485 /* Record the input event C in various ways. */
3493 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3495 /* To avoid filling recent_keys with help-echo and mouse-movement
3496 events, we filter out repeated help-echo events, only store the
3497 first and last in a series of mouse-movement events, and don't
3498 store repeated help-echo events which are only separated by
3499 mouse-movement events. */
3501 Lisp_Object ev1
, ev2
, ev3
;
3504 if ((ix1
= recent_keys_index
- 1) < 0)
3505 ix1
= NUM_RECENT_KEYS
- 1;
3506 ev1
= AREF (recent_keys
, ix1
);
3508 if ((ix2
= ix1
- 1) < 0)
3509 ix2
= NUM_RECENT_KEYS
- 1;
3510 ev2
= AREF (recent_keys
, ix2
);
3512 if ((ix3
= ix2
- 1) < 0)
3513 ix3
= NUM_RECENT_KEYS
- 1;
3514 ev3
= AREF (recent_keys
, ix3
);
3516 if (EQ (XCAR (c
), Qhelp_echo
))
3518 /* Don't record `help-echo' in recent_keys unless it shows some help
3519 message, and a different help than the previously recorded
3521 Lisp_Object help
, last_help
;
3523 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3524 if (!STRINGP (help
))
3526 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3527 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3529 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3530 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3531 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3533 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3534 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3535 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3536 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3539 else if (EQ (XCAR (c
), Qmouse_movement
))
3541 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3542 So additional mouse movement events replace the last element. */
3543 Lisp_Object last_window
, window
;
3545 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3546 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3547 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3548 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3549 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3551 ASET (recent_keys
, ix1
, c
);
3557 store_kbd_macro_char (c
);
3562 ASET (recent_keys
, recent_keys_index
, c
);
3563 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3564 recent_keys_index
= 0;
3566 else if (recorded
< 0)
3568 /* We need to remove one or two events from recent_keys.
3569 To do this, we simply put nil at those events and move the
3570 recent_keys_index backwards over those events. Usually,
3571 users will never see those nil events, as they will be
3572 overwritten by the command keys entered to see recent_keys
3575 while (recorded
++ < 0 && total_keys
> 0)
3577 if (total_keys
< NUM_RECENT_KEYS
)
3579 if (--recent_keys_index
< 0)
3580 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3581 ASET (recent_keys
, recent_keys_index
, Qnil
);
3585 num_nonmacro_input_events
++;
3587 /* Write c to the dribble file. If c is a lispy event, write
3588 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3589 If you, dear reader, have a better idea, you've got the source. :-) */
3595 if (XUINT (c
) < 0x100)
3596 putc (XINT (c
), dribble
);
3598 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3602 Lisp_Object dribblee
;
3604 /* If it's a structured event, take the event header. */
3605 dribblee
= EVENT_HEAD (c
);
3607 if (SYMBOLP (dribblee
))
3609 putc ('<', dribble
);
3610 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3611 SBYTES (SYMBOL_NAME (dribblee
)),
3613 putc ('>', dribble
);
3626 struct buffer
*old
= current_buffer
;
3627 Fprinc (object
, Qnil
);
3628 set_buffer_internal (XBUFFER (Vstandard_output
));
3629 call0 (intern ("help-mode"));
3630 set_buffer_internal (old
);
3634 /* Copy out or in the info on where C-g should throw to.
3635 This is used when running Lisp code from within get_char,
3636 in case get_char is called recursively.
3637 See read_process_output. */
3643 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3647 restore_getcjmp (temp
)
3650 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3653 /* Low level keyboard/mouse input.
3654 kbd_buffer_store_event places events in kbd_buffer, and
3655 kbd_buffer_get_event retrieves them. */
3657 /* Return true if there are any events in the queue that read-char
3658 would return. If this returns false, a read-char would block. */
3660 readable_events (flags
)
3664 /* Check whether a D-Bus message has arrived. */
3665 if (xd_pending_messages () > 0)
3667 #endif /* HAVE_DBUS */
3669 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3672 /* If the buffer contains only FOCUS_IN_EVENT events, and
3673 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3674 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3676 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3677 #ifdef USE_TOOLKIT_SCROLL_BARS
3678 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3682 struct input_event
*event
;
3684 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3691 #ifdef USE_TOOLKIT_SCROLL_BARS
3692 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3694 event
->kind
== FOCUS_IN_EVENT
)
3695 #ifdef USE_TOOLKIT_SCROLL_BARS
3696 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3697 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3698 && event
->part
== scroll_bar_handle
3699 && event
->modifiers
== 0)
3704 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3707 while (event
!= kbd_store_ptr
);
3713 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3714 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3715 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3720 if (current_kboard
->kbd_queue_has_data
)
3726 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3727 if (kb
->kbd_queue_has_data
)
3733 /* Set this for debugging, to have a way to get out */
3737 event_to_kboard (event
)
3738 struct input_event
*event
;
3741 frame
= event
->frame_or_window
;
3743 frame
= XCAR (frame
);
3744 else if (WINDOWP (frame
))
3745 frame
= WINDOW_FRAME (XWINDOW (frame
));
3747 /* There are still some events that don't set this field.
3748 For now, just ignore the problem.
3749 Also ignore dead frames here. */
3750 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3753 return FRAME_KBOARD (XFRAME (frame
));
3757 Lisp_Object Vthrow_on_input
;
3759 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3762 kbd_buffer_store_event (event
)
3763 register struct input_event
*event
;
3765 kbd_buffer_store_event_hold (event
, 0);
3768 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3770 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3771 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3772 Else, if EVENT is a quit event, store the quit event
3773 in HOLD_QUIT, and return (thus ignoring further events).
3775 This is used in read_avail_input to postpone the processing
3776 of the quit event until all subsequent input events have been
3777 parsed (and discarded).
3781 kbd_buffer_store_event_hold (event
, hold_quit
)
3782 register struct input_event
*event
;
3783 struct input_event
*hold_quit
;
3785 if (event
->kind
== NO_EVENT
)
3788 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3791 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3793 register int c
= event
->code
& 0377;
3795 if (event
->modifiers
& ctrl_modifier
)
3796 c
= make_ctrl_char (c
);
3798 c
|= (event
->modifiers
3799 & (meta_modifier
| alt_modifier
3800 | hyper_modifier
| super_modifier
));
3804 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3805 struct input_event
*sp
;
3807 if (single_kboard
&& kb
!= current_kboard
)
3810 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3811 Fcons (make_number (c
), Qnil
));
3812 kb
->kbd_queue_has_data
= 1;
3813 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3815 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3818 if (event_to_kboard (sp
) == kb
)
3820 sp
->kind
= NO_EVENT
;
3821 sp
->frame_or_window
= Qnil
;
3830 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3834 /* If this results in a quit_char being returned to Emacs as
3835 input, set Vlast_event_frame properly. If this doesn't
3836 get returned to Emacs as an event, the next event read
3837 will set Vlast_event_frame again, so this is safe to do. */
3841 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3843 focus
= event
->frame_or_window
;
3844 internal_last_event_frame
= focus
;
3845 Vlast_event_frame
= focus
;
3848 last_event_timestamp
= event
->timestamp
;
3849 handle_interrupt ();
3853 if (c
&& c
== stop_character
)
3859 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3860 Just ignore the second one. */
3861 else if (event
->kind
== BUFFER_SWITCH_EVENT
3862 && kbd_fetch_ptr
!= kbd_store_ptr
3863 && ((kbd_store_ptr
== kbd_buffer
3864 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3865 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3868 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3869 kbd_store_ptr
= kbd_buffer
;
3871 /* Don't let the very last slot in the buffer become full,
3872 since that would make the two pointers equal,
3873 and that is indistinguishable from an empty buffer.
3874 Discard the event if it would fill the last slot. */
3875 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3877 *kbd_store_ptr
= *event
;
3881 /* If we're inside while-no-input, and this event qualifies
3882 as input, set quit-flag to cause an interrupt. */
3883 if (!NILP (Vthrow_on_input
)
3884 && event
->kind
!= FOCUS_IN_EVENT
3885 && event
->kind
!= HELP_EVENT
3886 && event
->kind
!= DEICONIFY_EVENT
)
3888 Vquit_flag
= Vthrow_on_input
;
3889 /* If we're inside a function that wants immediate quits,
3891 if (immediate_quit
&& NILP (Vinhibit_quit
))
3901 /* Put an input event back in the head of the event queue. */
3904 kbd_buffer_unget_event (event
)
3905 register struct input_event
*event
;
3907 if (kbd_fetch_ptr
== kbd_buffer
)
3908 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3910 /* Don't let the very last slot in the buffer become full, */
3911 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3914 *kbd_fetch_ptr
= *event
;
3919 /* Generate HELP_EVENT input_events in BUFP which has room for
3920 SIZE events. If there's not enough room in BUFP, ignore this
3923 HELP is the help form.
3925 FRAME is the frame on which the help is generated. OBJECT is the
3926 Lisp object where the help was found (a buffer, a string, an
3927 overlay, or nil if neither from a string nor from a buffer. POS is
3928 the position within OBJECT where the help was found.
3930 Value is the number of input_events generated. */
3933 gen_help_event (help
, frame
, window
, object
, pos
)
3934 Lisp_Object help
, frame
, object
, window
;
3937 struct input_event event
;
3941 event
.kind
= HELP_EVENT
;
3942 event
.frame_or_window
= frame
;
3944 event
.x
= WINDOWP (window
) ? window
: frame
;
3947 kbd_buffer_store_event (&event
);
3951 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3954 kbd_buffer_store_help_event (frame
, help
)
3955 Lisp_Object frame
, help
;
3957 struct input_event event
;
3959 event
.kind
= HELP_EVENT
;
3960 event
.frame_or_window
= frame
;
3965 kbd_buffer_store_event (&event
);
3969 /* Discard any mouse events in the event buffer by setting them to
3972 discard_mouse_events ()
3974 struct input_event
*sp
;
3975 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3977 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3980 if (sp
->kind
== MOUSE_CLICK_EVENT
3981 || sp
->kind
== WHEEL_EVENT
3982 || sp
->kind
== HORIZ_WHEEL_EVENT
3984 || sp
->kind
== GPM_CLICK_EVENT
3986 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3988 sp
->kind
= NO_EVENT
;
3994 /* Return non-zero if there are any real events waiting in the event
3995 buffer, not counting `NO_EVENT's.
3997 If DISCARD is non-zero, discard NO_EVENT events at the front of
3998 the input queue, possibly leaving the input queue empty if there
3999 are no real input events. */
4002 kbd_buffer_events_waiting (discard
)
4005 struct input_event
*sp
;
4007 for (sp
= kbd_fetch_ptr
;
4008 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4011 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4018 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4022 /* Clear input event EVENT. */
4026 struct input_event
*event
;
4028 event
->kind
= NO_EVENT
;
4032 /* Read one event from the event buffer, waiting if necessary.
4033 The value is a Lisp object representing the event.
4034 The value is nil for an event that should be ignored,
4035 or that was handled here.
4036 We always read and discard one event. */
4039 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4041 int *used_mouse_menu
;
4042 EMACS_TIME
*end_time
;
4048 /* In case we are running as a daemon, only do this before
4049 detaching from the terminal. */
4050 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
4054 *kbp
= current_kboard
;
4058 /* Wait until there is input available. */
4061 /* Break loop if there's an unread command event. Needed in
4062 moused window autoselection which uses a timer to insert such
4064 if (CONSP (Vunread_command_events
))
4067 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4069 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4070 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4074 /* If the quit flag is set, then read_char will return
4075 quit_char, so that counts as "available input." */
4076 if (!NILP (Vquit_flag
))
4077 quit_throw_to_read_char ();
4079 /* One way or another, wait until input is available; then, if
4080 interrupt handlers have not read it, read it now. */
4082 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4086 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4088 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4089 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4094 EMACS_TIME duration
;
4095 EMACS_GET_TIME (duration
);
4096 if (EMACS_TIME_GE (duration
, *end_time
))
4097 return Qnil
; /* finished waiting */
4100 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4101 wait_reading_process_output (EMACS_SECS (duration
),
4102 EMACS_USECS (duration
),
4103 -1, 1, Qnil
, NULL
, 0);
4107 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4109 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4110 /* Pass 1 for EXPECT since we just waited to have input. */
4111 read_avail_input (1);
4114 if (CONSP (Vunread_command_events
))
4117 first
= XCAR (Vunread_command_events
);
4118 Vunread_command_events
= XCDR (Vunread_command_events
);
4119 *kbp
= current_kboard
;
4123 /* At this point, we know that there is a readable event available
4124 somewhere. If the event queue is empty, then there must be a
4125 mouse movement enabled and available. */
4126 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4128 struct input_event
*event
;
4130 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4134 last_event_timestamp
= event
->timestamp
;
4136 *kbp
= event_to_kboard (event
);
4138 *kbp
= current_kboard
; /* Better than returning null ptr? */
4142 /* These two kinds of events get special handling
4143 and don't actually appear to the command loop.
4144 We return nil for them. */
4145 if (event
->kind
== SELECTION_REQUEST_EVENT
4146 || event
->kind
== SELECTION_CLEAR_EVENT
)
4149 struct input_event copy
;
4151 /* Remove it from the buffer before processing it,
4152 since otherwise swallow_events will see it
4153 and process it again. */
4155 kbd_fetch_ptr
= event
+ 1;
4156 input_pending
= readable_events (0);
4157 x_handle_selection_event (©
);
4159 /* We're getting selection request events, but we don't have
4165 #if defined (HAVE_NS)
4166 else if (event
->kind
== NS_TEXT_EVENT
)
4168 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4169 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4171 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4172 kbd_fetch_ptr
= event
+ 1;
4173 if (used_mouse_menu
)
4174 *used_mouse_menu
= 1;
4178 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4179 || defined (HAVE_NS)
4180 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4182 /* Make an event (delete-frame (FRAME)). */
4183 obj
= Fcons (event
->frame_or_window
, Qnil
);
4184 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4185 kbd_fetch_ptr
= event
+ 1;
4188 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4189 || defined (HAVE_NS)
4190 else if (event
->kind
== ICONIFY_EVENT
)
4192 /* Make an event (iconify-frame (FRAME)). */
4193 obj
= Fcons (event
->frame_or_window
, Qnil
);
4194 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4195 kbd_fetch_ptr
= event
+ 1;
4197 else if (event
->kind
== DEICONIFY_EVENT
)
4199 /* Make an event (make-frame-visible (FRAME)). */
4200 obj
= Fcons (event
->frame_or_window
, Qnil
);
4201 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4202 kbd_fetch_ptr
= event
+ 1;
4205 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4207 /* The value doesn't matter here; only the type is tested. */
4208 XSETBUFFER (obj
, current_buffer
);
4209 kbd_fetch_ptr
= event
+ 1;
4211 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4212 || defined(HAVE_NS) || defined (USE_GTK)
4213 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4215 kbd_fetch_ptr
= event
+ 1;
4216 input_pending
= readable_events (0);
4217 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4218 x_activate_menubar (XFRAME (event
->frame_or_window
));
4221 #if defined (WINDOWSNT)
4222 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4224 /* Make an event (language-change (FRAME CHARSET LCID)). */
4225 obj
= Fcons (event
->frame_or_window
, Qnil
);
4226 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4227 kbd_fetch_ptr
= event
+ 1;
4230 else if (event
->kind
== SAVE_SESSION_EVENT
)
4232 obj
= Fcons (Qsave_session
, Qnil
);
4233 kbd_fetch_ptr
= event
+ 1;
4235 /* Just discard these, by returning nil.
4236 With MULTI_KBOARD, these events are used as placeholders
4237 when we need to randomly delete events from the queue.
4238 (They shouldn't otherwise be found in the buffer,
4239 but on some machines it appears they do show up
4240 even without MULTI_KBOARD.) */
4241 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4242 mouse events during a popup-menu call. */
4243 else if (event
->kind
== NO_EVENT
)
4244 kbd_fetch_ptr
= event
+ 1;
4245 else if (event
->kind
== HELP_EVENT
)
4247 Lisp_Object object
, position
, help
, frame
, window
;
4249 frame
= event
->frame_or_window
;
4250 object
= event
->arg
;
4251 position
= make_number (event
->code
);
4254 clear_event (event
);
4256 kbd_fetch_ptr
= event
+ 1;
4257 if (!WINDOWP (window
))
4259 obj
= Fcons (Qhelp_echo
,
4260 list5 (frame
, help
, window
, object
, position
));
4262 else if (event
->kind
== FOCUS_IN_EVENT
)
4264 /* Notification of a FocusIn event. The frame receiving the
4265 focus is in event->frame_or_window. Generate a
4266 switch-frame event if necessary. */
4267 Lisp_Object frame
, focus
;
4269 frame
= event
->frame_or_window
;
4270 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4274 if (!EQ (frame
, internal_last_event_frame
)
4275 && !EQ (frame
, selected_frame
))
4276 obj
= make_lispy_switch_frame (frame
);
4277 internal_last_event_frame
= frame
;
4278 kbd_fetch_ptr
= event
+ 1;
4281 else if (event
->kind
== DBUS_EVENT
)
4283 obj
= make_lispy_event (event
);
4284 kbd_fetch_ptr
= event
+ 1;
4289 /* If this event is on a different frame, return a switch-frame this
4290 time, and leave the event in the queue for next time. */
4294 frame
= event
->frame_or_window
;
4296 frame
= XCAR (frame
);
4297 else if (WINDOWP (frame
))
4298 frame
= WINDOW_FRAME (XWINDOW (frame
));
4300 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4304 if (! EQ (frame
, internal_last_event_frame
)
4305 && !EQ (frame
, selected_frame
))
4306 obj
= make_lispy_switch_frame (frame
);
4307 internal_last_event_frame
= frame
;
4309 /* If we didn't decide to make a switch-frame event, go ahead
4310 and build a real event from the queue entry. */
4314 obj
= make_lispy_event (event
);
4316 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4317 || defined(HAVE_NS) || defined (USE_GTK)
4318 /* If this was a menu selection, then set the flag to inhibit
4319 writing to last_nonmenu_event. Don't do this if the event
4320 we're returning is (menu-bar), though; that indicates the
4321 beginning of the menu sequence, and we might as well leave
4322 that as the `event with parameters' for this selection. */
4324 && !EQ (event
->frame_or_window
, event
->arg
)
4325 && (event
->kind
== MENU_BAR_EVENT
4326 || event
->kind
== TOOL_BAR_EVENT
))
4327 *used_mouse_menu
= 1;
4330 /* certain system events are non-key events */
4332 && event
->kind
== NS_NONKEY_EVENT
)
4333 *used_mouse_menu
= 1;
4336 /* Wipe out this event, to catch bugs. */
4337 clear_event (event
);
4338 kbd_fetch_ptr
= event
+ 1;
4342 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4343 /* Try generating a mouse motion event. */
4344 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4346 FRAME_PTR f
= some_mouse_moved ();
4347 Lisp_Object bar_window
;
4348 enum scroll_bar_part part
;
4352 *kbp
= current_kboard
;
4353 /* Note that this uses F to determine which terminal to look at.
4354 If there is no valid info, it does not store anything
4355 so x remains nil. */
4358 /* XXX Can f or mouse_position_hook be NULL here? */
4359 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4360 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4361 &part
, &x
, &y
, &time
);
4365 /* Decide if we should generate a switch-frame event. Don't
4366 generate switch-frame events for motion outside of all Emacs
4372 frame
= FRAME_FOCUS_FRAME (f
);
4374 XSETFRAME (frame
, f
);
4376 if (! EQ (frame
, internal_last_event_frame
)
4377 && !EQ (frame
, selected_frame
))
4378 obj
= make_lispy_switch_frame (frame
);
4379 internal_last_event_frame
= frame
;
4382 /* If we didn't decide to make a switch-frame event, go ahead and
4383 return a mouse-motion event. */
4384 if (!NILP (x
) && NILP (obj
))
4385 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4387 #endif /* HAVE_MOUSE || HAVE GPM */
4389 /* We were promised by the above while loop that there was
4390 something for us to read! */
4393 input_pending
= readable_events (0);
4395 Vlast_event_frame
= internal_last_event_frame
;
4400 /* Process any events that are not user-visible,
4401 then return, without reading any user-visible events. */
4404 swallow_events (do_display
)
4409 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4411 struct input_event
*event
;
4413 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4417 last_event_timestamp
= event
->timestamp
;
4419 /* These two kinds of events get special handling
4420 and don't actually appear to the command loop. */
4421 if (event
->kind
== SELECTION_REQUEST_EVENT
4422 || event
->kind
== SELECTION_CLEAR_EVENT
)
4425 struct input_event copy
;
4427 /* Remove it from the buffer before processing it,
4428 since otherwise swallow_events called recursively could see it
4429 and process it again. */
4431 kbd_fetch_ptr
= event
+ 1;
4432 input_pending
= readable_events (0);
4433 x_handle_selection_event (©
);
4435 /* We're getting selection request events, but we don't have
4444 old_timers_run
= timers_run
;
4445 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4447 if (timers_run
!= old_timers_run
&& do_display
)
4448 redisplay_preserve_echo_area (7);
4451 /* Record the start of when Emacs is idle,
4452 for the sake of running idle-time timers. */
4459 /* If we are already in the idle state, do nothing. */
4460 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4463 EMACS_GET_TIME (timer_idleness_start_time
);
4465 timer_last_idleness_start_time
= timer_idleness_start_time
;
4467 /* Mark all idle-time timers as once again candidates for running. */
4468 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4472 timer
= XCAR (timers
);
4474 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4476 XVECTOR (timer
)->contents
[0] = Qnil
;
4480 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4485 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4488 /* Resume idle timer from last idle start time. */
4491 timer_resume_idle ()
4493 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4496 timer_idleness_start_time
= timer_last_idleness_start_time
;
4499 /* This is only for debugging. */
4500 struct input_event last_timer_event
;
4502 /* List of elisp functions to call, delayed because they were generated in
4503 a context where Elisp could not be safely run (e.g. redisplay, signal,
4504 ...). Each element has the form (FUN . ARGS). */
4505 Lisp_Object pending_funcalls
;
4507 extern Lisp_Object Qapply
;
4509 /* Check whether a timer has fired. To prevent larger problems we simply
4510 disregard elements that are not proper timers. Do not make a circular
4511 timer list for the time being.
4513 Returns the number of seconds to wait until the next timer fires. If a
4514 timer is triggering now, return zero seconds.
4515 If no timer is active, return -1 seconds.
4517 If a timer is ripe, we run it, with quitting turned off.
4519 DO_IT_NOW is now ignored. It used to mean that we should
4520 run the timer directly instead of queueing a timer-event.
4521 Now we always run timers directly. */
4524 timer_check (do_it_now
)
4527 EMACS_TIME nexttime
;
4528 EMACS_TIME now
, idleness_now
;
4529 Lisp_Object timers
, idle_timers
, chosen_timer
;
4530 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4532 EMACS_SET_SECS (nexttime
, -1);
4533 EMACS_SET_USECS (nexttime
, -1);
4535 /* Always consider the ordinary timers. */
4536 timers
= Vtimer_list
;
4537 /* Consider the idle timers only if Emacs is idle. */
4538 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4539 idle_timers
= Vtimer_idle_list
;
4542 chosen_timer
= Qnil
;
4543 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4545 /* First run the code that was delayed. */
4546 while (CONSP (pending_funcalls
))
4548 Lisp_Object funcall
= XCAR (pending_funcalls
);
4549 pending_funcalls
= XCDR (pending_funcalls
);
4550 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4553 if (CONSP (timers
) || CONSP (idle_timers
))
4555 EMACS_GET_TIME (now
);
4556 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4557 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4560 while (CONSP (timers
) || CONSP (idle_timers
))
4562 Lisp_Object
*vector
;
4563 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4564 EMACS_TIME timer_time
, idle_timer_time
;
4565 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4567 /* Skip past invalid timers and timers already handled. */
4570 timer
= XCAR (timers
);
4571 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4573 timers
= XCDR (timers
);
4576 vector
= XVECTOR (timer
)->contents
;
4578 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4579 || !INTEGERP (vector
[3])
4580 || ! NILP (vector
[0]))
4582 timers
= XCDR (timers
);
4586 if (!NILP (idle_timers
))
4588 timer
= XCAR (idle_timers
);
4589 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4591 idle_timers
= XCDR (idle_timers
);
4594 vector
= XVECTOR (timer
)->contents
;
4596 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4597 || !INTEGERP (vector
[3])
4598 || ! NILP (vector
[0]))
4600 idle_timers
= XCDR (idle_timers
);
4605 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4606 based on the next ordinary timer.
4607 TIMER_DIFFERENCE is the distance in time from NOW to when
4608 this timer becomes ripe (negative if it's already ripe). */
4611 timer
= XCAR (timers
);
4612 vector
= XVECTOR (timer
)->contents
;
4613 EMACS_SET_SECS (timer_time
,
4614 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4615 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4616 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4619 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4620 based on the next idle timer. */
4621 if (!NILP (idle_timers
))
4623 idle_timer
= XCAR (idle_timers
);
4624 vector
= XVECTOR (idle_timer
)->contents
;
4625 EMACS_SET_SECS (idle_timer_time
,
4626 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4627 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4628 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4631 /* Decide which timer is the next timer,
4632 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4633 Also step down the list where we found that timer. */
4635 if (! NILP (timers
) && ! NILP (idle_timers
))
4638 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4639 if (EMACS_TIME_NEG_P (temp
))
4641 chosen_timer
= timer
;
4642 timers
= XCDR (timers
);
4643 difference
= timer_difference
;
4647 chosen_timer
= idle_timer
;
4648 idle_timers
= XCDR (idle_timers
);
4649 difference
= idle_timer_difference
;
4652 else if (! NILP (timers
))
4654 chosen_timer
= timer
;
4655 timers
= XCDR (timers
);
4656 difference
= timer_difference
;
4660 chosen_timer
= idle_timer
;
4661 idle_timers
= XCDR (idle_timers
);
4662 difference
= idle_timer_difference
;
4664 vector
= XVECTOR (chosen_timer
)->contents
;
4666 /* If timer is ripe, run it if it hasn't been run. */
4667 if (EMACS_TIME_NEG_P (difference
)
4668 || (EMACS_SECS (difference
) == 0
4669 && EMACS_USECS (difference
) == 0))
4671 if (NILP (vector
[0]))
4673 int count
= SPECPDL_INDEX ();
4674 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4676 /* Mark the timer as triggered to prevent problems if the lisp
4677 code fails to reschedule it right. */
4680 specbind (Qinhibit_quit
, Qt
);
4682 call1 (Qtimer_event_handler
, chosen_timer
);
4683 Vdeactivate_mark
= old_deactivate_mark
;
4685 unbind_to (count
, Qnil
);
4687 /* Since we have handled the event,
4688 we don't need to tell the caller to wake up and do it. */
4692 /* When we encounter a timer that is still waiting,
4693 return the amount of time to wait before it is ripe. */
4700 /* No timers are pending in the future. */
4701 /* Return 0 if we generated an event, and -1 if not. */
4706 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4707 doc
: /* Return the current length of Emacs idleness, or nil.
4708 The value when Emacs is idle is a list of three integers. The first has
4709 the most significant 16 bits of the seconds, while the second has the least
4710 significant 16 bits. The third integer gives the microsecond count.
4712 The value when Emacs is not idle is nil.
4714 The microsecond count is zero on systems that do not provide
4715 resolution finer than a second. */)
4718 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4720 EMACS_TIME now
, idleness_now
;
4722 EMACS_GET_TIME (now
);
4723 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4725 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4726 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4727 make_number (EMACS_USECS (idleness_now
)));
4733 /* Caches for modify_event_symbol. */
4734 static Lisp_Object accent_key_syms
;
4735 static Lisp_Object func_key_syms
;
4736 static Lisp_Object mouse_syms
;
4737 static Lisp_Object wheel_syms
;
4738 static Lisp_Object drag_n_drop_syms
;
4740 /* This is a list of keysym codes for special "accent" characters.
4741 It parallels lispy_accent_keys. */
4743 static int lispy_accent_codes
[] =
4745 #ifdef XK_dead_circumflex
4750 #ifdef XK_dead_grave
4755 #ifdef XK_dead_tilde
4760 #ifdef XK_dead_diaeresis
4765 #ifdef XK_dead_macron
4770 #ifdef XK_dead_degree
4775 #ifdef XK_dead_acute
4780 #ifdef XK_dead_cedilla
4785 #ifdef XK_dead_breve
4790 #ifdef XK_dead_ogonek
4795 #ifdef XK_dead_caron
4800 #ifdef XK_dead_doubleacute
4801 XK_dead_doubleacute
,
4805 #ifdef XK_dead_abovedot
4810 #ifdef XK_dead_abovering
4820 #ifdef XK_dead_belowdot
4825 #ifdef XK_dead_voiced_sound
4826 XK_dead_voiced_sound
,
4830 #ifdef XK_dead_semivoiced_sound
4831 XK_dead_semivoiced_sound
,
4847 /* This is a list of Lisp names for special "accent" characters.
4848 It parallels lispy_accent_codes. */
4850 static char *lispy_accent_keys
[] =
4868 "dead-voiced-sound",
4869 "dead-semivoiced-sound",
4875 #define FUNCTION_KEY_OFFSET 0x0
4877 char *lispy_function_keys
[] =
4881 0, /* VK_LBUTTON 0x01 */
4882 0, /* VK_RBUTTON 0x02 */
4883 "cancel", /* VK_CANCEL 0x03 */
4884 0, /* VK_MBUTTON 0x04 */
4886 0, 0, 0, /* 0x05 .. 0x07 */
4888 "backspace", /* VK_BACK 0x08 */
4889 "tab", /* VK_TAB 0x09 */
4891 0, 0, /* 0x0A .. 0x0B */
4893 "clear", /* VK_CLEAR 0x0C */
4894 "return", /* VK_RETURN 0x0D */
4896 0, 0, /* 0x0E .. 0x0F */
4898 0, /* VK_SHIFT 0x10 */
4899 0, /* VK_CONTROL 0x11 */
4900 0, /* VK_MENU 0x12 */
4901 "pause", /* VK_PAUSE 0x13 */
4902 "capslock", /* VK_CAPITAL 0x14 */
4903 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4905 "junja", /* VK_JUNJA 0x17 */
4906 "final", /* VK_FINAL 0x18 */
4907 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4909 "escape", /* VK_ESCAPE 0x1B */
4910 "convert", /* VK_CONVERT 0x1C */
4911 "non-convert", /* VK_NONCONVERT 0x1D */
4912 "accept", /* VK_ACCEPT 0x1E */
4913 "mode-change", /* VK_MODECHANGE 0x1F */
4914 0, /* VK_SPACE 0x20 */
4915 "prior", /* VK_PRIOR 0x21 */
4916 "next", /* VK_NEXT 0x22 */
4917 "end", /* VK_END 0x23 */
4918 "home", /* VK_HOME 0x24 */
4919 "left", /* VK_LEFT 0x25 */
4920 "up", /* VK_UP 0x26 */
4921 "right", /* VK_RIGHT 0x27 */
4922 "down", /* VK_DOWN 0x28 */
4923 "select", /* VK_SELECT 0x29 */
4924 "print", /* VK_PRINT 0x2A */
4925 "execute", /* VK_EXECUTE 0x2B */
4926 "snapshot", /* VK_SNAPSHOT 0x2C */
4927 "insert", /* VK_INSERT 0x2D */
4928 "delete", /* VK_DELETE 0x2E */
4929 "help", /* VK_HELP 0x2F */
4931 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4933 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4935 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4937 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4939 0, 0, 0, 0, 0, 0, 0, 0, 0,
4940 0, 0, 0, 0, 0, 0, 0, 0, 0,
4941 0, 0, 0, 0, 0, 0, 0, 0,
4943 "lwindow", /* VK_LWIN 0x5B */
4944 "rwindow", /* VK_RWIN 0x5C */
4945 "apps", /* VK_APPS 0x5D */
4948 "kp-0", /* VK_NUMPAD0 0x60 */
4949 "kp-1", /* VK_NUMPAD1 0x61 */
4950 "kp-2", /* VK_NUMPAD2 0x62 */
4951 "kp-3", /* VK_NUMPAD3 0x63 */
4952 "kp-4", /* VK_NUMPAD4 0x64 */
4953 "kp-5", /* VK_NUMPAD5 0x65 */
4954 "kp-6", /* VK_NUMPAD6 0x66 */
4955 "kp-7", /* VK_NUMPAD7 0x67 */
4956 "kp-8", /* VK_NUMPAD8 0x68 */
4957 "kp-9", /* VK_NUMPAD9 0x69 */
4958 "kp-multiply", /* VK_MULTIPLY 0x6A */
4959 "kp-add", /* VK_ADD 0x6B */
4960 "kp-separator", /* VK_SEPARATOR 0x6C */
4961 "kp-subtract", /* VK_SUBTRACT 0x6D */
4962 "kp-decimal", /* VK_DECIMAL 0x6E */
4963 "kp-divide", /* VK_DIVIDE 0x6F */
4964 "f1", /* VK_F1 0x70 */
4965 "f2", /* VK_F2 0x71 */
4966 "f3", /* VK_F3 0x72 */
4967 "f4", /* VK_F4 0x73 */
4968 "f5", /* VK_F5 0x74 */
4969 "f6", /* VK_F6 0x75 */
4970 "f7", /* VK_F7 0x76 */
4971 "f8", /* VK_F8 0x77 */
4972 "f9", /* VK_F9 0x78 */
4973 "f10", /* VK_F10 0x79 */
4974 "f11", /* VK_F11 0x7A */
4975 "f12", /* VK_F12 0x7B */
4976 "f13", /* VK_F13 0x7C */
4977 "f14", /* VK_F14 0x7D */
4978 "f15", /* VK_F15 0x7E */
4979 "f16", /* VK_F16 0x7F */
4980 "f17", /* VK_F17 0x80 */
4981 "f18", /* VK_F18 0x81 */
4982 "f19", /* VK_F19 0x82 */
4983 "f20", /* VK_F20 0x83 */
4984 "f21", /* VK_F21 0x84 */
4985 "f22", /* VK_F22 0x85 */
4986 "f23", /* VK_F23 0x86 */
4987 "f24", /* VK_F24 0x87 */
4989 0, 0, 0, 0, /* 0x88 .. 0x8B */
4990 0, 0, 0, 0, /* 0x8C .. 0x8F */
4992 "kp-numlock", /* VK_NUMLOCK 0x90 */
4993 "scroll", /* VK_SCROLL 0x91 */
4994 /* Not sure where the following block comes from.
4995 Windows headers have NEC and Fujitsu specific keys in
4996 this block, but nothing generic. */
4997 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4998 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4999 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
5000 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5001 "kp-end", /* VK_NUMPAD_END 0x96 */
5002 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5003 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5004 "kp-up", /* VK_NUMPAD_UP 0x99 */
5005 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5006 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5007 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5008 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5010 0, 0, /* 0x9E .. 0x9F */
5013 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5014 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5015 * No other API or message will distinguish left and right keys this way.
5020 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5021 to enable them selectively, and gives access to a few more functions.
5022 See lispy_multimedia_keys below. */
5023 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5024 0, 0, 0, /* 0xAD .. 0xAF Volume */
5025 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5026 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5028 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5029 0, 0, 0, 0, 0, 0, 0, 0, 0,
5031 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5032 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5033 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5036 "ax", /* VK_OEM_AX 0xE1 */
5037 0, /* VK_OEM_102 0xE2 */
5038 "ico-help", /* VK_ICO_HELP 0xE3 */
5039 "ico-00", /* VK_ICO_00 0xE4 */
5040 0, /* VK_PROCESSKEY 0xE5 */
5041 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5042 "packet", /* VK_PACKET 0xE7 */
5044 "reset", /* VK_OEM_RESET 0xE9 */
5045 "jump", /* VK_OEM_JUMP 0xEA */
5046 "oem-pa1", /* VK_OEM_PA1 0xEB */
5047 "oem-pa2", /* VK_OEM_PA2 0xEC */
5048 "oem-pa3", /* VK_OEM_PA3 0xED */
5049 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5050 "cusel", /* VK_OEM_CUSEL 0xEF */
5051 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5052 "finish", /* VK_OEM_FINISH 0xF1 */
5053 "copy", /* VK_OEM_COPY 0xF2 */
5054 "auto", /* VK_OEM_AUTO 0xF3 */
5055 "enlw", /* VK_OEM_ENLW 0xF4 */
5056 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5057 "attn", /* VK_ATTN 0xF6 */
5058 "crsel", /* VK_CRSEL 0xF7 */
5059 "exsel", /* VK_EXSEL 0xF8 */
5060 "ereof", /* VK_EREOF 0xF9 */
5061 "play", /* VK_PLAY 0xFA */
5062 "zoom", /* VK_ZOOM 0xFB */
5063 "noname", /* VK_NONAME 0xFC */
5064 "pa1", /* VK_PA1 0xFD */
5065 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5069 /* Some of these duplicate the "Media keys" on newer keyboards,
5070 but they are delivered to the application in a different way. */
5071 static char *lispy_multimedia_keys
[] =
5079 "browser-favorites",
5116 "toggle-dictate-command",
5122 "media-fast-forward",
5125 "media-channel-down"
5128 #else /* not HAVE_NTGUI */
5130 /* This should be dealt with in XTread_socket now, and that doesn't
5131 depend on the client system having the Kana syms defined. See also
5132 the XK_kana_A case below. */
5135 static char *lispy_kana_keys
[] =
5137 /* X Keysym value */
5138 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5139 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5140 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5141 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5142 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5143 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5144 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5145 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5146 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5147 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5148 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5149 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5150 "kana-i", "kana-u", "kana-e", "kana-o",
5151 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5152 "prolongedsound", "kana-A", "kana-I", "kana-U",
5153 "kana-E", "kana-O", "kana-KA", "kana-KI",
5154 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5155 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5156 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5157 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5158 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5159 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5160 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5161 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5162 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5163 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5164 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5165 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5167 #endif /* XK_kana_A */
5170 #define FUNCTION_KEY_OFFSET 0xff00
5172 /* You'll notice that this table is arranged to be conveniently
5173 indexed by X Windows keysym values. */
5174 static char *lispy_function_keys
[] =
5176 /* X Keysym value */
5178 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5179 "backspace", "tab", "linefeed", "clear",
5181 0, 0, 0, "pause", /* 0xff10...1f */
5182 0, 0, 0, 0, 0, 0, 0, "escape",
5184 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5185 "romaji", "hiragana", "katakana", "hiragana-katakana",
5186 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5187 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5188 "eisu-toggle", /* 0xff30...3f */
5189 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5190 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5192 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5193 "down", "prior", "next", "end",
5194 "begin", 0, 0, 0, 0, 0, 0, 0,
5195 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5206 "break", /* 0xff6b */
5209 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5210 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5211 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5212 0, 0, 0, 0, 0, 0, 0, 0,
5213 "kp-tab", /* 0xff89 */
5215 "kp-enter", /* 0xff8d */
5217 "kp-f1", /* 0xff91 */
5221 "kp-home", /* 0xff95 */
5226 "kp-prior", /* kp-page-up */
5227 "kp-next", /* kp-page-down */
5233 0, 0, 0, 0, 0, 0, 0, 0, 0,
5234 "kp-multiply", /* 0xffaa */
5239 "kp-divide", /* 0xffaf */
5240 "kp-0", /* 0xffb0 */
5241 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5244 "kp-equal", /* 0xffbd */
5245 "f1", /* 0xffbe */ /* IsFunctionKey */
5247 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5248 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5249 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5250 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5251 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5252 0, 0, 0, 0, 0, 0, 0, 0,
5253 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5254 0, 0, 0, 0, 0, 0, 0, "delete"
5257 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5258 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5260 static char *iso_lispy_function_keys
[] =
5262 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5263 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5264 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5265 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5266 "iso-lefttab", /* 0xfe20 */
5267 "iso-move-line-up", "iso-move-line-down",
5268 "iso-partial-line-up", "iso-partial-line-down",
5269 "iso-partial-space-left", "iso-partial-space-right",
5270 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5271 "iso-release-margin-left", "iso-release-margin-right",
5272 "iso-release-both-margins",
5273 "iso-fast-cursor-left", "iso-fast-cursor-right",
5274 "iso-fast-cursor-up", "iso-fast-cursor-down",
5275 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5276 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5279 #endif /* not HAVE_NTGUI */
5281 Lisp_Object Vlispy_mouse_stem
;
5283 static char *lispy_wheel_names
[] =
5285 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5288 /* drag-n-drop events are generated when a set of selected files are
5289 dragged from another application and dropped onto an Emacs window. */
5290 static char *lispy_drag_n_drop_names
[] =
5295 /* Scroll bar parts. */
5296 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5297 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5298 Lisp_Object Qtop
, Qratio
;
5300 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5301 Lisp_Object
*scroll_bar_parts
[] = {
5302 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5303 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5306 /* A vector, indexed by button number, giving the down-going location
5307 of currently depressed buttons, both scroll bar and non-scroll bar.
5309 The elements have the form
5310 (BUTTON-NUMBER MODIFIER-MASK . REST)
5311 where REST is the cdr of a position as it would be reported in the event.
5313 The make_lispy_event function stores positions here to tell the
5314 difference between click and drag events, and to store the starting
5315 location to be included in drag events. */
5317 static Lisp_Object button_down_location
;
5319 /* Information about the most recent up-going button event: Which
5320 button, what location, and what time. */
5322 static int last_mouse_button
;
5323 static int last_mouse_x
;
5324 static int last_mouse_y
;
5325 static unsigned long button_down_time
;
5327 /* The maximum time between clicks to make a double-click, or Qnil to
5328 disable double-click detection, or Qt for no time limit. */
5330 Lisp_Object Vdouble_click_time
;
5332 /* Maximum number of pixels the mouse may be moved between clicks
5333 to make a double-click. */
5335 EMACS_INT double_click_fuzz
;
5337 /* The number of clicks in this multiple-click. */
5339 int double_click_count
;
5341 /* Return position of a mouse click or wheel event */
5344 make_lispy_position (f
, x
, y
, time
)
5350 enum window_part part
;
5351 Lisp_Object posn
= Qnil
;
5352 Lisp_Object extra_info
= Qnil
;
5355 /* Set `window' to the window under frame pixel coordinates (x,y) */
5357 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5358 &part
, &wx
, &wy
, 0);
5362 if (WINDOWP (window
))
5364 /* It's a click in window window at frame coordinates (x,y) */
5365 struct window
*w
= XWINDOW (window
);
5366 Lisp_Object string_info
= Qnil
;
5367 int textpos
= -1, rx
= -1, ry
= -1;
5368 int dx
= -1, dy
= -1;
5369 int width
= -1, height
= -1;
5370 Lisp_Object object
= Qnil
;
5372 /* Set event coordinates to window-relative coordinates
5373 for constructing the Lisp event below. */
5377 if (part
== ON_TEXT
)
5379 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5381 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5383 /* Mode line or header line. Look for a string under
5384 the mouse that may have a `local-map' property. */
5388 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5390 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5391 &object
, &dx
, &dy
, &width
, &height
);
5392 if (STRINGP (string
))
5393 string_info
= Fcons (string
, make_number (charpos
));
5394 if (w
== XWINDOW (selected_window
)
5395 && current_buffer
== XBUFFER (w
->buffer
))
5398 textpos
= XMARKER (w
->pointm
)->charpos
;
5400 else if (part
== ON_VERTICAL_BORDER
)
5402 posn
= Qvertical_line
;
5407 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5412 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5414 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5415 &object
, &dx
, &dy
, &width
, &height
);
5416 if (STRINGP (string
))
5417 string_info
= Fcons (string
, make_number (charpos
));
5418 if (part
== ON_LEFT_MARGIN
)
5421 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5423 else if (part
== ON_LEFT_FRINGE
)
5425 posn
= Qleft_fringe
;
5428 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5430 : window_box_width (w
, LEFT_MARGIN_AREA
));
5433 else if (part
== ON_RIGHT_FRINGE
)
5435 posn
= Qright_fringe
;
5438 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5439 + window_box_width (w
, TEXT_AREA
)
5440 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5441 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5447 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5448 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5453 Lisp_Object string2
, object2
= Qnil
;
5454 struct display_pos p
;
5456 int width2
, height2
;
5457 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5458 &object2
, &dx2
, &dy2
,
5460 textpos
= CHARPOS (p
.pos
);
5461 if (rx
< 0) rx
= wx
;
5462 if (ry
< 0) ry
= wy
;
5463 if (dx
< 0) dx
= dx2
;
5464 if (dy
< 0) dy
= dy2
;
5465 if (width
< 0) width
= width2
;
5466 if (height
< 0) height
= height2
;
5470 posn
= make_number (textpos
);
5471 if (STRINGP (string2
))
5472 string_info
= Fcons (string2
,
5473 make_number (CHARPOS (p
.string_pos
)));
5479 #ifdef HAVE_WINDOW_SYSTEM
5480 if (IMAGEP (object
))
5482 Lisp_Object image_map
, hotspot
;
5483 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5485 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5487 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5488 posn
= XCAR (hotspot
);
5493 extra_info
= Fcons (object
,
5494 Fcons (Fcons (make_number (dx
),
5496 Fcons (Fcons (make_number (width
),
5497 make_number (height
)),
5501 extra_info
= Fcons (string_info
,
5502 Fcons (make_number (textpos
),
5503 Fcons (Fcons (make_number (rx
),
5509 XSETFRAME (window
, f
);
5514 XSETFASTINT (*x
, 0);
5515 XSETFASTINT (*y
, 0);
5518 return Fcons (window
,
5520 Fcons (Fcons (*x
, *y
),
5521 Fcons (make_number (time
),
5525 /* Given a struct input_event, build the lisp event which represents
5526 it. If EVENT is 0, build a mouse movement event from the mouse
5527 movement buffer, which should have a movement event in it.
5529 Note that events must be passed to this function in the order they
5530 are received; this function stores the location of button presses
5531 in order to build drag events when the button is released. */
5534 make_lispy_event (event
)
5535 struct input_event
*event
;
5539 switch (SWITCH_ENUM_CAST (event
->kind
))
5541 /* A simple keystroke. */
5542 case ASCII_KEYSTROKE_EVENT
:
5543 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5545 Lisp_Object lispy_c
;
5546 int c
= event
->code
;
5547 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5550 eassert (c
== event
->code
);
5551 /* Turn ASCII characters into control characters
5553 if (event
->modifiers
& ctrl_modifier
)
5555 c
= make_ctrl_char (c
);
5556 event
->modifiers
&= ~ctrl_modifier
;
5560 /* Add in the other modifier bits. The shift key was taken care
5561 of by the X code. */
5562 c
|= (event
->modifiers
5563 & (meta_modifier
| alt_modifier
5564 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5565 /* Distinguish Shift-SPC from SPC. */
5566 if ((event
->code
) == 040
5567 && event
->modifiers
& shift_modifier
)
5568 c
|= shift_modifier
;
5569 button_down_time
= 0;
5570 XSETFASTINT (lispy_c
, c
);
5575 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5576 except that they are non-key events (last-nonmenu-event is nil). */
5577 case NS_NONKEY_EVENT
:
5580 /* A function key. The symbol may need to have modifier prefixes
5582 case NON_ASCII_KEYSTROKE_EVENT
:
5583 button_down_time
= 0;
5585 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5586 if (event
->code
== lispy_accent_codes
[i
])
5587 return modify_event_symbol (i
,
5589 Qfunction_key
, Qnil
,
5590 lispy_accent_keys
, &accent_key_syms
,
5591 (sizeof (lispy_accent_keys
)
5592 / sizeof (lispy_accent_keys
[0])));
5596 if (event
->code
>= 0x400 && event
->code
< 0x500)
5597 return modify_event_symbol (event
->code
- 0x400,
5598 event
->modifiers
& ~shift_modifier
,
5599 Qfunction_key
, Qnil
,
5600 lispy_kana_keys
, &func_key_syms
,
5601 (sizeof (lispy_kana_keys
)
5602 / sizeof (lispy_kana_keys
[0])));
5603 #endif /* XK_kana_A */
5606 #ifdef ISO_FUNCTION_KEY_OFFSET
5607 if (event
->code
< FUNCTION_KEY_OFFSET
5608 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5609 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5611 Qfunction_key
, Qnil
,
5612 iso_lispy_function_keys
, &func_key_syms
,
5613 (sizeof (iso_lispy_function_keys
)
5614 / sizeof (iso_lispy_function_keys
[0])));
5617 /* Handle system-specific or unknown keysyms. */
5618 if (event
->code
& (1 << 28)
5619 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5620 || (event
->code
- FUNCTION_KEY_OFFSET
5621 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5622 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5624 /* We need to use an alist rather than a vector as the cache
5625 since we can't make a vector long enuf. */
5626 if (NILP (current_kboard
->system_key_syms
))
5627 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5628 return modify_event_symbol (event
->code
,
5631 current_kboard
->Vsystem_key_alist
,
5632 0, ¤t_kboard
->system_key_syms
,
5636 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5638 Qfunction_key
, Qnil
,
5639 lispy_function_keys
, &func_key_syms
,
5640 (sizeof (lispy_function_keys
)
5641 / sizeof (lispy_function_keys
[0])));
5644 case MULTIMEDIA_KEY_EVENT
:
5645 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5646 / sizeof (lispy_multimedia_keys
[0]))
5647 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5649 return modify_event_symbol (event
->code
, event
->modifiers
,
5650 Qfunction_key
, Qnil
,
5651 lispy_multimedia_keys
, &func_key_syms
,
5652 (sizeof (lispy_multimedia_keys
)
5653 / sizeof (lispy_multimedia_keys
[0])));
5659 /* A mouse click. Figure out where it is, decide whether it's
5660 a press, click or drag, and build the appropriate structure. */
5661 case MOUSE_CLICK_EVENT
:
5662 #ifndef USE_TOOLKIT_SCROLL_BARS
5663 case SCROLL_BAR_CLICK_EVENT
:
5666 int button
= event
->code
;
5668 Lisp_Object position
;
5669 Lisp_Object
*start_pos_ptr
;
5670 Lisp_Object start_pos
;
5674 /* Build the position as appropriate for this mouse click. */
5675 if (event
->kind
== MOUSE_CLICK_EVENT
)
5677 struct frame
*f
= XFRAME (event
->frame_or_window
);
5678 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5682 /* Ignore mouse events that were made on frame that
5683 have been deleted. */
5684 if (! FRAME_LIVE_P (f
))
5687 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5688 /* EVENT->x and EVENT->y are frame-relative pixel
5689 coordinates at this place. Under old redisplay, COLUMN
5690 and ROW are set to frame relative glyph coordinates
5691 which are then used to determine whether this click is
5692 in a menu (non-toolkit version). */
5693 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5694 &column
, &row
, NULL
, 1);
5696 /* In the non-toolkit version, clicks on the menu bar
5697 are ordinary button events in the event buffer.
5698 Distinguish them, and invoke the menu.
5700 (In the toolkit version, the toolkit handles the menu bar
5701 and Emacs doesn't know about it until after the user
5702 makes a selection.) */
5703 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5704 && (event
->modifiers
& down_modifier
))
5706 Lisp_Object items
, item
;
5711 /* Activate the menu bar on the down event. If the
5712 up event comes in before the menu code can deal with it,
5714 if (! (event
->modifiers
& down_modifier
))
5718 /* Find the menu bar item under `column'. */
5720 items
= FRAME_MENU_BAR_ITEMS (f
);
5721 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5723 Lisp_Object pos
, string
;
5724 string
= AREF (items
, i
+ 1);
5725 pos
= AREF (items
, i
+ 3);
5728 if (column
>= XINT (pos
)
5729 && column
< XINT (pos
) + SCHARS (string
))
5731 item
= AREF (items
, i
);
5736 /* ELisp manual 2.4b says (x y) are window relative but
5737 code says they are frame-relative. */
5739 = Fcons (event
->frame_or_window
,
5741 Fcons (Fcons (event
->x
, event
->y
),
5742 Fcons (make_number (event
->timestamp
),
5745 return Fcons (item
, Fcons (position
, Qnil
));
5747 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5749 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5752 #ifndef USE_TOOLKIT_SCROLL_BARS
5755 /* It's a scrollbar click. */
5757 Lisp_Object portion_whole
;
5760 window
= event
->frame_or_window
;
5761 portion_whole
= Fcons (event
->x
, event
->y
);
5762 part
= *scroll_bar_parts
[(int) event
->part
];
5766 Fcons (Qvertical_scroll_bar
,
5767 Fcons (portion_whole
,
5768 Fcons (make_number (event
->timestamp
),
5769 Fcons (part
, Qnil
)))));
5771 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5773 if (button
>= ASIZE (button_down_location
))
5775 button_down_location
= larger_vector (button_down_location
,
5777 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5780 start_pos_ptr
= &AREF (button_down_location
, button
);
5781 start_pos
= *start_pos_ptr
;
5782 *start_pos_ptr
= Qnil
;
5785 /* On window-system frames, use the value of
5786 double-click-fuzz as is. On other frames, interpret it
5787 as a multiple of 1/8 characters. */
5791 if (WINDOWP (event
->frame_or_window
))
5792 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5793 else if (FRAMEP (event
->frame_or_window
))
5794 f
= XFRAME (event
->frame_or_window
);
5798 if (FRAME_WINDOW_P (f
))
5799 fuzz
= double_click_fuzz
;
5801 fuzz
= double_click_fuzz
/ 8;
5803 is_double
= (button
== last_mouse_button
5804 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5805 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5806 && button_down_time
!= 0
5807 && (EQ (Vdouble_click_time
, Qt
)
5808 || (INTEGERP (Vdouble_click_time
)
5809 && ((int)(event
->timestamp
- button_down_time
)
5810 < XINT (Vdouble_click_time
)))));
5813 last_mouse_button
= button
;
5814 last_mouse_x
= XINT (event
->x
);
5815 last_mouse_y
= XINT (event
->y
);
5817 /* If this is a button press, squirrel away the location, so
5818 we can decide later whether it was a click or a drag. */
5819 if (event
->modifiers
& down_modifier
)
5823 double_click_count
++;
5824 event
->modifiers
|= ((double_click_count
> 2)
5829 double_click_count
= 1;
5830 button_down_time
= event
->timestamp
;
5831 *start_pos_ptr
= Fcopy_alist (position
);
5832 ignore_mouse_drag_p
= 0;
5835 /* Now we're releasing a button - check the co-ordinates to
5836 see if this was a click or a drag. */
5837 else if (event
->modifiers
& up_modifier
)
5839 /* If we did not see a down before this up, ignore the up.
5840 Probably this happened because the down event chose a
5841 menu item. It would be an annoyance to treat the
5842 release of the button that chose the menu item as a
5845 if (!CONSP (start_pos
))
5848 event
->modifiers
&= ~up_modifier
;
5849 #if 0 /* Formerly we treated an up with no down as a click event. */
5850 if (!CONSP (start_pos
))
5851 event
->modifiers
|= click_modifier
;
5856 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5858 /* The third element of every position
5859 should be the (x,y) pair. */
5860 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5862 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5864 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5865 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5868 if (ignore_mouse_drag_p
)
5870 event
->modifiers
|= click_modifier
;
5871 ignore_mouse_drag_p
= 0;
5873 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5874 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5875 /* Maybe the mouse has moved a lot, caused scrolling, and
5876 eventually ended up at the same screen position (but
5877 not buffer position) in which case it is a drag, not
5879 /* FIXME: OTOH if the buffer position has changed
5880 because of a timer or process filter rather than
5881 because of mouse movement, it should be considered as
5882 a click. But mouse-drag-region completely ignores
5883 this case and it hasn't caused any real problem, so
5884 it's probably OK to ignore it as well. */
5885 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5886 /* Mouse hasn't moved (much). */
5887 event
->modifiers
|= click_modifier
;
5890 button_down_time
= 0;
5891 event
->modifiers
|= drag_modifier
;
5894 /* Don't check is_double; treat this as multiple
5895 if the down-event was multiple. */
5896 if (double_click_count
> 1)
5897 event
->modifiers
|= ((double_click_count
> 2)
5903 /* Every mouse event should either have the down_modifier or
5904 the up_modifier set. */
5908 /* Get the symbol we should use for the mouse click. */
5911 head
= modify_event_symbol (button
,
5913 Qmouse_click
, Vlispy_mouse_stem
,
5916 XVECTOR (mouse_syms
)->size
);
5917 if (event
->modifiers
& drag_modifier
)
5922 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5925 Fcons (make_number (double_click_count
),
5935 case HORIZ_WHEEL_EVENT
:
5937 Lisp_Object position
;
5940 /* Build the position as appropriate for this mouse click. */
5941 struct frame
*f
= XFRAME (event
->frame_or_window
);
5943 /* Ignore wheel events that were made on frame that have been
5945 if (! FRAME_LIVE_P (f
))
5948 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5951 /* Set double or triple modifiers to indicate the wheel speed. */
5953 /* On window-system frames, use the value of
5954 double-click-fuzz as is. On other frames, interpret it
5955 as a multiple of 1/8 characters. */
5960 if (WINDOWP (event
->frame_or_window
))
5961 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5962 else if (FRAMEP (event
->frame_or_window
))
5963 f
= XFRAME (event
->frame_or_window
);
5967 if (FRAME_WINDOW_P (f
))
5968 fuzz
= double_click_fuzz
;
5970 fuzz
= double_click_fuzz
/ 8;
5972 is_double
= (last_mouse_button
< 0
5973 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5974 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5975 && button_down_time
!= 0
5976 && (EQ (Vdouble_click_time
, Qt
)
5977 || (INTEGERP (Vdouble_click_time
)
5978 && ((int)(event
->timestamp
- button_down_time
)
5979 < XINT (Vdouble_click_time
)))));
5982 double_click_count
++;
5983 event
->modifiers
|= ((double_click_count
> 2)
5989 double_click_count
= 1;
5990 event
->modifiers
|= click_modifier
;
5993 button_down_time
= event
->timestamp
;
5994 /* Use a negative value to distinguish wheel from mouse button. */
5995 last_mouse_button
= -1;
5996 last_mouse_x
= XINT (event
->x
);
5997 last_mouse_y
= XINT (event
->y
);
6003 if (event
->modifiers
& up_modifier
)
6005 /* Emit a wheel-up event. */
6006 event
->modifiers
&= ~up_modifier
;
6009 else if (event
->modifiers
& down_modifier
)
6011 /* Emit a wheel-down event. */
6012 event
->modifiers
&= ~down_modifier
;
6016 /* Every wheel event should either have the down_modifier or
6017 the up_modifier set. */
6020 if (event
->kind
== HORIZ_WHEEL_EVENT
)
6023 /* Get the symbol we should use for the wheel event. */
6024 head
= modify_event_symbol (symbol_num
,
6030 ASIZE (wheel_syms
));
6033 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6036 Fcons (make_number (double_click_count
),
6045 #ifdef USE_TOOLKIT_SCROLL_BARS
6047 /* We don't have down and up events if using toolkit scroll bars,
6048 so make this always a click event. Store in the `part' of
6049 the Lisp event a symbol which maps to the following actions:
6051 `above_handle' page up
6052 `below_handle' page down
6056 `bottom' bottom of buffer
6057 `handle' thumb has been dragged.
6058 `end-scroll' end of interaction with scroll bar
6060 The incoming input_event contains in its `part' member an
6061 index of type `enum scroll_bar_part' which we can use as an
6062 index in scroll_bar_parts to get the appropriate symbol. */
6064 case SCROLL_BAR_CLICK_EVENT
:
6066 Lisp_Object position
, head
, window
, portion_whole
, part
;
6068 window
= event
->frame_or_window
;
6069 portion_whole
= Fcons (event
->x
, event
->y
);
6070 part
= *scroll_bar_parts
[(int) event
->part
];
6074 Fcons (Qvertical_scroll_bar
,
6075 Fcons (portion_whole
,
6076 Fcons (make_number (event
->timestamp
),
6077 Fcons (part
, Qnil
)))));
6079 /* Always treat scroll bar events as clicks. */
6080 event
->modifiers
|= click_modifier
;
6081 event
->modifiers
&= ~up_modifier
;
6083 if (event
->code
>= ASIZE (mouse_syms
))
6084 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6086 /* Get the symbol we should use for the mouse click. */
6087 head
= modify_event_symbol (event
->code
,
6092 XVECTOR (mouse_syms
)->size
);
6093 return Fcons (head
, Fcons (position
, Qnil
));
6096 #endif /* USE_TOOLKIT_SCROLL_BARS */
6098 case DRAG_N_DROP_EVENT
:
6101 Lisp_Object head
, position
;
6104 f
= XFRAME (event
->frame_or_window
);
6107 /* Ignore mouse events that were made on frames that
6108 have been deleted. */
6109 if (! FRAME_LIVE_P (f
))
6112 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6115 head
= modify_event_symbol (0, event
->modifiers
,
6117 lispy_drag_n_drop_names
,
6118 &drag_n_drop_syms
, 1);
6124 #endif /* HAVE_MOUSE */
6126 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6127 || defined(HAVE_NS) || defined (USE_GTK)
6128 case MENU_BAR_EVENT
:
6129 if (EQ (event
->arg
, event
->frame_or_window
))
6130 /* This is the prefix key. We translate this to
6131 `(menu_bar)' because the code in keyboard.c for menu
6132 events, which we use, relies on this. */
6133 return Fcons (Qmenu_bar
, Qnil
);
6137 case SELECT_WINDOW_EVENT
:
6138 /* Make an event (select-window (WINDOW)). */
6139 return Fcons (Qselect_window
,
6140 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6143 case TOOL_BAR_EVENT
:
6144 if (EQ (event
->arg
, event
->frame_or_window
))
6145 /* This is the prefix key. We translate this to
6146 `(tool_bar)' because the code in keyboard.c for tool bar
6147 events, which we use, relies on this. */
6148 return Fcons (Qtool_bar
, Qnil
);
6149 else if (SYMBOLP (event
->arg
))
6150 return apply_modifiers (event
->modifiers
, event
->arg
);
6153 case USER_SIGNAL_EVENT
:
6154 /* A user signal. */
6156 char *name
= find_user_signal_name (event
->code
);
6159 return intern (name
);
6162 case SAVE_SESSION_EVENT
:
6163 return Qsave_session
;
6168 return Fcons (Qdbus_event
, event
->arg
);
6170 #endif /* HAVE_DBUS */
6173 case GPM_CLICK_EVENT
:
6175 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6176 Lisp_Object head
, position
;
6177 Lisp_Object
*start_pos_ptr
;
6178 Lisp_Object start_pos
;
6179 int button
= event
->code
;
6181 if (button
>= ASIZE (button_down_location
))
6183 button_down_location
= larger_vector (button_down_location
,
6185 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6188 start_pos_ptr
= &AREF (button_down_location
, button
);
6189 start_pos
= *start_pos_ptr
;
6191 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6194 if (event
->modifiers
& down_modifier
)
6195 *start_pos_ptr
= Fcopy_alist (position
);
6196 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6198 if (!CONSP (start_pos
))
6200 event
->modifiers
&= ~up_modifier
;
6203 head
= modify_event_symbol (button
,
6205 Qmouse_click
, Vlispy_mouse_stem
,
6208 XVECTOR (mouse_syms
)->size
);
6210 if (event
->modifiers
& drag_modifier
)
6215 else if (event
->modifiers
& double_modifier
)
6218 Fcons (make_number (2),
6220 else if (event
->modifiers
& triple_modifier
)
6223 Fcons (make_number (3),
6230 #endif /* HAVE_GPM */
6232 /* The 'kind' field of the event is something we don't recognize. */
6238 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6241 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6243 Lisp_Object bar_window
;
6244 enum scroll_bar_part part
;
6248 /* Is it a scroll bar movement? */
6249 if (frame
&& ! NILP (bar_window
))
6251 Lisp_Object part_sym
;
6253 part_sym
= *scroll_bar_parts
[(int) part
];
6254 return Fcons (Qscroll_bar_movement
,
6255 (Fcons (Fcons (bar_window
,
6256 Fcons (Qvertical_scroll_bar
,
6257 Fcons (Fcons (x
, y
),
6258 Fcons (make_number (time
),
6264 /* Or is it an ordinary mouse movement? */
6267 Lisp_Object position
;
6269 position
= make_lispy_position (frame
, &x
, &y
, time
);
6271 return Fcons (Qmouse_movement
,
6277 #endif /* HAVE_MOUSE || HAVE GPM */
6279 /* Construct a switch frame event. */
6281 make_lispy_switch_frame (frame
)
6284 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6287 /* Manipulating modifiers. */
6289 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6291 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6292 SYMBOL's name of the end of the modifiers; the string from this
6293 position is the unmodified symbol name.
6295 This doesn't use any caches. */
6298 parse_modifiers_uncached (symbol
, modifier_end
)
6306 CHECK_SYMBOL (symbol
);
6309 name
= SYMBOL_NAME (symbol
);
6311 for (i
= 0; i
+2 <= SBYTES (name
); )
6313 int this_mod_end
= 0;
6316 /* See if the name continues with a modifier word.
6317 Check that the word appears, but don't check what follows it.
6318 Set this_mod and this_mod_end to record what we find. */
6320 switch (SREF (name
, i
))
6322 #define SINGLE_LETTER_MOD(BIT) \
6323 (this_mod_end = i + 1, this_mod = BIT)
6326 SINGLE_LETTER_MOD (alt_modifier
);
6330 SINGLE_LETTER_MOD (ctrl_modifier
);
6334 SINGLE_LETTER_MOD (hyper_modifier
);
6338 SINGLE_LETTER_MOD (meta_modifier
);
6342 SINGLE_LETTER_MOD (shift_modifier
);
6346 SINGLE_LETTER_MOD (super_modifier
);
6349 #undef SINGLE_LETTER_MOD
6351 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6352 if (i + LEN + 1 <= SBYTES (name) \
6353 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6355 this_mod_end = i + LEN; \
6360 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6361 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6362 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6366 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6368 #undef MULTI_LETTER_MOD
6372 /* If we found no modifier, stop looking for them. */
6373 if (this_mod_end
== 0)
6376 /* Check there is a dash after the modifier, so that it
6377 really is a modifier. */
6378 if (this_mod_end
>= SBYTES (name
)
6379 || SREF (name
, this_mod_end
) != '-')
6382 /* This modifier is real; look for another. */
6383 modifiers
|= this_mod
;
6384 i
= this_mod_end
+ 1;
6387 /* Should we include the `click' modifier? */
6388 if (! (modifiers
& (down_modifier
| drag_modifier
6389 | double_modifier
| triple_modifier
))
6390 && i
+ 7 == SBYTES (name
)
6391 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6392 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6393 modifiers
|= click_modifier
;
6395 if (! (modifiers
& (double_modifier
| triple_modifier
))
6396 && i
+ 6 < SBYTES (name
)
6397 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6398 modifiers
|= click_modifier
;
6406 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6407 prepended to the string BASE[0..BASE_LEN-1].
6408 This doesn't use any caches. */
6410 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6413 int base_len
, base_len_byte
;
6415 /* Since BASE could contain nulls, we can't use intern here; we have
6416 to use Fintern, which expects a genuine Lisp_String, and keeps a
6419 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6425 /* Only the event queue may use the `up' modifier; it should always
6426 be turned into a click or drag event before presented to lisp code. */
6427 if (modifiers
& up_modifier
)
6430 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6431 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6432 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6433 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6434 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6435 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6436 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6437 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6438 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6439 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6440 /* The click modifier is denoted by the absence of other modifiers. */
6444 mod_len
= p
- new_mods
;
6448 Lisp_Object new_name
;
6450 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6451 mod_len
+ base_len_byte
);
6452 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6453 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6455 return Fintern (new_name
, Qnil
);
6460 static char *modifier_names
[] =
6462 "up", "down", "drag", "click", "double", "triple", 0, 0,
6463 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6464 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6466 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6468 static Lisp_Object modifier_symbols
;
6470 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6472 lispy_modifier_list (modifiers
)
6475 Lisp_Object modifier_list
;
6478 modifier_list
= Qnil
;
6479 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6480 if (modifiers
& (1<<i
))
6481 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6484 return modifier_list
;
6488 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6489 where UNMODIFIED is the unmodified form of SYMBOL,
6490 MASK is the set of modifiers present in SYMBOL's name.
6491 This is similar to parse_modifiers_uncached, but uses the cache in
6492 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6493 Qevent_symbol_elements property. */
6495 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6498 parse_modifiers (symbol
)
6501 Lisp_Object elements
;
6503 if (INTEGERP (symbol
))
6504 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6505 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6507 else if (!SYMBOLP (symbol
))
6510 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6511 if (CONSP (elements
))
6516 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6517 Lisp_Object unmodified
;
6520 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6521 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6524 if (modifiers
& ~INTMASK
)
6526 XSETFASTINT (mask
, modifiers
);
6527 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6529 /* Cache the parsing results on SYMBOL. */
6530 Fput (symbol
, Qevent_symbol_element_mask
,
6532 Fput (symbol
, Qevent_symbol_elements
,
6533 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6535 /* Since we know that SYMBOL is modifiers applied to unmodified,
6536 it would be nice to put that in unmodified's cache.
6537 But we can't, since we're not sure that parse_modifiers is
6544 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6545 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6546 doc
: /* Parse the event symbol. For internal use. */)
6550 /* Fill the cache if needed. */
6551 parse_modifiers (symbol
);
6552 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6553 and use the Lispier representation stored on Qevent_symbol_elements
6555 return Fget (symbol
, Qevent_symbol_elements
);
6558 /* Apply the modifiers MODIFIERS to the symbol BASE.
6559 BASE must be unmodified.
6561 This is like apply_modifiers_uncached, but uses BASE's
6562 Qmodifier_cache property, if present. It also builds
6563 Qevent_symbol_elements properties, since it has that info anyway.
6565 apply_modifiers copies the value of BASE's Qevent_kind property to
6566 the modified symbol. */
6568 apply_modifiers (modifiers
, base
)
6572 Lisp_Object cache
, index
, entry
, new_symbol
;
6574 /* Mask out upper bits. We don't know where this value's been. */
6575 modifiers
&= INTMASK
;
6577 if (INTEGERP (base
))
6578 return make_number (XINT (base
) | modifiers
);
6580 /* The click modifier never figures into cache indices. */
6581 cache
= Fget (base
, Qmodifier_cache
);
6582 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6583 entry
= assq_no_quit (index
, cache
);
6586 new_symbol
= XCDR (entry
);
6589 /* We have to create the symbol ourselves. */
6590 new_symbol
= apply_modifiers_uncached (modifiers
,
6591 SDATA (SYMBOL_NAME (base
)),
6592 SCHARS (SYMBOL_NAME (base
)),
6593 SBYTES (SYMBOL_NAME (base
)));
6595 /* Add the new symbol to the base's cache. */
6596 entry
= Fcons (index
, new_symbol
);
6597 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6599 /* We have the parsing info now for free, so we could add it to
6601 XSETFASTINT (index, modifiers);
6602 Fput (new_symbol, Qevent_symbol_element_mask,
6603 Fcons (base, Fcons (index, Qnil)));
6604 Fput (new_symbol, Qevent_symbol_elements,
6605 Fcons (base, lispy_modifier_list (modifiers)));
6606 Sadly, this is only correct if `base' is indeed a base event,
6607 which is not necessarily the case. -stef */
6610 /* Make sure this symbol is of the same kind as BASE.
6612 You'd think we could just set this once and for all when we
6613 intern the symbol above, but reorder_modifiers may call us when
6614 BASE's property isn't set right; we can't assume that just
6615 because it has a Qmodifier_cache property it must have its
6616 Qevent_kind set right as well. */
6617 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6621 kind
= Fget (base
, Qevent_kind
);
6623 Fput (new_symbol
, Qevent_kind
, kind
);
6630 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6631 return a symbol with the modifiers placed in the canonical order.
6632 Canonical order is alphabetical, except for down and drag, which
6633 always come last. The 'click' modifier is never written out.
6635 Fdefine_key calls this to make sure that (for example) C-M-foo
6636 and M-C-foo end up being equivalent in the keymap. */
6639 reorder_modifiers (symbol
)
6642 /* It's hopefully okay to write the code this way, since everything
6643 will soon be in caches, and no consing will be done at all. */
6646 parsed
= parse_modifiers (symbol
);
6647 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6652 /* For handling events, we often want to produce a symbol whose name
6653 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6654 to some base, like the name of a function key or mouse button.
6655 modify_event_symbol produces symbols of this sort.
6657 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6658 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6661 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6662 into symbol names, or a string specifying a name stem used to
6663 construct a symbol name or the form `STEM-N', where N is the decimal
6664 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6665 non-nil; otherwise NAME_TABLE is used.
6667 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6668 persist between calls to modify_event_symbol that it can use to
6669 store a cache of the symbols it's generated for this NAME_TABLE
6670 before. The object stored there may be a vector or an alist.
6672 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6674 MODIFIERS is a set of modifier bits (as given in struct input_events)
6675 whose prefixes should be applied to the symbol name.
6677 SYMBOL_KIND is the value to be placed in the event_kind property of
6678 the returned symbol.
6680 The symbols we create are supposed to have an
6681 `event-symbol-elements' property, which lists the modifiers present
6682 in the symbol's name. */
6685 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6686 name_table
, symbol_table
, table_size
)
6689 Lisp_Object symbol_kind
;
6690 Lisp_Object name_alist_or_stem
;
6692 Lisp_Object
*symbol_table
;
6693 unsigned int table_size
;
6696 Lisp_Object symbol_int
;
6698 /* Get rid of the "vendor-specific" bit here. */
6699 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6701 /* Is this a request for a valid symbol? */
6702 if (symbol_num
< 0 || symbol_num
>= table_size
)
6705 if (CONSP (*symbol_table
))
6706 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6708 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6709 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6710 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6711 we've never used that symbol before. */
6714 if (! VECTORP (*symbol_table
)
6715 || XVECTOR (*symbol_table
)->size
!= table_size
)
6719 XSETFASTINT (size
, table_size
);
6720 *symbol_table
= Fmake_vector (size
, Qnil
);
6723 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6726 /* Have we already used this symbol before? */
6729 /* No; let's create it. */
6730 if (CONSP (name_alist_or_stem
))
6731 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6732 else if (STRINGP (name_alist_or_stem
))
6734 int len
= SBYTES (name_alist_or_stem
);
6735 char *buf
= (char *) alloca (len
+ 50);
6736 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6737 (long) XINT (symbol_int
) + 1);
6738 value
= intern (buf
);
6740 else if (name_table
!= 0 && name_table
[symbol_num
])
6741 value
= intern (name_table
[symbol_num
]);
6743 #ifdef HAVE_WINDOW_SYSTEM
6746 char *name
= x_get_keysym_name (symbol_num
);
6748 value
= intern (name
);
6755 sprintf (buf
, "key-%d", symbol_num
);
6756 value
= intern (buf
);
6759 if (CONSP (*symbol_table
))
6760 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6762 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6764 /* Fill in the cache entries for this symbol; this also
6765 builds the Qevent_symbol_elements property, which the user
6767 apply_modifiers (modifiers
& click_modifier
, value
);
6768 Fput (value
, Qevent_kind
, symbol_kind
);
6771 /* Apply modifiers to that symbol. */
6772 return apply_modifiers (modifiers
, value
);
6775 /* Convert a list that represents an event type,
6776 such as (ctrl meta backspace), into the usual representation of that
6777 event type as a number or a symbol. */
6779 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6780 doc
: /* Convert the event description list EVENT-DESC to an event type.
6781 EVENT-DESC should contain one base event type (a character or symbol)
6782 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6783 drag, down, double or triple). The base must be last.
6784 The return value is an event type (a character or symbol) which
6785 has the same base event type and all the specified modifiers. */)
6787 Lisp_Object event_desc
;
6795 while (CONSP (rest
))
6803 /* Given a symbol, see if it is a modifier name. */
6804 if (SYMBOLP (elt
) && CONSP (rest
))
6805 this = parse_solitary_modifier (elt
);
6809 else if (!NILP (base
))
6810 error ("Two bases given in one event");
6816 /* Let the symbol A refer to the character A. */
6817 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6818 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6820 if (INTEGERP (base
))
6822 /* Turn (shift a) into A. */
6823 if ((modifiers
& shift_modifier
) != 0
6824 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6826 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6827 modifiers
&= ~shift_modifier
;
6830 /* Turn (control a) into C-a. */
6831 if (modifiers
& ctrl_modifier
)
6832 return make_number ((modifiers
& ~ctrl_modifier
)
6833 | make_ctrl_char (XINT (base
)));
6835 return make_number (modifiers
| XINT (base
));
6837 else if (SYMBOLP (base
))
6838 return apply_modifiers (modifiers
, base
);
6841 error ("Invalid base event");
6846 /* Try to recognize SYMBOL as a modifier name.
6847 Return the modifier flag bit, or 0 if not recognized. */
6850 parse_solitary_modifier (Lisp_Object symbol
)
6852 Lisp_Object name
= SYMBOL_NAME (symbol
);
6854 switch (SREF (name
, 0))
6856 #define SINGLE_LETTER_MOD(BIT) \
6857 if (SBYTES (name) == 1) \
6860 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6861 if (LEN == SBYTES (name) \
6862 && ! strncmp (SDATA (name), NAME, LEN)) \
6866 SINGLE_LETTER_MOD (alt_modifier
);
6870 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6874 SINGLE_LETTER_MOD (ctrl_modifier
);
6878 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6879 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6883 SINGLE_LETTER_MOD (hyper_modifier
);
6887 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6891 SINGLE_LETTER_MOD (meta_modifier
);
6895 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6899 SINGLE_LETTER_MOD (shift_modifier
);
6903 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6904 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6905 SINGLE_LETTER_MOD (super_modifier
);
6909 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6910 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6911 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6915 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6918 #undef SINGLE_LETTER_MOD
6919 #undef MULTI_LETTER_MOD
6925 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6926 Such a list is not valid as an event,
6927 but it can be a Lucid-style event type list. */
6930 lucid_event_type_list_p (object
)
6935 if (! CONSP (object
))
6938 if (EQ (XCAR (object
), Qhelp_echo
)
6939 || EQ (XCAR (object
), Qvertical_line
)
6940 || EQ (XCAR (object
), Qmode_line
)
6941 || EQ (XCAR (object
), Qheader_line
))
6944 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6948 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6955 /* Store into *addr a value nonzero if terminal input chars are available.
6956 Serves the purpose of ioctl (0, FIONREAD, addr)
6957 but works even if FIONREAD does not exist.
6958 (In fact, this may actually read some input.)
6960 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6961 timer events that are ripe.
6962 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6963 events (FOCUS_IN_EVENT).
6964 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6965 movements and toolkit scroll bar thumb drags. */
6968 get_input_pending (addr
, flags
)
6972 /* First of all, have we already counted some input? */
6973 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6975 /* If input is being read as it arrives, and we have none, there is none. */
6976 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6979 /* Try to read some input and see how much we get. */
6981 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6984 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6987 gobble_input (expected
)
6991 /* Read D-Bus messages. */
6992 xd_read_queued_messages ();
6993 #endif /* HAVE_DBUS */
6996 if (interrupt_input
)
6999 mask
= sigblock (sigmask (SIGIO
));
7000 read_avail_input (expected
);
7004 #ifdef POLL_FOR_INPUT
7005 /* XXX This condition was (read_socket_hook && !interrupt_input),
7006 but read_socket_hook is not global anymore. Let's pretend that
7008 if (!interrupt_input
&& poll_suppress_count
== 0)
7011 mask
= sigblock (sigmask (SIGALRM
));
7012 read_avail_input (expected
);
7018 read_avail_input (expected
);
7021 /* Put a BUFFER_SWITCH_EVENT in the buffer
7022 so that read_key_sequence will notice the new current buffer. */
7025 record_asynch_buffer_change ()
7027 struct input_event event
;
7031 event
.kind
= BUFFER_SWITCH_EVENT
;
7032 event
.frame_or_window
= Qnil
;
7036 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7037 The purpose of the event is to make read_key_sequence look up the
7038 keymaps again. If we aren't in read_key_sequence, we don't need one,
7039 and the event could cause trouble by messing up (input-pending-p). */
7040 tem
= Fwaiting_for_user_input_p ();
7044 /* We never need these events if we have no asynchronous subprocesses. */
7048 /* Make sure no interrupt happens while storing the event. */
7050 if (interrupt_input
)
7053 mask
= sigblock (sigmask (SIGIO
));
7054 kbd_buffer_store_event (&event
);
7061 kbd_buffer_store_event (&event
);
7066 /* Read any terminal input already buffered up by the system
7067 into the kbd_buffer, but do not wait.
7069 EXPECTED should be nonzero if the caller knows there is some input.
7071 Returns the number of keyboard chars read, or -1 meaning
7072 this is a bad time to try to read input. */
7075 read_avail_input (expected
)
7082 /* Store pending user signal events, if any. */
7083 if (store_user_signal_events ())
7086 /* Loop through the available terminals, and call their input hooks. */
7090 struct terminal
*next
= t
->next_terminal
;
7092 if (t
->read_socket_hook
)
7095 struct input_event hold_quit
;
7097 EVENT_INIT (hold_quit
);
7098 hold_quit
.kind
= NO_EVENT
;
7100 /* No need for FIONREAD or fcntl; just say don't wait. */
7101 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7107 if (nr
== -1) /* Not OK to read input now. */
7111 else if (nr
== -2) /* Non-transient error. */
7113 /* The terminal device terminated; it should be closed. */
7115 /* Kill Emacs if this was our last terminal. */
7116 if (!terminal_list
->next_terminal
)
7117 /* Formerly simply reported no input, but that
7118 sometimes led to a failure of Emacs to terminate.
7119 SIGHUP seems appropriate if we can't reach the
7121 /* ??? Is it really right to send the signal just to
7122 this process rather than to the whole process
7123 group? Perhaps on systems with FIONREAD Emacs is
7124 alone in its group. */
7125 kill (getpid (), SIGHUP
);
7127 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7130 XSETTERMINAL (tmp
, t
);
7131 Fdelete_terminal (tmp
, Qnoelisp
);
7135 if (hold_quit
.kind
!= NO_EVENT
)
7136 kbd_buffer_store_event (&hold_quit
);
7145 frame_make_pointer_visible ();
7151 decode_keyboard_code (struct tty_display_info
*tty
,
7152 struct coding_system
*coding
,
7153 unsigned char *buf
, int nbytes
)
7155 unsigned char *src
= buf
;
7156 const unsigned char *p
;
7161 if (tty
->meta_key
!= 2)
7162 for (i
= 0; i
< nbytes
; i
++)
7164 if (coding
->carryover_bytes
> 0)
7166 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7167 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7168 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7169 nbytes
+= coding
->carryover_bytes
;
7171 coding
->destination
= alloca (nbytes
* 4);
7172 coding
->dst_bytes
= nbytes
* 4;
7173 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7174 if (coding
->produced_char
== 0)
7176 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7178 struct input_event buf
;
7181 buf
.code
= STRING_CHAR_ADVANCE (p
);
7182 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7183 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7184 /* See the comment in tty_read_avail_input. */
7185 buf
.frame_or_window
= tty
->top_frame
;
7187 kbd_buffer_store_event (&buf
);
7191 /* This is the tty way of reading available input.
7193 Note that each terminal device has its own `struct terminal' object,
7194 and so this function is called once for each individual termcap
7195 terminal. The first parameter indicates which terminal to read from. */
7198 tty_read_avail_input (struct terminal
*terminal
,
7200 struct input_event
*hold_quit
)
7202 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7203 the kbd_buffer can really hold. That may prevent loss
7204 of characters on some systems when input is stuffed at us. */
7205 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7207 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7210 if (!terminal
->name
) /* Don't read from a dead terminal. */
7213 if (terminal
->type
!= output_termcap
7214 && terminal
->type
!= output_msdos_raw
)
7217 /* XXX I think the following code should be moved to separate hook
7218 functions in system-dependent files. */
7221 #else /* not WINDOWSNT */
7222 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7226 return 0; /* The terminal is suspended. */
7229 n_to_read
= dos_keysns ();
7233 cbuf
[0] = dos_keyread ();
7236 #else /* not MSDOS */
7241 struct input_event hold_quit
;
7242 int gpm
, fd
= gpm_fd
;
7244 EVENT_INIT (hold_quit
);
7245 hold_quit
.kind
= NO_EVENT
;
7247 /* gpm==1 if event received.
7248 gpm==0 if the GPM daemon has closed the connection, in which case
7249 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7250 we save it in `fd' so close_gpm can remove it from the
7252 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7253 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7254 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7257 /* Presumably the GPM daemon has closed the connection. */
7259 if (hold_quit
.kind
!= NO_EVENT
)
7260 kbd_buffer_store_event (&hold_quit
);
7264 #endif /* HAVE_GPM */
7266 /* Determine how many characters we should *try* to read. */
7268 /* Find out how much input is available. */
7269 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7271 if (! noninteractive
)
7272 return -2; /* Close this terminal. */
7278 if (n_to_read
> sizeof cbuf
)
7279 n_to_read
= sizeof cbuf
;
7280 #else /* no FIONREAD */
7281 #if defined (USG) || defined(CYGWIN)
7282 /* Read some input if available, but don't wait. */
7283 n_to_read
= sizeof cbuf
;
7284 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7290 /* Now read; for one reason or another, this will not block.
7291 NREAD is set to the number of chars read. */
7294 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7295 /* POSIX infers that processes which are not in the session leader's
7296 process group won't get SIGHUP's at logout time. BSDI adheres to
7297 this part standard and returns -1 from read (0) with errno==EIO
7298 when the control tty is taken away.
7299 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7300 if (nread
== -1 && errno
== EIO
)
7301 return -2; /* Close this terminal. */
7302 #if defined (AIX) && defined (_BSD)
7303 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7304 This looks incorrect, but it isn't, because _BSD causes
7305 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7306 and that causes a value other than 0 when there is no input. */
7308 return -2; /* Close this terminal. */
7312 /* We used to retry the read if it was interrupted.
7313 But this does the wrong thing when O_NDELAY causes
7314 an EAGAIN error. Does anybody know of a situation
7315 where a retry is actually needed? */
7317 nread
< 0 && (errno
== EAGAIN
7331 #if defined (USG) || defined (CYGWIN)
7332 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7333 #endif /* USG or CYGWIN */
7334 #endif /* no FIONREAD */
7339 #endif /* not MSDOS */
7340 #endif /* not WINDOWSNT */
7342 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7343 & CODING_REQUIRE_DECODING_MASK
)
7345 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7348 /* Decode the key sequence except for those with meta
7350 for (i
= from
= 0; ; i
++)
7351 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7353 struct input_event buf
;
7355 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7360 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7361 buf
.modifiers
= meta_modifier
;
7362 buf
.code
= cbuf
[i
] & ~0x80;
7363 /* See the comment below. */
7364 buf
.frame_or_window
= tty
->top_frame
;
7366 kbd_buffer_store_event (&buf
);
7372 for (i
= 0; i
< nread
; i
++)
7374 struct input_event buf
;
7376 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7378 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7379 buf
.modifiers
= meta_modifier
;
7380 if (tty
->meta_key
!= 2)
7384 /* Set the frame corresponding to the active tty. Note that the
7385 value of selected_frame is not reliable here, redisplay tends
7386 to temporarily change it. */
7387 buf
.frame_or_window
= tty
->top_frame
;
7390 kbd_buffer_store_event (&buf
);
7391 /* Don't look at input that follows a C-g too closely.
7392 This reduces lossage due to autorepeat on C-g. */
7393 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7394 && buf
.code
== quit_char
)
7402 handle_async_input ()
7404 interrupt_input_pending
= 0;
7406 pending_signals
= pending_atimers
;
7408 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7409 doing anything dangerous. */
7416 nread
= read_avail_input (1);
7417 /* -1 means it's not ok to read the input now.
7418 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7419 0 means there was no keyboard input available. */
7429 process_pending_signals ()
7431 if (interrupt_input_pending
)
7432 handle_async_input ();
7433 do_pending_atimers ();
7436 #ifdef SIGIO /* for entire page */
7437 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7440 input_available_signal (signo
)
7443 /* Must preserve main program's value of errno. */
7444 int old_errno
= errno
;
7445 #if defined (USG) && !defined (POSIX_SIGNALS)
7446 /* USG systems forget handlers when they are used;
7447 must reestablish each time */
7448 signal (signo
, input_available_signal
);
7452 interrupt_input_pending
= 1;
7453 pending_signals
= 1;
7455 SIGNAL_THREAD_CHECK (signo
);
7458 if (input_available_clear_time
)
7459 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7462 handle_async_input ();
7469 /* Send ourselves a SIGIO.
7471 This function exists so that the UNBLOCK_INPUT macro in
7472 blockinput.h can have some way to take care of input we put off
7473 dealing with, without assuming that every file which uses
7474 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7476 reinvoke_input_signal ()
7479 handle_async_input ();
7485 /* User signal events. */
7487 struct user_signal_info
7489 /* Signal number. */
7492 /* Name of the signal. */
7495 /* Number of pending signals. */
7498 struct user_signal_info
*next
;
7501 /* List of user signals. */
7502 static struct user_signal_info
*user_signals
= NULL
;
7505 add_user_signal (sig
, name
)
7509 struct user_signal_info
*p
;
7511 for (p
= user_signals
; p
; p
= p
->next
)
7513 /* Already added. */
7516 p
= xmalloc (sizeof (struct user_signal_info
));
7518 p
->name
= xstrdup (name
);
7520 p
->next
= user_signals
;
7523 signal (sig
, handle_user_signal
);
7527 handle_user_signal (sig
)
7530 int old_errno
= errno
;
7531 struct user_signal_info
*p
;
7533 #if defined (USG) && !defined (POSIX_SIGNALS)
7534 /* USG systems forget handlers when they are used;
7535 must reestablish each time */
7536 signal (sig
, handle_user_signal
);
7539 SIGNAL_THREAD_CHECK (sig
);
7541 for (p
= user_signals
; p
; p
= p
->next
)
7546 if (interrupt_input
)
7547 kill (getpid (), SIGIO
);
7551 /* Tell wait_reading_process_output that it needs to wake
7552 up and look around. */
7553 if (input_available_clear_time
)
7554 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7563 find_user_signal_name (sig
)
7566 struct user_signal_info
*p
;
7568 for (p
= user_signals
; p
; p
= p
->next
)
7576 store_user_signal_events ()
7578 struct user_signal_info
*p
;
7579 struct input_event buf
;
7582 for (p
= user_signals
; p
; p
= p
->next
)
7583 if (p
->npending
> 0)
7589 bzero (&buf
, sizeof buf
);
7590 buf
.kind
= USER_SIGNAL_EVENT
;
7591 buf
.frame_or_window
= selected_frame
;
7593 nstored
+= p
->npending
;
7595 mask
= sigblock (sigmask (p
->sig
));
7599 kbd_buffer_store_event (&buf
);
7602 while (p
->npending
> 0);
7610 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7611 static Lisp_Object menu_bar_one_keymap_changed_items
;
7613 /* These variables hold the vector under construction within
7614 menu_bar_items and its subroutines, and the current index
7615 for storing into that vector. */
7616 static Lisp_Object menu_bar_items_vector
;
7617 static int menu_bar_items_index
;
7619 /* Return a vector of menu items for a menu bar, appropriate
7620 to the current buffer. Each item has three elements in the vector:
7623 OLD is an old vector we can optionally reuse, or nil. */
7626 menu_bar_items (old
)
7629 /* The number of keymaps we're scanning right now, and the number of
7630 keymaps we have allocated space for. */
7633 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7634 in the current keymaps, or nil where it is not a prefix. */
7637 Lisp_Object def
, tail
;
7646 /* In order to build the menus, we need to call the keymap
7647 accessors. They all call QUIT. But this function is called
7648 during redisplay, during which a quit is fatal. So inhibit
7649 quitting while building the menus.
7650 We do this instead of specbind because (1) errors will clear it anyway
7651 and (2) this avoids risk of specpdl overflow. */
7652 oquit
= Vinhibit_quit
;
7656 menu_bar_items_vector
= old
;
7658 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7659 menu_bar_items_index
= 0;
7661 /* Build our list of keymaps.
7662 If we recognize a function key and replace its escape sequence in
7663 keybuf with its symbol, or if the sequence starts with a mouse
7664 click and we need to switch buffers, we jump back here to rebuild
7665 the initial keymaps from the current buffer. */
7669 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7670 if (!NILP (Voverriding_local_map_menu_flag
))
7672 /* Yes, use them (if non-nil) as well as the global map. */
7673 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7675 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7676 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7677 if (!NILP (Voverriding_local_map
))
7678 maps
[nmaps
++] = Voverriding_local_map
;
7682 /* No, so use major and minor mode keymaps and keymap property.
7683 Note that menu-bar bindings in the local-map and keymap
7684 properties may not work reliable, as they are only
7685 recognized when the menu-bar (or mode-line) is updated,
7686 which does not normally happen after every command. */
7689 nminor
= current_minor_maps (NULL
, &tmaps
);
7690 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7692 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7693 maps
[nmaps
++] = tem
;
7694 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7696 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7698 maps
[nmaps
++] = current_global_map
;
7701 /* Look up in each map the dummy prefix key `menu-bar'. */
7705 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7706 if (!NILP (maps
[mapno
]))
7708 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7712 menu_bar_one_keymap_changed_items
= Qnil
;
7713 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7717 /* Move to the end those items that should be at the end. */
7719 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7722 int end
= menu_bar_items_index
;
7724 for (i
= 0; i
< end
; i
+= 4)
7725 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7727 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7728 /* Move the item at index I to the end,
7729 shifting all the others forward. */
7730 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7731 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7732 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7733 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7735 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7736 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7737 (end
- i
- 4) * sizeof (Lisp_Object
));
7738 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7739 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7740 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7741 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7746 /* Add nil, nil, nil, nil at the end. */
7747 i
= menu_bar_items_index
;
7748 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7749 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7750 /* Add this item. */
7751 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7752 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7753 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7754 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7755 menu_bar_items_index
= i
;
7757 Vinhibit_quit
= oquit
;
7758 return menu_bar_items_vector
;
7761 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7762 If there's already an item for KEY, add this DEF to it. */
7764 Lisp_Object item_properties
;
7767 menu_bar_item (key
, item
, dummy1
, dummy2
)
7768 Lisp_Object key
, item
, dummy1
;
7771 struct gcpro gcpro1
;
7775 if (EQ (item
, Qundefined
))
7777 /* If a map has an explicit `undefined' as definition,
7778 discard any previously made menu bar item. */
7780 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7781 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7783 if (menu_bar_items_index
> i
+ 4)
7784 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7785 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7786 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7787 menu_bar_items_index
-= 4;
7791 /* If this keymap has already contributed to this KEY,
7792 don't contribute to it a second time. */
7793 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7794 if (!NILP (tem
) || NILP (item
))
7797 menu_bar_one_keymap_changed_items
7798 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7800 /* We add to menu_bar_one_keymap_changed_items before doing the
7801 parse_menu_item, so that if it turns out it wasn't a menu item,
7802 it still correctly hides any further menu item. */
7804 i
= parse_menu_item (item
, 0, 1);
7809 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7811 /* Find any existing item for this KEY. */
7812 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7813 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7816 /* If we did not find this KEY, add it at the end. */
7817 if (i
== menu_bar_items_index
)
7819 /* If vector is too small, get a bigger one. */
7820 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7821 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7822 /* Add this item. */
7823 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7824 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7825 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7826 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7827 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7828 menu_bar_items_index
= i
;
7830 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7834 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7835 /* If the new and the old items are not both keymaps,
7836 the lookup will only find `item'. */
7837 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7838 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7842 /* This is used as the handler when calling menu_item_eval_property. */
7844 menu_item_eval_property_1 (arg
)
7847 /* If we got a quit from within the menu computation,
7848 quit all the way out of it. This takes care of C-] in the debugger. */
7849 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7850 Fsignal (Qquit
, Qnil
);
7855 /* Evaluate an expression and return the result (or nil if something
7856 went wrong). Used to evaluate dynamic parts of menu items. */
7858 menu_item_eval_property (sexpr
)
7861 int count
= SPECPDL_INDEX ();
7863 specbind (Qinhibit_redisplay
, Qt
);
7864 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7865 menu_item_eval_property_1
);
7866 return unbind_to (count
, val
);
7869 /* This function parses a menu item and leaves the result in the
7870 vector item_properties.
7871 ITEM is a key binding, a possible menu item.
7872 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7873 evaluate dynamic expressions in the menu item.
7874 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7876 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7877 parse_menu_item returns true if the item is a menu item and false
7881 parse_menu_item (item
, notreal
, inmenubar
)
7883 int notreal
, inmenubar
;
7885 Lisp_Object def
, tem
, item_string
, start
;
7886 Lisp_Object cachelist
;
7888 Lisp_Object keyhint
;
7899 /* Create item_properties vector if necessary. */
7900 if (NILP (item_properties
))
7902 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7904 /* Initialize optional entries. */
7905 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7906 ASET (item_properties
, i
, Qnil
);
7907 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7909 /* Save the item here to protect it from GC. */
7910 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7912 item_string
= XCAR (item
);
7916 if (STRINGP (item_string
))
7918 /* Old format menu item. */
7919 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7921 /* Maybe help string. */
7922 if (CONSP (item
) && STRINGP (XCAR (item
)))
7924 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7929 /* Maybe key binding cache. */
7930 if (CONSP (item
) && CONSP (XCAR (item
))
7931 && (NILP (XCAR (XCAR (item
)))
7932 || VECTORP (XCAR (XCAR (item
)))))
7934 cachelist
= XCAR (item
);
7938 /* This is the real definition--the function to run. */
7939 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7941 /* Get enable property, if any. */
7944 tem
= Fget (item
, Qmenu_enable
);
7945 if (!NILP (Venable_disabled_menus_and_buttons
))
7946 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7947 else if (!NILP (tem
))
7948 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7951 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7953 /* New format menu item. */
7954 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7955 start
= XCDR (item
);
7958 /* We have a real binding. */
7959 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7961 item
= XCDR (start
);
7962 /* Is there a cache list with key equivalences. */
7963 if (CONSP (item
) && CONSP (XCAR (item
)))
7965 cachelist
= XCAR (item
);
7969 /* Parse properties. */
7970 while (CONSP (item
) && CONSP (XCDR (item
)))
7975 if (EQ (tem
, QCenable
))
7977 if (!NILP (Venable_disabled_menus_and_buttons
))
7978 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7980 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7982 else if (EQ (tem
, QCvisible
) && !notreal
)
7984 /* If got a visible property and that evaluates to nil
7985 then ignore this item. */
7986 tem
= menu_item_eval_property (XCAR (item
));
7990 else if (EQ (tem
, QChelp
))
7991 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7992 else if (EQ (tem
, QCfilter
))
7994 else if (EQ (tem
, QCkey_sequence
))
7997 if (NILP (cachelist
)
7998 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7999 /* Be GC protected. Set keyhint to item instead of tem. */
8002 else if (EQ (tem
, QCkeys
))
8005 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
8006 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8008 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
8013 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8015 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8017 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
8023 else if (inmenubar
|| !NILP (start
))
8027 return 0; /* not a menu item */
8029 /* If item string is not a string, evaluate it to get string.
8030 If we don't get a string, skip this item. */
8031 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
8032 if (!(STRINGP (item_string
) || notreal
))
8034 item_string
= menu_item_eval_property (item_string
);
8035 if (!STRINGP (item_string
))
8037 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
8040 /* If got a filter apply it on definition. */
8041 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8044 def
= menu_item_eval_property (list2 (XCAR (filter
),
8045 list2 (Qquote
, def
)));
8047 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
8050 /* Enable or disable selection of item. */
8051 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
8057 tem
= menu_item_eval_property (tem
);
8058 if (inmenubar
&& NILP (tem
))
8059 return 0; /* Ignore disabled items in menu bar. */
8060 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
8063 /* If we got no definition, this item is just unselectable text which
8064 is OK in a submenu but not in the menubar. */
8066 return (inmenubar
? 0 : 1);
8068 /* See if this is a separate pane or a submenu. */
8069 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8070 tem
= get_keymap (def
, 0, 1);
8071 /* For a subkeymap, just record its details and exit. */
8074 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
8075 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
8079 /* At the top level in the menu bar, do likewise for commands also.
8080 The menu bar does not display equivalent key bindings anyway.
8081 ITEM_PROPERTY_DEF is already set up properly. */
8085 /* This is a command. See if there is an equivalent key binding. */
8086 if (NILP (cachelist
))
8088 /* We have to create a cachelist. */
8089 /* With the introduction of where_is_cache, the computation
8090 of equivalent key bindings is sufficiently fast that we
8091 do not need to cache it here any more. */
8092 /* CHECK_IMPURE (start);
8093 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
8094 cachelist = XCAR (XCDR (start)); */
8095 cachelist
= Fcons (Qnil
, Qnil
);
8097 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8098 if (!NILP (keyhint
))
8100 XSETCAR (cachelist
, XCAR (keyhint
));
8103 else if (STRINGP (tem
))
8105 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
8106 XSETCAR (cachelist
, Qt
);
8110 tem
= XCAR (cachelist
);
8117 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8119 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8122 def
= XCAR (prefix
);
8123 prefix
= XCDR (prefix
);
8126 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8128 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8130 if (newcache
/* Always check first time. */
8131 /* Should we check everything when precomputing key
8133 /* If something had no key binding before, don't recheck it
8134 because that is too slow--except if we have a list of
8135 rebound commands in Vdefine_key_rebound_commands, do
8136 recheck any command that appears in that list. */
8137 || (CONSP (Vdefine_key_rebound_commands
)
8138 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8141 /* We had a saved key. Is it still bound to the command? */
8144 /* If the command is an alias for another
8145 (such as lmenu.el set it up), check if the
8146 original command matches the cached command. */
8147 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8148 chkcache
= 1; /* Need to recompute key binding. */
8152 /* Recompute equivalent key binding. If the command is an alias
8153 for another (such as lmenu.el set it up), see if the original
8154 command name has equivalent keys. Otherwise look up the
8155 specified command itself. We don't try both, because that
8156 makes lmenu menus slow. */
8158 && SYMBOLP (XSYMBOL (def
)->function
)
8159 && ! NILP (Fget (def
, Qmenu_alias
)))
8160 def
= XSYMBOL (def
)->function
;
8161 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8163 /* Don't display remap bindings.*/
8164 if (VECTORP (tem
) && ASIZE (tem
) > 0 && EQ (AREF (tem
, 0), Qremap
))
8167 XSETCAR (cachelist
, tem
);
8170 XSETCDR (cachelist
, Qnil
);
8174 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8176 tem
= XCAR (cachelist
);
8180 newcache
= chkcache
;
8183 tem
= Fkey_description (tem
, Qnil
);
8186 if (STRINGP (XCAR (prefix
)))
8187 tem
= concat2 (XCAR (prefix
), tem
);
8188 if (STRINGP (XCDR (prefix
)))
8189 tem
= concat2 (tem
, XCDR (prefix
));
8191 XSETCDR (cachelist
, tem
);
8195 tem
= XCDR (cachelist
);
8196 if (newcache
&& !NILP (tem
))
8198 tem
= concat2 (build_string (" "), tem
);
8199 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8200 XSETCDR (cachelist
, tem
);
8203 /* If we only want to precompute equivalent key bindings, stop here. */
8207 /* If we have an equivalent key binding, use that. */
8208 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8210 /* Include this when menu help is implemented.
8211 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8212 if (!(NILP (tem) || STRINGP (tem)))
8214 tem = menu_item_eval_property (tem);
8217 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8221 /* Handle radio buttons or toggle boxes. */
8222 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8224 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8225 menu_item_eval_property (tem
));
8232 /***********************************************************************
8234 ***********************************************************************/
8236 /* A vector holding tool bar items while they are parsed in function
8237 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8240 static Lisp_Object tool_bar_items_vector
;
8242 /* A vector holding the result of parse_tool_bar_item. Layout is like
8243 the one for a single item in tool_bar_items_vector. */
8245 static Lisp_Object tool_bar_item_properties
;
8247 /* Next free index in tool_bar_items_vector. */
8249 static int ntool_bar_items
;
8251 /* The symbols `tool-bar', `:image' and `:rtl'. */
8253 extern Lisp_Object Qtool_bar
;
8254 Lisp_Object QCimage
;
8257 /* Function prototypes. */
8259 static void init_tool_bar_items
P_ ((Lisp_Object
));
8260 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8261 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8262 static void append_tool_bar_item
P_ ((void));
8265 /* Return a vector of tool bar items for keymaps currently in effect.
8266 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8267 tool bar items found. */
8270 tool_bar_items (reuse
, nitems
)
8281 /* In order to build the menus, we need to call the keymap
8282 accessors. They all call QUIT. But this function is called
8283 during redisplay, during which a quit is fatal. So inhibit
8284 quitting while building the menus. We do this instead of
8285 specbind because (1) errors will clear it anyway and (2) this
8286 avoids risk of specpdl overflow. */
8287 oquit
= Vinhibit_quit
;
8290 /* Initialize tool_bar_items_vector and protect it from GC. */
8291 init_tool_bar_items (reuse
);
8293 /* Build list of keymaps in maps. Set nmaps to the number of maps
8296 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8297 if (!NILP (Voverriding_local_map_menu_flag
))
8299 /* Yes, use them (if non-nil) as well as the global map. */
8300 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8302 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8303 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8304 if (!NILP (Voverriding_local_map
))
8305 maps
[nmaps
++] = Voverriding_local_map
;
8309 /* No, so use major and minor mode keymaps and keymap property.
8310 Note that tool-bar bindings in the local-map and keymap
8311 properties may not work reliable, as they are only
8312 recognized when the tool-bar (or mode-line) is updated,
8313 which does not normally happen after every command. */
8316 nminor
= current_minor_maps (NULL
, &tmaps
);
8317 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8319 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8320 maps
[nmaps
++] = tem
;
8321 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8323 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8326 /* Add global keymap at the end. */
8327 maps
[nmaps
++] = current_global_map
;
8329 /* Process maps in reverse order and look up in each map the prefix
8331 for (i
= nmaps
- 1; i
>= 0; --i
)
8332 if (!NILP (maps
[i
]))
8336 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8338 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8341 Vinhibit_quit
= oquit
;
8342 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8343 return tool_bar_items_vector
;
8347 /* Process the definition of KEY which is DEF. */
8350 process_tool_bar_item (key
, def
, data
, args
)
8351 Lisp_Object key
, def
, data
;
8355 extern Lisp_Object Qundefined
;
8356 struct gcpro gcpro1
, gcpro2
;
8358 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8362 if (EQ (def
, Qundefined
))
8364 /* If a map has an explicit `undefined' as definition,
8365 discard any previously made item. */
8366 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8368 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8370 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8372 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8373 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8374 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8375 * sizeof (Lisp_Object
)));
8376 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8381 else if (parse_tool_bar_item (key
, def
))
8382 /* Append a new tool bar item to tool_bar_items_vector. Accept
8383 more than one definition for the same key. */
8384 append_tool_bar_item ();
8390 /* Parse a tool bar item specification ITEM for key KEY and return the
8391 result in tool_bar_item_properties. Value is zero if ITEM is
8394 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8396 CAPTION is the caption of the item, If it's not a string, it is
8397 evaluated to get a string.
8399 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8400 as binding are currently ignored.
8402 The following properties are recognized:
8406 FORM is evaluated and specifies whether the tool bar item is
8407 enabled or disabled.
8411 FORM is evaluated and specifies whether the tool bar item is visible.
8413 - `:filter FUNCTION'
8415 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8416 result is stored as the new binding.
8418 - `:button (TYPE SELECTED)'
8420 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8421 and specifies whether the button is selected (pressed) or not.
8425 IMAGES is either a single image specification or a vector of four
8426 image specifications. See enum tool_bar_item_images.
8428 - `:help HELP-STRING'.
8430 Gives a help string to display for the tool bar item. */
8433 parse_tool_bar_item (key
, item
)
8434 Lisp_Object key
, item
;
8436 /* Access slot with index IDX of vector tool_bar_item_properties. */
8437 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8439 Lisp_Object filter
= Qnil
;
8440 Lisp_Object caption
;
8443 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8444 Rule out items that aren't lists, don't start with
8445 `menu-item' or whose rest following `tool-bar-item' is not a
8448 || !EQ (XCAR (item
), Qmenu_item
)
8449 || (item
= XCDR (item
),
8453 /* Create tool_bar_item_properties vector if necessary. Reset it to
8455 if (VECTORP (tool_bar_item_properties
))
8457 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8461 tool_bar_item_properties
8462 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8465 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8466 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8468 /* Get the caption of the item. If the caption is not a string,
8469 evaluate it to get a string. If we don't get a string, skip this
8471 caption
= XCAR (item
);
8472 if (!STRINGP (caption
))
8474 caption
= menu_item_eval_property (caption
);
8475 if (!STRINGP (caption
))
8478 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8480 /* Give up if rest following the caption is not a list. */
8485 /* Store the binding. */
8486 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8489 /* Ignore cached key binding, if any. */
8490 if (CONSP (item
) && CONSP (XCAR (item
)))
8493 /* Process the rest of the properties. */
8494 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8496 Lisp_Object key
, value
;
8499 value
= XCAR (XCDR (item
));
8501 if (EQ (key
, QCenable
))
8503 /* `:enable FORM'. */
8504 if (!NILP (Venable_disabled_menus_and_buttons
))
8505 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8507 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8509 else if (EQ (key
, QCvisible
))
8511 /* `:visible FORM'. If got a visible property and that
8512 evaluates to nil then ignore this item. */
8513 if (NILP (menu_item_eval_property (value
)))
8516 else if (EQ (key
, QChelp
))
8517 /* `:help HELP-STRING'. */
8518 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8519 else if (EQ (key
, QCfilter
))
8520 /* ':filter FORM'. */
8522 else if (EQ (key
, QCbutton
) && CONSP (value
))
8524 /* `:button (TYPE . SELECTED)'. */
8525 Lisp_Object type
, selected
;
8527 type
= XCAR (value
);
8528 selected
= XCDR (value
);
8529 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8531 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8532 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8535 else if (EQ (key
, QCimage
)
8537 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8538 /* Value is either a single image specification or a vector
8539 of 4 such specifications for the different button states. */
8540 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8541 else if (EQ (key
, Qrtl
))
8543 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8546 /* If got a filter apply it on binding. */
8548 PROP (TOOL_BAR_ITEM_BINDING
)
8549 = menu_item_eval_property (list2 (filter
,
8551 PROP (TOOL_BAR_ITEM_BINDING
))));
8553 /* See if the binding is a keymap. Give up if it is. */
8554 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8557 /* Enable or disable selection of item. */
8558 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8559 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8560 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8562 /* Handle radio buttons or toggle boxes. */
8563 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8564 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8565 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8573 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8574 that can be reused. */
8577 init_tool_bar_items (reuse
)
8580 if (VECTORP (reuse
))
8581 tool_bar_items_vector
= reuse
;
8583 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8584 ntool_bar_items
= 0;
8588 /* Append parsed tool bar item properties from
8589 tool_bar_item_properties */
8592 append_tool_bar_item ()
8594 Lisp_Object
*to
, *from
;
8596 /* Enlarge tool_bar_items_vector if necessary. */
8597 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8598 >= XVECTOR (tool_bar_items_vector
)->size
)
8599 tool_bar_items_vector
8600 = larger_vector (tool_bar_items_vector
,
8601 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8603 /* Append entries from tool_bar_item_properties to the end of
8604 tool_bar_items_vector. */
8605 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8606 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8607 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8608 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8615 /* Read a character using menus based on maps in the array MAPS.
8616 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8617 Return t if we displayed a menu but the user rejected it.
8619 PREV_EVENT is the previous input event, or nil if we are reading
8620 the first event of a key sequence.
8622 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8623 if we used a mouse menu to read the input, or zero otherwise. If
8624 USED_MOUSE_MENU is null, we don't dereference it.
8626 The prompting is done based on the prompt-string of the map
8627 and the strings associated with various map elements.
8629 This can be done with X menus or with menus put in the minibuf.
8630 These are done in different ways, depending on how the input will be read.
8631 Menus using X are done after auto-saving in read-char, getting the input
8632 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8633 and do auto-saving in the inner call of read_char. */
8636 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8639 Lisp_Object prev_event
;
8640 int *used_mouse_menu
;
8643 register Lisp_Object name
= Qnil
;
8645 if (used_mouse_menu
)
8646 *used_mouse_menu
= 0;
8648 /* Use local over global Menu maps */
8650 if (! menu_prompting
)
8653 /* Optionally disregard all but the global map. */
8654 if (inhibit_local_menu_bar_menus
)
8656 maps
+= (nmaps
- 1);
8660 /* Get the menu name from the first map that has one (a prompt string). */
8661 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8663 name
= Fkeymap_prompt (maps
[mapno
]);
8668 /* If we don't have any menus, just read a character normally. */
8669 if (!STRINGP (name
))
8673 /* If we got to this point via a mouse click,
8674 use a real menu for mouse selection. */
8675 if (EVENT_HAS_PARAMETERS (prev_event
)
8676 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8677 && !EQ (XCAR (prev_event
), Qtool_bar
))
8679 /* Display the menu and get the selection. */
8680 Lisp_Object
*realmaps
8681 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8685 /* Use the maps that are not nil. */
8686 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8687 if (!NILP (maps
[mapno
]))
8688 realmaps
[nmaps1
++] = maps
[mapno
];
8690 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8695 record_menu_key (XCAR (value
));
8697 /* If we got multiple events, unread all but
8699 There is no way to prevent those unread events
8700 from showing up later in last_nonmenu_event.
8701 So turn symbol and integer events into lists,
8702 to indicate that they came from a mouse menu,
8703 so that when present in last_nonmenu_event
8704 they won't confuse things. */
8705 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8707 record_menu_key (XCAR (tem
));
8708 if (SYMBOLP (XCAR (tem
))
8709 || INTEGERP (XCAR (tem
)))
8710 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8713 /* If we got more than one event, put all but the first
8714 onto this list to be read later.
8715 Return just the first event now. */
8716 Vunread_command_events
8717 = nconc2 (XCDR (value
), Vunread_command_events
);
8718 value
= XCAR (value
);
8720 else if (NILP (value
))
8722 if (used_mouse_menu
)
8723 *used_mouse_menu
= 1;
8726 #endif /* HAVE_MENUS */
8730 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8731 We make this bigger when necessary, and never free it. */
8732 static char *read_char_minibuf_menu_text
;
8733 /* Size of that buffer. */
8734 static int read_char_minibuf_menu_width
;
8737 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8743 register Lisp_Object name
;
8745 /* FIXME: Use the minibuffer's frame width. */
8746 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8749 Lisp_Object rest
, vector
;
8755 if (! menu_prompting
)
8758 /* Get the menu name from the first map that has one (a prompt string). */
8759 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8761 name
= Fkeymap_prompt (maps
[mapno
]);
8766 /* If we don't have any menus, just read a character normally. */
8767 if (!STRINGP (name
))
8770 /* Make sure we have a big enough buffer for the menu text. */
8771 width
= max (width
, SBYTES (name
));
8772 if (read_char_minibuf_menu_text
== 0)
8774 read_char_minibuf_menu_width
= width
+ 4;
8775 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8777 else if (width
+ 4 > read_char_minibuf_menu_width
)
8779 read_char_minibuf_menu_width
= width
+ 4;
8780 read_char_minibuf_menu_text
8781 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8783 menu
= read_char_minibuf_menu_text
;
8785 /* Prompt string always starts with map's prompt, and a space. */
8786 strcpy (menu
, SDATA (name
));
8787 nlength
= SBYTES (name
);
8788 menu
[nlength
++] = ':';
8789 menu
[nlength
++] = ' ';
8792 /* Start prompting at start of first map. */
8796 /* Present the documented bindings, a line at a time. */
8803 Lisp_Object orig_defn_macro
;
8805 /* Loop over elements of map. */
8810 /* If reached end of map, start at beginning of next map. */
8814 /* At end of last map, wrap around to first map if just starting,
8815 or end this line if already have something on it. */
8819 if (notfirst
|| nobindings
) break;
8824 /* Look at the next element of the map. */
8826 elt
= XVECTOR (vector
)->contents
[idx
];
8828 elt
= Fcar_safe (rest
);
8830 if (idx
< 0 && VECTORP (elt
))
8832 /* If we found a dense table in the keymap,
8833 advanced past it, but start scanning its contents. */
8834 rest
= Fcdr_safe (rest
);
8840 /* An ordinary element. */
8841 Lisp_Object event
, tem
;
8845 event
= Fcar_safe (elt
); /* alist */
8846 elt
= Fcdr_safe (elt
);
8850 XSETINT (event
, idx
); /* vector */
8853 /* Ignore the element if it has no prompt string. */
8854 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8856 /* 1 if the char to type matches the string. */
8858 Lisp_Object upcased_event
, downcased_event
;
8859 Lisp_Object desc
= Qnil
;
8861 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8863 upcased_event
= Fupcase (event
);
8864 downcased_event
= Fdowncase (event
);
8865 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8866 || XINT (downcased_event
) == SREF (s
, 0));
8868 desc
= Fsingle_key_description (event
, Qnil
);
8870 #if 0 /* It is redundant to list the equivalent key bindings because
8871 the prefix is what the user has already typed. */
8873 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8875 /* Insert equivalent keybinding. */
8876 s
= concat2 (s
, tem
);
8879 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8880 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8882 /* Insert button prefix. */
8883 Lisp_Object selected
8884 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8885 if (EQ (tem
, QCradio
))
8886 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8888 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8889 s
= concat2 (tem
, s
);
8893 /* If we have room for the prompt string, add it to this line.
8894 If this is the first on the line, always add it. */
8895 if ((SCHARS (s
) + i
+ 2
8896 + (char_matches
? 0 : SCHARS (desc
) + 3))
8902 /* Punctuate between strings. */
8905 strcpy (menu
+ i
, ", ");
8911 /* If the char to type doesn't match the string's
8912 first char, explicitly show what char to type. */
8915 /* Add as much of string as fits. */
8916 thiswidth
= SCHARS (desc
);
8917 if (thiswidth
+ i
> width
)
8918 thiswidth
= width
- i
;
8919 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8921 strcpy (menu
+ i
, " = ");
8925 /* Add as much of string as fits. */
8926 thiswidth
= SCHARS (s
);
8927 if (thiswidth
+ i
> width
)
8928 thiswidth
= width
- i
;
8929 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8935 /* If this element does not fit, end the line now,
8936 and save the element for the next line. */
8937 strcpy (menu
+ i
, "...");
8942 /* Move past this element. */
8943 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8944 /* Handle reaching end of dense table. */
8949 rest
= Fcdr_safe (rest
);
8953 /* Prompt with that and read response. */
8954 message2_nolog (menu
, strlen (menu
),
8955 ! NILP (current_buffer
->enable_multibyte_characters
));
8957 /* Make believe its not a keyboard macro in case the help char
8958 is pressed. Help characters are not recorded because menu prompting
8959 is not used on replay.
8961 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8962 current_kboard
->defining_kbd_macro
= Qnil
;
8964 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8965 while (BUFFERP (obj
));
8966 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8968 if (!INTEGERP (obj
))
8970 else if (XINT (obj
) == -2)
8975 if (! EQ (obj
, menu_prompt_more_char
)
8976 && (!INTEGERP (menu_prompt_more_char
)
8977 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8979 if (!NILP (current_kboard
->defining_kbd_macro
))
8980 store_kbd_macro_char (obj
);
8983 /* Help char - go round again */
8987 /* Reading key sequences. */
8989 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8990 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8991 keymap, or nil otherwise. Return the index of the first keymap in
8992 which KEY has any binding, or NMAPS if no map has a binding.
8994 If KEY is a meta ASCII character, treat it like meta-prefix-char
8995 followed by the corresponding non-meta character. Keymaps in
8996 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8999 If KEY has no bindings in any of the CURRENT maps, NEXT is left
9002 NEXT may be the same array as CURRENT. */
9005 follow_key (key
, nmaps
, current
, defs
, next
)
9007 Lisp_Object
*current
, *defs
, *next
;
9010 int i
, first_binding
;
9012 first_binding
= nmaps
;
9013 for (i
= nmaps
- 1; i
>= 0; i
--)
9015 if (! NILP (current
[i
]))
9017 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
9018 if (! NILP (defs
[i
]))
9025 /* Given the set of bindings we've found, produce the next set of maps. */
9026 if (first_binding
< nmaps
)
9027 for (i
= 0; i
< nmaps
; i
++)
9028 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
9030 return first_binding
;
9033 /* Structure used to keep track of partial application of key remapping
9034 such as Vfunction_key_map and Vkey_translation_map. */
9035 typedef struct keyremap
9037 /* This is the map originally specified for this use. */
9039 /* This is a submap reached by looking up, in PARENT,
9040 the events from START to END. */
9042 /* Positions [START, END) in the key sequence buffer
9043 are the key that we have scanned so far.
9044 Those events are the ones that we will replace
9045 if PAREHT maps them into a key sequence. */
9049 /* Lookup KEY in MAP.
9050 MAP is a keymap mapping keys to key vectors or functions.
9051 If the mapping is a function and DO_FUNCTION is non-zero, then
9052 the function is called with PROMPT as parameter and its return
9053 value is used as the return value of this function (after checking
9054 that it is indeed a vector). */
9057 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
9058 Lisp_Object map
, key
, prompt
;
9063 next
= access_keymap (map
, key
, 1, 0, 1);
9065 /* Handle symbol with autoload definition. */
9066 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
9067 && CONSP (XSYMBOL (next
)->function
)
9068 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9069 do_autoload (XSYMBOL (next
)->function
, next
);
9071 /* Handle a symbol whose function definition is a keymap
9073 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
9074 && (ARRAYP (XSYMBOL (next
)->function
)
9075 || KEYMAPP (XSYMBOL (next
)->function
)))
9076 next
= XSYMBOL (next
)->function
;
9078 /* If the keymap gives a function, not an
9079 array, then call the function with one arg and use
9080 its value instead. */
9081 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
9086 next
= call1 (next
, prompt
);
9087 /* If the function returned something invalid,
9088 barf--don't ignore it.
9089 (To ignore it safely, we would need to gcpro a bunch of
9090 other variables.) */
9091 if (! (VECTORP (next
) || STRINGP (next
)))
9092 error ("Function %s returns invalid key sequence", tem
);
9097 /* Do one step of the key remapping used for function-key-map and
9098 key-translation-map:
9099 KEYBUF is the buffer holding the input events.
9100 BUFSIZE is its maximum size.
9101 FKEY is a pointer to the keyremap structure to use.
9102 INPUT is the index of the last element in KEYBUF.
9103 DOIT if non-zero says that the remapping can actually take place.
9104 DIFF is used to return the number of keys added/removed by the remapping.
9105 PARENT is the root of the keymap.
9106 PROMPT is the prompt to use if the remapping happens through a function.
9107 The return value is non-zero if the remapping actually took place. */
9110 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9111 Lisp_Object
*keybuf
, prompt
;
9113 int input
, doit
, *diff
, bufsize
;
9115 Lisp_Object next
, key
;
9117 key
= keybuf
[fkey
->end
++];
9119 if (KEYMAPP (fkey
->parent
))
9120 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9124 /* If keybuf[fkey->start..fkey->end] is bound in the
9125 map and we're in a position to do the key remapping, replace it with
9126 the binding and restart with fkey->start at the end. */
9127 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9129 int len
= XFASTINT (Flength (next
));
9132 *diff
= len
- (fkey
->end
- fkey
->start
);
9134 if (input
+ *diff
>= bufsize
)
9135 error ("Key sequence too long");
9137 /* Shift the keys that follow fkey->end. */
9139 for (i
= fkey
->end
; i
< input
; i
++)
9140 keybuf
[i
+ *diff
] = keybuf
[i
];
9142 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9143 keybuf
[i
+ *diff
] = keybuf
[i
];
9144 /* Overwrite the old keys with the new ones. */
9145 for (i
= 0; i
< len
; i
++)
9146 keybuf
[fkey
->start
+ i
]
9147 = Faref (next
, make_number (i
));
9149 fkey
->start
= fkey
->end
+= *diff
;
9150 fkey
->map
= fkey
->parent
;
9155 fkey
->map
= get_keymap (next
, 0, 1);
9157 /* If we no longer have a bound suffix, try a new position for
9159 if (!CONSP (fkey
->map
))
9161 fkey
->end
= ++fkey
->start
;
9162 fkey
->map
= fkey
->parent
;
9167 /* Read a sequence of keys that ends with a non prefix character,
9168 storing it in KEYBUF, a buffer of size BUFSIZE.
9170 Return the length of the key sequence stored.
9171 Return -1 if the user rejected a command menu.
9173 Echo starting immediately unless `prompt' is 0.
9175 Where a key sequence ends depends on the currently active keymaps.
9176 These include any minor mode keymaps active in the current buffer,
9177 the current buffer's local map, and the global map.
9179 If a key sequence has no other bindings, we check Vfunction_key_map
9180 to see if some trailing subsequence might be the beginning of a
9181 function key's sequence. If so, we try to read the whole function
9182 key, and substitute its symbolic name into the key sequence.
9184 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9185 `double-' events into similar click events, if that would make them
9186 bound. We try to turn `triple-' events first into `double-' events,
9189 If we get a mouse click in a mode line, vertical divider, or other
9190 non-text area, we treat the click as if it were prefixed by the
9191 symbol denoting that area - `mode-line', `vertical-line', or
9194 If the sequence starts with a mouse click, we read the key sequence
9195 with respect to the buffer clicked on, not the current buffer.
9197 If the user switches frames in the midst of a key sequence, we put
9198 off the switch-frame event until later; the next call to
9199 read_char will return it.
9201 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9202 from the selected window's buffer. */
9205 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9206 can_return_switch_frame
, fix_current_buffer
)
9207 Lisp_Object
*keybuf
;
9210 int dont_downcase_last
;
9211 int can_return_switch_frame
;
9212 int fix_current_buffer
;
9214 volatile Lisp_Object from_string
;
9215 volatile int count
= SPECPDL_INDEX ();
9217 /* How many keys there are in the current key sequence. */
9220 /* The length of the echo buffer when we started reading, and
9221 the length of this_command_keys when we started reading. */
9222 volatile int echo_start
;
9223 volatile int keys_start
;
9225 /* The number of keymaps we're scanning right now, and the number of
9226 keymaps we have allocated space for. */
9228 volatile int nmaps_allocated
= 0;
9230 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9231 the current keymaps. */
9232 Lisp_Object
*volatile defs
= NULL
;
9234 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9235 in the current keymaps, or nil where it is not a prefix. */
9236 Lisp_Object
*volatile submaps
= NULL
;
9238 /* The local map to start out with at start of key sequence. */
9239 volatile Lisp_Object orig_local_map
;
9241 /* The map from the `keymap' property to start out with at start of
9243 volatile Lisp_Object orig_keymap
;
9245 /* 1 if we have already considered switching to the local-map property
9246 of the place where a mouse click occurred. */
9247 volatile int localized_local_map
= 0;
9249 /* The index in submaps[] of the first keymap that has a binding for
9250 this key sequence. In other words, the lowest i such that
9251 submaps[i] is non-nil. */
9252 volatile int first_binding
;
9253 /* Index of the first key that has no binding.
9254 It is useless to try fkey.start larger than that. */
9255 volatile int first_unbound
;
9257 /* If t < mock_input, then KEYBUF[t] should be read as the next
9260 We use this to recover after recognizing a function key. Once we
9261 realize that a suffix of the current key sequence is actually a
9262 function key's escape sequence, we replace the suffix with the
9263 function key's binding from Vfunction_key_map. Now keybuf
9264 contains a new and different key sequence, so the echo area,
9265 this_command_keys, and the submaps and defs arrays are wrong. In
9266 this situation, we set mock_input to t, set t to 0, and jump to
9267 restart_sequence; the loop will read keys from keybuf up until
9268 mock_input, thus rebuilding the state; and then it will resume
9269 reading characters from the keyboard. */
9270 volatile int mock_input
= 0;
9272 /* If the sequence is unbound in submaps[], then
9273 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9274 and fkey.map is its binding.
9276 These might be > t, indicating that all function key scanning
9277 should hold off until t reaches them. We do this when we've just
9278 recognized a function key, to avoid searching for the function
9279 key's again in Vfunction_key_map. */
9280 volatile keyremap fkey
;
9282 /* Likewise, for key_translation_map and input-decode-map. */
9283 volatile keyremap keytran
, indec
;
9285 /* Non-zero if we are trying to map a key by changing an upper-case
9286 letter to lower case, or a shifted function key to an unshifted
9288 volatile int shift_translated
= 0;
9290 /* If we receive a `switch-frame' or `select-window' event in the middle of
9291 a key sequence, we put it off for later.
9292 While we're reading, we keep the event here. */
9293 volatile Lisp_Object delayed_switch_frame
;
9295 /* See the comment below... */
9296 #if defined (GOBBLE_FIRST_EVENT)
9297 Lisp_Object first_event
;
9300 volatile Lisp_Object original_uppercase
;
9301 volatile int original_uppercase_position
= -1;
9303 /* Gets around Microsoft compiler limitations. */
9306 struct buffer
*starting_buffer
;
9308 /* List of events for which a fake prefix key has been generated. */
9309 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9311 #if defined (GOBBLE_FIRST_EVENT)
9315 struct gcpro gcpro1
;
9317 GCPRO1 (fake_prefixed_keys
);
9318 raw_keybuf_count
= 0;
9320 last_nonmenu_event
= Qnil
;
9322 delayed_switch_frame
= Qnil
;
9327 echo_prompt (prompt
);
9328 else if (cursor_in_echo_area
9329 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9330 && NILP (Fzerop (Vecho_keystrokes
)))
9331 /* This doesn't put in a dash if the echo buffer is empty, so
9332 you don't always see a dash hanging out in the minibuffer. */
9336 /* Record the initial state of the echo area and this_command_keys;
9337 we will need to restore them if we replay a key sequence. */
9339 echo_start
= echo_length ();
9340 keys_start
= this_command_key_count
;
9341 this_single_command_key_start
= keys_start
;
9343 #if defined (GOBBLE_FIRST_EVENT)
9344 /* This doesn't quite work, because some of the things that read_char
9345 does cannot safely be bypassed. It seems too risky to try to make
9348 /* Read the first char of the sequence specially, before setting
9349 up any keymaps, in case a filter runs and switches buffers on us. */
9350 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9352 #endif /* GOBBLE_FIRST_EVENT */
9354 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9355 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9358 /* We jump here when we need to reinitialize fkey and keytran; this
9359 happens if we switch keyboards between rescans. */
9360 replay_entire_sequence
:
9362 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9363 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9364 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9365 indec
.start
= indec
.end
= 0;
9366 fkey
.start
= fkey
.end
= 0;
9367 keytran
.start
= keytran
.end
= 0;
9369 /* We jump here when the key sequence has been thoroughly changed, and
9370 we need to rescan it starting from the beginning. When we jump here,
9371 keybuf[0..mock_input] holds the sequence we should reread. */
9374 starting_buffer
= current_buffer
;
9375 first_unbound
= bufsize
+ 1;
9377 /* Build our list of keymaps.
9378 If we recognize a function key and replace its escape sequence in
9379 keybuf with its symbol, or if the sequence starts with a mouse
9380 click and we need to switch buffers, we jump back here to rebuild
9381 the initial keymaps from the current buffer. */
9384 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9386 if (2 > nmaps_allocated
)
9388 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9389 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9390 nmaps_allocated
= 2;
9392 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9394 else if (!NILP (Voverriding_local_map
))
9396 if (2 > nmaps_allocated
)
9398 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9399 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9400 nmaps_allocated
= 2;
9402 submaps
[nmaps
++] = Voverriding_local_map
;
9410 nminor
= current_minor_maps (0, &maps
);
9411 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9413 if (total
> nmaps_allocated
)
9415 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9416 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9417 nmaps_allocated
= total
;
9420 if (!NILP (orig_keymap
))
9421 submaps
[nmaps
++] = orig_keymap
;
9423 bcopy (maps
, (void *) (submaps
+ nmaps
),
9424 nminor
* sizeof (submaps
[0]));
9428 submaps
[nmaps
++] = orig_local_map
;
9430 submaps
[nmaps
++] = current_global_map
;
9432 /* Find an accurate initial value for first_binding. */
9433 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9434 if (! NILP (submaps
[first_binding
]))
9437 /* Start from the beginning in keybuf. */
9440 /* These are no-ops the first time through, but if we restart, they
9441 revert the echo area and this_command_keys to their original state. */
9442 this_command_key_count
= keys_start
;
9443 if (INTERACTIVE
&& t
< mock_input
)
9444 echo_truncate (echo_start
);
9446 /* If the best binding for the current key sequence is a keymap, or
9447 we may be looking at a function key's escape sequence, keep on
9449 while (first_binding
< nmaps
9450 /* Keep reading as long as there's a prefix binding. */
9451 ? !NILP (submaps
[first_binding
])
9452 /* Don't return in the middle of a possible function key sequence,
9453 if the only bindings we found were via case conversion.
9454 Thus, if ESC O a has a function-key-map translation
9455 and ESC o has a binding, don't return after ESC O,
9456 so that we can translate ESC O plus the next character. */
9457 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9460 int used_mouse_menu
= 0;
9462 /* Where the last real key started. If we need to throw away a
9463 key that has expanded into more than one element of keybuf
9464 (say, a mouse click on the mode line which is being treated
9465 as [mode-line (mouse-...)], then we backtrack to this point
9467 volatile int last_real_key_start
;
9469 /* These variables are analogous to echo_start and keys_start;
9470 while those allow us to restart the entire key sequence,
9471 echo_local_start and keys_local_start allow us to throw away
9473 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9475 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9476 eassert (indec
.start
<= indec
.end
);
9477 eassert (fkey
.start
<= fkey
.end
);
9478 eassert (keytran
.start
<= keytran
.end
);
9479 /* key-translation-map is applied *after* function-key-map
9480 which is itself applied *after* input-decode-map. */
9481 eassert (fkey
.end
<= indec
.start
);
9482 eassert (keytran
.end
<= fkey
.start
);
9484 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9485 first_unbound
< keytran
.start
)
9486 { /* The prefix upto first_unbound has no binding and has
9487 no translation left to do either, so we know it's unbound.
9488 If we don't stop now, we risk staying here indefinitely
9489 (if the user keeps entering fkey or keytran prefixes
9490 like C-c ESC ESC ESC ESC ...) */
9492 for (i
= first_unbound
+ 1; i
< t
; i
++)
9493 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9494 mock_input
= t
- first_unbound
- 1;
9495 indec
.end
= indec
.start
-= first_unbound
+ 1;
9496 indec
.map
= indec
.parent
;
9497 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9498 fkey
.map
= fkey
.parent
;
9499 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9500 keytran
.map
= keytran
.parent
;
9501 goto replay_sequence
;
9505 error ("Key sequence too long");
9508 echo_local_start
= echo_length ();
9509 keys_local_start
= this_command_key_count
;
9510 local_first_binding
= first_binding
;
9513 /* These are no-ops, unless we throw away a keystroke below and
9514 jumped back up to replay_key; in that case, these restore the
9515 variables to their original state, allowing us to replay the
9517 if (INTERACTIVE
&& t
< mock_input
)
9518 echo_truncate (echo_local_start
);
9519 this_command_key_count
= keys_local_start
;
9520 first_binding
= local_first_binding
;
9522 /* By default, assume each event is "real". */
9523 last_real_key_start
= t
;
9525 /* Does mock_input indicate that we are re-reading a key sequence? */
9529 add_command_key (key
);
9530 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9531 && NILP (Fzerop (Vecho_keystrokes
)))
9535 /* If not, we should actually read a character. */
9539 KBOARD
*interrupted_kboard
= current_kboard
;
9540 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9541 key
= read_char (NILP (prompt
), nmaps
,
9542 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9543 &used_mouse_menu
, NULL
);
9544 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9549 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9550 if (k
== interrupted_kboard
)
9555 /* Don't touch interrupted_kboard when it's been
9557 delayed_switch_frame
= Qnil
;
9558 goto replay_entire_sequence
;
9561 if (!NILP (delayed_switch_frame
))
9563 interrupted_kboard
->kbd_queue
9564 = Fcons (delayed_switch_frame
,
9565 interrupted_kboard
->kbd_queue
);
9566 delayed_switch_frame
= Qnil
;
9570 interrupted_kboard
->kbd_queue
9571 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9573 /* If the side queue is non-empty, ensure it begins with a
9574 switch-frame, so we'll replay it in the right context. */
9575 if (CONSP (interrupted_kboard
->kbd_queue
)
9576 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9577 !(EVENT_HAS_PARAMETERS (key
)
9578 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9582 XSETFRAME (frame
, interrupted_frame
);
9583 interrupted_kboard
->kbd_queue
9584 = Fcons (make_lispy_switch_frame (frame
),
9585 interrupted_kboard
->kbd_queue
);
9588 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9589 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9590 goto replay_entire_sequence
;
9594 /* read_char returns t when it shows a menu and the user rejects it.
9598 unbind_to (count
, Qnil
);
9603 /* read_char returns -1 at the end of a macro.
9604 Emacs 18 handles this by returning immediately with a
9605 zero, so that's what we'll do. */
9606 if (INTEGERP (key
) && XINT (key
) == -1)
9609 /* The Microsoft C compiler can't handle the goto that
9615 /* If the current buffer has been changed from under us, the
9616 keymap may have changed, so replay the sequence. */
9619 timer_resume_idle ();
9622 /* Reset the current buffer from the selected window
9623 in case something changed the former and not the latter.
9624 This is to be more consistent with the behavior
9625 of the command_loop_1. */
9626 if (fix_current_buffer
)
9628 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9630 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9631 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9634 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9635 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9636 goto replay_sequence
;
9639 /* If we have a quit that was typed in another frame, and
9640 quit_throw_to_read_char switched buffers,
9641 replay to get the right keymap. */
9643 && XINT (key
) == quit_char
9644 && current_buffer
!= starting_buffer
)
9647 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9651 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9652 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9653 goto replay_sequence
;
9658 if (EVENT_HAS_PARAMETERS (key
)
9659 /* Either a `switch-frame' or a `select-window' event. */
9660 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9662 /* If we're at the beginning of a key sequence, and the caller
9663 says it's okay, go ahead and return this event. If we're
9664 in the midst of a key sequence, delay it until the end. */
9665 if (t
> 0 || !can_return_switch_frame
)
9667 delayed_switch_frame
= key
;
9673 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9677 /* Clicks in non-text areas get prefixed by the symbol
9678 in their CHAR-ADDRESS field. For example, a click on
9679 the mode line is prefixed by the symbol `mode-line'.
9681 Furthermore, key sequences beginning with mouse clicks
9682 are read using the keymaps of the buffer clicked on, not
9683 the current buffer. So we may have to switch the buffer
9686 When we turn one event into two events, we must make sure
9687 that neither of the two looks like the original--so that,
9688 if we replay the events, they won't be expanded again.
9689 If not for this, such reexpansion could happen either here
9690 or when user programs play with this-command-keys. */
9691 if (EVENT_HAS_PARAMETERS (key
))
9696 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9697 if (EQ (kind
, Qmouse_click
))
9699 Lisp_Object window
, posn
;
9701 window
= POSN_WINDOW (EVENT_START (key
));
9702 posn
= POSN_POSN (EVENT_START (key
));
9705 || (!NILP (fake_prefixed_keys
)
9706 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9708 /* We're looking a second time at an event for which
9709 we generated a fake prefix key. Set
9710 last_real_key_start appropriately. */
9712 last_real_key_start
= t
- 1;
9715 /* Key sequences beginning with mouse clicks are
9716 read using the keymaps in the buffer clicked on,
9717 not the current buffer. If we're at the
9718 beginning of a key sequence, switch buffers. */
9719 if (last_real_key_start
== 0
9721 && BUFFERP (XWINDOW (window
)->buffer
)
9722 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9724 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9728 /* Arrange to go back to the original buffer once we're
9729 done reading the key sequence. Note that we can't
9730 use save_excursion_{save,restore} here, because they
9731 save point as well as the current buffer; we don't
9732 want to save point, because redisplay may change it,
9733 to accommodate a Fset_window_start or something. We
9734 don't want to do this at the top of the function,
9735 because we may get input from a subprocess which
9736 wants to change the selected window and stuff (say,
9738 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9740 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9742 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9743 orig_local_map
= get_local_map (PT
, current_buffer
,
9745 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9746 goto replay_sequence
;
9749 /* For a mouse click, get the local text-property keymap
9750 of the place clicked on, rather than point. */
9751 if (last_real_key_start
== 0
9752 && CONSP (XCDR (key
))
9753 && ! localized_local_map
)
9755 Lisp_Object map_here
, start
, pos
;
9757 localized_local_map
= 1;
9758 start
= EVENT_START (key
);
9760 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9762 pos
= POSN_BUFFER_POSN (start
);
9764 && XINT (pos
) >= BEGV
9765 && XINT (pos
) <= ZV
)
9767 map_here
= get_local_map (XINT (pos
),
9768 current_buffer
, Qlocal_map
);
9769 if (!EQ (map_here
, orig_local_map
))
9771 orig_local_map
= map_here
;
9772 ++localized_local_map
;
9775 map_here
= get_local_map (XINT (pos
),
9776 current_buffer
, Qkeymap
);
9777 if (!EQ (map_here
, orig_keymap
))
9779 orig_keymap
= map_here
;
9780 ++localized_local_map
;
9783 if (localized_local_map
> 1)
9788 goto replay_sequence
;
9794 /* Expand mode-line and scroll-bar events into two events:
9795 use posn as a fake prefix key. */
9797 && (NILP (fake_prefixed_keys
)
9798 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9800 if (t
+ 1 >= bufsize
)
9801 error ("Key sequence too long");
9804 keybuf
[t
+ 1] = key
;
9807 /* Record that a fake prefix key has been generated
9808 for KEY. Don't modify the event; this would
9809 prevent proper action when the event is pushed
9810 back into unread-command-events. */
9811 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9813 /* If on a mode line string with a local keymap,
9814 reconsider the key sequence with that keymap. */
9815 if (string
= POSN_STRING (EVENT_START (key
)),
9816 (CONSP (string
) && STRINGP (XCAR (string
))))
9818 Lisp_Object pos
, map
, map2
;
9820 pos
= XCDR (string
);
9821 string
= XCAR (string
);
9823 && XINT (pos
) < SCHARS (string
))
9825 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9827 orig_local_map
= map
;
9828 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9831 if (!NILP (map
) || !NILP (map2
))
9832 goto replay_sequence
;
9838 else if (NILP (from_string
)
9839 && (string
= POSN_STRING (EVENT_START (key
)),
9840 (CONSP (string
) && STRINGP (XCAR (string
)))))
9842 /* For a click on a string, i.e. overlay string or a
9843 string displayed via the `display' property,
9844 consider `local-map' and `keymap' properties of
9846 Lisp_Object pos
, map
, map2
;
9848 pos
= XCDR (string
);
9849 string
= XCAR (string
);
9851 && XINT (pos
) < SCHARS (string
))
9853 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9855 orig_local_map
= map
;
9856 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9860 if (!NILP (map
) || !NILP (map2
))
9862 from_string
= string
;
9865 goto replay_sequence
;
9870 else if (CONSP (XCDR (key
))
9871 && CONSP (EVENT_START (key
))
9872 && CONSP (XCDR (EVENT_START (key
))))
9876 posn
= POSN_POSN (EVENT_START (key
));
9877 /* Handle menu-bar events:
9878 insert the dummy prefix event `menu-bar'. */
9879 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9881 if (t
+ 1 >= bufsize
)
9882 error ("Key sequence too long");
9886 /* Zap the position in key, so we know that we've
9887 expanded it, and don't try to do so again. */
9888 POSN_SET_POSN (EVENT_START (key
),
9889 Fcons (posn
, Qnil
));
9892 goto replay_sequence
;
9894 else if (CONSP (posn
))
9896 /* We're looking at the second event of a
9897 sequence which we expanded before. Set
9898 last_real_key_start appropriately. */
9899 if (last_real_key_start
== t
&& t
> 0)
9900 last_real_key_start
= t
- 1;
9905 /* We have finally decided that KEY is something we might want
9907 first_binding
= (follow_key (key
,
9908 nmaps
- first_binding
,
9909 submaps
+ first_binding
,
9910 defs
+ first_binding
,
9911 submaps
+ first_binding
)
9914 /* If KEY wasn't bound, we'll try some fallbacks. */
9915 if (first_binding
< nmaps
)
9916 /* This is needed for the following scenario:
9917 event 0: a down-event that gets dropped by calling replay_key.
9918 event 1: some normal prefix like C-h.
9919 After event 0, first_unbound is 0, after event 1 indec.start,
9920 fkey.start, and keytran.start are all 1, so when we see that
9921 C-h is bound, we need to update first_unbound. */
9922 first_unbound
= max (t
+ 1, first_unbound
);
9927 /* Remember the position to put an upper bound on indec.start. */
9928 first_unbound
= min (t
, first_unbound
);
9930 head
= EVENT_HEAD (key
);
9931 if (help_char_p (head
) && t
> 0)
9933 read_key_sequence_cmd
= Vprefix_help_command
;
9935 last_nonmenu_event
= key
;
9936 /* The Microsoft C compiler can't handle the goto that
9944 Lisp_Object breakdown
;
9947 breakdown
= parse_modifiers (head
);
9948 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9949 /* Attempt to reduce an unbound mouse event to a simpler
9950 event that is bound:
9951 Drags reduce to clicks.
9952 Double-clicks reduce to clicks.
9953 Triple-clicks reduce to double-clicks, then to clicks.
9954 Down-clicks are eliminated.
9955 Double-downs reduce to downs, then are eliminated.
9956 Triple-downs reduce to double-downs, then to downs,
9957 then are eliminated. */
9958 if (modifiers
& (down_modifier
| drag_modifier
9959 | double_modifier
| triple_modifier
))
9961 while (modifiers
& (down_modifier
| drag_modifier
9962 | double_modifier
| triple_modifier
))
9964 Lisp_Object new_head
, new_click
;
9965 if (modifiers
& triple_modifier
)
9966 modifiers
^= (double_modifier
| triple_modifier
);
9967 else if (modifiers
& double_modifier
)
9968 modifiers
&= ~double_modifier
;
9969 else if (modifiers
& drag_modifier
)
9970 modifiers
&= ~drag_modifier
;
9973 /* Dispose of this `down' event by simply jumping
9974 back to replay_key, to get another event.
9976 Note that if this event came from mock input,
9977 then just jumping back to replay_key will just
9978 hand it to us again. So we have to wipe out any
9981 We could delete keybuf[t] and shift everything
9982 after that to the left by one spot, but we'd also
9983 have to fix up any variable that points into
9984 keybuf, and shifting isn't really necessary
9987 Adding prefixes for non-textual mouse clicks
9988 creates two characters of mock input, and both
9989 must be thrown away. If we're only looking at
9990 the prefix now, we can just jump back to
9991 replay_key. On the other hand, if we've already
9992 processed the prefix, and now the actual click
9993 itself is giving us trouble, then we've lost the
9994 state of the keymaps we want to backtrack to, and
9995 we need to replay the whole sequence to rebuild
9998 Beyond that, only function key expansion could
9999 create more than two keys, but that should never
10000 generate mouse events, so it's okay to zero
10001 mock_input in that case too.
10003 FIXME: The above paragraph seems just plain
10004 wrong, if you consider things like
10005 xterm-mouse-mode. -stef
10007 Isn't this just the most wonderful code ever? */
10009 /* If mock_input > t + 1, the above simplification
10010 will actually end up dropping keys on the floor.
10011 This is probably OK for now, but even
10012 if mock_input <= t + 1, we need to adjust indec,
10014 Typical case [header-line down-mouse-N]:
10015 mock_input = 2, t = 1, fkey.end = 1,
10016 last_real_key_start = 0. */
10017 if (indec
.end
> last_real_key_start
)
10019 indec
.end
= indec
.start
10020 = min (last_real_key_start
, indec
.start
);
10021 indec
.map
= indec
.parent
;
10022 if (fkey
.end
> last_real_key_start
)
10024 fkey
.end
= fkey
.start
10025 = min (last_real_key_start
, fkey
.start
);
10026 fkey
.map
= fkey
.parent
;
10027 if (keytran
.end
> last_real_key_start
)
10029 keytran
.end
= keytran
.start
10030 = min (last_real_key_start
, keytran
.start
);
10031 keytran
.map
= keytran
.parent
;
10035 if (t
== last_real_key_start
)
10042 mock_input
= last_real_key_start
;
10043 goto replay_sequence
;
10048 = apply_modifiers (modifiers
, XCAR (breakdown
));
10050 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
10052 /* Look for a binding for this new key. follow_key
10053 promises that it didn't munge submaps the
10054 last time we called it, since key was unbound. */
10056 = (follow_key (new_click
,
10057 nmaps
- local_first_binding
,
10058 submaps
+ local_first_binding
,
10059 defs
+ local_first_binding
,
10060 submaps
+ local_first_binding
)
10061 + local_first_binding
);
10063 /* If that click is bound, go for it. */
10064 if (first_binding
< nmaps
)
10069 /* Otherwise, we'll leave key set to the drag event. */
10076 /* Normally, last_nonmenu_event gets the previous key we read.
10077 But when a mouse popup menu is being used,
10078 we don't update last_nonmenu_event; it continues to hold the mouse
10079 event that preceded the first level of menu. */
10080 if (!used_mouse_menu
)
10081 last_nonmenu_event
= key
;
10083 /* Record what part of this_command_keys is the current key sequence. */
10084 this_single_command_key_start
= this_command_key_count
- t
;
10086 /* Look for this sequence in input-decode-map.
10087 Scan from indec.end until we find a bound suffix. */
10088 while (indec
.end
< t
)
10090 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10093 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10094 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10099 mock_input
= diff
+ max (t
, mock_input
);
10100 goto replay_sequence
;
10104 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10105 && indec
.start
>= t
)
10106 /* There is a binding and it's not a prefix.
10107 (and it doesn't have any input-decode-map translation pending).
10108 There is thus no function-key in this sequence.
10109 Moving fkey.start is important in this case to allow keytran.start
10110 to go over the sequence before we return (since we keep the
10111 invariant that keytran.end <= fkey.start). */
10113 if (fkey
.start
< t
)
10114 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10117 /* If the sequence is unbound, see if we can hang a function key
10118 off the end of it. */
10119 /* Continue scan from fkey.end until we find a bound suffix. */
10120 while (fkey
.end
< indec
.start
)
10122 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10125 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10126 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10127 max (t
, mock_input
),
10128 /* If there's a binding (i.e.
10129 first_binding >= nmaps) we don't want
10130 to apply this function-key-mapping. */
10131 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10136 mock_input
= diff
+ max (t
, mock_input
);
10137 /* Adjust the input-decode-map counters. */
10139 indec
.start
+= diff
;
10141 goto replay_sequence
;
10145 /* Look for this sequence in key-translation-map.
10146 Scan from keytran.end until we find a bound suffix. */
10147 while (keytran
.end
< fkey
.start
)
10149 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10152 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10153 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10158 mock_input
= diff
+ max (t
, mock_input
);
10159 /* Adjust the function-key-map and input-decode-map counters. */
10161 indec
.start
+= diff
;
10163 fkey
.start
+= diff
;
10165 goto replay_sequence
;
10169 /* If KEY is not defined in any of the keymaps,
10170 and cannot be part of a function key or translation,
10171 and is an upper case letter
10172 use the corresponding lower-case letter instead. */
10173 if (first_binding
>= nmaps
10174 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10176 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10177 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10178 || (XINT (key
) & shift_modifier
)))
10180 Lisp_Object new_key
;
10182 original_uppercase
= key
;
10183 original_uppercase_position
= t
- 1;
10185 if (XINT (key
) & shift_modifier
)
10186 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10188 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10189 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10191 /* We have to do this unconditionally, regardless of whether
10192 the lower-case char is defined in the keymaps, because they
10193 might get translated through function-key-map. */
10194 keybuf
[t
- 1] = new_key
;
10195 mock_input
= max (t
, mock_input
);
10196 shift_translated
= 1;
10198 goto replay_sequence
;
10200 /* If KEY is not defined in any of the keymaps,
10201 and cannot be part of a function key or translation,
10202 and is a shifted function key,
10203 use the corresponding unshifted function key instead. */
10204 if (first_binding
>= nmaps
10205 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10207 Lisp_Object breakdown
= parse_modifiers (key
);
10209 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10211 if (modifiers
& shift_modifier
10212 /* Treat uppercase keys as shifted. */
10214 && (KEY_TO_CHAR (key
)
10215 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10216 && UPPERCASEP (KEY_TO_CHAR (key
))))
10218 Lisp_Object new_key
10219 = (modifiers
& shift_modifier
10220 ? apply_modifiers (modifiers
& ~shift_modifier
,
10222 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10224 original_uppercase
= key
;
10225 original_uppercase_position
= t
- 1;
10227 /* We have to do this unconditionally, regardless of whether
10228 the lower-case char is defined in the keymaps, because they
10229 might get translated through function-key-map. */
10230 keybuf
[t
- 1] = new_key
;
10231 mock_input
= max (t
, mock_input
);
10232 /* Reset fkey (and consequently keytran) to apply
10233 function-key-map on the result, so that S-backspace is
10234 correctly mapped to DEL (via backspace). OTOH,
10235 input-decode-map doesn't need to go through it again. */
10236 fkey
.start
= fkey
.end
= 0;
10237 keytran
.start
= keytran
.end
= 0;
10238 shift_translated
= 1;
10240 goto replay_sequence
;
10245 read_key_sequence_cmd
= (first_binding
< nmaps
10246 ? defs
[first_binding
]
10249 unread_switch_frame
= delayed_switch_frame
;
10250 unbind_to (count
, Qnil
);
10252 /* Don't downcase the last character if the caller says don't.
10253 Don't downcase it if the result is undefined, either. */
10254 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10256 && t
- 1 == original_uppercase_position
)
10258 keybuf
[t
- 1] = original_uppercase
;
10259 shift_translated
= 0;
10262 if (shift_translated
)
10263 Vthis_command_keys_shift_translated
= Qt
;
10265 /* Occasionally we fabricate events, perhaps by expanding something
10266 according to function-key-map, or by adding a prefix symbol to a
10267 mouse click in the scroll bar or modeline. In this cases, return
10268 the entire generated key sequence, even if we hit an unbound
10269 prefix or a definition before the end. This means that you will
10270 be able to push back the event properly, and also means that
10271 read-key-sequence will always return a logical unit.
10274 for (; t
< mock_input
; t
++)
10276 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10277 && NILP (Fzerop (Vecho_keystrokes
)))
10278 echo_char (keybuf
[t
]);
10279 add_command_key (keybuf
[t
]);
10286 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10287 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10288 The sequence is sufficient to specify a non-prefix command in the
10289 current local and global maps.
10291 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10292 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10293 as a continuation of the previous key.
10295 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10296 convert the last event to lower case. (Normally any upper case event
10297 is converted to lower case if the original event is undefined and the lower
10298 case equivalent is defined.) A non-nil value is appropriate for reading
10299 a key sequence to be defined.
10301 A C-g typed while in this function is treated like any other character,
10302 and `quit-flag' is not set.
10304 If the key sequence starts with a mouse click, then the sequence is read
10305 using the keymaps of the buffer of the window clicked in, not the buffer
10306 of the selected window as normal.
10308 `read-key-sequence' drops unbound button-down events, since you normally
10309 only care about the click or drag events which follow them. If a drag
10310 or multi-click event is unbound, but the corresponding click event would
10311 be bound, `read-key-sequence' turns the event into a click event at the
10312 drag's starting position. This means that you don't have to distinguish
10313 between click and drag, double, or triple events unless you want to.
10315 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10316 lines separating windows, and scroll bars with imaginary keys
10317 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10319 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10320 function will process a switch-frame event if the user switches frames
10321 before typing anything. If the user switches frames in the middle of a
10322 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10323 is nil, then the event will be put off until after the current key sequence.
10325 `read-key-sequence' checks `function-key-map' for function key
10326 sequences, where they wouldn't conflict with ordinary bindings. See
10327 `function-key-map' for more details.
10329 The optional fifth argument COMMAND-LOOP, if non-nil, means
10330 that this key sequence is being read by something that will
10331 read commands one after another. It should be nil if the caller
10332 will read just one key sequence. */)
10333 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10335 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10336 Lisp_Object can_return_switch_frame
, command_loop
;
10338 Lisp_Object keybuf
[30];
10340 struct gcpro gcpro1
;
10341 int count
= SPECPDL_INDEX ();
10343 if (!NILP (prompt
))
10344 CHECK_STRING (prompt
);
10347 specbind (Qinput_method_exit_on_first_char
,
10348 (NILP (command_loop
) ? Qt
: Qnil
));
10349 specbind (Qinput_method_use_echo_area
,
10350 (NILP (command_loop
) ? Qt
: Qnil
));
10352 bzero (keybuf
, sizeof keybuf
);
10353 GCPRO1 (keybuf
[0]);
10354 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10356 if (NILP (continue_echo
))
10358 this_command_key_count
= 0;
10359 this_command_key_count_reset
= 0;
10360 this_single_command_key_start
= 0;
10363 #ifdef HAVE_WINDOW_SYSTEM
10364 if (display_hourglass_p
)
10365 cancel_hourglass ();
10368 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10369 prompt
, ! NILP (dont_downcase_last
),
10370 ! NILP (can_return_switch_frame
), 0);
10372 #if 0 /* The following is fine for code reading a key sequence and
10373 then proceeding with a lenghty computation, but it's not good
10374 for code reading keys in a loop, like an input method. */
10375 #ifdef HAVE_WINDOW_SYSTEM
10376 if (display_hourglass_p
)
10377 start_hourglass ();
10387 return unbind_to (count
, make_event_array (i
, keybuf
));
10390 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10391 Sread_key_sequence_vector
, 1, 5, 0,
10392 doc
: /* Like `read-key-sequence' but always return a vector. */)
10393 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10395 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10396 Lisp_Object can_return_switch_frame
, command_loop
;
10398 Lisp_Object keybuf
[30];
10400 struct gcpro gcpro1
;
10401 int count
= SPECPDL_INDEX ();
10403 if (!NILP (prompt
))
10404 CHECK_STRING (prompt
);
10407 specbind (Qinput_method_exit_on_first_char
,
10408 (NILP (command_loop
) ? Qt
: Qnil
));
10409 specbind (Qinput_method_use_echo_area
,
10410 (NILP (command_loop
) ? Qt
: Qnil
));
10412 bzero (keybuf
, sizeof keybuf
);
10413 GCPRO1 (keybuf
[0]);
10414 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10416 if (NILP (continue_echo
))
10418 this_command_key_count
= 0;
10419 this_command_key_count_reset
= 0;
10420 this_single_command_key_start
= 0;
10423 #ifdef HAVE_WINDOW_SYSTEM
10424 if (display_hourglass_p
)
10425 cancel_hourglass ();
10428 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10429 prompt
, ! NILP (dont_downcase_last
),
10430 ! NILP (can_return_switch_frame
), 0);
10432 #ifdef HAVE_WINDOW_SYSTEM
10433 if (display_hourglass_p
)
10434 start_hourglass ();
10443 return unbind_to (count
, Fvector (i
, keybuf
));
10446 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10447 doc
: /* Execute CMD as an editor command.
10448 CMD must be a symbol that satisfies the `commandp' predicate.
10449 Optional second arg RECORD-FLAG non-nil
10450 means unconditionally put this command in `command-history'.
10451 Otherwise, that is done only if an arg is read using the minibuffer.
10452 The argument KEYS specifies the value to use instead of (this-command-keys)
10453 when reading the arguments; if it is nil, (this-command-keys) is used.
10454 The argument SPECIAL, if non-nil, means that this command is executing
10455 a special event, so ignore the prefix argument and don't clear it. */)
10456 (cmd
, record_flag
, keys
, special
)
10457 Lisp_Object cmd
, record_flag
, keys
, special
;
10459 register Lisp_Object final
;
10460 register Lisp_Object tem
;
10461 Lisp_Object prefixarg
;
10462 extern int debug_on_next_call
;
10464 debug_on_next_call
= 0;
10466 if (NILP (special
))
10468 prefixarg
= current_kboard
->Vprefix_arg
;
10469 Vcurrent_prefix_arg
= prefixarg
;
10470 current_kboard
->Vprefix_arg
= Qnil
;
10477 tem
= Fget (cmd
, Qdisabled
);
10478 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10480 tem
= Fsymbol_value (Qdisabled_command_function
);
10482 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10488 final
= Findirect_function (cmd
, Qnil
);
10490 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10492 struct gcpro gcpro1
, gcpro2
;
10494 GCPRO2 (cmd
, prefixarg
);
10495 do_autoload (final
, cmd
);
10502 if (STRINGP (final
) || VECTORP (final
))
10504 /* If requested, place the macro in the command history. For
10505 other sorts of commands, call-interactively takes care of
10507 if (!NILP (record_flag
))
10510 = Fcons (Fcons (Qexecute_kbd_macro
,
10511 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10514 /* Don't keep command history around forever. */
10515 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10517 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10519 XSETCDR (tem
, Qnil
);
10523 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10526 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10527 /* Don't call Fcall_interactively directly because we want to make
10528 sure the backtrace has an entry for `call-interactively'.
10529 For the same reason, pass `cmd' rather than `final'. */
10530 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10537 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10539 doc
: /* Read function name, then read its arguments and call it.
10541 To pass a numeric argument to the command you are invoking with, specify
10542 the numeric argument to this command.
10544 Noninteractively, the argument PREFIXARG is the prefix argument to
10545 give to the command you invoke, if it asks for an argument. */)
10547 Lisp_Object prefixarg
;
10549 Lisp_Object function
;
10551 int saved_last_point_position
;
10552 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10553 Lisp_Object bindings
, value
;
10554 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10555 #ifdef HAVE_WINDOW_SYSTEM
10556 /* The call to Fcompleting_read wil start and cancel the hourglass,
10557 but if the hourglass was already scheduled, this means that no
10558 hourglass will be shown for the actual M-x command itself.
10559 So we restart it if it is already scheduled. Note that checking
10560 hourglass_shown_p is not enough, normally the hourglass is not shown,
10561 just scheduled to be shown. */
10562 int hstarted
= hourglass_started ();
10565 saved_keys
= Fvector (this_command_key_count
,
10566 XVECTOR (this_command_keys
)->contents
);
10567 saved_last_point_position_buffer
= last_point_position_buffer
;
10568 saved_last_point_position
= last_point_position
;
10570 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10572 if (EQ (prefixarg
, Qminus
))
10573 strcpy (buf
, "- ");
10574 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10575 strcpy (buf
, "C-u ");
10576 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10577 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10578 else if (INTEGERP (prefixarg
))
10579 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10581 /* This isn't strictly correct if execute-extended-command
10582 is bound to anything else. Perhaps it should use
10583 this_command_keys? */
10584 strcat (buf
, "M-x ");
10586 /* Prompt with buf, and then read a string, completing from and
10587 restricting to the set of all defined commands. Don't provide
10588 any initial input. Save the command read on the extended-command
10590 function
= Fcompleting_read (build_string (buf
),
10591 Vobarray
, Qcommandp
,
10592 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10595 #ifdef HAVE_WINDOW_SYSTEM
10596 if (hstarted
) start_hourglass ();
10599 if (STRINGP (function
) && SCHARS (function
) == 0)
10600 error ("No command name given");
10602 /* Set this_command_keys to the concatenation of saved_keys and
10603 function, followed by a RET. */
10608 this_command_key_count
= 0;
10609 this_command_key_count_reset
= 0;
10610 this_single_command_key_start
= 0;
10612 keys
= XVECTOR (saved_keys
)->contents
;
10613 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10614 add_command_key (keys
[i
]);
10616 for (i
= 0; i
< SCHARS (function
); i
++)
10617 add_command_key (Faref (function
, make_number (i
)));
10619 add_command_key (make_number ('\015'));
10622 last_point_position
= saved_last_point_position
;
10623 last_point_position_buffer
= saved_last_point_position_buffer
;
10627 function
= Fintern (function
, Qnil
);
10628 current_kboard
->Vprefix_arg
= prefixarg
;
10629 Vthis_command
= function
;
10630 real_this_command
= function
;
10632 /* If enabled, show which key runs this command. */
10633 if (!NILP (Vsuggest_key_bindings
)
10634 && NILP (Vexecuting_kbd_macro
)
10635 && SYMBOLP (function
))
10636 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10642 GCPRO3 (bindings
, value
, function
);
10643 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10645 /* If the command has a key binding, print it now. */
10646 if (!NILP (bindings
)
10647 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10650 /* But first wait, and skip the message if there is input. */
10651 Lisp_Object waited
;
10653 /* If this command displayed something in the echo area;
10654 wait a few seconds, then display our suggestion message. */
10655 if (NILP (echo_area_buffer
[0]))
10656 waited
= sit_for (make_number (0), 0, 2);
10657 else if (NUMBERP (Vsuggest_key_bindings
))
10658 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10660 waited
= sit_for (make_number (2), 0, 2);
10662 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10664 Lisp_Object binding
;
10666 int message_p
= push_message ();
10667 int count
= SPECPDL_INDEX ();
10669 record_unwind_protect (pop_message_unwind
, Qnil
);
10670 binding
= Fkey_description (bindings
, Qnil
);
10673 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10676 sprintf (newmessage
, "You can run the command `%s' with %s",
10677 SDATA (SYMBOL_NAME (function
)),
10679 message2_nolog (newmessage
,
10680 strlen (newmessage
),
10681 STRING_MULTIBYTE (binding
));
10682 if (NUMBERP (Vsuggest_key_bindings
))
10683 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10685 waited
= sit_for (make_number (2), 0, 2);
10687 if (!NILP (waited
) && message_p
)
10688 restore_message ();
10690 unbind_to (count
, Qnil
);
10694 RETURN_UNGCPRO (value
);
10698 /* Return nonzero if input events are pending. */
10701 detect_input_pending ()
10703 if (!input_pending
)
10704 get_input_pending (&input_pending
, 0);
10706 return input_pending
;
10709 /* Return nonzero if input events other than mouse movements are
10713 detect_input_pending_ignore_squeezables ()
10715 if (!input_pending
)
10716 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10718 return input_pending
;
10721 /* Return nonzero if input events are pending, and run any pending timers. */
10724 detect_input_pending_run_timers (do_display
)
10727 int old_timers_run
= timers_run
;
10729 if (!input_pending
)
10730 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10732 if (old_timers_run
!= timers_run
&& do_display
)
10734 redisplay_preserve_echo_area (8);
10735 /* The following fixes a bug when using lazy-lock with
10736 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10737 from an idle timer function. The symptom of the bug is that
10738 the cursor sometimes doesn't become visible until the next X
10739 event is processed. --gerd. */
10741 Lisp_Object tail
, frame
;
10742 FOR_EACH_FRAME (tail
, frame
)
10743 if (FRAME_RIF (XFRAME (frame
)))
10744 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10748 return input_pending
;
10751 /* This is called in some cases before a possible quit.
10752 It cases the next call to detect_input_pending to recompute input_pending.
10753 So calling this function unnecessarily can't do any harm. */
10756 clear_input_pending ()
10761 /* Return nonzero if there are pending requeued events.
10762 This isn't used yet. The hope is to make wait_reading_process_output
10763 call it, and return if it runs Lisp code that unreads something.
10764 The problem is, kbd_buffer_get_event needs to be fixed to know what
10765 to do in that case. It isn't trivial. */
10768 requeued_events_pending_p ()
10770 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10774 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10775 doc
: /* Return t if command input is currently available with no wait.
10776 Actually, the value is nil only if we can be sure that no input is available;
10777 if there is a doubt, the value is t. */)
10780 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10781 || !NILP (Vunread_post_input_method_events
)
10782 || !NILP (Vunread_input_method_events
))
10785 get_input_pending (&input_pending
,
10786 READABLE_EVENTS_DO_TIMERS_NOW
10787 | READABLE_EVENTS_FILTER_EVENTS
);
10788 return input_pending
> 0 ? Qt
: Qnil
;
10791 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10792 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10795 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10798 if (total_keys
< NUM_RECENT_KEYS
)
10799 return Fvector (total_keys
, keys
);
10802 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10803 bcopy (keys
+ recent_keys_index
,
10804 XVECTOR (val
)->contents
,
10805 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10807 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10808 recent_keys_index
* sizeof (Lisp_Object
));
10813 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10814 doc
: /* Return the key sequence that invoked this command.
10815 However, if the command has called `read-key-sequence', it returns
10816 the last key sequence that has been read.
10817 The value is a string or a vector.
10819 See also `this-command-keys-vector'. */)
10822 return make_event_array (this_command_key_count
,
10823 XVECTOR (this_command_keys
)->contents
);
10826 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10827 doc
: /* Return the key sequence that invoked this command, as a vector.
10828 However, if the command has called `read-key-sequence', it returns
10829 the last key sequence that has been read.
10831 See also `this-command-keys'. */)
10834 return Fvector (this_command_key_count
,
10835 XVECTOR (this_command_keys
)->contents
);
10838 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10839 Sthis_single_command_keys
, 0, 0, 0,
10840 doc
: /* Return the key sequence that invoked this command.
10841 More generally, it returns the last key sequence read, either by
10842 the command loop or by `read-key-sequence'.
10843 Unlike `this-command-keys', this function's value
10844 does not include prefix arguments.
10845 The value is always a vector. */)
10848 return Fvector (this_command_key_count
10849 - this_single_command_key_start
,
10850 (XVECTOR (this_command_keys
)->contents
10851 + this_single_command_key_start
));
10854 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10855 Sthis_single_command_raw_keys
, 0, 0, 0,
10856 doc
: /* Return the raw events that were read for this command.
10857 More generally, it returns the last key sequence read, either by
10858 the command loop or by `read-key-sequence'.
10859 Unlike `this-single-command-keys', this function's value
10860 shows the events before all translations (except for input methods).
10861 The value is always a vector. */)
10864 return Fvector (raw_keybuf_count
,
10865 (XVECTOR (raw_keybuf
)->contents
));
10868 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10869 Sreset_this_command_lengths
, 0, 0, 0,
10870 doc
: /* Make the unread events replace the last command and echo.
10871 Used in `universal-argument-other-key'.
10873 `universal-argument-other-key' rereads the event just typed.
10874 It then gets translated through `function-key-map'.
10875 The translated event has to replace the real events,
10876 both in the value of (this-command-keys) and in echoing.
10877 To achieve this, `universal-argument-other-key' calls
10878 `reset-this-command-lengths', which discards the record of reading
10879 these events the first time. */)
10882 this_command_key_count
= before_command_key_count
;
10883 if (this_command_key_count
< this_single_command_key_start
)
10884 this_single_command_key_start
= this_command_key_count
;
10886 echo_truncate (before_command_echo_length
);
10888 /* Cause whatever we put into unread-command-events
10889 to echo as if it were being freshly read from the keyboard. */
10890 this_command_key_count_reset
= 1;
10895 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10896 Sclear_this_command_keys
, 0, 1, 0,
10897 doc
: /* Clear out the vector that `this-command-keys' returns.
10898 Also clear the record of the last 100 events, unless optional arg
10899 KEEP-RECORD is non-nil. */)
10901 Lisp_Object keep_record
;
10905 this_command_key_count
= 0;
10906 this_command_key_count_reset
= 0;
10908 if (NILP (keep_record
))
10910 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10911 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10913 recent_keys_index
= 0;
10918 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10919 doc
: /* Return the current depth in recursive edits. */)
10923 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10927 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10928 "FOpen dribble file: ",
10929 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10930 If FILE is nil, close any open dribble file. */)
10943 file
= Fexpand_file_name (file
, Qnil
);
10944 dribble
= fopen (SDATA (file
), "w");
10946 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10951 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10952 doc
: /* Discard the contents of the terminal input buffer.
10953 Also end any kbd macro being defined. */)
10956 if (!NILP (current_kboard
->defining_kbd_macro
))
10958 /* Discard the last command from the macro. */
10959 Fcancel_kbd_macro_events ();
10963 update_mode_lines
++;
10965 Vunread_command_events
= Qnil
;
10966 unread_command_char
= -1;
10968 discard_tty_input ();
10970 kbd_fetch_ptr
= kbd_store_ptr
;
10976 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10977 doc
: /* Stop Emacs and return to superior process. You can resume later.
10978 If `cannot-suspend' is non-nil, or if the system doesn't support job
10979 control, run a subshell instead.
10981 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10982 to be read as terminal input by Emacs's parent, after suspension.
10984 Before suspending, run the normal hook `suspend-hook'.
10985 After resumption run the normal hook `suspend-resume-hook'.
10987 Some operating systems cannot stop the Emacs process and resume it later.
10988 On such systems, Emacs starts a subshell instead of suspending. */)
10990 Lisp_Object stuffstring
;
10992 int count
= SPECPDL_INDEX ();
10993 int old_height
, old_width
;
10995 struct gcpro gcpro1
;
10997 if (tty_list
&& tty_list
->next
)
10998 error ("There are other tty frames open; close them before suspending Emacs");
11000 if (!NILP (stuffstring
))
11001 CHECK_STRING (stuffstring
);
11003 /* Run the functions in suspend-hook. */
11004 if (!NILP (Vrun_hooks
))
11005 call1 (Vrun_hooks
, intern ("suspend-hook"));
11007 GCPRO1 (stuffstring
);
11008 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
11009 reset_all_sys_modes ();
11010 /* sys_suspend can get an error if it tries to fork a subshell
11011 and the system resources aren't available for that. */
11012 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
11014 stuff_buffered_input (stuffstring
);
11015 if (cannot_suspend
)
11019 unbind_to (count
, Qnil
);
11021 /* Check if terminal/window size has changed.
11022 Note that this is not useful when we are running directly
11023 with a window system; but suspend should be disabled in that case. */
11024 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
11025 if (width
!= old_width
|| height
!= old_height
)
11026 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
11028 /* Run suspend-resume-hook. */
11029 if (!NILP (Vrun_hooks
))
11030 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
11036 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
11037 Then in any case stuff anything Emacs has read ahead and not used. */
11040 stuff_buffered_input (stuffstring
)
11041 Lisp_Object stuffstring
;
11043 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
11044 register unsigned char *p
;
11046 if (STRINGP (stuffstring
))
11048 register int count
;
11050 p
= SDATA (stuffstring
);
11051 count
= SBYTES (stuffstring
);
11052 while (count
-- > 0)
11057 /* Anything we have read ahead, put back for the shell to read. */
11058 /* ?? What should this do when we have multiple keyboards??
11059 Should we ignore anything that was typed in at the "wrong" kboard?
11061 rms: we should stuff everything back into the kboard
11063 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
11066 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11067 kbd_fetch_ptr
= kbd_buffer
;
11068 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
11069 stuff_char (kbd_fetch_ptr
->code
);
11071 clear_event (kbd_fetch_ptr
);
11075 #endif /* SIGTSTP */
11079 set_waiting_for_input (time_to_clear
)
11080 EMACS_TIME
*time_to_clear
;
11082 input_available_clear_time
= time_to_clear
;
11084 /* Tell handle_interrupt to throw back to read_char, */
11085 waiting_for_input
= 1;
11087 /* If handle_interrupt was called before and buffered a C-g,
11088 make it run again now, to avoid timing error. */
11089 if (!NILP (Vquit_flag
))
11090 quit_throw_to_read_char ();
11094 clear_waiting_for_input ()
11096 /* Tell handle_interrupt not to throw back to read_char, */
11097 waiting_for_input
= 0;
11098 input_available_clear_time
= 0;
11101 /* The SIGINT handler.
11103 If we have a frame on the controlling tty, we assume that the
11104 SIGINT was generated by C-g, so we call handle_interrupt.
11105 Otherwise, the handler kills Emacs. */
11108 interrupt_signal (signalnum
) /* If we don't have an argument, */
11109 int signalnum
; /* some compilers complain in signal calls. */
11111 /* Must preserve main program's value of errno. */
11112 int old_errno
= errno
;
11113 struct terminal
*terminal
;
11115 #if defined (USG) && !defined (POSIX_SIGNALS)
11116 /* USG systems forget handlers when they are used;
11117 must reestablish each time */
11118 signal (SIGINT
, interrupt_signal
);
11119 signal (SIGQUIT
, interrupt_signal
);
11122 SIGNAL_THREAD_CHECK (signalnum
);
11124 /* See if we have an active terminal on our controlling tty. */
11125 terminal
= get_named_tty ("/dev/tty");
11128 /* If there are no frames there, let's pretend that we are a
11129 well-behaving UN*X program and quit. */
11130 Fkill_emacs (Qnil
);
11134 /* Otherwise, the SIGINT was probably generated by C-g. */
11136 /* Set internal_last_event_frame to the top frame of the
11137 controlling tty, if we have a frame there. We disable the
11138 interrupt key on secondary ttys, so the SIGINT must have come
11139 from the controlling tty. */
11140 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11142 handle_interrupt ();
11148 /* This routine is called at interrupt level in response to C-g.
11150 It is called from the SIGINT handler or kbd_buffer_store_event.
11152 If `waiting_for_input' is non zero, then unless `echoing' is
11153 nonzero, immediately throw back to read_char.
11155 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11156 eval to throw, when it gets a chance. If quit-flag is already
11157 non-nil, it stops the job right away. */
11160 handle_interrupt ()
11166 /* XXX This code needs to be revised for multi-tty support. */
11167 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
11169 /* If SIGINT isn't blocked, don't let us be interrupted by
11170 another SIGINT, it might be harmful due to non-reentrancy
11171 in I/O functions. */
11172 sigblock (sigmask (SIGINT
));
11175 reset_all_sys_modes ();
11177 #ifdef SIGTSTP /* Support possible in later USG versions */
11179 * On systems which can suspend the current process and return to the original
11180 * shell, this command causes the user to end up back at the shell.
11181 * The "Auto-save" and "Abort" questions are not asked until
11182 * the user elects to return to emacs, at which point he can save the current
11183 * job and either dump core or continue.
11187 /* Perhaps should really fork an inferior shell?
11188 But that would not provide any way to get back
11189 to the original shell, ever. */
11190 printf ("No support for stopping a process on this operating system;\n");
11191 printf ("you can continue or abort.\n");
11192 #endif /* not SIGTSTP */
11194 /* We must remain inside the screen area when the internal terminal
11195 is used. Note that [Enter] is not echoed by dos. */
11196 cursor_to (SELECTED_FRAME (), 0, 0);
11198 /* It doesn't work to autosave while GC is in progress;
11199 the code used for auto-saving doesn't cope with the mark bit. */
11200 if (!gc_in_progress
)
11202 printf ("Auto-save? (y or n) ");
11204 if (((c
= getchar ()) & ~040) == 'Y')
11206 Fdo_auto_save (Qt
, Qnil
);
11208 printf ("\r\nAuto-save done");
11209 #else /* not MSDOS */
11210 printf ("Auto-save done\n");
11211 #endif /* not MSDOS */
11213 while (c
!= '\n') c
= getchar ();
11217 /* During GC, it must be safe to reenable quitting again. */
11218 Vinhibit_quit
= Qnil
;
11221 #endif /* not MSDOS */
11222 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11223 printf ("but will instead do a real quit after garbage collection ends\r\n");
11228 printf ("\r\nAbort? (y or n) ");
11229 #else /* not MSDOS */
11230 printf ("Abort (and dump core)? (y or n) ");
11231 #endif /* not MSDOS */
11233 if (((c
= getchar ()) & ~040) == 'Y')
11235 while (c
!= '\n') c
= getchar ();
11237 printf ("\r\nContinuing...\r\n");
11238 #else /* not MSDOS */
11239 printf ("Continuing...\n");
11240 #endif /* not MSDOS */
11242 init_all_sys_modes ();
11247 /* If executing a function that wants to be interrupted out of
11248 and the user has not deferred quitting by binding `inhibit-quit'
11249 then quit right away. */
11250 if (immediate_quit
&& NILP (Vinhibit_quit
))
11252 struct gl_state_s saved
;
11253 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11255 immediate_quit
= 0;
11258 GCPRO4 (saved
.object
, saved
.global_code
,
11259 saved
.current_syntax_table
, saved
.old_prop
);
11260 Fsignal (Qquit
, Qnil
);
11265 /* Else request quit when it's safe */
11269 /* TODO: The longjmp in this call throws the NS event loop integration off,
11270 and it seems to do fine without this. Probably some attention
11271 needs to be paid to the setting of waiting_for_input in
11272 wait_reading_process_output() under HAVE_NS because of the call
11273 to ns_select there (needed because otherwise events aren't picked up
11274 outside of polling since we don't get SIGIO like X and we don't have a
11275 separate event loop thread like W32. */
11277 if (waiting_for_input
&& !echoing
)
11278 quit_throw_to_read_char ();
11282 /* Handle a C-g by making read_char return C-g. */
11285 quit_throw_to_read_char ()
11288 /* Prevent another signal from doing this before we finish. */
11289 clear_waiting_for_input ();
11292 Vunread_command_events
= Qnil
;
11293 unread_command_char
= -1;
11295 #if 0 /* Currently, sit_for is called from read_char without turning
11296 off polling. And that can call set_waiting_for_input.
11297 It seems to be harmless. */
11298 #ifdef POLL_FOR_INPUT
11299 /* May be > 1 if in recursive minibuffer. */
11300 if (poll_suppress_count
== 0)
11304 if (FRAMEP (internal_last_event_frame
)
11305 && !EQ (internal_last_event_frame
, selected_frame
))
11306 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11309 _longjmp (getcjmp
, 1);
11312 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11313 doc
: /* Set interrupt mode of reading keyboard input.
11314 If INTERRUPT is non-nil, Emacs will use input interrupts;
11315 otherwise Emacs uses CBREAK mode.
11317 See also `current-input-mode'. */)
11319 Lisp_Object interrupt
;
11321 int new_interrupt_input
;
11323 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11324 #ifdef HAVE_X_WINDOWS
11325 if (x_display_list
!= NULL
)
11327 /* When using X, don't give the user a real choice,
11328 because we haven't implemented the mechanisms to support it. */
11329 #ifdef NO_SOCK_SIGIO
11330 new_interrupt_input
= 0;
11331 #else /* not NO_SOCK_SIGIO */
11332 new_interrupt_input
= 1;
11333 #endif /* NO_SOCK_SIGIO */
11336 #endif /* HAVE_X_WINDOWS */
11337 new_interrupt_input
= !NILP (interrupt
);
11338 #else /* not SIGIO */
11339 new_interrupt_input
= 0;
11340 #endif /* not SIGIO */
11342 if (new_interrupt_input
!= interrupt_input
)
11344 #ifdef POLL_FOR_INPUT
11348 /* this causes startup screen to be restored and messes with the mouse */
11349 reset_all_sys_modes ();
11351 interrupt_input
= new_interrupt_input
;
11353 init_all_sys_modes ();
11356 #ifdef POLL_FOR_INPUT
11357 poll_suppress_count
= 1;
11364 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11365 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11366 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11367 C-q in key sequences.
11369 This setting only has an effect on tty terminals and only when
11370 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11372 See also `current-input-mode'. */)
11374 Lisp_Object flow
, terminal
;
11376 struct terminal
*t
= get_terminal (terminal
, 1);
11377 struct tty_display_info
*tty
;
11378 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11380 tty
= t
->display_info
.tty
;
11382 if (tty
->flow_control
!= !NILP (flow
))
11385 /* this causes startup screen to be restored and messes with the mouse */
11386 reset_sys_modes (tty
);
11389 tty
->flow_control
= !NILP (flow
);
11392 init_sys_modes (tty
);
11398 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11399 doc
: /* Enable or disable 8-bit input on TERMINAL.
11400 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11401 bit as the Meta modifier.
11403 If META is nil, Emacs will ignore the top bit, on the assumption it is
11406 Otherwise, Emacs will accept and pass through 8-bit input without
11407 specially interpreting the top bit.
11409 This setting only has an effect on tty terminal devices.
11411 Optional parameter TERMINAL specifies the tty terminal device to use.
11412 It may be a terminal object, a frame, or nil for the terminal used by
11413 the currently selected frame.
11415 See also `current-input-mode'. */)
11417 Lisp_Object meta
, terminal
;
11419 struct terminal
*t
= get_terminal (terminal
, 1);
11420 struct tty_display_info
*tty
;
11423 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11425 tty
= t
->display_info
.tty
;
11429 else if (EQ (meta
, Qt
))
11434 if (tty
->meta_key
!= new_meta
)
11437 /* this causes startup screen to be restored and messes with the mouse */
11438 reset_sys_modes (tty
);
11441 tty
->meta_key
= new_meta
;
11444 init_sys_modes (tty
);
11450 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11451 doc
: /* Specify character used for quitting.
11452 QUIT must be an ASCII character.
11454 This function only has an effect on the controlling tty of the Emacs
11457 See also `current-input-mode'. */)
11461 struct terminal
*t
= get_named_tty ("/dev/tty");
11462 struct tty_display_info
*tty
;
11463 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11465 tty
= t
->display_info
.tty
;
11467 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11468 error ("QUIT must be an ASCII character");
11471 /* this causes startup screen to be restored and messes with the mouse */
11472 reset_sys_modes (tty
);
11475 /* Don't let this value be out of range. */
11476 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11479 init_sys_modes (tty
);
11485 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11486 doc
: /* Set mode of reading keyboard input.
11487 First arg INTERRUPT non-nil means use input interrupts;
11488 nil means use CBREAK mode.
11489 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11490 (no effect except in CBREAK mode).
11491 Third arg META t means accept 8-bit input (for a Meta key).
11492 META nil means ignore the top bit, on the assumption it is parity.
11493 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11494 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11495 See also `current-input-mode'. */)
11496 (interrupt
, flow
, meta
, quit
)
11497 Lisp_Object interrupt
, flow
, meta
, quit
;
11499 Fset_input_interrupt_mode (interrupt
);
11500 Fset_output_flow_control (flow
, Qnil
);
11501 Fset_input_meta_mode (meta
, Qnil
);
11503 Fset_quit_char (quit
);
11507 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11508 doc
: /* Return information about the way Emacs currently reads keyboard input.
11509 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11510 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11511 nil, Emacs is using CBREAK mode.
11512 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11513 terminal; this does not apply if Emacs uses interrupt-driven input.
11514 META is t if accepting 8-bit input with 8th bit as Meta flag.
11515 META nil means ignoring the top bit, on the assumption it is parity.
11516 META is neither t nor nil if accepting 8-bit input and using
11517 all 8 bits as the character code.
11518 QUIT is the character Emacs currently uses to quit.
11519 The elements of this list correspond to the arguments of
11520 `set-input-mode'. */)
11523 Lisp_Object val
[4];
11524 struct frame
*sf
= XFRAME (selected_frame
);
11526 val
[0] = interrupt_input
? Qt
: Qnil
;
11527 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11529 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11530 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11532 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11539 XSETFASTINT (val
[3], quit_char
);
11541 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11544 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11545 doc
: /* Return position information for pixel coordinates X and Y.
11546 By default, X and Y are relative to text area of the selected window.
11547 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11548 If optional fourth arg WHOLE is non-nil, X is relative to the left
11549 edge of the window.
11551 The return value is similar to a mouse click position:
11552 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11553 IMAGE (DX . DY) (WIDTH . HEIGHT))
11554 The `posn-' functions access elements of such lists. */)
11555 (x
, y
, frame_or_window
, whole
)
11556 Lisp_Object x
, y
, frame_or_window
, whole
;
11561 if (NILP (frame_or_window
))
11562 frame_or_window
= selected_window
;
11564 if (WINDOWP (frame_or_window
))
11568 CHECK_LIVE_WINDOW (frame_or_window
);
11570 w
= XWINDOW (frame_or_window
);
11571 XSETINT (x
, (XINT (x
)
11572 + WINDOW_LEFT_EDGE_X (w
)
11574 ? window_box_left_offset (w
, TEXT_AREA
)
11576 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11577 frame_or_window
= w
->frame
;
11580 CHECK_LIVE_FRAME (frame_or_window
);
11582 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11585 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11586 doc
: /* Return position information for buffer POS in WINDOW.
11587 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11589 Return nil if position is not visible in window. Otherwise,
11590 the return value is similar to that returned by `event-start' for
11591 a mouse click at the upper left corner of the glyph corresponding
11592 to the given buffer position:
11593 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11594 IMAGE (DX . DY) (WIDTH . HEIGHT))
11595 The `posn-' functions access elements of such lists. */)
11597 Lisp_Object pos
, window
;
11602 window
= selected_window
;
11604 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11607 Lisp_Object x
= XCAR (tem
);
11608 Lisp_Object y
= XCAR (XCDR (tem
));
11610 /* Point invisible due to hscrolling? */
11613 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11621 * Set up a new kboard object with reasonable initial values.
11627 kb
->Voverriding_terminal_local_map
= Qnil
;
11628 kb
->Vlast_command
= Qnil
;
11629 kb
->Vreal_last_command
= Qnil
;
11630 kb
->Vkeyboard_translate_table
= Qnil
;
11631 kb
->Vlast_repeatable_command
= Qnil
;
11632 kb
->Vprefix_arg
= Qnil
;
11633 kb
->Vlast_prefix_arg
= Qnil
;
11634 kb
->kbd_queue
= Qnil
;
11635 kb
->kbd_queue_has_data
= 0;
11636 kb
->immediate_echo
= 0;
11637 kb
->echo_string
= Qnil
;
11638 kb
->echo_after_prompt
= -1;
11639 kb
->kbd_macro_buffer
= 0;
11640 kb
->kbd_macro_bufsize
= 0;
11641 kb
->defining_kbd_macro
= Qnil
;
11642 kb
->Vlast_kbd_macro
= Qnil
;
11643 kb
->reference_count
= 0;
11644 kb
->Vsystem_key_alist
= Qnil
;
11645 kb
->system_key_syms
= Qnil
;
11646 kb
->Vwindow_system
= Qt
; /* Unset. */
11647 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11648 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11649 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11650 kb
->Vdefault_minibuffer_frame
= Qnil
;
11654 * Destroy the contents of a kboard object, but not the object itself.
11655 * We use this just before deleting it, or if we're going to initialize
11656 * it a second time.
11662 xfree (kb
->kbd_macro_buffer
);
11665 /* Free KB and memory referenced from it. */
11673 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11676 *kbp
= kb
->next_kboard
;
11678 /* Prevent a dangling reference to KB. */
11679 if (kb
== current_kboard
11680 && FRAMEP (selected_frame
)
11681 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11683 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11685 if (current_kboard
== kb
)
11696 /* This is correct before outermost invocation of the editor loop */
11697 command_loop_level
= -1;
11698 immediate_quit
= 0;
11699 quit_char
= Ctl ('g');
11700 Vunread_command_events
= Qnil
;
11701 unread_command_char
= -1;
11702 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11704 recent_keys_index
= 0;
11705 kbd_fetch_ptr
= kbd_buffer
;
11706 kbd_store_ptr
= kbd_buffer
;
11707 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11708 do_mouse_tracking
= Qnil
;
11711 interrupt_input_blocked
= 0;
11712 interrupt_input_pending
= 0;
11714 pending_signals
= 0;
11717 /* This means that command_loop_1 won't try to select anything the first
11719 internal_last_event_frame
= Qnil
;
11720 Vlast_event_frame
= internal_last_event_frame
;
11722 current_kboard
= initial_kboard
;
11723 /* Re-initialize the keyboard again. */
11724 wipe_kboard (current_kboard
);
11725 init_kboard (current_kboard
);
11726 /* A value of nil for Vwindow_system normally means a tty, but we also use
11727 it for the initial terminal since there is no window system there. */
11728 current_kboard
->Vwindow_system
= Qnil
;
11730 if (!noninteractive
)
11732 /* Before multi-tty support, these handlers used to be installed
11733 only if the current session was a tty session. Now an Emacs
11734 session may have multiple display types, so we always handle
11735 SIGINT. There is special code in interrupt_signal to exit
11736 Emacs on SIGINT when there are no termcap frames on the
11737 controlling terminal. */
11738 signal (SIGINT
, interrupt_signal
);
11739 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11740 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11741 SIGQUIT and we can't tell which one it will give us. */
11742 signal (SIGQUIT
, interrupt_signal
);
11743 #endif /* HAVE_TERMIO */
11745 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11747 if (!noninteractive
)
11748 signal (SIGIO
, input_available_signal
);
11751 /* Use interrupt input by default, if it works and noninterrupt input
11752 has deficiencies. */
11754 #ifdef INTERRUPT_INPUT
11755 interrupt_input
= 1;
11757 interrupt_input
= 0;
11763 if (keyboard_init_hook
)
11764 (*keyboard_init_hook
) ();
11766 #ifdef POLL_FOR_INPUT
11768 poll_suppress_count
= 1;
11773 /* This type's only use is in syms_of_keyboard, to initialize the
11774 event header symbols and put properties on them. */
11775 struct event_head
{
11781 struct event_head head_table
[] = {
11782 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11783 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11784 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11785 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11786 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11787 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11788 /* `select-window' should be handled just like `switch-frame'
11789 in read_key_sequence. */
11790 {&Qselect_window
, "select-window", &Qswitch_frame
}
11794 syms_of_keyboard ()
11796 pending_funcalls
= Qnil
;
11797 staticpro (&pending_funcalls
);
11799 Vlispy_mouse_stem
= build_string ("mouse");
11800 staticpro (&Vlispy_mouse_stem
);
11803 QCimage
= intern (":image");
11804 staticpro (&QCimage
);
11806 staticpro (&Qhelp_echo
);
11807 Qhelp_echo
= intern ("help-echo");
11810 Qrtl
= intern (":rtl");
11812 staticpro (&item_properties
);
11813 item_properties
= Qnil
;
11815 staticpro (&tool_bar_item_properties
);
11816 tool_bar_item_properties
= Qnil
;
11817 staticpro (&tool_bar_items_vector
);
11818 tool_bar_items_vector
= Qnil
;
11820 staticpro (&real_this_command
);
11821 real_this_command
= Qnil
;
11823 Qtimer_event_handler
= intern ("timer-event-handler");
11824 staticpro (&Qtimer_event_handler
);
11826 Qdisabled_command_function
= intern ("disabled-command-function");
11827 staticpro (&Qdisabled_command_function
);
11829 Qself_insert_command
= intern ("self-insert-command");
11830 staticpro (&Qself_insert_command
);
11832 Qforward_char
= intern ("forward-char");
11833 staticpro (&Qforward_char
);
11835 Qbackward_char
= intern ("backward-char");
11836 staticpro (&Qbackward_char
);
11838 Qdisabled
= intern ("disabled");
11839 staticpro (&Qdisabled
);
11841 Qundefined
= intern ("undefined");
11842 staticpro (&Qundefined
);
11844 Qpre_command_hook
= intern ("pre-command-hook");
11845 staticpro (&Qpre_command_hook
);
11847 Qpost_command_hook
= intern ("post-command-hook");
11848 staticpro (&Qpost_command_hook
);
11850 Qdeferred_action_function
= intern ("deferred-action-function");
11851 staticpro (&Qdeferred_action_function
);
11853 Qcommand_hook_internal
= intern ("command-hook-internal");
11854 staticpro (&Qcommand_hook_internal
);
11856 Qfunction_key
= intern ("function-key");
11857 staticpro (&Qfunction_key
);
11858 Qmouse_click
= intern ("mouse-click");
11859 staticpro (&Qmouse_click
);
11860 #if defined (WINDOWSNT)
11861 Qlanguage_change
= intern ("language-change");
11862 staticpro (&Qlanguage_change
);
11864 Qdrag_n_drop
= intern ("drag-n-drop");
11865 staticpro (&Qdrag_n_drop
);
11867 Qsave_session
= intern ("save-session");
11868 staticpro (&Qsave_session
);
11871 Qdbus_event
= intern ("dbus-event");
11872 staticpro (&Qdbus_event
);
11875 Qmenu_enable
= intern ("menu-enable");
11876 staticpro (&Qmenu_enable
);
11877 Qmenu_alias
= intern ("menu-alias");
11878 staticpro (&Qmenu_alias
);
11879 QCenable
= intern (":enable");
11880 staticpro (&QCenable
);
11881 QCvisible
= intern (":visible");
11882 staticpro (&QCvisible
);
11883 QChelp
= intern (":help");
11884 staticpro (&QChelp
);
11885 QCfilter
= intern (":filter");
11886 staticpro (&QCfilter
);
11887 QCbutton
= intern (":button");
11888 staticpro (&QCbutton
);
11889 QCkeys
= intern (":keys");
11890 staticpro (&QCkeys
);
11891 QCkey_sequence
= intern (":key-sequence");
11892 staticpro (&QCkey_sequence
);
11893 QCtoggle
= intern (":toggle");
11894 staticpro (&QCtoggle
);
11895 QCradio
= intern (":radio");
11896 staticpro (&QCradio
);
11898 Qmode_line
= intern ("mode-line");
11899 staticpro (&Qmode_line
);
11900 Qvertical_line
= intern ("vertical-line");
11901 staticpro (&Qvertical_line
);
11902 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11903 staticpro (&Qvertical_scroll_bar
);
11904 Qmenu_bar
= intern ("menu-bar");
11905 staticpro (&Qmenu_bar
);
11907 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11908 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11909 staticpro (&Qmouse_fixup_help_message
);
11912 Qabove_handle
= intern ("above-handle");
11913 staticpro (&Qabove_handle
);
11914 Qhandle
= intern ("handle");
11915 staticpro (&Qhandle
);
11916 Qbelow_handle
= intern ("below-handle");
11917 staticpro (&Qbelow_handle
);
11918 Qup
= intern ("up");
11920 Qdown
= intern ("down");
11921 staticpro (&Qdown
);
11922 Qtop
= intern ("top");
11924 Qbottom
= intern ("bottom");
11925 staticpro (&Qbottom
);
11926 Qend_scroll
= intern ("end-scroll");
11927 staticpro (&Qend_scroll
);
11928 Qratio
= intern ("ratio");
11929 staticpro (&Qratio
);
11931 Qevent_kind
= intern ("event-kind");
11932 staticpro (&Qevent_kind
);
11933 Qevent_symbol_elements
= intern ("event-symbol-elements");
11934 staticpro (&Qevent_symbol_elements
);
11935 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11936 staticpro (&Qevent_symbol_element_mask
);
11937 Qmodifier_cache
= intern ("modifier-cache");
11938 staticpro (&Qmodifier_cache
);
11940 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11941 staticpro (&Qrecompute_lucid_menubar
);
11942 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11943 staticpro (&Qactivate_menubar_hook
);
11945 Qpolling_period
= intern ("polling-period");
11946 staticpro (&Qpolling_period
);
11948 Qinput_method_function
= intern ("input-method-function");
11949 staticpro (&Qinput_method_function
);
11951 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11952 staticpro (&Qinput_method_exit_on_first_char
);
11953 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11954 staticpro (&Qinput_method_use_echo_area
);
11956 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11957 Fset (Qinput_method_use_echo_area
, Qnil
);
11959 last_point_position_buffer
= Qnil
;
11960 last_point_position_window
= Qnil
;
11963 struct event_head
*p
;
11965 for (p
= head_table
;
11966 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11969 *p
->var
= intern (p
->name
);
11970 staticpro (p
->var
);
11971 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11972 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11976 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11977 staticpro (&button_down_location
);
11978 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11979 staticpro (&mouse_syms
);
11980 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11981 staticpro (&wheel_syms
);
11985 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11987 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11988 for (i
= 0; i
< len
; i
++)
11989 if (modifier_names
[i
])
11990 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11991 staticpro (&modifier_symbols
);
11994 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11995 staticpro (&recent_keys
);
11997 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11998 staticpro (&this_command_keys
);
12000 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
12001 staticpro (&raw_keybuf
);
12003 Qextended_command_history
= intern ("extended-command-history");
12004 Fset (Qextended_command_history
, Qnil
);
12005 staticpro (&Qextended_command_history
);
12007 accent_key_syms
= Qnil
;
12008 staticpro (&accent_key_syms
);
12010 func_key_syms
= Qnil
;
12011 staticpro (&func_key_syms
);
12013 drag_n_drop_syms
= Qnil
;
12014 staticpro (&drag_n_drop_syms
);
12016 unread_switch_frame
= Qnil
;
12017 staticpro (&unread_switch_frame
);
12019 internal_last_event_frame
= Qnil
;
12020 staticpro (&internal_last_event_frame
);
12022 read_key_sequence_cmd
= Qnil
;
12023 staticpro (&read_key_sequence_cmd
);
12025 menu_bar_one_keymap_changed_items
= Qnil
;
12026 staticpro (&menu_bar_one_keymap_changed_items
);
12028 menu_bar_items_vector
= Qnil
;
12029 staticpro (&menu_bar_items_vector
);
12031 help_form_saved_window_configs
= Qnil
;
12032 staticpro (&help_form_saved_window_configs
);
12034 defsubr (&Scurrent_idle_time
);
12035 defsubr (&Sevent_symbol_parse_modifiers
);
12036 defsubr (&Sevent_convert_list
);
12037 defsubr (&Sread_key_sequence
);
12038 defsubr (&Sread_key_sequence_vector
);
12039 defsubr (&Srecursive_edit
);
12040 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
12041 defsubr (&Strack_mouse
);
12043 defsubr (&Sinput_pending_p
);
12044 defsubr (&Scommand_execute
);
12045 defsubr (&Srecent_keys
);
12046 defsubr (&Sthis_command_keys
);
12047 defsubr (&Sthis_command_keys_vector
);
12048 defsubr (&Sthis_single_command_keys
);
12049 defsubr (&Sthis_single_command_raw_keys
);
12050 defsubr (&Sreset_this_command_lengths
);
12051 defsubr (&Sclear_this_command_keys
);
12052 defsubr (&Ssuspend_emacs
);
12053 defsubr (&Sabort_recursive_edit
);
12054 defsubr (&Sexit_recursive_edit
);
12055 defsubr (&Srecursion_depth
);
12056 defsubr (&Stop_level
);
12057 defsubr (&Sdiscard_input
);
12058 defsubr (&Sopen_dribble_file
);
12059 defsubr (&Sset_input_interrupt_mode
);
12060 defsubr (&Sset_output_flow_control
);
12061 defsubr (&Sset_input_meta_mode
);
12062 defsubr (&Sset_quit_char
);
12063 defsubr (&Sset_input_mode
);
12064 defsubr (&Scurrent_input_mode
);
12065 defsubr (&Sexecute_extended_command
);
12066 defsubr (&Sposn_at_point
);
12067 defsubr (&Sposn_at_x_y
);
12069 DEFVAR_LISP ("last-command-event", &last_command_event
,
12070 doc
: /* Last input event that was part of a command. */);
12072 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
12073 doc
: /* Last input event in a command, except for mouse menu events.
12074 Mouse menus give back keys that don't look like mouse events;
12075 this variable holds the actual mouse event that led to the menu,
12076 so that you can determine whether the command was run by mouse or not. */);
12078 DEFVAR_LISP ("last-input-event", &last_input_event
,
12079 doc
: /* Last input event. */);
12081 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12082 doc
: /* List of events to be read as the command input.
12083 These events are processed first, before actual keyboard input.
12084 Events read from this list are not normally added to `this-command-keys',
12085 as they will already have been added once as they were read for the first time.
12086 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12087 Vunread_command_events
= Qnil
;
12089 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12090 doc
: /* If not -1, an object to be read as next command input event. */);
12092 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12093 doc
: /* List of events to be processed as input by input methods.
12094 These events are processed before `unread-command-events'
12095 and actual keyboard input, but are not given to `input-method-function'. */);
12096 Vunread_post_input_method_events
= Qnil
;
12098 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12099 doc
: /* List of events to be processed as input by input methods.
12100 These events are processed after `unread-command-events', but
12101 before actual keyboard input.
12102 If there's an active input method, the events are given to
12103 `input-method-function'. */);
12104 Vunread_input_method_events
= Qnil
;
12106 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12107 doc
: /* Meta-prefix character code.
12108 Meta-foo as command input turns into this character followed by foo. */);
12109 XSETINT (meta_prefix_char
, 033);
12111 DEFVAR_KBOARD ("last-command", Vlast_command
,
12112 doc
: /* The last command executed.
12113 Normally a symbol with a function definition, but can be whatever was found
12114 in the keymap, or whatever the variable `this-command' was set to by that
12117 The value `mode-exit' is special; it means that the previous command
12118 read an event that told it to exit, and it did so and unread that event.
12119 In other words, the present command is the event that made the previous
12122 The value `kill-region' is special; it means that the previous command
12123 was a kill command.
12125 `last-command' has a separate binding for each terminal device.
12126 See Info node `(elisp)Multiple displays'. */);
12128 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12129 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12131 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12132 doc
: /* Last command that may be repeated.
12133 The last command executed that was not bound to an input event.
12134 This is the command `repeat' will try to repeat. */);
12136 DEFVAR_LISP ("this-command", &Vthis_command
,
12137 doc
: /* The command now being executed.
12138 The command can set this variable; whatever is put here
12139 will be in `last-command' during the following command. */);
12140 Vthis_command
= Qnil
;
12142 DEFVAR_LISP ("this-command-keys-shift-translated",
12143 &Vthis_command_keys_shift_translated
,
12144 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12145 Shift-translation occurs when there is no binding for the key sequence
12146 as entered, but a binding was found by changing an upper-case letter
12147 to lower-case, or a shifted function key to an unshifted one. */);
12148 Vthis_command_keys_shift_translated
= Qnil
;
12150 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12151 doc
: /* The command bound to the current key sequence before remapping.
12152 It equals `this-command' if the original command was not remapped through
12153 any of the active keymaps. Otherwise, the value of `this-command' is the
12154 result of looking up the original command in the active keymaps. */);
12155 Vthis_original_command
= Qnil
;
12157 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12158 doc
: /* *Number of input events between auto-saves.
12159 Zero means disable autosaving due to number of characters typed. */);
12160 auto_save_interval
= 300;
12162 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12163 doc
: /* *Number of seconds idle time before auto-save.
12164 Zero or nil means disable auto-saving due to idleness.
12165 After auto-saving due to this many seconds of idle time,
12166 Emacs also does a garbage collection if that seems to be warranted. */);
12167 XSETFASTINT (Vauto_save_timeout
, 30);
12169 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12170 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12171 The value may be integer or floating point. */);
12172 Vecho_keystrokes
= make_number (1);
12174 DEFVAR_INT ("polling-period", &polling_period
,
12175 doc
: /* *Interval between polling for input during Lisp execution.
12176 The reason for polling is to make C-g work to stop a running program.
12177 Polling is needed only when using X windows and SIGIO does not work.
12178 Polling is automatically disabled in all other cases. */);
12179 polling_period
= 2;
12181 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12182 doc
: /* *Maximum time between mouse clicks to make a double-click.
12183 Measured in milliseconds. The value nil means disable double-click
12184 recognition; t means double-clicks have no time limit and are detected
12185 by position only. */);
12186 Vdouble_click_time
= make_number (500);
12188 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12189 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12190 On window-system frames, value is the number of pixels the mouse may have
12191 moved horizontally or vertically between two clicks to make a double-click.
12192 On non window-system frames, value is interpreted in units of 1/8 characters
12195 This variable is also the threshold for motion of the mouse
12196 to count as a drag. */);
12197 double_click_fuzz
= 3;
12199 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12200 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12201 inhibit_local_menu_bar_menus
= 0;
12203 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12204 doc
: /* Number of complete key sequences read as input so far.
12205 This includes key sequences read from keyboard macros.
12206 The number is effectively the number of interactive command invocations. */);
12207 num_input_keys
= 0;
12209 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12210 doc
: /* Number of input events read from the keyboard so far.
12211 This does not include events generated by keyboard macros. */);
12212 num_nonmacro_input_events
= 0;
12214 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12215 doc
: /* The frame in which the most recently read event occurred.
12216 If the last event came from a keyboard macro, this is set to `macro'. */);
12217 Vlast_event_frame
= Qnil
;
12219 /* This variable is set up in sysdep.c. */
12220 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12221 doc
: /* The ERASE character as set by the user with stty. */);
12223 DEFVAR_LISP ("help-char", &Vhelp_char
,
12224 doc
: /* Character to recognize as meaning Help.
12225 When it is read, do `(eval help-form)', and display result if it's a string.
12226 If the value of `help-form' is nil, this char can be read normally. */);
12227 XSETINT (Vhelp_char
, Ctl ('H'));
12229 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12230 doc
: /* List of input events to recognize as meaning Help.
12231 These work just like the value of `help-char' (see that). */);
12232 Vhelp_event_list
= Qnil
;
12234 DEFVAR_LISP ("help-form", &Vhelp_form
,
12235 doc
: /* Form to execute when character `help-char' is read.
12236 If the form returns a string, that string is displayed.
12237 If `help-form' is nil, the help char is not recognized. */);
12240 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12241 doc
: /* Command to run when `help-char' character follows a prefix key.
12242 This command is used only when there is no actual binding
12243 for that character after that prefix key. */);
12244 Vprefix_help_command
= Qnil
;
12246 DEFVAR_LISP ("top-level", &Vtop_level
,
12247 doc
: /* Form to evaluate when Emacs starts up.
12248 Useful to set before you dump a modified Emacs. */);
12251 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12252 doc
: /* Translate table for local keyboard input, or nil.
12253 If non-nil, the value should be a char-table. Each character read
12254 from the keyboard is looked up in this char-table. If the value found
12255 there is non-nil, then it is used instead of the actual input character.
12257 The value can also be a string or vector, but this is considered obsolete.
12258 If it is a string or vector of length N, character codes N and up are left
12259 untranslated. In a vector, an element which is nil means "no translation".
12261 This is applied to the characters supplied to input methods, not their
12262 output. See also `translation-table-for-input'.
12264 This variable has a separate binding for each terminal. See Info node
12265 `(elisp)Multiple displays'. */);
12267 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12268 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12269 \(Even if the operating system has support for stopping a process.\) */);
12270 cannot_suspend
= 0;
12272 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12273 doc
: /* Non-nil means prompt with menus when appropriate.
12274 This is done when reading from a keymap that has a prompt string,
12275 for elements that have prompt strings.
12276 The menu is displayed on the screen
12277 if X menus were enabled at configuration
12278 time and the previous event was a mouse click prefix key.
12279 Otherwise, menu prompting uses the echo area. */);
12280 menu_prompting
= 1;
12282 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12283 doc
: /* Character to see next line of menu prompt.
12284 Type this character while in a menu prompt to rotate around the lines of it. */);
12285 XSETINT (menu_prompt_more_char
, ' ');
12287 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12288 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12289 Emacs applies the modifiers of the character stored here to each keyboard
12290 character it reads. For example, after evaluating the expression
12291 (setq extra-keyboard-modifiers ?\\C-x)
12292 all input characters will have the control modifier applied to them.
12294 Note that the character ?\\C-@, equivalent to the integer zero, does
12295 not count as a control character; rather, it counts as a character
12296 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12297 cancels any modification. */);
12298 extra_keyboard_modifiers
= 0;
12300 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12301 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12302 The command loop sets this to nil before each command,
12303 and tests the value when the command returns.
12304 Buffer modification stores t in this variable. */);
12305 Vdeactivate_mark
= Qnil
;
12306 Qdeactivate_mark
= intern ("deactivate-mark");
12307 staticpro (&Qdeactivate_mark
);
12309 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12310 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12311 Vcommand_hook_internal
= Qnil
;
12313 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12314 doc
: /* Normal hook run before each command is executed.
12315 If an unhandled error happens in running this hook,
12316 the hook value is set to nil, since otherwise the error
12317 might happen repeatedly and make Emacs nonfunctional. */);
12318 Vpre_command_hook
= Qnil
;
12320 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12321 doc
: /* Normal hook run after each command is executed.
12322 If an unhandled error happens in running this hook,
12323 the hook value is set to nil, since otherwise the error
12324 might happen repeatedly and make Emacs nonfunctional. */);
12325 Vpost_command_hook
= Qnil
;
12328 DEFVAR_LISP ("echo-area-clear-hook", ...,
12329 doc
: /* Normal hook run when clearing the echo area. */);
12331 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12332 staticpro (&Qecho_area_clear_hook
);
12333 Fset (Qecho_area_clear_hook
, Qnil
);
12335 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12336 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12337 Vlucid_menu_bar_dirty_flag
= Qnil
;
12339 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12340 doc
: /* List of menu bar items to move to the end of the menu bar.
12341 The elements of the list are event types that may have menu bar bindings. */);
12342 Vmenu_bar_final_items
= Qnil
;
12344 DEFVAR_KBOARD ("overriding-terminal-local-map",
12345 Voverriding_terminal_local_map
,
12346 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12347 If this variable is non-nil, it is used as a keymap instead of the
12348 buffer's local map, and the minor mode keymaps and text property keymaps.
12349 It also replaces `overriding-local-map'.
12351 This variable is intended to let commands such as `universal-argument'
12352 set up a different keymap for reading the next command.
12354 `overriding-terminal-local-map' has a separate binding for each
12356 See Info node `(elisp)Multiple displays'. */);
12358 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12359 doc
: /* Keymap that overrides all other local keymaps.
12360 If this variable is non-nil, it is used as a keymap--replacing the
12361 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12362 Voverriding_local_map
= Qnil
;
12364 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12365 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12366 Otherwise, the menu bar continues to reflect the buffer's local map
12367 and the minor mode maps regardless of `overriding-local-map'. */);
12368 Voverriding_local_map_menu_flag
= Qnil
;
12370 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12371 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12372 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12374 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12375 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12377 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12378 doc
: /* Alist of system-specific X windows key symbols.
12379 Each element should have the form (N . SYMBOL) where N is the
12380 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12381 and SYMBOL is its name.
12383 `system-key-alist' has a separate binding for each terminal device.
12384 See Info node `(elisp)Multiple displays'. */);
12386 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12387 doc
: /* Keymap that translates key sequences to key sequences during input.
12388 This is used mainly for mapping key sequences into some preferred
12389 key events (symbols).
12391 The `read-key-sequence' function replaces any subsequence bound by
12392 `local-function-key-map' with its binding. More precisely, when the
12393 active keymaps have no binding for the current key sequence but
12394 `local-function-key-map' binds a suffix of the sequence to a vector or
12395 string, `read-key-sequence' replaces the matching suffix with its
12396 binding, and continues with the new sequence.
12398 If the binding is a function, it is called with one argument (the prompt)
12399 and its return value (a key sequence) is used.
12401 The events that come from bindings in `local-function-key-map' are not
12402 themselves looked up in `local-function-key-map'.
12404 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12405 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12406 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12407 typing `ESC O P x' would return [f1 x].
12409 `local-function-key-map' has a separate binding for each terminal
12410 device. See Info node `(elisp)Multiple displays'. If you need to
12411 define a binding on all terminals, change `function-key-map'
12412 instead. Initially, `local-function-key-map' is an empty keymap that
12413 has `function-key-map' as its parent on all terminal devices. */);
12415 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12416 doc
: /* Keymap that decodes input escape sequences.
12417 This is used mainly for mapping ASCII function key sequences into
12418 real Emacs function key events (symbols).
12420 The `read-key-sequence' function replaces any subsequence bound by
12421 `input-decode-map' with its binding. Contrary to `function-key-map',
12422 this map applies its rebinding regardless of the presence of an ordinary
12423 binding. So it is more like `key-translation-map' except that it applies
12424 before `function-key-map' rather than after.
12426 If the binding is a function, it is called with one argument (the prompt)
12427 and its return value (a key sequence) is used.
12429 The events that come from bindings in `input-decode-map' are not
12430 themselves looked up in `input-decode-map'.
12432 This variable is keyboard-local. */);
12434 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12435 doc
: /* The parent keymap of all `local-function-key-map' instances.
12436 Function key definitions that apply to all terminal devices should go
12437 here. If a mapping is defined in both the current
12438 `local-function-key-map' binding and this variable, then the local
12439 definition will take precendence. */);
12440 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12442 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12443 doc
: /* Keymap of key translations that can override keymaps.
12444 This keymap works like `function-key-map', but comes after that,
12445 and its non-prefix bindings override ordinary bindings.
12446 Another difference is that it is global rather than keyboard-local. */);
12447 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12449 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12450 doc
: /* List of deferred actions to be performed at a later time.
12451 The precise format isn't relevant here; we just check whether it is nil. */);
12452 Vdeferred_action_list
= Qnil
;
12454 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12455 doc
: /* Function to call to handle deferred actions, after each command.
12456 This function is called with no arguments after each command
12457 whenever `deferred-action-list' is non-nil. */);
12458 Vdeferred_action_function
= Qnil
;
12460 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12461 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12462 The value can be a length of time to show the message for.
12463 If the value is non-nil and not a number, we wait 2 seconds. */);
12464 Vsuggest_key_bindings
= Qt
;
12466 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12467 doc
: /* List of active absolute time timers in order of increasing time. */);
12468 Vtimer_list
= Qnil
;
12470 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12471 doc
: /* List of active idle-time timers in order of increasing time. */);
12472 Vtimer_idle_list
= Qnil
;
12474 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12475 doc
: /* If non-nil, the function that implements the current input method.
12476 It's called with one argument, a printing character that was just read.
12477 \(That means a character with code 040...0176.)
12478 Typically this function uses `read-event' to read additional events.
12479 When it does so, it should first bind `input-method-function' to nil
12480 so it will not be called recursively.
12482 The function should return a list of zero or more events
12483 to be used as input. If it wants to put back some events
12484 to be reconsidered, separately, by the input method,
12485 it can add them to the beginning of `unread-command-events'.
12487 The input method function can find in `input-method-previous-message'
12488 the previous echo area message.
12490 The input method function should refer to the variables
12491 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12492 for guidance on what to do. */);
12493 Vinput_method_function
= Qnil
;
12495 DEFVAR_LISP ("input-method-previous-message",
12496 &Vinput_method_previous_message
,
12497 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12498 This variable exists because `read-event' clears the echo area
12499 before running the input method. It is nil if there was no message. */);
12500 Vinput_method_previous_message
= Qnil
;
12502 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12503 doc
: /* If non-nil, the function that implements the display of help.
12504 It's called with one argument, the help string to display. */);
12505 Vshow_help_function
= Qnil
;
12507 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12508 doc
: /* If non-nil, suppress point adjustment after executing a command.
12510 After a command is executed, if point is moved into a region that has
12511 special properties (e.g. composition, display), we adjust point to
12512 the boundary of the region. But, when a command sets this variable to
12513 non-nil, we suppress the point adjustment.
12515 This variable is set to nil before reading a command, and is checked
12516 just after executing the command. */);
12517 Vdisable_point_adjustment
= Qnil
;
12519 DEFVAR_LISP ("global-disable-point-adjustment",
12520 &Vglobal_disable_point_adjustment
,
12521 doc
: /* *If non-nil, always suppress point adjustment.
12523 The default value is nil, in which case, point adjustment are
12524 suppressed only after special commands that set
12525 `disable-point-adjustment' (which see) to non-nil. */);
12526 Vglobal_disable_point_adjustment
= Qnil
;
12528 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12529 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12530 If the value is not a number, such messages don't time out. */);
12531 Vminibuffer_message_timeout
= make_number (2);
12533 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12534 doc
: /* If non-nil, any keyboard input throws to this symbol.
12535 The value of that variable is passed to `quit-flag' and later causes a
12536 peculiar kind of quitting. */);
12537 Vthrow_on_input
= Qnil
;
12539 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12540 doc
: /* If non-nil, function to output error messages.
12541 The arguments are the error data, a list of the form
12542 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12543 such as just as `condition-case' would bind its variable to,
12544 the context (a string which normally goes at the start of the message),
12545 and the Lisp function within which the error was signaled. */);
12546 Vcommand_error_function
= Qnil
;
12548 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12549 &Venable_disabled_menus_and_buttons
,
12550 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12552 Help functions bind this to allow help on disabled menu items
12553 and tool-bar buttons. */);
12554 Venable_disabled_menus_and_buttons
= Qnil
;
12556 /* Create the initial keyboard. */
12557 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12558 init_kboard (initial_kboard
);
12559 /* Vwindow_system is left at t for now. */
12560 initial_kboard
->next_kboard
= all_kboards
;
12561 all_kboards
= initial_kboard
;
12565 keys_of_keyboard ()
12567 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12568 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12569 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12570 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12571 initial_define_key (meta_map
, 'x', "execute-extended-command");
12573 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12574 "handle-delete-frame");
12575 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12576 "ns-put-working-text");
12577 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12578 "ns-unput-working-text");
12579 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12580 current-prefix-arg, as is done in `handle-switch-frame'.
12581 But `handle-switch-frame is not run from the special-map.
12582 Commands from that map are run in a special way that automatically
12583 preserves the prefix-arg. Restoring the prefix arg here is not just
12584 redundant but harmful:
12586 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12587 - after the first prompt, the exit-minibuffer-hook is run which may
12588 iconify a frame and thus push a `iconify-frame' event.
12589 - after running exit-minibuffer-hook, current-prefix-arg is
12590 restored to the non-nil value it had before the prompt.
12591 - we enter the second prompt.
12592 current-prefix-arg is non-nil, prefix-arg is nil.
12593 - before running the first real event, we run the special iconify-frame
12594 event, but we pass the `special' arg to execute-command so
12595 current-prefix-arg and prefix-arg are left untouched.
12596 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12597 - the next key event will have a spuriously non-nil current-prefix-arg. */
12598 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12600 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12602 /* Handling it at such a low-level causes read_key_sequence to get
12603 * confused because it doesn't realize that the current_buffer was
12604 * changed by read_char.
12606 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12607 * "handle-select-window"); */
12608 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12609 "handle-save-session");
12612 /* Define a special event which is raised for dbus callback
12614 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12615 "dbus-handle-event");
12619 /* Mark the pointers in the kboard objects.
12620 Called by the Fgarbage_collector. */
12626 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12628 if (kb
->kbd_macro_buffer
)
12629 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12631 mark_object (kb
->Voverriding_terminal_local_map
);
12632 mark_object (kb
->Vlast_command
);
12633 mark_object (kb
->Vreal_last_command
);
12634 mark_object (kb
->Vkeyboard_translate_table
);
12635 mark_object (kb
->Vlast_repeatable_command
);
12636 mark_object (kb
->Vprefix_arg
);
12637 mark_object (kb
->Vlast_prefix_arg
);
12638 mark_object (kb
->kbd_queue
);
12639 mark_object (kb
->defining_kbd_macro
);
12640 mark_object (kb
->Vlast_kbd_macro
);
12641 mark_object (kb
->Vsystem_key_alist
);
12642 mark_object (kb
->system_key_syms
);
12643 mark_object (kb
->Vwindow_system
);
12644 mark_object (kb
->Vinput_decode_map
);
12645 mark_object (kb
->Vlocal_function_key_map
);
12646 mark_object (kb
->Vdefault_minibuffer_frame
);
12647 mark_object (kb
->echo_string
);
12650 struct input_event
*event
;
12651 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12653 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12654 event
= kbd_buffer
;
12655 if (event
->kind
!= SELECTION_REQUEST_EVENT
12656 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12658 mark_object (event
->x
);
12659 mark_object (event
->y
);
12661 mark_object (event
->frame_or_window
);
12662 mark_object (event
->arg
);
12667 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12668 (do not change this comment) */