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, 2010 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #include "syssignal.h"
60 #include <sys/types.h>
69 /* This is to get the definitions of the XK_ symbols. */
76 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 volatile int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
91 /* This var should be (interrupt_input_pending || pending_atimers).
92 The QUIT macro checks this instead of interrupt_input_pending and
93 pending_atimers separately, to reduce code size. So, any code that
94 changes interrupt_input_pending or pending_atimers should update
100 #define KBD_BUFFER_SIZE 4096
102 KBOARD
*initial_kboard
;
103 KBOARD
*current_kboard
;
107 /* Non-nil disable property on a command means
108 do not execute it; call disabled-command-function's value instead. */
109 Lisp_Object Qdisabled
, Qdisabled_command_function
;
111 #define NUM_RECENT_KEYS (300)
112 int recent_keys_index
; /* Index for storing next element into recent_keys */
113 int total_keys
; /* Total number of elements stored into recent_keys */
114 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
116 /* Vector holding the key sequence that invoked the current command.
117 It is reused for each command, and it may be longer than the current
118 sequence; this_command_key_count indicates how many elements
119 actually mean something.
120 It's easier to staticpro a single Lisp_Object than an array. */
121 Lisp_Object this_command_keys
;
122 int this_command_key_count
;
124 /* 1 after calling Freset_this_command_lengths.
126 int this_command_key_count_reset
;
128 /* This vector is used as a buffer to record the events that were actually read
129 by read_key_sequence. */
130 Lisp_Object raw_keybuf
;
131 int raw_keybuf_count
;
133 /* Non-nil if the present key sequence was obtained by shift translation. */
134 Lisp_Object Vthis_command_keys_shift_translated
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
138 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 int this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static int before_command_key_count
;
147 static int before_command_echo_length
;
149 extern int minbuf_level
;
151 extern int message_enable_multibyte
;
153 /* If non-nil, the function that implements the display of help.
154 It's called with one argument, the help string to display. */
156 Lisp_Object Vshow_help_function
;
158 /* Nonzero means do menu prompting. */
160 static int menu_prompting
;
162 /* Character to see next line of menu prompt. */
164 static Lisp_Object menu_prompt_more_char
;
166 /* For longjmp to where kbd input is being done. */
168 static jmp_buf getcjmp
;
170 /* True while doing kbd input. */
171 int waiting_for_input
;
173 /* True while displaying for echoing. Delays C-g throwing. */
177 /* Non-null means we can start echoing at the next input pause even
178 though there is something in the echo area. */
180 static struct kboard
*ok_to_echo_at_next_pause
;
182 /* The kboard last echoing, or null for none. Reset to 0 in
183 cancel_echoing. If non-null, and a current echo area message
184 exists, and echo_message_buffer is eq to the current message
185 buffer, we know that the message comes from echo_kboard. */
187 struct kboard
*echo_kboard
;
189 /* The buffer used for echoing. Set in echo_now, reset in
192 Lisp_Object echo_message_buffer
;
194 /* Nonzero means disregard local maps for the menu bar. */
195 static int inhibit_local_menu_bar_menus
;
197 /* Nonzero means C-g should cause immediate error-signal. */
200 /* The user's hook function for outputting an error message. */
201 Lisp_Object Vcommand_error_function
;
203 /* The user's ERASE setting. */
204 Lisp_Object Vtty_erase_char
;
206 /* Character to recognize as the help char. */
207 Lisp_Object Vhelp_char
;
209 /* List of other event types to recognize as meaning "help". */
210 Lisp_Object Vhelp_event_list
;
212 /* Form to execute when help char is typed. */
213 Lisp_Object Vhelp_form
;
215 /* Command to run when the help character follows a prefix key. */
216 Lisp_Object Vprefix_help_command
;
218 /* List of items that should move to the end of the menu bar. */
219 Lisp_Object Vmenu_bar_final_items
;
221 /* Non-nil means show the equivalent key-binding for
222 any M-x command that has one.
223 The value can be a length of time to show the message for.
224 If the value is non-nil and not a number, we wait 2 seconds. */
225 Lisp_Object Vsuggest_key_bindings
;
227 /* How long to display an echo-area message when the minibuffer is active.
228 If the value is not a number, such messages don't time out. */
229 Lisp_Object Vminibuffer_message_timeout
;
231 /* Character that causes a quit. Normally C-g.
233 If we are running on an ordinary terminal, this must be an ordinary
234 ASCII char, since we want to make it our interrupt character.
236 If we are not running on an ordinary terminal, it still needs to be
237 an ordinary ASCII char. This character needs to be recognized in
238 the input interrupt handler. At this point, the keystroke is
239 represented as a struct input_event, while the desired quit
240 character is specified as a lispy event. The mapping from struct
241 input_events to lispy events cannot run in an interrupt handler,
242 and the reverse mapping is difficult for anything but ASCII
245 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
249 /* If non-nil, this is a map that overrides all other local maps. */
250 Lisp_Object Voverriding_local_map
;
252 /* If non-nil, Voverriding_local_map applies to the menu bar. */
253 Lisp_Object Voverriding_local_map_menu_flag
;
255 /* Keymap that defines special misc events that should
256 be processed immediately at a low level. */
257 Lisp_Object Vspecial_event_map
;
259 /* Current depth in recursive edits. */
260 int command_loop_level
;
262 /* Total number of times command_loop has read a key sequence. */
263 EMACS_INT num_input_keys
;
265 /* Last input event read as a command. */
266 Lisp_Object last_command_event
;
268 /* Last input character read as a command, not counting menus
269 reached by the mouse. */
270 Lisp_Object last_nonmenu_event
;
272 /* Last input event read for any purpose. */
273 Lisp_Object last_input_event
;
275 /* If not Qnil, a list of objects to be read as subsequent command input. */
276 Lisp_Object Vunread_command_events
;
278 /* If not Qnil, a list of objects to be read as subsequent command input
279 including input method processing. */
280 Lisp_Object Vunread_input_method_events
;
282 /* If not Qnil, a list of objects to be read as subsequent command input
283 but NOT including input method processing. */
284 Lisp_Object Vunread_post_input_method_events
;
286 /* If not -1, an event to be read as subsequent command input. */
287 EMACS_INT unread_command_char
;
289 /* If not Qnil, this is a switch-frame event which we decided to put
290 off until the end of a key sequence. This should be read as the
291 next command input, after any unread_command_events.
293 read_key_sequence uses this to delay switch-frame events until the
294 end of the key sequence; Fread_char uses it to put off switch-frame
295 events until a non-ASCII event is acceptable as input. */
296 Lisp_Object unread_switch_frame
;
298 /* A mask of extra modifier bits to put into every keyboard char. */
299 EMACS_INT extra_keyboard_modifiers
;
301 /* Char to use as prefix when a meta character is typed in.
302 This is bound on entry to minibuffer in case ESC is changed there. */
304 Lisp_Object meta_prefix_char
;
306 /* Last size recorded for a current buffer which is not a minibuffer. */
307 static EMACS_INT last_non_minibuf_size
;
309 /* Number of idle seconds before an auto-save and garbage collection. */
310 static Lisp_Object Vauto_save_timeout
;
312 /* Total number of times read_char has returned. */
313 int num_input_events
;
315 /* Total number of times read_char has returned, outside of macros. */
316 EMACS_INT num_nonmacro_input_events
;
318 /* Auto-save automatically when this many characters have been typed
319 since the last time. */
321 static EMACS_INT auto_save_interval
;
323 /* Value of num_nonmacro_input_events as of last auto save. */
327 /* The command being executed by the command loop.
328 Commands may set this, and the value set will be copied into
329 current_kboard->Vlast_command instead of the actual command. */
330 Lisp_Object Vthis_command
;
332 /* This is like Vthis_command, except that commands never set it. */
333 Lisp_Object real_this_command
;
335 /* If the lookup of the command returns a binding, the original
336 command is stored in this-original-command. It is nil otherwise. */
337 Lisp_Object Vthis_original_command
;
339 /* The value of point when the last command was started. */
340 EMACS_INT last_point_position
;
342 /* The buffer that was current when the last command was started. */
343 Lisp_Object last_point_position_buffer
;
345 /* The window that was selected when the last command was started. */
346 Lisp_Object last_point_position_window
;
348 /* The frame in which the last input event occurred, or Qmacro if the
349 last event came from a macro. We use this to determine when to
350 generate switch-frame events. This may be cleared by functions
351 like Fselect_frame, to make sure that a switch-frame event is
352 generated by the next character. */
353 Lisp_Object internal_last_event_frame
;
355 /* A user-visible version of the above, intended to allow users to
356 figure out where the last event came from, if the event doesn't
357 carry that information itself (i.e. if it was a character). */
358 Lisp_Object Vlast_event_frame
;
360 /* The timestamp of the last input event we received from the X server.
361 X Windows wants this for selection ownership. */
362 unsigned long last_event_timestamp
;
364 /* If non-nil, active regions automatically become the window selection. */
365 Lisp_Object Vselect_active_regions
;
367 /* The text in the active region prior to modifying the buffer.
368 Used by the `select-active-regions' feature. */
369 Lisp_Object Vsaved_region_selection
;
371 Lisp_Object Qx_set_selection
, QPRIMARY
, Qhandle_switch_frame
;
373 Lisp_Object Qself_insert_command
;
374 Lisp_Object Qforward_char
;
375 Lisp_Object Qbackward_char
;
376 Lisp_Object Qundefined
;
377 Lisp_Object Qtimer_event_handler
;
379 /* read_key_sequence stores here the command definition of the
380 key sequence that it reads. */
381 Lisp_Object read_key_sequence_cmd
;
383 /* Echo unfinished commands after this many seconds of pause. */
384 Lisp_Object Vecho_keystrokes
;
386 /* Form to evaluate (if non-nil) when Emacs is started. */
387 Lisp_Object Vtop_level
;
389 /* If non-nil, this implements the current input method. */
390 Lisp_Object Vinput_method_function
;
391 Lisp_Object Qinput_method_function
;
393 /* When we call Vinput_method_function,
394 this holds the echo area message that was just erased. */
395 Lisp_Object Vinput_method_previous_message
;
397 /* Non-nil means deactivate the mark at end of this command. */
398 Lisp_Object Vdeactivate_mark
;
399 Lisp_Object Qdeactivate_mark
;
401 /* Menu bar specified in Lucid Emacs fashion. */
403 Lisp_Object Vlucid_menu_bar_dirty_flag
;
404 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
406 Lisp_Object Qecho_area_clear_hook
;
408 /* Hooks to run before and after each command. */
409 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
410 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
411 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
413 /* Parent keymap of terminal-local function-key-map instances. */
414 Lisp_Object Vfunction_key_map
;
416 /* Keymap of key translations that can override keymaps. */
417 Lisp_Object Vkey_translation_map
;
419 /* List of deferred actions to be performed at a later time.
420 The precise format isn't relevant here; we just check whether it is nil. */
421 Lisp_Object Vdeferred_action_list
;
423 /* Function to call to handle deferred actions, when there are any. */
424 Lisp_Object Vdeferred_action_function
;
425 Lisp_Object Qdeferred_action_function
;
427 Lisp_Object Qinput_method_exit_on_first_char
;
428 Lisp_Object Qinput_method_use_echo_area
;
430 /* File in which we write all commands we read. */
433 /* Nonzero if input is available. */
436 extern char *pending_malloc_warning
;
438 /* Circular buffer for pre-read keyboard input. */
440 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
442 /* Pointer to next available character in kbd_buffer.
443 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
444 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
445 next available char is in kbd_buffer[0]. */
446 static struct input_event
*kbd_fetch_ptr
;
448 /* Pointer to next place to store character in kbd_buffer. This
449 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
450 character should go in kbd_buffer[0]. */
451 static struct input_event
* volatile kbd_store_ptr
;
453 /* The above pair of variables forms a "queue empty" flag. When we
454 enqueue a non-hook event, we increment kbd_store_ptr. When we
455 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
456 there is input available if the two pointers are not equal.
458 Why not just have a flag set and cleared by the enqueuing and
459 dequeuing functions? Such a flag could be screwed up by interrupts
460 at inopportune times. */
462 /* If this flag is non-nil, we check mouse_moved to see when the
463 mouse moves, and motion events will appear in the input stream.
464 Otherwise, mouse motion is ignored. */
465 Lisp_Object do_mouse_tracking
;
467 /* Symbols to head events. */
468 Lisp_Object Qmouse_movement
;
469 Lisp_Object Qscroll_bar_movement
;
470 Lisp_Object Qswitch_frame
;
471 Lisp_Object Qdelete_frame
;
472 Lisp_Object Qiconify_frame
;
473 Lisp_Object Qmake_frame_visible
;
474 Lisp_Object Qselect_window
;
475 Lisp_Object Qhelp_echo
;
477 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
478 Lisp_Object Qmouse_fixup_help_message
;
481 /* Symbols to denote kinds of events. */
482 Lisp_Object Qfunction_key
;
483 Lisp_Object Qmouse_click
;
484 #if defined (WINDOWSNT)
485 Lisp_Object Qlanguage_change
;
487 Lisp_Object Qdrag_n_drop
;
488 Lisp_Object Qsave_session
;
490 Lisp_Object Qdbus_event
;
492 Lisp_Object Qconfig_changed_event
;
494 /* Lisp_Object Qmouse_movement; - also an event header */
496 /* Properties of event headers. */
497 Lisp_Object Qevent_kind
;
498 Lisp_Object Qevent_symbol_elements
;
500 /* menu item parts */
501 Lisp_Object Qmenu_enable
;
502 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
503 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
;
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
;
524 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
525 Lisp_Object
Fthis_command_keys (void);
526 Lisp_Object Qextended_command_history
;
527 EMACS_TIME
timer_check (int do_it_now
);
529 static void record_menu_key (Lisp_Object c
);
530 static int echo_length (void);
532 Lisp_Object Qpolling_period
;
534 /* List of absolute timers. Appears in order of next scheduled event. */
535 Lisp_Object Vtimer_list
;
537 /* List of idle time timers. Appears in order of next scheduled event. */
538 Lisp_Object Vtimer_idle_list
;
540 /* Incremented whenever a timer is run. */
543 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
545 EMACS_TIME
*input_available_clear_time
;
547 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
548 Default is 1 if INTERRUPT_INPUT is defined. */
551 /* Nonzero while interrupts are temporarily deferred during redisplay. */
552 int interrupts_deferred
;
554 /* Allow m- file to inhibit use of FIONREAD. */
555 #ifdef BROKEN_FIONREAD
559 /* We are unable to use interrupts if FIONREAD is not available,
560 so flush SIGIO so we won't try. */
561 #if !defined (FIONREAD)
567 /* If we support a window system, turn on the code to poll periodically
568 to detect C-g. It isn't actually used when doing interrupt input. */
569 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
570 #define POLL_FOR_INPUT
573 /* After a command is executed, if point is moved into a region that
574 has specific properties (e.g. composition, display), we adjust
575 point to the boundary of the region. But, if a command sets this
576 variable to non-nil, we suppress this point adjustment. This
577 variable is set to nil before reading a command. */
579 Lisp_Object Vdisable_point_adjustment
;
581 /* If non-nil, always disable point adjustment. */
583 Lisp_Object Vglobal_disable_point_adjustment
;
585 /* The time when Emacs started being idle. */
587 static EMACS_TIME timer_idleness_start_time
;
589 /* After Emacs stops being idle, this saves the last value
590 of timer_idleness_start_time from when it was idle. */
592 static EMACS_TIME timer_last_idleness_start_time
;
594 /* If non-nil, events produced by disabled menu items and tool-bar
595 buttons are not ignored. Help functions bind this to allow help on
596 those items and buttons. */
597 Lisp_Object Venable_disabled_menus_and_buttons
;
600 /* Global variable declarations. */
602 /* Flags for readable_events. */
603 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
604 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
605 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
607 /* Function for init_keyboard to call with no args (if nonzero). */
608 void (*keyboard_init_hook
) (void);
610 static int read_avail_input (int);
611 static void get_input_pending (int *, int);
612 static int readable_events (int);
613 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
615 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
617 static Lisp_Object
make_lispy_event (struct input_event
*);
618 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
619 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
620 enum scroll_bar_part
,
621 Lisp_Object
, Lisp_Object
,
624 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
625 Lisp_Object
, const char **,
626 Lisp_Object
*, unsigned);
627 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
628 static void save_getcjmp (jmp_buf);
629 static void restore_getcjmp (jmp_buf);
630 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
631 static void clear_event (struct input_event
*);
632 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
633 static SIGTYPE
interrupt_signal (int signalnum
);
635 static SIGTYPE
input_available_signal (int signo
);
637 static void handle_interrupt (void);
638 static void timer_start_idle (void);
639 static void timer_stop_idle (void);
640 static void timer_resume_idle (void);
641 static SIGTYPE
handle_user_signal (int);
642 static char *find_user_signal_name (int);
643 static int store_user_signal_events (void);
645 /* Nonzero means don't try to suspend even if the operating system seems
647 static int cannot_suspend
;
650 /* Install the string STR as the beginning of the string of echoing,
651 so that it serves as a prompt for the next character.
652 Also start echoing. */
655 echo_prompt (Lisp_Object str
)
657 current_kboard
->echo_string
= str
;
658 current_kboard
->echo_after_prompt
= SCHARS (str
);
662 /* Add C to the echo string, if echoing is going on.
663 C can be a character, which is printed prettily ("M-C-x" and all that
664 jazz), or a symbol, whose name is printed. */
667 echo_char (Lisp_Object c
)
669 if (current_kboard
->immediate_echo
)
671 int size
= KEY_DESCRIPTION_SIZE
+ 100;
672 char *buffer
= (char *) alloca (size
);
674 Lisp_Object echo_string
;
676 echo_string
= current_kboard
->echo_string
;
678 /* If someone has passed us a composite event, use its head symbol. */
683 ptr
= push_key_description (XINT (c
), ptr
, 1);
685 else if (SYMBOLP (c
))
687 Lisp_Object name
= SYMBOL_NAME (c
);
688 int nbytes
= SBYTES (name
);
690 if (size
- (ptr
- buffer
) < nbytes
)
692 int offset
= ptr
- buffer
;
693 size
= max (2 * size
, size
+ nbytes
);
694 buffer
= (char *) alloca (size
);
695 ptr
= buffer
+ offset
;
698 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
699 STRING_MULTIBYTE (name
), 1);
702 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
705 const char *text
= " (Type ? for further options)";
706 int len
= strlen (text
);
708 if (size
- (ptr
- buffer
) < len
)
710 int offset
= ptr
- buffer
;
712 buffer
= (char *) alloca (size
);
713 ptr
= buffer
+ offset
;
716 memcpy (ptr
, text
, len
);
720 /* Replace a dash from echo_dash with a space, otherwise
721 add a space at the end as a separator between keys. */
722 if (STRINGP (echo_string
)
723 && SCHARS (echo_string
) > 1)
725 Lisp_Object last_char
, prev_char
, idx
;
727 idx
= make_number (SCHARS (echo_string
) - 2);
728 prev_char
= Faref (echo_string
, idx
);
730 idx
= make_number (SCHARS (echo_string
) - 1);
731 last_char
= Faref (echo_string
, idx
);
733 /* We test PREV_CHAR to make sure this isn't the echoing
735 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
736 Faset (echo_string
, idx
, make_number (' '));
738 echo_string
= concat2 (echo_string
, build_string (" "));
740 else if (STRINGP (echo_string
))
741 echo_string
= concat2 (echo_string
, build_string (" "));
743 current_kboard
->echo_string
744 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
750 /* Temporarily add a dash to the end of the echo string if it's not
751 empty, so that it serves as a mini-prompt for the very next character. */
756 /* Do nothing if not echoing at all. */
757 if (NILP (current_kboard
->echo_string
))
760 if (!current_kboard
->immediate_echo
761 && SCHARS (current_kboard
->echo_string
) == 0)
764 /* Do nothing if we just printed a prompt. */
765 if (current_kboard
->echo_after_prompt
766 == SCHARS (current_kboard
->echo_string
))
769 /* Do nothing if we have already put a dash at the end. */
770 if (SCHARS (current_kboard
->echo_string
) > 1)
772 Lisp_Object last_char
, prev_char
, idx
;
774 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
775 prev_char
= Faref (current_kboard
->echo_string
, idx
);
777 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
778 last_char
= Faref (current_kboard
->echo_string
, idx
);
780 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
784 /* Put a dash at the end of the buffer temporarily,
785 but make it go away when the next character is added. */
786 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
791 /* Display the current echo string, and begin echoing if not already
797 if (!current_kboard
->immediate_echo
)
800 current_kboard
->immediate_echo
= 1;
802 for (i
= 0; i
< this_command_key_count
; i
++)
806 /* Set before_command_echo_length to the value that would
807 have been saved before the start of this subcommand in
808 command_loop_1, if we had already been echoing then. */
809 if (i
== this_single_command_key_start
)
810 before_command_echo_length
= echo_length ();
812 c
= XVECTOR (this_command_keys
)->contents
[i
];
813 if (! (EVENT_HAS_PARAMETERS (c
)
814 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
818 /* Set before_command_echo_length to the value that would
819 have been saved before the start of this subcommand in
820 command_loop_1, if we had already been echoing then. */
821 if (this_command_key_count
== this_single_command_key_start
)
822 before_command_echo_length
= echo_length ();
824 /* Put a dash at the end to invite the user to type more. */
829 message3_nolog (current_kboard
->echo_string
,
830 SBYTES (current_kboard
->echo_string
),
831 STRING_MULTIBYTE (current_kboard
->echo_string
));
834 /* Record in what buffer we echoed, and from which kboard. */
835 echo_message_buffer
= echo_area_buffer
[0];
836 echo_kboard
= current_kboard
;
838 if (waiting_for_input
&& !NILP (Vquit_flag
))
839 quit_throw_to_read_char ();
842 /* Turn off echoing, for the start of a new command. */
845 cancel_echoing (void)
847 current_kboard
->immediate_echo
= 0;
848 current_kboard
->echo_after_prompt
= -1;
849 current_kboard
->echo_string
= Qnil
;
850 ok_to_echo_at_next_pause
= NULL
;
852 echo_message_buffer
= Qnil
;
855 /* Return the length of the current echo string. */
860 return (STRINGP (current_kboard
->echo_string
)
861 ? SCHARS (current_kboard
->echo_string
)
865 /* Truncate the current echo message to its first LEN chars.
866 This and echo_char get used by read_key_sequence when the user
867 switches frames while entering a key sequence. */
870 echo_truncate (EMACS_INT nchars
)
872 if (STRINGP (current_kboard
->echo_string
))
873 current_kboard
->echo_string
874 = Fsubstring (current_kboard
->echo_string
,
875 make_number (0), make_number (nchars
));
876 truncate_echo_area (nchars
);
880 /* Functions for manipulating this_command_keys. */
882 add_command_key (Lisp_Object key
)
884 #if 0 /* Not needed after we made Freset_this_command_lengths
885 do the job immediately. */
886 /* If reset-this-command-length was called recently, obey it now.
887 See the doc string of that function for an explanation of why. */
888 if (before_command_restore_flag
)
890 this_command_key_count
= before_command_key_count_1
;
891 if (this_command_key_count
< this_single_command_key_start
)
892 this_single_command_key_start
= this_command_key_count
;
893 echo_truncate (before_command_echo_length_1
);
894 before_command_restore_flag
= 0;
898 if (this_command_key_count
>= ASIZE (this_command_keys
))
899 this_command_keys
= larger_vector (this_command_keys
,
900 2 * ASIZE (this_command_keys
),
903 ASET (this_command_keys
, this_command_key_count
, key
);
904 ++this_command_key_count
;
909 recursive_edit_1 (void)
911 int count
= SPECPDL_INDEX ();
914 if (command_loop_level
> 0)
916 specbind (Qstandard_output
, Qt
);
917 specbind (Qstandard_input
, Qt
);
920 #ifdef HAVE_WINDOW_SYSTEM
921 /* The command loop has started an hourglass timer, so we have to
922 cancel it here, otherwise it will fire because the recursive edit
923 can take some time. Do not check for display_hourglass_p here,
924 because it could already be nil. */
928 /* This function may have been called from a debugger called from
929 within redisplay, for instance by Edebugging a function called
930 from fontification-functions. We want to allow redisplay in
931 the debugging session.
933 The recursive edit is left with a `(throw exit ...)'. The `exit'
934 tag is not caught anywhere in redisplay, i.e. when we leave the
935 recursive edit, the original redisplay leading to the recursive
936 edit will be unwound. The outcome should therefore be safe. */
937 specbind (Qinhibit_redisplay
, Qnil
);
940 val
= command_loop ();
942 Fsignal (Qquit
, Qnil
);
943 /* Handle throw from read_minibuf when using minibuffer
944 while it's active but we're in another window. */
946 xsignal1 (Qerror
, val
);
948 return unbind_to (count
, Qnil
);
951 /* When an auto-save happens, record the "time", and don't do again soon. */
954 record_auto_save (void)
956 last_auto_save
= num_nonmacro_input_events
;
959 /* Make an auto save happen as soon as possible at command level. */
962 force_auto_save_soon (void)
964 last_auto_save
= - auto_save_interval
- 1;
966 record_asynch_buffer_change ();
969 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
970 doc
: /* Invoke the editor command loop recursively.
971 To get out of the recursive edit, a command can do `(throw 'exit nil)';
972 that tells this function to return.
973 Alternatively, `(throw 'exit t)' makes this function signal an error.
974 This function is called by the editor initialization to begin editing. */)
977 int count
= SPECPDL_INDEX ();
980 /* If we enter while input is blocked, don't lock up here.
981 This may happen through the debugger during redisplay. */
985 command_loop_level
++;
986 update_mode_lines
= 1;
988 if (command_loop_level
989 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
990 buffer
= Fcurrent_buffer ();
994 /* If we leave recursive_edit_1 below with a `throw' for instance,
995 like it is done in the splash screen display, we have to
996 make sure that we restore single_kboard as command_loop_1
997 would have done if it were left normally. */
998 if (command_loop_level
> 0)
999 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1000 record_unwind_protect (recursive_edit_unwind
, buffer
);
1002 recursive_edit_1 ();
1003 return unbind_to (count
, Qnil
);
1007 recursive_edit_unwind (Lisp_Object buffer
)
1009 if (BUFFERP (buffer
))
1010 Fset_buffer (buffer
);
1012 command_loop_level
--;
1013 update_mode_lines
= 1;
1018 #if 0 /* These two functions are now replaced with
1019 temporarily_switch_to_single_kboard. */
1023 #if 0 /* Theory: if there's anything in Vunread_command_events,
1024 it will right away be read by read_key_sequence,
1025 and then if we do switch KBOARDS, it will go into the side
1026 queue then. So we don't need to do anything special here -- rms. */
1027 if (CONSP (Vunread_command_events
))
1029 current_kboard
->kbd_queue
1030 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1031 current_kboard
->kbd_queue_has_data
= 1;
1033 Vunread_command_events
= Qnil
;
1038 /* Switch to the single-kboard state, making current_kboard
1039 the only KBOARD from which further input is accepted. */
1042 single_kboard_state ()
1048 /* If we're in single_kboard state for kboard KBOARD,
1052 not_single_kboard_state (KBOARD
*kboard
)
1054 if (kboard
== current_kboard
)
1058 /* Maintain a stack of kboards, so other parts of Emacs
1059 can switch temporarily to the kboard of a given frame
1060 and then revert to the previous status. */
1065 struct kboard_stack
*next
;
1068 static struct kboard_stack
*kboard_stack
;
1071 push_kboard (struct kboard
*k
)
1073 struct kboard_stack
*p
1074 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1076 p
->next
= kboard_stack
;
1077 p
->kboard
= current_kboard
;
1087 struct kboard_stack
*p
= kboard_stack
;
1089 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1091 if (t
->kboard
== p
->kboard
)
1093 current_kboard
= p
->kboard
;
1100 /* The terminal we remembered has been deleted. */
1101 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1104 kboard_stack
= p
->next
;
1108 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1109 from which further input is accepted. If F is non-nil, set its
1110 KBOARD as the current keyboard.
1112 This function uses record_unwind_protect to return to the previous
1115 If Emacs is already in single_kboard mode, and F's keyboard is
1116 locked, then this function will throw an errow. */
1119 temporarily_switch_to_single_kboard (struct frame
*f
)
1121 int was_locked
= single_kboard
;
1124 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1125 /* We can not switch keyboards while in single_kboard mode.
1126 In rare cases, Lisp code may call `recursive-edit' (or
1127 `read-minibuffer' or `y-or-n-p') after it switched to a
1128 locked frame. For example, this is likely to happen
1129 when server.el connects to a new terminal while Emacs is in
1130 single_kboard mode. It is best to throw an error instead
1131 of presenting the user with a frozen screen. */
1132 error ("Terminal %d is locked, cannot read from it",
1133 FRAME_TERMINAL (f
)->id
);
1135 /* This call is unnecessary, but helps
1136 `restore_kboard_configuration' discover if somebody changed
1137 `current_kboard' behind our back. */
1138 push_kboard (current_kboard
);
1141 current_kboard
= FRAME_KBOARD (f
);
1143 record_unwind_protect (restore_kboard_configuration
,
1144 (was_locked
? Qt
: Qnil
));
1147 #if 0 /* This function is not needed anymore. */
1149 record_single_kboard_state ()
1152 push_kboard (current_kboard
);
1153 record_unwind_protect (restore_kboard_configuration
,
1154 (single_kboard
? Qt
: Qnil
));
1159 restore_kboard_configuration (Lisp_Object was_locked
)
1161 if (NILP (was_locked
))
1165 struct kboard
*prev
= current_kboard
;
1168 /* The pop should not change the kboard. */
1169 if (single_kboard
&& current_kboard
!= prev
)
1176 /* Handle errors that are not handled at inner levels
1177 by printing an error message and returning to the editor command loop. */
1180 cmd_error (Lisp_Object data
)
1182 Lisp_Object old_level
, old_length
;
1183 char macroerror
[50];
1185 #ifdef HAVE_WINDOW_SYSTEM
1186 if (display_hourglass_p
)
1187 cancel_hourglass ();
1190 if (!NILP (executing_kbd_macro
))
1192 if (executing_kbd_macro_iterations
== 1)
1193 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1195 sprintf (macroerror
, "After %d kbd macro iterations: ",
1196 executing_kbd_macro_iterations
);
1201 Vstandard_output
= Qt
;
1202 Vstandard_input
= Qt
;
1203 Vexecuting_kbd_macro
= Qnil
;
1204 executing_kbd_macro
= Qnil
;
1205 current_kboard
->Vprefix_arg
= Qnil
;
1206 current_kboard
->Vlast_prefix_arg
= Qnil
;
1209 /* Avoid unquittable loop if data contains a circular list. */
1210 old_level
= Vprint_level
;
1211 old_length
= Vprint_length
;
1212 XSETFASTINT (Vprint_level
, 10);
1213 XSETFASTINT (Vprint_length
, 10);
1214 cmd_error_internal (data
, macroerror
);
1215 Vprint_level
= old_level
;
1216 Vprint_length
= old_length
;
1220 Vinhibit_quit
= Qnil
;
1221 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1222 if (command_loop_level
== 0 && minibuf_level
== 0)
1223 any_kboard_state ();
1226 return make_number (0);
1229 /* Take actions on handling an error. DATA is the data that describes
1232 CONTEXT is a C-string containing ASCII characters only which
1233 describes the context in which the error happened. If we need to
1234 generalize CONTEXT to allow multibyte characters, make it a Lisp
1238 cmd_error_internal (Lisp_Object data
, const char *context
)
1240 struct frame
*sf
= SELECTED_FRAME ();
1242 /* The immediate context is not interesting for Quits,
1243 since they are asyncronous. */
1244 if (EQ (XCAR (data
), Qquit
))
1245 Vsignaling_function
= Qnil
;
1250 /* Use user's specified output function if any. */
1251 if (!NILP (Vcommand_error_function
))
1252 call3 (Vcommand_error_function
, data
,
1253 context
? build_string (context
) : empty_unibyte_string
,
1254 Vsignaling_function
);
1255 /* If the window system or terminal frame hasn't been initialized
1256 yet, or we're not interactive, write the message to stderr and exit. */
1257 else if (!sf
->glyphs_initialized_p
1258 /* The initial frame is a special non-displaying frame. It
1259 will be current in daemon mode when there are no frames
1260 to display, and in non-daemon mode before the real frame
1261 has finished initializing. If an error is thrown in the
1262 latter case while creating the frame, then the frame
1263 will never be displayed, so the safest thing to do is
1264 write to stderr and quit. In daemon mode, there are
1265 many other potential errors that do not prevent frames
1266 from being created, so continuing as normal is better in
1268 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1271 print_error_message (data
, Qexternal_debugging_output
,
1272 context
, Vsignaling_function
);
1273 Fterpri (Qexternal_debugging_output
);
1274 Fkill_emacs (make_number (-1));
1278 clear_message (1, 0);
1280 message_log_maybe_newline ();
1283 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1286 Vsignaling_function
= Qnil
;
1289 Lisp_Object
command_loop_1 (void);
1290 Lisp_Object
command_loop_2 (Lisp_Object
);
1291 Lisp_Object
top_level_1 (Lisp_Object
);
1293 /* Entry to editor-command-loop.
1294 This level has the catches for exiting/returning to editor command loop.
1295 It returns nil to exit recursive edit, t to abort it. */
1300 if (command_loop_level
> 0 || minibuf_level
> 0)
1303 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1304 executing_kbd_macro
= Qnil
;
1310 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1311 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1312 /* Reset single_kboard in case top-level set it while
1313 evaluating an -f option, or we are stuck there for some
1315 any_kboard_state ();
1317 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1318 executing_kbd_macro
= Qnil
;
1320 /* End of file in -batch run causes exit here. */
1326 /* Here we catch errors in execution of commands within the
1327 editing loop, and reenter the editing loop.
1328 When there is an error, cmd_error runs and returns a non-nil
1329 value to us. A value of nil means that command_loop_1 itself
1330 returned due to end of file (or end of kbd macro). */
1333 command_loop_2 (Lisp_Object ignore
)
1335 register Lisp_Object val
;
1338 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1339 while (!NILP (val
));
1347 return Feval (Vtop_level
);
1351 top_level_1 (Lisp_Object ignore
)
1353 /* On entry to the outer level, run the startup file */
1354 if (!NILP (Vtop_level
))
1355 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1356 else if (!NILP (Vpurify_flag
))
1357 message ("Bare impure Emacs (standard Lisp code not loaded)");
1359 message ("Bare Emacs (standard Lisp code not loaded)");
1363 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1364 doc
: /* Exit all recursive editing levels.
1365 This also exits all active minibuffers. */)
1368 #ifdef HAVE_WINDOW_SYSTEM
1369 if (display_hourglass_p
)
1370 cancel_hourglass ();
1373 /* Unblock input if we enter with input blocked. This may happen if
1374 redisplay traps e.g. during tool-bar update with input blocked. */
1375 while (INPUT_BLOCKED_P
)
1378 Fthrow (Qtop_level
, Qnil
);
1381 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1382 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1385 if (command_loop_level
> 0 || minibuf_level
> 0)
1386 Fthrow (Qexit
, Qnil
);
1388 error ("No recursive edit is in progress");
1391 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1392 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1395 if (command_loop_level
> 0 || minibuf_level
> 0)
1398 error ("No recursive edit is in progress");
1401 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1403 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1404 of this function. */
1407 tracking_off (Lisp_Object old_value
)
1409 do_mouse_tracking
= old_value
;
1410 if (NILP (old_value
))
1412 /* Redisplay may have been preempted because there was input
1413 available, and it assumes it will be called again after the
1414 input has been processed. If the only input available was
1415 the sort that we have just disabled, then we need to call
1417 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1419 redisplay_preserve_echo_area (6);
1420 get_input_pending (&input_pending
,
1421 READABLE_EVENTS_DO_TIMERS_NOW
);
1427 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1428 doc
: /* Evaluate BODY with mouse movement events enabled.
1429 Within a `track-mouse' form, mouse motion generates input events that
1430 you can read with `read-event'.
1431 Normally, mouse motion is ignored.
1432 usage: (track-mouse BODY...) */)
1435 int count
= SPECPDL_INDEX ();
1438 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1440 do_mouse_tracking
= Qt
;
1442 val
= Fprogn (args
);
1443 return unbind_to (count
, val
);
1446 /* If mouse has moved on some frame, return one of those frames.
1450 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1451 after resizing the tool-bar window. */
1453 int ignore_mouse_drag_p
;
1456 some_mouse_moved (void)
1458 Lisp_Object tail
, frame
;
1460 if (ignore_mouse_drag_p
)
1462 /* ignore_mouse_drag_p = 0; */
1466 FOR_EACH_FRAME (tail
, frame
)
1468 if (XFRAME (frame
)->mouse_moved
)
1469 return XFRAME (frame
);
1475 #endif /* HAVE_MOUSE || HAVE_GPM */
1477 /* This is the actual command reading loop,
1478 sans error-handling encapsulation. */
1480 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1482 void safe_run_hooks (Lisp_Object
);
1483 static void adjust_point_for_property (EMACS_INT
, int);
1485 /* Cancel hourglass from protect_unwind.
1487 #ifdef HAVE_WINDOW_SYSTEM
1489 cancel_hourglass_unwind (Lisp_Object arg
)
1491 cancel_hourglass ();
1496 /* FIXME: This is wrong rather than test window-system, we should call
1497 a new set-selection, which will then dispatch to x-set-selection, or
1498 tty-set-selection, or w32-set-selection, ... */
1499 EXFUN (Fwindow_system
, 1);
1502 command_loop_1 (void)
1505 Lisp_Object keybuf
[30];
1507 int prev_modiff
= 0;
1508 struct buffer
*prev_buffer
= NULL
;
1509 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1510 int was_locked
= single_kboard
;
1512 int already_adjusted
= 0;
1514 current_kboard
->Vprefix_arg
= Qnil
;
1515 current_kboard
->Vlast_prefix_arg
= Qnil
;
1516 Vdeactivate_mark
= Qnil
;
1517 waiting_for_input
= 0;
1520 this_command_key_count
= 0;
1521 this_command_key_count_reset
= 0;
1522 this_single_command_key_start
= 0;
1524 if (NILP (Vmemory_full
))
1526 /* Make sure this hook runs after commands that get errors and
1527 throw to top level. */
1528 /* Note that the value cell will never directly contain nil
1529 if the symbol is a local variable. */
1530 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1531 safe_run_hooks (Qpost_command_hook
);
1533 /* If displaying a message, resize the echo area window to fit
1534 that message's size exactly. */
1535 if (!NILP (echo_area_buffer
[0]))
1536 resize_echo_area_exactly ();
1538 if (!NILP (Vdeferred_action_list
))
1539 safe_run_hooks (Qdeferred_action_function
);
1542 /* Do this after running Vpost_command_hook, for consistency. */
1543 current_kboard
->Vlast_command
= Vthis_command
;
1544 current_kboard
->Vreal_last_command
= real_this_command
;
1545 if (!CONSP (last_command_event
))
1546 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1550 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1553 /* Make sure the current window's buffer is selected. */
1554 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1555 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1557 /* Display any malloc warning that just came out. Use while because
1558 displaying one warning can cause another. */
1560 while (pending_malloc_warning
)
1561 display_malloc_warning ();
1563 Vdeactivate_mark
= Qnil
;
1565 /* If minibuffer on and echo area in use,
1566 wait a short time and redraw minibuffer. */
1569 && !NILP (echo_area_buffer
[0])
1570 && EQ (minibuf_window
, echo_area_window
)
1571 && NUMBERP (Vminibuffer_message_timeout
))
1573 /* Bind inhibit-quit to t so that C-g gets read in
1574 rather than quitting back to the minibuffer. */
1575 int count
= SPECPDL_INDEX ();
1576 specbind (Qinhibit_quit
, Qt
);
1578 sit_for (Vminibuffer_message_timeout
, 0, 2);
1580 /* Clear the echo area. */
1582 safe_run_hooks (Qecho_area_clear_hook
);
1584 unbind_to (count
, Qnil
);
1586 /* If a C-g came in before, treat it as input now. */
1587 if (!NILP (Vquit_flag
))
1590 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1595 /* Select the frame that the last event came from. Usually,
1596 switch-frame events will take care of this, but if some lisp
1597 code swallows a switch-frame event, we'll fix things up here.
1598 Is this a good idea? */
1599 if (FRAMEP (internal_last_event_frame
)
1600 && !EQ (internal_last_event_frame
, selected_frame
))
1601 Fselect_frame (internal_last_event_frame
, Qnil
);
1603 /* If it has changed current-menubar from previous value,
1604 really recompute the menubar from the value. */
1605 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1606 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1607 call0 (Qrecompute_lucid_menubar
);
1609 before_command_key_count
= this_command_key_count
;
1610 before_command_echo_length
= echo_length ();
1612 Vthis_command
= Qnil
;
1613 real_this_command
= Qnil
;
1614 Vthis_original_command
= Qnil
;
1615 Vthis_command_keys_shift_translated
= Qnil
;
1617 /* Read next key sequence; i gets its length. */
1618 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1621 /* A filter may have run while we were reading the input. */
1622 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1624 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1625 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1629 /* Now we have read a key sequence of length I,
1630 or else I is 0 and we found end of file. */
1632 if (i
== 0) /* End of file -- happens only in */
1633 return Qnil
; /* a kbd macro, at the end. */
1634 /* -1 means read_key_sequence got a menu that was rejected.
1635 Just loop around and read another command. */
1639 this_command_key_count
= 0;
1640 this_command_key_count_reset
= 0;
1641 this_single_command_key_start
= 0;
1645 last_command_event
= keybuf
[i
- 1];
1647 /* If the previous command tried to force a specific window-start,
1648 forget about that, in case this command moves point far away
1649 from that position. But also throw away beg_unchanged and
1650 end_unchanged information in that case, so that redisplay will
1651 update the whole window properly. */
1652 if (!NILP (XWINDOW (selected_window
)->force_start
))
1655 XWINDOW (selected_window
)->force_start
= Qnil
;
1656 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1657 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1660 cmd
= read_key_sequence_cmd
;
1661 if (!NILP (Vexecuting_kbd_macro
))
1663 if (!NILP (Vquit_flag
))
1665 Vexecuting_kbd_macro
= Qt
;
1666 QUIT
; /* Make some noise. */
1667 /* Will return since macro now empty. */
1671 /* Do redisplay processing after this command except in special
1672 cases identified below. */
1673 prev_buffer
= current_buffer
;
1674 prev_modiff
= MODIFF
;
1675 last_point_position
= PT
;
1676 last_point_position_window
= selected_window
;
1677 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1679 /* By default, we adjust point to a boundary of a region that
1680 has such a property that should be treated intangible
1681 (e.g. composition, display). But, some commands will set
1682 this variable differently. */
1683 Vdisable_point_adjustment
= Qnil
;
1685 /* Process filters and timers may have messed with deactivate-mark.
1686 reset it before we execute the command. */
1687 Vdeactivate_mark
= Qnil
;
1689 /* Remap command through active keymaps */
1690 Vthis_original_command
= cmd
;
1694 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1698 /* Execute the command. */
1700 Vthis_command
= cmd
;
1701 real_this_command
= cmd
;
1702 /* Note that the value cell will never directly contain nil
1703 if the symbol is a local variable. */
1704 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1705 safe_run_hooks (Qpre_command_hook
);
1707 already_adjusted
= 0;
1709 if (NILP (Vthis_command
))
1711 /* nil means key is undefined. */
1712 Lisp_Object keys
= Fvector (i
, keybuf
);
1713 keys
= Fkey_description (keys
, Qnil
);
1715 message_with_string ("%s is undefined", keys
, 0);
1716 current_kboard
->defining_kbd_macro
= Qnil
;
1717 update_mode_lines
= 1;
1718 current_kboard
->Vprefix_arg
= Qnil
;
1722 /* Here for a command that isn't executed directly */
1724 #ifdef HAVE_WINDOW_SYSTEM
1725 int scount
= SPECPDL_INDEX ();
1727 if (display_hourglass_p
1728 && NILP (Vexecuting_kbd_macro
))
1730 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1735 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1737 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1739 #ifdef HAVE_WINDOW_SYSTEM
1740 /* Do not check display_hourglass_p here, because
1741 Fcommand_execute could change it, but we should cancel
1742 hourglass cursor anyway.
1743 But don't cancel the hourglass within a macro
1744 just because a command in the macro finishes. */
1745 if (NILP (Vexecuting_kbd_macro
))
1746 unbind_to (scount
, Qnil
);
1749 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1751 /* Note that the value cell will never directly contain nil
1752 if the symbol is a local variable. */
1753 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1754 safe_run_hooks (Qpost_command_hook
);
1756 /* If displaying a message, resize the echo area window to fit
1757 that message's size exactly. */
1758 if (!NILP (echo_area_buffer
[0]))
1759 resize_echo_area_exactly ();
1761 if (!NILP (Vdeferred_action_list
))
1762 safe_run_hooks (Qdeferred_action_function
);
1764 /* If there is a prefix argument,
1765 1) We don't want Vlast_command to be ``universal-argument''
1766 (that would be dumb), so don't set Vlast_command,
1767 2) we want to leave echoing on so that the prefix will be
1768 echoed as part of this key sequence, so don't call
1770 3) we want to leave this_command_key_count non-zero, so that
1771 read_char will realize that it is re-reading a character, and
1772 not echo it a second time.
1774 If the command didn't actually create a prefix arg,
1775 but is merely a frame event that is transparent to prefix args,
1776 then the above doesn't apply. */
1777 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1779 current_kboard
->Vlast_command
= Vthis_command
;
1780 current_kboard
->Vreal_last_command
= real_this_command
;
1781 if (!CONSP (last_command_event
))
1782 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1784 this_command_key_count
= 0;
1785 this_command_key_count_reset
= 0;
1786 this_single_command_key_start
= 0;
1789 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1791 /* In Emacs 22, setting transient-mark-mode to `only' was a
1792 way of turning it on for just one command. This usage is
1793 obsolete, but support it anyway. */
1794 if (EQ (Vtransient_mark_mode
, Qidentity
))
1795 Vtransient_mark_mode
= Qnil
;
1796 else if (EQ (Vtransient_mark_mode
, Qonly
))
1797 Vtransient_mark_mode
= Qidentity
;
1799 if (!NILP (Vdeactivate_mark
))
1800 /* If `select-active-regions' is non-nil, this call to
1801 `deactivate-mark' also sets the PRIMARY selection. */
1802 call0 (Qdeactivate_mark
);
1805 /* Even if not deactivating the mark, set PRIMARY if
1806 `select-active-regions' is non-nil. */
1807 if (!NILP (Fwindow_system (Qnil
))
1808 && (EQ (Vselect_active_regions
, Qonly
)
1809 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1810 : (!NILP (Vselect_active_regions
)
1811 && !NILP (Vtransient_mark_mode
)))
1812 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1815 XINT (Fmarker_position (current_buffer
->mark
));
1818 call2 (Qx_set_selection
, QPRIMARY
,
1819 make_buffer_string (beg
, end
, 0));
1821 call2 (Qx_set_selection
, QPRIMARY
,
1822 make_buffer_string (end
, beg
, 0));
1823 /* Don't set empty selections. */
1826 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1827 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1830 Vsaved_region_selection
= Qnil
;
1835 if (current_buffer
== prev_buffer
1836 && last_point_position
!= PT
1837 && NILP (Vdisable_point_adjustment
)
1838 && NILP (Vglobal_disable_point_adjustment
))
1840 if (last_point_position
> BEGV
1841 && last_point_position
< ZV
1842 && (composition_adjust_point (last_point_position
,
1843 last_point_position
)
1844 != last_point_position
))
1845 /* The last point was temporarily set within a grapheme
1846 cluster to prevent automatic composition. To recover
1847 the automatic composition, we must update the
1849 windows_or_buffers_changed
++;
1850 if (!already_adjusted
)
1851 adjust_point_for_property (last_point_position
,
1852 MODIFF
!= prev_modiff
);
1855 /* Install chars successfully executed in kbd macro. */
1857 if (!NILP (current_kboard
->defining_kbd_macro
)
1858 && NILP (current_kboard
->Vprefix_arg
))
1859 finalize_kbd_macro_chars ();
1860 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1862 any_kboard_state ();
1867 /* Adjust point to a boundary of a region that has such a property
1868 that should be treated intangible. For the moment, we check
1869 `composition', `display' and `invisible' properties.
1870 LAST_PT is the last position of point. */
1873 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1876 Lisp_Object val
, overlay
, tmp
;
1877 /* When called after buffer modification, we should temporarily
1878 suppress the point adjustment for automatic composition so that a
1879 user can keep inserting another character at point or keep
1880 deleting characters around point. */
1881 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1882 EMACS_INT orig_pt
= PT
;
1884 /* FIXME: cycling is probably not necessary because these properties
1885 can't be usefully combined anyway. */
1886 while (check_composition
|| check_display
|| check_invisible
)
1888 /* FIXME: check `intangible'. */
1889 if (check_composition
1890 && PT
> BEGV
&& PT
< ZV
1891 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1894 check_display
= check_invisible
= 1;
1896 check_composition
= 0;
1898 && PT
> BEGV
&& PT
< ZV
1899 && !NILP (val
= get_char_property_and_overlay
1900 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1901 && display_prop_intangible_p (val
)
1902 && (!OVERLAYP (overlay
)
1903 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1904 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1905 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1906 && (beg
< PT
/* && end > PT <- It's always the case. */
1907 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1910 SET_PT (PT
< last_pt
1911 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1913 check_composition
= check_invisible
= 1;
1916 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1918 int inv
, ellipsis
= 0;
1921 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1924 /* FIXME: We should stop if we find a spot between
1925 two runs of `invisible' where inserted text would
1926 be visible. This is important when we have two
1927 invisible boundaries that enclose an area: if the
1928 area is empty, we need this test in order to make
1929 it possible to place point in the middle rather
1930 than skip both boundaries. However, this code
1931 also stops anywhere in a non-sticky text-property,
1932 which breaks (e.g.) Org mode. */
1933 && (val
= get_pos_property (make_number (end
),
1935 TEXT_PROP_MEANS_INVISIBLE (val
))
1937 && !NILP (val
= get_char_property_and_overlay
1938 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1939 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1941 ellipsis
= ellipsis
|| inv
> 1
1942 || (OVERLAYP (overlay
)
1943 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1944 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1945 tmp
= Fnext_single_char_property_change
1946 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1947 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1951 && (val
= get_pos_property (make_number (beg
),
1953 TEXT_PROP_MEANS_INVISIBLE (val
))
1955 && !NILP (val
= get_char_property_and_overlay
1956 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1957 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1959 ellipsis
= ellipsis
|| inv
> 1
1960 || (OVERLAYP (overlay
)
1961 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1962 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1963 tmp
= Fprevious_single_char_property_change
1964 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1965 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1968 /* Move away from the inside area. */
1969 if (beg
< PT
&& end
> PT
)
1971 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1972 /* We haven't moved yet (so we don't need to fear
1973 infinite-looping) and we were outside the range
1974 before (so either end of the range still corresponds
1975 to a move in the right direction): pretend we moved
1976 less than we actually did, so that we still have
1977 more freedom below in choosing which end of the range
1979 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1980 /* We either have moved already or the last point
1981 was already in the range: we don't get to choose
1982 which end of the range we have to go to. */
1983 : (PT
< last_pt
? beg
: end
));
1984 check_composition
= check_display
= 1;
1986 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1987 the point to something other than its argument, due to
1988 point-motion hooks, intangibility, etc. */
1989 xassert (PT
== beg
|| PT
== end
);
1992 /* Pretend the area doesn't exist if the buffer is not
1994 if (!modified
&& !ellipsis
&& beg
< end
)
1996 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1997 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1998 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1999 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2000 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2001 /* We've already moved as far as we can. Trying to go
2002 to the other end would mean moving backwards and thus
2003 could lead to an infinite loop. */
2005 else if (val
= get_pos_property (make_number (PT
),
2007 TEXT_PROP_MEANS_INVISIBLE (val
)
2008 && (val
= get_pos_property
2009 (make_number (PT
== beg
? end
: beg
),
2011 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2012 (check_composition
= check_display
= 1,
2013 SET_PT (PT
== beg
? end
: beg
));
2016 check_invisible
= 0;
2020 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2023 safe_run_hooks_1 (void)
2025 if (NILP (Vrun_hooks
))
2027 return call1 (Vrun_hooks
, Vinhibit_quit
);
2030 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2033 safe_run_hooks_error (Lisp_Object data
)
2035 Lisp_Object args
[3];
2036 args
[0] = build_string ("Error in %s: %s");
2037 args
[1] = Vinhibit_quit
;
2040 return Fset (Vinhibit_quit
, Qnil
);
2043 /* If we get an error while running the hook, cause the hook variable
2044 to be nil. Also inhibit quits, so that C-g won't cause the hook
2045 to mysteriously evaporate. */
2048 safe_run_hooks (Lisp_Object hook
)
2050 int count
= SPECPDL_INDEX ();
2051 specbind (Qinhibit_quit
, hook
);
2053 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2055 unbind_to (count
, Qnil
);
2059 /* Number of seconds between polling for input. This is a Lisp
2060 variable that can be bound. */
2062 EMACS_INT polling_period
;
2064 /* Nonzero means polling for input is temporarily suppressed. */
2066 int poll_suppress_count
;
2068 /* Asynchronous timer for polling. */
2070 struct atimer
*poll_timer
;
2073 #ifdef POLL_FOR_INPUT
2075 /* Poll for input, so that we catch a C-g if it comes in. This
2076 function is called from x_make_frame_visible, see comment
2080 poll_for_input_1 (void)
2082 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2083 doing anything dangerous. */
2087 if (interrupt_input_blocked
== 0
2088 && !waiting_for_input
)
2089 read_avail_input (0);
2095 /* Timer callback function for poll_timer. TIMER is equal to
2099 poll_for_input (struct atimer
*timer
)
2101 if (poll_suppress_count
== 0)
2104 interrupt_input_pending
= 1;
2105 pending_signals
= 1;
2107 poll_for_input_1 ();
2112 #endif /* POLL_FOR_INPUT */
2114 /* Begin signals to poll for input, if they are appropriate.
2115 This function is called unconditionally from various places. */
2118 start_polling (void)
2120 #ifdef POLL_FOR_INPUT
2121 /* XXX This condition was (read_socket_hook && !interrupt_input),
2122 but read_socket_hook is not global anymore. Let's pretend that
2124 if (!interrupt_input
)
2126 /* Turn alarm handling on unconditionally. It might have
2127 been turned off in process.c. */
2128 turn_on_atimers (1);
2130 /* If poll timer doesn't exist, are we need one with
2131 a different interval, start a new one. */
2132 if (poll_timer
== NULL
2133 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2135 EMACS_TIME interval
;
2138 cancel_atimer (poll_timer
);
2140 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2141 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2142 poll_for_input
, NULL
);
2145 /* Let the timer's callback function poll for input
2146 if this becomes zero. */
2147 --poll_suppress_count
;
2152 /* Nonzero if we are using polling to handle input asynchronously. */
2155 input_polling_used (void)
2157 #ifdef POLL_FOR_INPUT
2158 /* XXX This condition was (read_socket_hook && !interrupt_input),
2159 but read_socket_hook is not global anymore. Let's pretend that
2161 return !interrupt_input
;
2167 /* Turn off polling. */
2172 #ifdef POLL_FOR_INPUT
2173 /* XXX This condition was (read_socket_hook && !interrupt_input),
2174 but read_socket_hook is not global anymore. Let's pretend that
2176 if (!interrupt_input
)
2177 ++poll_suppress_count
;
2181 /* Set the value of poll_suppress_count to COUNT
2182 and start or stop polling accordingly. */
2185 set_poll_suppress_count (int count
)
2187 #ifdef POLL_FOR_INPUT
2188 if (count
== 0 && poll_suppress_count
!= 0)
2190 poll_suppress_count
= 1;
2193 else if (count
!= 0 && poll_suppress_count
== 0)
2197 poll_suppress_count
= count
;
2201 /* Bind polling_period to a value at least N.
2202 But don't decrease it. */
2205 bind_polling_period (int n
)
2207 #ifdef POLL_FOR_INPUT
2208 int new = polling_period
;
2213 stop_other_atimers (poll_timer
);
2215 specbind (Qpolling_period
, make_number (new));
2216 /* Start a new alarm with the new period. */
2221 /* Apply the control modifier to CHARACTER. */
2224 make_ctrl_char (int c
)
2226 /* Save the upper bits here. */
2227 int upper
= c
& ~0177;
2229 if (! ASCII_BYTE_P (c
))
2230 return c
|= ctrl_modifier
;
2234 /* Everything in the columns containing the upper-case letters
2235 denotes a control character. */
2236 if (c
>= 0100 && c
< 0140)
2240 /* Set the shift modifier for a control char
2241 made from a shifted letter. But only for letters! */
2242 if (oc
>= 'A' && oc
<= 'Z')
2243 c
|= shift_modifier
;
2246 /* The lower-case letters denote control characters too. */
2247 else if (c
>= 'a' && c
<= 'z')
2250 /* Include the bits for control and shift
2251 only if the basic ASCII code can't indicate them. */
2255 /* Replace the high bits. */
2256 c
|= (upper
& ~ctrl_modifier
);
2261 /* Display the help-echo property of the character after the mouse pointer.
2262 Either show it in the echo area, or call show-help-function to display
2263 it by other means (maybe in a tooltip).
2265 If HELP is nil, that means clear the previous help echo.
2267 If HELP is a string, display that string. If HELP is a function,
2268 call it with OBJECT and POS as arguments; the function should
2269 return a help string or nil for none. For all other types of HELP,
2270 evaluate it to obtain a string.
2272 WINDOW is the window in which the help was generated, if any.
2273 It is nil if not in a window.
2275 If OBJECT is a buffer, POS is the position in the buffer where the
2276 `help-echo' text property was found.
2278 If OBJECT is an overlay, that overlay has a `help-echo' property,
2279 and POS is the position in the overlay's buffer under the mouse.
2281 If OBJECT is a string (an overlay string or a string displayed with
2282 the `display' property). POS is the position in that string under
2285 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2286 echo overwrites a keystroke echo currently displayed in the echo
2289 Note: this function may only be called with HELP nil or a string
2290 from X code running asynchronously. */
2293 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2294 Lisp_Object pos
, int ok_to_overwrite_keystroke_echo
)
2296 if (!NILP (help
) && !STRINGP (help
))
2298 if (FUNCTIONP (help
))
2300 Lisp_Object args
[4];
2305 help
= safe_call (4, args
);
2308 help
= safe_eval (help
);
2310 if (!STRINGP (help
))
2314 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2315 if (!noninteractive
&& STRINGP (help
))
2317 /* The mouse-fixup-help-message Lisp function can call
2318 mouse_position_hook, which resets the mouse_moved flags.
2319 This causes trouble if we are trying to read a mouse motion
2320 event (i.e., if we are inside a `track-mouse' form), so we
2321 restore the mouse_moved flag. */
2322 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2323 help
= call1 (Qmouse_fixup_help_message
, help
);
2329 if (STRINGP (help
) || NILP (help
))
2331 if (!NILP (Vshow_help_function
))
2332 call1 (Vshow_help_function
, help
);
2333 help_echo_showing_p
= STRINGP (help
);
2339 /* Input of single characters from keyboard */
2341 Lisp_Object
print_help (Lisp_Object object
);
2342 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2343 struct timeval
*end_time
);
2344 static void record_char (Lisp_Object c
);
2346 static Lisp_Object help_form_saved_window_configs
;
2348 read_char_help_form_unwind (Lisp_Object arg
)
2350 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2351 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2352 if (!NILP (window_config
))
2353 Fset_window_configuration (window_config
);
2357 #define STOP_POLLING \
2358 do { if (! polling_stopped_here) stop_polling (); \
2359 polling_stopped_here = 1; } while (0)
2361 #define RESUME_POLLING \
2362 do { if (polling_stopped_here) start_polling (); \
2363 polling_stopped_here = 0; } while (0)
2365 /* read a character from the keyboard; call the redisplay if needed */
2366 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2367 -1 means do not do redisplay, but do do autosaving.
2370 /* The arguments MAPS and NMAPS are for menu prompting.
2371 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2373 PREV_EVENT is the previous input event, or nil if we are reading
2374 the first event of a key sequence (or not reading a key sequence).
2375 If PREV_EVENT is t, that is a "magic" value that says
2376 not to run input methods, but in other respects to act as if
2377 not reading a key sequence.
2379 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2380 if we used a mouse menu to read the input, or zero otherwise. If
2381 USED_MOUSE_MENU is null, we don't dereference it.
2383 Value is -2 when we find input on another keyboard. A second call
2384 to read_char will read it.
2386 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2387 specifying the maximum time to wait until. If no input arrives by
2388 that time, stop waiting and return nil.
2390 Value is t if we showed a menu and the user rejected it. */
2393 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2394 int *used_mouse_menu
, struct timeval
*end_time
)
2396 volatile Lisp_Object c
;
2397 int count
, jmpcount
;
2398 jmp_buf local_getcjmp
;
2400 volatile int key_already_recorded
= 0;
2401 Lisp_Object tem
, save
;
2402 volatile Lisp_Object previous_echo_area_message
;
2403 volatile Lisp_Object also_record
;
2404 volatile int reread
;
2405 struct gcpro gcpro1
, gcpro2
;
2406 int polling_stopped_here
= 0;
2407 struct kboard
*orig_kboard
= current_kboard
;
2411 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2412 before_command_key_count
= this_command_key_count
;
2413 before_command_echo_length
= echo_length ();
2416 previous_echo_area_message
= Qnil
;
2418 GCPRO2 (c
, previous_echo_area_message
);
2423 if (CONSP (Vunread_post_input_method_events
))
2425 c
= XCAR (Vunread_post_input_method_events
);
2426 Vunread_post_input_method_events
2427 = XCDR (Vunread_post_input_method_events
);
2429 /* Undo what read_char_x_menu_prompt did when it unread
2430 additional keys returned by Fx_popup_menu. */
2432 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2440 if (unread_command_char
!= -1)
2442 XSETINT (c
, unread_command_char
);
2443 unread_command_char
= -1;
2449 if (CONSP (Vunread_command_events
))
2451 int was_disabled
= 0;
2453 c
= XCAR (Vunread_command_events
);
2454 Vunread_command_events
= XCDR (Vunread_command_events
);
2458 /* Undo what sit-for did when it unread additional keys
2459 inside universal-argument. */
2462 && EQ (XCAR (c
), Qt
))
2468 /* Undo what read_char_x_menu_prompt did when it unread
2469 additional keys returned by Fx_popup_menu. */
2471 && EQ (XCDR (c
), Qdisabled
)
2472 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2478 /* If the queued event is something that used the mouse,
2479 set used_mouse_menu accordingly. */
2481 /* Also check was_disabled so last-nonmenu-event won't return
2482 a bad value when submenus are involved. (Bug#447) */
2483 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2484 *used_mouse_menu
= 1;
2486 goto reread_for_input_method
;
2489 if (CONSP (Vunread_input_method_events
))
2491 c
= XCAR (Vunread_input_method_events
);
2492 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2494 /* Undo what read_char_x_menu_prompt did when it unread
2495 additional keys returned by Fx_popup_menu. */
2497 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2501 goto reread_for_input_method
;
2504 this_command_key_count_reset
= 0;
2506 if (!NILP (Vexecuting_kbd_macro
))
2508 /* We set this to Qmacro; since that's not a frame, nobody will
2509 try to switch frames on us, and the selected window will
2512 Since this event came from a macro, it would be misleading to
2513 leave internal_last_event_frame set to wherever the last
2514 real event came from. Normally, a switch-frame event selects
2515 internal_last_event_frame after each command is read, but
2516 events read from a macro should never cause a new frame to be
2518 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2520 /* Exit the macro if we are at the end.
2521 Also, some things replace the macro with t
2522 to force an early exit. */
2523 if (EQ (Vexecuting_kbd_macro
, Qt
)
2524 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2530 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2531 if (STRINGP (Vexecuting_kbd_macro
)
2532 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2533 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2535 executing_kbd_macro_index
++;
2540 if (!NILP (unread_switch_frame
))
2542 c
= unread_switch_frame
;
2543 unread_switch_frame
= Qnil
;
2545 /* This event should make it into this_command_keys, and get echoed
2546 again, so we do not set `reread'. */
2550 /* if redisplay was requested */
2551 if (commandflag
>= 0)
2553 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2555 /* If there is pending input, process any events which are not
2556 user-visible, such as X selection_request events. */
2558 || detect_input_pending_run_timers (0))
2559 swallow_events (0); /* may clear input_pending */
2561 /* Redisplay if no pending input. */
2562 while (!input_pending
)
2564 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2565 redisplay_preserve_echo_area (5);
2570 /* Normal case: no input arrived during redisplay. */
2573 /* Input arrived and pre-empted redisplay.
2574 Process any events which are not user-visible. */
2576 /* If that cleared input_pending, try again to redisplay. */
2579 /* Prevent the redisplay we just did
2580 from messing up echoing of the input after the prompt. */
2581 if (commandflag
== 0 && echo_current
)
2582 echo_message_buffer
= echo_area_buffer
[0];
2586 /* Message turns off echoing unless more keystrokes turn it on again.
2588 The code in 20.x for the condition was
2590 1. echo_area_glyphs && *echo_area_glyphs
2591 2. && echo_area_glyphs != current_kboard->echobuf
2592 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2594 (1) means there's a current message displayed
2596 (2) means it's not the message from echoing from the current
2599 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2600 is set to a non-null value. This is done in read_char and it is
2601 set to echo_area_glyphs after a call to echo_char. That means
2602 ok_to_echo_at_next_pause is either null or
2603 current_kboard->echobuf with the appropriate current_kboard at
2606 So, condition (3) means in clear text ok_to_echo_at_next_pause
2607 must be either null, or the current message isn't from echoing at
2608 all, or it's from echoing from a different kboard than the
2611 if (/* There currently is something in the echo area. */
2612 !NILP (echo_area_buffer
[0])
2613 && (/* And it's either not from echoing. */
2614 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2615 /* Or it's an echo from a different kboard. */
2616 || echo_kboard
!= current_kboard
2617 /* Or we explicitly allow overwriting whatever there is. */
2618 || ok_to_echo_at_next_pause
== NULL
))
2623 /* Try reading a character via menu prompting in the minibuf.
2624 Try this before the sit-for, because the sit-for
2625 would do the wrong thing if we are supposed to do
2626 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2627 after a mouse event so don't try a minibuf menu. */
2629 if (nmaps
> 0 && INTERACTIVE
2630 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2631 /* Don't bring up a menu if we already have another event. */
2632 && NILP (Vunread_command_events
)
2633 && unread_command_char
< 0
2634 && !detect_input_pending_run_timers (0))
2636 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2638 if (INTEGERP (c
) && XINT (c
) == -2)
2639 return c
; /* wrong_kboard_jmpbuf */
2643 key_already_recorded
= 1;
2648 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2649 We will do that below, temporarily for short sections of code,
2650 when appropriate. local_getcjmp must be in effect
2651 around any call to sit_for or kbd_buffer_get_event;
2652 it *must not* be in effect when we call redisplay. */
2654 jmpcount
= SPECPDL_INDEX ();
2655 if (_setjmp (local_getcjmp
))
2657 /* Handle quits while reading the keyboard. */
2658 /* We must have saved the outer value of getcjmp here,
2659 so restore it now. */
2660 restore_getcjmp (save_jump
);
2661 unbind_to (jmpcount
, Qnil
);
2662 XSETINT (c
, quit_char
);
2663 internal_last_event_frame
= selected_frame
;
2664 Vlast_event_frame
= internal_last_event_frame
;
2665 /* If we report the quit char as an event,
2666 don't do so more than once. */
2667 if (!NILP (Vinhibit_quit
))
2671 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2672 if (kb
!= current_kboard
)
2674 Lisp_Object link
= kb
->kbd_queue
;
2675 /* We shouldn't get here if we were in single-kboard mode! */
2680 while (CONSP (XCDR (link
)))
2682 if (!NILP (XCDR (link
)))
2686 kb
->kbd_queue
= Fcons (c
, Qnil
);
2688 XSETCDR (link
, Fcons (c
, Qnil
));
2689 kb
->kbd_queue_has_data
= 1;
2690 current_kboard
= kb
;
2691 /* This is going to exit from read_char
2692 so we had better get rid of this frame's stuff. */
2694 return make_number (-2); /* wrong_kboard_jmpbuf */
2700 /* Start idle timers if no time limit is supplied. We don't do it
2701 if a time limit is supplied to avoid an infinite recursion in the
2702 situation where an idle timer calls `sit-for'. */
2705 timer_start_idle ();
2707 /* If in middle of key sequence and minibuffer not active,
2708 start echoing if enough time elapses. */
2710 if (minibuf_level
== 0
2712 && !current_kboard
->immediate_echo
2713 && this_command_key_count
> 0
2715 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2716 && NILP (Fzerop (Vecho_keystrokes
))
2717 && (/* No message. */
2718 NILP (echo_area_buffer
[0])
2719 /* Or empty message. */
2720 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2721 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2722 /* Or already echoing from same kboard. */
2723 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2724 /* Or not echoing before and echoing allowed. */
2725 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2727 /* After a mouse event, start echoing right away.
2728 This is because we are probably about to display a menu,
2729 and we don't want to delay before doing so. */
2730 if (EVENT_HAS_PARAMETERS (prev_event
))
2736 save_getcjmp (save_jump
);
2737 restore_getcjmp (local_getcjmp
);
2738 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2739 restore_getcjmp (save_jump
);
2741 && ! CONSP (Vunread_command_events
))
2746 /* Maybe auto save due to number of keystrokes. */
2748 if (commandflag
!= 0
2749 && auto_save_interval
> 0
2750 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2751 && !detect_input_pending_run_timers (0))
2753 Fdo_auto_save (Qnil
, Qnil
);
2754 /* Hooks can actually change some buffers in auto save. */
2758 /* Try reading using an X menu.
2759 This is never confused with reading using the minibuf
2760 because the recursive call of read_char in read_char_minibuf_menu_prompt
2761 does not pass on any keymaps. */
2763 if (nmaps
> 0 && INTERACTIVE
2764 && !NILP (prev_event
)
2765 && EVENT_HAS_PARAMETERS (prev_event
)
2766 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2767 && !EQ (XCAR (prev_event
), Qtool_bar
)
2768 /* Don't bring up a menu if we already have another event. */
2769 && NILP (Vunread_command_events
)
2770 && unread_command_char
< 0)
2772 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2774 /* Now that we have read an event, Emacs is not idle. */
2781 /* Maybe autosave and/or garbage collect due to idleness. */
2783 if (INTERACTIVE
&& NILP (c
))
2786 EMACS_INT buffer_size
;
2788 /* Slow down auto saves logarithmically in size of current buffer,
2789 and garbage collect while we're at it. */
2790 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2791 last_non_minibuf_size
= Z
- BEG
;
2792 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2794 while (buffer_size
> 64)
2795 delay_level
++, buffer_size
-= buffer_size
>> 2;
2796 if (delay_level
< 4) delay_level
= 4;
2797 /* delay_level is 4 for files under around 50k, 7 at 100k,
2798 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2800 /* Auto save if enough time goes by without input. */
2801 if (commandflag
!= 0
2802 && num_nonmacro_input_events
> last_auto_save
2803 && INTEGERP (Vauto_save_timeout
)
2804 && XINT (Vauto_save_timeout
) > 0)
2807 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2809 save_getcjmp (save_jump
);
2810 restore_getcjmp (local_getcjmp
);
2811 tem0
= sit_for (make_number (timeout
), 1, 1);
2812 restore_getcjmp (save_jump
);
2815 && ! CONSP (Vunread_command_events
))
2817 Fdo_auto_save (Qnil
, Qnil
);
2819 /* If we have auto-saved and there is still no input
2820 available, garbage collect if there has been enough
2821 consing going on to make it worthwhile. */
2822 if (!detect_input_pending_run_timers (0)
2823 && consing_since_gc
> gc_cons_threshold
/ 2)
2824 Fgarbage_collect ();
2831 /* Notify the caller if an autosave hook, or a timer, sentinel or
2832 filter in the sit_for calls above have changed the current
2833 kboard. This could happen if they use the minibuffer or start a
2834 recursive edit, like the fancy splash screen in server.el's
2835 filter. If this longjmp wasn't here, read_key_sequence would
2836 interpret the next key sequence using the wrong translation
2837 tables and function keymaps. */
2838 if (NILP (c
) && current_kboard
!= orig_kboard
)
2841 return make_number (-2); /* wrong_kboard_jmpbuf */
2844 /* If this has become non-nil here, it has been set by a timer
2845 or sentinel or filter. */
2846 if (CONSP (Vunread_command_events
))
2848 c
= XCAR (Vunread_command_events
);
2849 Vunread_command_events
= XCDR (Vunread_command_events
);
2852 /* Read something from current KBOARD's side queue, if possible. */
2856 if (current_kboard
->kbd_queue_has_data
)
2858 if (!CONSP (current_kboard
->kbd_queue
))
2860 c
= XCAR (current_kboard
->kbd_queue
);
2861 current_kboard
->kbd_queue
2862 = XCDR (current_kboard
->kbd_queue
);
2863 if (NILP (current_kboard
->kbd_queue
))
2864 current_kboard
->kbd_queue_has_data
= 0;
2865 input_pending
= readable_events (0);
2866 if (EVENT_HAS_PARAMETERS (c
)
2867 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2868 internal_last_event_frame
= XCAR (XCDR (c
));
2869 Vlast_event_frame
= internal_last_event_frame
;
2873 /* If current_kboard's side queue is empty check the other kboards.
2874 If one of them has data that we have not yet seen here,
2875 switch to it and process the data waiting for it.
2877 Note: if the events queued up for another kboard
2878 have already been seen here, and therefore are not a complete command,
2879 the kbd_queue_has_data field is 0, so we skip that kboard here.
2880 That's to avoid an infinite loop switching between kboards here. */
2881 if (NILP (c
) && !single_kboard
)
2884 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2885 if (kb
->kbd_queue_has_data
)
2887 current_kboard
= kb
;
2888 /* This is going to exit from read_char
2889 so we had better get rid of this frame's stuff. */
2891 return make_number (-2); /* wrong_kboard_jmpbuf */
2899 /* Finally, we read from the main queue,
2900 and if that gives us something we can't use yet, we put it on the
2901 appropriate side queue and try again. */
2910 EMACS_GET_TIME (now
);
2911 if (EMACS_TIME_GE (now
, *end_time
))
2915 /* Actually read a character, waiting if necessary. */
2916 save_getcjmp (save_jump
);
2917 restore_getcjmp (local_getcjmp
);
2919 timer_start_idle ();
2920 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2921 restore_getcjmp (save_jump
);
2923 if (! NILP (c
) && (kb
!= current_kboard
))
2925 Lisp_Object link
= kb
->kbd_queue
;
2928 while (CONSP (XCDR (link
)))
2930 if (!NILP (XCDR (link
)))
2934 kb
->kbd_queue
= Fcons (c
, Qnil
);
2936 XSETCDR (link
, Fcons (c
, Qnil
));
2937 kb
->kbd_queue_has_data
= 1;
2941 current_kboard
= kb
;
2942 /* This is going to exit from read_char
2943 so we had better get rid of this frame's stuff. */
2945 return make_number (-2);
2949 /* Terminate Emacs in batch mode if at eof. */
2950 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2951 Fkill_emacs (make_number (1));
2955 /* Add in any extra modifiers, where appropriate. */
2956 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2957 || ((extra_keyboard_modifiers
& 0177) < ' '
2958 && (extra_keyboard_modifiers
& 0177) != 0))
2959 XSETINT (c
, make_ctrl_char (XINT (c
)));
2961 /* Transfer any other modifier bits directly from
2962 extra_keyboard_modifiers to c. Ignore the actual character code
2963 in the low 16 bits of extra_keyboard_modifiers. */
2964 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2975 if (commandflag
>= 0
2976 && !input_pending
&& !detect_input_pending_run_timers (0))
2984 /* Buffer switch events are only for internal wakeups
2985 so don't show them to the user.
2986 Also, don't record a key if we already did. */
2987 if (BUFFERP (c
) || key_already_recorded
)
2990 /* Process special events within read_char
2991 and loop around to read another event. */
2994 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2999 struct buffer
*prev_buffer
= current_buffer
;
3000 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3001 int was_locked
= single_kboard
;
3002 int count
= SPECPDL_INDEX ();
3003 record_single_kboard_state ();
3006 last_input_event
= c
;
3007 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3009 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3010 /* We stopped being idle for this event; undo that. This
3011 prevents automatic window selection (under
3012 mouse_autoselect_window from acting as a real input event, for
3013 example banishing the mouse under mouse-avoidance-mode. */
3014 timer_resume_idle ();
3016 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3017 /* Resume allowing input from any kboard, if that was true before. */
3019 any_kboard_state ();
3020 unbind_to (count
, Qnil
);
3023 if (current_buffer
!= prev_buffer
)
3025 /* The command may have changed the keymaps. Pretend there
3026 is input in another keyboard and return. This will
3027 recalculate keymaps. */
3028 c
= make_number (-2);
3035 /* Handle things that only apply to characters. */
3038 /* If kbd_buffer_get_event gave us an EOF, return that. */
3042 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3043 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3044 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3045 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3046 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3050 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3051 /* nil in keyboard-translate-table means no translation. */
3057 /* If this event is a mouse click in the menu bar,
3058 return just menu-bar for now. Modify the mouse click event
3059 so we won't do this twice, then queue it up. */
3060 if (EVENT_HAS_PARAMETERS (c
)
3062 && CONSP (EVENT_START (c
))
3063 && CONSP (XCDR (EVENT_START (c
))))
3067 posn
= POSN_POSN (EVENT_START (c
));
3068 /* Handle menu-bar events:
3069 insert the dummy prefix event `menu-bar'. */
3070 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3072 /* Change menu-bar to (menu-bar) as the event "position". */
3073 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3076 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3081 /* Store these characters into recent_keys, the dribble file if any,
3082 and the keyboard macro being defined, if any. */
3084 if (! NILP (also_record
))
3085 record_char (also_record
);
3087 /* Wipe the echo area.
3088 But first, if we are about to use an input method,
3089 save the echo area contents for it to refer to. */
3091 && ! NILP (Vinput_method_function
)
3092 && (unsigned) XINT (c
) >= ' '
3093 && (unsigned) XINT (c
) != 127
3094 && (unsigned) XINT (c
) < 256)
3096 previous_echo_area_message
= Fcurrent_message ();
3097 Vinput_method_previous_message
= previous_echo_area_message
;
3100 /* Now wipe the echo area, except for help events which do their
3101 own stuff with the echo area. */
3103 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3104 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3106 if (!NILP (echo_area_buffer
[0]))
3107 safe_run_hooks (Qecho_area_clear_hook
);
3108 clear_message (1, 0);
3111 reread_for_input_method
:
3113 /* Pass this to the input method, if appropriate. */
3115 && ! NILP (Vinput_method_function
)
3116 /* Don't run the input method within a key sequence,
3117 after the first event of the key sequence. */
3118 && NILP (prev_event
)
3119 && (unsigned) XINT (c
) >= ' '
3120 && (unsigned) XINT (c
) != 127
3121 && (unsigned) XINT (c
) < 256)
3124 int key_count
, key_count_reset
;
3125 struct gcpro gcpro1
;
3126 int count
= SPECPDL_INDEX ();
3128 /* Save the echo status. */
3129 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3130 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3131 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3132 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3135 if (before_command_restore_flag
)
3137 this_command_key_count
= before_command_key_count_1
;
3138 if (this_command_key_count
< this_single_command_key_start
)
3139 this_single_command_key_start
= this_command_key_count
;
3140 echo_truncate (before_command_echo_length_1
);
3141 before_command_restore_flag
= 0;
3145 /* Save the this_command_keys status. */
3146 key_count
= this_command_key_count
;
3147 key_count_reset
= this_command_key_count_reset
;
3150 keys
= Fcopy_sequence (this_command_keys
);
3155 /* Clear out this_command_keys. */
3156 this_command_key_count
= 0;
3157 this_command_key_count_reset
= 0;
3159 /* Now wipe the echo area. */
3160 if (!NILP (echo_area_buffer
[0]))
3161 safe_run_hooks (Qecho_area_clear_hook
);
3162 clear_message (1, 0);
3165 /* If we are not reading a key sequence,
3166 never use the echo area. */
3169 specbind (Qinput_method_use_echo_area
, Qt
);
3172 /* Call the input method. */
3173 tem
= call1 (Vinput_method_function
, c
);
3175 tem
= unbind_to (count
, tem
);
3177 /* Restore the saved echoing state
3178 and this_command_keys state. */
3179 this_command_key_count
= key_count
;
3180 this_command_key_count_reset
= key_count_reset
;
3182 this_command_keys
= keys
;
3185 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3186 current_kboard
->echo_string
= saved_echo_string
;
3187 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3188 if (saved_immediate_echo
)
3193 /* The input method can return no events. */
3196 /* Bring back the previous message, if any. */
3197 if (! NILP (previous_echo_area_message
))
3198 message_with_string ("%s", previous_echo_area_message
, 0);
3201 /* It returned one event or more. */
3203 Vunread_post_input_method_events
3204 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3209 /* Display help if not echoing. */
3210 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3212 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3213 Lisp_Object help
, object
, position
, window
, tem
;
3215 tem
= Fcdr (XCDR (c
));
3218 window
= Fcar (tem
);
3220 object
= Fcar (tem
);
3222 position
= Fcar (tem
);
3224 show_help_echo (help
, window
, object
, position
, 0);
3226 /* We stopped being idle for this event; undo that. */
3228 timer_resume_idle ();
3232 if ((! reread
|| this_command_key_count
== 0
3233 || this_command_key_count_reset
)
3237 /* Don't echo mouse motion events. */
3238 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3239 && NILP (Fzerop (Vecho_keystrokes
))
3240 && ! (EVENT_HAS_PARAMETERS (c
)
3241 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3244 if (! NILP (also_record
))
3245 echo_char (also_record
);
3246 /* Once we reread a character, echoing can happen
3247 the next time we pause to read a new one. */
3248 ok_to_echo_at_next_pause
= current_kboard
;
3251 /* Record this character as part of the current key. */
3252 add_command_key (c
);
3253 if (! NILP (also_record
))
3254 add_command_key (also_record
);
3257 last_input_event
= c
;
3260 /* Process the help character specially if enabled */
3261 if (!NILP (Vhelp_form
) && help_char_p (c
))
3264 count
= SPECPDL_INDEX ();
3266 help_form_saved_window_configs
3267 = Fcons (Fcurrent_window_configuration (Qnil
),
3268 help_form_saved_window_configs
);
3269 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3271 tem0
= Feval (Vhelp_form
);
3273 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3278 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3279 if (EVENT_HAS_PARAMETERS (c
)
3280 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3281 XSETCAR (help_form_saved_window_configs
, Qnil
);
3283 while (BUFFERP (c
));
3284 /* Remove the help from the frame */
3285 unbind_to (count
, Qnil
);
3288 if (EQ (c
, make_number (040)))
3292 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3293 while (BUFFERP (c
));
3302 /* Record a key that came from a mouse menu.
3303 Record it for echoing, for this-command-keys, and so on. */
3306 record_menu_key (Lisp_Object c
)
3308 /* Wipe the echo area. */
3309 clear_message (1, 0);
3314 before_command_key_count
= this_command_key_count
;
3315 before_command_echo_length
= echo_length ();
3318 /* Don't echo mouse motion events. */
3319 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3320 && NILP (Fzerop (Vecho_keystrokes
)))
3324 /* Once we reread a character, echoing can happen
3325 the next time we pause to read a new one. */
3326 ok_to_echo_at_next_pause
= 0;
3329 /* Record this character as part of the current key. */
3330 add_command_key (c
);
3332 /* Re-reading in the middle of a command */
3333 last_input_event
= c
;
3337 /* Return 1 if should recognize C as "the help character". */
3340 help_char_p (Lisp_Object c
)
3344 if (EQ (c
, Vhelp_char
))
3346 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3347 if (EQ (c
, XCAR (tail
)))
3352 /* Record the input event C in various ways. */
3355 record_char (Lisp_Object c
)
3359 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3361 /* To avoid filling recent_keys with help-echo and mouse-movement
3362 events, we filter out repeated help-echo events, only store the
3363 first and last in a series of mouse-movement events, and don't
3364 store repeated help-echo events which are only separated by
3365 mouse-movement events. */
3367 Lisp_Object ev1
, ev2
, ev3
;
3370 if ((ix1
= recent_keys_index
- 1) < 0)
3371 ix1
= NUM_RECENT_KEYS
- 1;
3372 ev1
= AREF (recent_keys
, ix1
);
3374 if ((ix2
= ix1
- 1) < 0)
3375 ix2
= NUM_RECENT_KEYS
- 1;
3376 ev2
= AREF (recent_keys
, ix2
);
3378 if ((ix3
= ix2
- 1) < 0)
3379 ix3
= NUM_RECENT_KEYS
- 1;
3380 ev3
= AREF (recent_keys
, ix3
);
3382 if (EQ (XCAR (c
), Qhelp_echo
))
3384 /* Don't record `help-echo' in recent_keys unless it shows some help
3385 message, and a different help than the previously recorded
3387 Lisp_Object help
, last_help
;
3389 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3390 if (!STRINGP (help
))
3392 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3393 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3395 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3396 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3397 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3399 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3400 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3401 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3402 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3405 else if (EQ (XCAR (c
), Qmouse_movement
))
3407 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3408 So additional mouse movement events replace the last element. */
3409 Lisp_Object last_window
, window
;
3411 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3412 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3413 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3414 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3415 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3417 ASET (recent_keys
, ix1
, c
);
3423 store_kbd_macro_char (c
);
3428 ASET (recent_keys
, recent_keys_index
, c
);
3429 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3430 recent_keys_index
= 0;
3432 else if (recorded
< 0)
3434 /* We need to remove one or two events from recent_keys.
3435 To do this, we simply put nil at those events and move the
3436 recent_keys_index backwards over those events. Usually,
3437 users will never see those nil events, as they will be
3438 overwritten by the command keys entered to see recent_keys
3441 while (recorded
++ < 0 && total_keys
> 0)
3443 if (total_keys
< NUM_RECENT_KEYS
)
3445 if (--recent_keys_index
< 0)
3446 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3447 ASET (recent_keys
, recent_keys_index
, Qnil
);
3451 num_nonmacro_input_events
++;
3453 /* Write c to the dribble file. If c is a lispy event, write
3454 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3455 If you, dear reader, have a better idea, you've got the source. :-) */
3461 if (XUINT (c
) < 0x100)
3462 putc (XINT (c
), dribble
);
3464 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3468 Lisp_Object dribblee
;
3470 /* If it's a structured event, take the event header. */
3471 dribblee
= EVENT_HEAD (c
);
3473 if (SYMBOLP (dribblee
))
3475 putc ('<', dribble
);
3476 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3477 SBYTES (SYMBOL_NAME (dribblee
)),
3479 putc ('>', dribble
);
3489 print_help (Lisp_Object object
)
3491 struct buffer
*old
= current_buffer
;
3492 Fprinc (object
, Qnil
);
3493 set_buffer_internal (XBUFFER (Vstandard_output
));
3494 call0 (intern ("help-mode"));
3495 set_buffer_internal (old
);
3499 /* Copy out or in the info on where C-g should throw to.
3500 This is used when running Lisp code from within get_char,
3501 in case get_char is called recursively.
3502 See read_process_output. */
3505 save_getcjmp (jmp_buf temp
)
3507 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3511 restore_getcjmp (jmp_buf temp
)
3513 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3516 /* Low level keyboard/mouse input.
3517 kbd_buffer_store_event places events in kbd_buffer, and
3518 kbd_buffer_get_event retrieves them. */
3520 /* Return true if there are any events in the queue that read-char
3521 would return. If this returns false, a read-char would block. */
3523 readable_events (int flags
)
3526 /* Check whether a D-Bus message has arrived. */
3527 if (xd_pending_messages () > 0)
3529 #endif /* HAVE_DBUS */
3531 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3534 /* If the buffer contains only FOCUS_IN_EVENT events, and
3535 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3536 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3538 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3539 #ifdef USE_TOOLKIT_SCROLL_BARS
3540 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3544 struct input_event
*event
;
3546 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3553 #ifdef USE_TOOLKIT_SCROLL_BARS
3554 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3556 event
->kind
== FOCUS_IN_EVENT
)
3557 #ifdef USE_TOOLKIT_SCROLL_BARS
3558 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3559 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3560 && event
->part
== scroll_bar_handle
3561 && event
->modifiers
== 0)
3566 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3569 while (event
!= kbd_store_ptr
);
3575 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3576 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3577 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3582 if (current_kboard
->kbd_queue_has_data
)
3588 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3589 if (kb
->kbd_queue_has_data
)
3595 /* Set this for debugging, to have a way to get out */
3599 event_to_kboard (struct input_event
*event
)
3602 frame
= event
->frame_or_window
;
3604 frame
= XCAR (frame
);
3605 else if (WINDOWP (frame
))
3606 frame
= WINDOW_FRAME (XWINDOW (frame
));
3608 /* There are still some events that don't set this field.
3609 For now, just ignore the problem.
3610 Also ignore dead frames here. */
3611 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3614 return FRAME_KBOARD (XFRAME (frame
));
3617 /* Return the number of slots occupied in kbd_buffer. */
3620 kbd_buffer_nr_stored (void)
3622 return kbd_fetch_ptr
== kbd_store_ptr
3624 : (kbd_fetch_ptr
< kbd_store_ptr
3625 ? kbd_store_ptr
- kbd_fetch_ptr
3626 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3627 + (kbd_store_ptr
- kbd_buffer
)));
3630 Lisp_Object Vthrow_on_input
;
3632 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3635 kbd_buffer_store_event (register struct input_event
*event
)
3637 kbd_buffer_store_event_hold (event
, 0);
3640 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3642 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3643 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3644 Else, if EVENT is a quit event, store the quit event
3645 in HOLD_QUIT, and return (thus ignoring further events).
3647 This is used in read_avail_input to postpone the processing
3648 of the quit event until all subsequent input events have been
3649 parsed (and discarded).
3653 kbd_buffer_store_event_hold (register struct input_event
*event
,
3654 struct input_event
*hold_quit
)
3656 if (event
->kind
== NO_EVENT
)
3659 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3662 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3664 register int c
= event
->code
& 0377;
3666 if (event
->modifiers
& ctrl_modifier
)
3667 c
= make_ctrl_char (c
);
3669 c
|= (event
->modifiers
3670 & (meta_modifier
| alt_modifier
3671 | hyper_modifier
| super_modifier
));
3675 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3676 struct input_event
*sp
;
3678 if (single_kboard
&& kb
!= current_kboard
)
3681 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3682 Fcons (make_number (c
), Qnil
));
3683 kb
->kbd_queue_has_data
= 1;
3684 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3686 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3689 if (event_to_kboard (sp
) == kb
)
3691 sp
->kind
= NO_EVENT
;
3692 sp
->frame_or_window
= Qnil
;
3701 memcpy (hold_quit
, event
, sizeof (*event
));
3705 /* If this results in a quit_char being returned to Emacs as
3706 input, set Vlast_event_frame properly. If this doesn't
3707 get returned to Emacs as an event, the next event read
3708 will set Vlast_event_frame again, so this is safe to do. */
3712 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3714 focus
= event
->frame_or_window
;
3715 internal_last_event_frame
= focus
;
3716 Vlast_event_frame
= focus
;
3719 last_event_timestamp
= event
->timestamp
;
3720 handle_interrupt ();
3724 if (c
&& c
== stop_character
)
3730 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3731 Just ignore the second one. */
3732 else if (event
->kind
== BUFFER_SWITCH_EVENT
3733 && kbd_fetch_ptr
!= kbd_store_ptr
3734 && ((kbd_store_ptr
== kbd_buffer
3735 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3736 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3739 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3740 kbd_store_ptr
= kbd_buffer
;
3742 /* Don't let the very last slot in the buffer become full,
3743 since that would make the two pointers equal,
3744 and that is indistinguishable from an empty buffer.
3745 Discard the event if it would fill the last slot. */
3746 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3748 *kbd_store_ptr
= *event
;
3750 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3752 /* Don't read keyboard input until we have processed kbd_buffer.
3753 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3754 hold_keyboard_input ();
3756 if (!noninteractive
)
3757 signal (SIGIO
, SIG_IGN
);
3763 /* If we're inside while-no-input, and this event qualifies
3764 as input, set quit-flag to cause an interrupt. */
3765 if (!NILP (Vthrow_on_input
)
3766 && event
->kind
!= FOCUS_IN_EVENT
3767 && event
->kind
!= HELP_EVENT
3768 && event
->kind
!= DEICONIFY_EVENT
)
3770 Vquit_flag
= Vthrow_on_input
;
3771 /* If we're inside a function that wants immediate quits,
3773 if (immediate_quit
&& NILP (Vinhibit_quit
))
3783 /* Put an input event back in the head of the event queue. */
3786 kbd_buffer_unget_event (register struct input_event
*event
)
3788 if (kbd_fetch_ptr
== kbd_buffer
)
3789 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3791 /* Don't let the very last slot in the buffer become full, */
3792 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3795 *kbd_fetch_ptr
= *event
;
3800 /* Generate a HELP_EVENT input_event and store it in the keyboard
3803 HELP is the help form.
3805 FRAME and WINDOW are the frame and window where the help is
3806 generated. OBJECT is the Lisp object where the help was found (a
3807 buffer, a string, an overlay, or nil if neither from a string nor
3808 from a buffer). POS is the position within OBJECT where the help
3812 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3813 Lisp_Object object
, EMACS_INT pos
)
3815 struct input_event event
;
3819 event
.kind
= HELP_EVENT
;
3820 event
.frame_or_window
= frame
;
3822 event
.x
= WINDOWP (window
) ? window
: frame
;
3825 kbd_buffer_store_event (&event
);
3829 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3832 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3834 struct input_event event
;
3836 event
.kind
= HELP_EVENT
;
3837 event
.frame_or_window
= frame
;
3842 kbd_buffer_store_event (&event
);
3846 /* Discard any mouse events in the event buffer by setting them to
3849 discard_mouse_events (void)
3851 struct input_event
*sp
;
3852 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3854 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3857 if (sp
->kind
== MOUSE_CLICK_EVENT
3858 || sp
->kind
== WHEEL_EVENT
3859 || sp
->kind
== HORIZ_WHEEL_EVENT
3861 || sp
->kind
== GPM_CLICK_EVENT
3863 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3865 sp
->kind
= NO_EVENT
;
3871 /* Return non-zero if there are any real events waiting in the event
3872 buffer, not counting `NO_EVENT's.
3874 If DISCARD is non-zero, discard NO_EVENT events at the front of
3875 the input queue, possibly leaving the input queue empty if there
3876 are no real input events. */
3879 kbd_buffer_events_waiting (int discard
)
3881 struct input_event
*sp
;
3883 for (sp
= kbd_fetch_ptr
;
3884 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3887 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3894 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3898 /* Clear input event EVENT. */
3901 clear_event (struct input_event
*event
)
3903 event
->kind
= NO_EVENT
;
3907 /* Read one event from the event buffer, waiting if necessary.
3908 The value is a Lisp object representing the event.
3909 The value is nil for an event that should be ignored,
3910 or that was handled here.
3911 We always read and discard one event. */
3914 kbd_buffer_get_event (KBOARD
**kbp
,
3915 int *used_mouse_menu
,
3916 struct timeval
*end_time
)
3921 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3923 /* Start reading input again, we have processed enough so we can
3924 accept new events again. */
3925 unhold_keyboard_input ();
3927 if (!noninteractive
)
3928 signal (SIGIO
, input_available_signal
);
3934 /* In case we are running as a daemon, only do this before
3935 detaching from the terminal. */
3936 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3940 *kbp
= current_kboard
;
3944 /* Wait until there is input available. */
3947 /* Break loop if there's an unread command event. Needed in
3948 moused window autoselection which uses a timer to insert such
3950 if (CONSP (Vunread_command_events
))
3953 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3955 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3956 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3960 /* If the quit flag is set, then read_char will return
3961 quit_char, so that counts as "available input." */
3962 if (!NILP (Vquit_flag
))
3963 quit_throw_to_read_char ();
3965 /* One way or another, wait until input is available; then, if
3966 interrupt handlers have not read it, read it now. */
3968 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3972 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3974 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3975 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3980 EMACS_TIME duration
;
3981 EMACS_GET_TIME (duration
);
3982 if (EMACS_TIME_GE (duration
, *end_time
))
3983 return Qnil
; /* finished waiting */
3986 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3987 wait_reading_process_output (EMACS_SECS (duration
),
3988 EMACS_USECS (duration
),
3989 -1, 1, Qnil
, NULL
, 0);
3993 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3995 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3996 /* Pass 1 for EXPECT since we just waited to have input. */
3997 read_avail_input (1);
4000 if (CONSP (Vunread_command_events
))
4003 first
= XCAR (Vunread_command_events
);
4004 Vunread_command_events
= XCDR (Vunread_command_events
);
4005 *kbp
= current_kboard
;
4009 /* At this point, we know that there is a readable event available
4010 somewhere. If the event queue is empty, then there must be a
4011 mouse movement enabled and available. */
4012 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4014 struct input_event
*event
;
4016 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4020 last_event_timestamp
= event
->timestamp
;
4022 *kbp
= event_to_kboard (event
);
4024 *kbp
= current_kboard
; /* Better than returning null ptr? */
4028 /* These two kinds of events get special handling
4029 and don't actually appear to the command loop.
4030 We return nil for them. */
4031 if (event
->kind
== SELECTION_REQUEST_EVENT
4032 || event
->kind
== SELECTION_CLEAR_EVENT
)
4035 struct input_event copy
;
4037 /* Remove it from the buffer before processing it,
4038 since otherwise swallow_events will see it
4039 and process it again. */
4041 kbd_fetch_ptr
= event
+ 1;
4042 input_pending
= readable_events (0);
4043 x_handle_selection_event (©
);
4045 /* We're getting selection request events, but we don't have
4051 #if defined (HAVE_NS)
4052 else if (event
->kind
== NS_TEXT_EVENT
)
4054 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4055 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4057 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4058 kbd_fetch_ptr
= event
+ 1;
4059 if (used_mouse_menu
)
4060 *used_mouse_menu
= 1;
4064 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4065 || defined (HAVE_NS)
4066 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4068 /* Make an event (delete-frame (FRAME)). */
4069 obj
= Fcons (event
->frame_or_window
, Qnil
);
4070 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4071 kbd_fetch_ptr
= event
+ 1;
4074 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4075 || defined (HAVE_NS)
4076 else if (event
->kind
== ICONIFY_EVENT
)
4078 /* Make an event (iconify-frame (FRAME)). */
4079 obj
= Fcons (event
->frame_or_window
, Qnil
);
4080 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4081 kbd_fetch_ptr
= event
+ 1;
4083 else if (event
->kind
== DEICONIFY_EVENT
)
4085 /* Make an event (make-frame-visible (FRAME)). */
4086 obj
= Fcons (event
->frame_or_window
, Qnil
);
4087 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4088 kbd_fetch_ptr
= event
+ 1;
4091 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4093 /* The value doesn't matter here; only the type is tested. */
4094 XSETBUFFER (obj
, current_buffer
);
4095 kbd_fetch_ptr
= event
+ 1;
4097 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4098 || defined(HAVE_NS) || defined (USE_GTK)
4099 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4101 kbd_fetch_ptr
= event
+ 1;
4102 input_pending
= readable_events (0);
4103 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4104 x_activate_menubar (XFRAME (event
->frame_or_window
));
4107 #if defined (WINDOWSNT)
4108 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4110 /* Make an event (language-change (FRAME CHARSET LCID)). */
4111 obj
= Fcons (event
->frame_or_window
, Qnil
);
4112 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4113 kbd_fetch_ptr
= event
+ 1;
4116 else if (event
->kind
== SAVE_SESSION_EVENT
)
4118 obj
= Fcons (Qsave_session
, Qnil
);
4119 kbd_fetch_ptr
= event
+ 1;
4121 /* Just discard these, by returning nil.
4122 With MULTI_KBOARD, these events are used as placeholders
4123 when we need to randomly delete events from the queue.
4124 (They shouldn't otherwise be found in the buffer,
4125 but on some machines it appears they do show up
4126 even without MULTI_KBOARD.) */
4127 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4128 mouse events during a popup-menu call. */
4129 else if (event
->kind
== NO_EVENT
)
4130 kbd_fetch_ptr
= event
+ 1;
4131 else if (event
->kind
== HELP_EVENT
)
4133 Lisp_Object object
, position
, help
, frame
, window
;
4135 frame
= event
->frame_or_window
;
4136 object
= event
->arg
;
4137 position
= make_number (event
->code
);
4140 clear_event (event
);
4142 kbd_fetch_ptr
= event
+ 1;
4143 if (!WINDOWP (window
))
4145 obj
= Fcons (Qhelp_echo
,
4146 list5 (frame
, help
, window
, object
, position
));
4148 else if (event
->kind
== FOCUS_IN_EVENT
)
4150 /* Notification of a FocusIn event. The frame receiving the
4151 focus is in event->frame_or_window. Generate a
4152 switch-frame event if necessary. */
4153 Lisp_Object frame
, focus
;
4155 frame
= event
->frame_or_window
;
4156 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4160 if (!EQ (frame
, internal_last_event_frame
)
4161 && !EQ (frame
, selected_frame
))
4162 obj
= make_lispy_switch_frame (frame
);
4163 internal_last_event_frame
= frame
;
4164 kbd_fetch_ptr
= event
+ 1;
4167 else if (event
->kind
== DBUS_EVENT
)
4169 obj
= make_lispy_event (event
);
4170 kbd_fetch_ptr
= event
+ 1;
4173 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4175 obj
= make_lispy_event (event
);
4176 kbd_fetch_ptr
= event
+ 1;
4180 /* If this event is on a different frame, return a switch-frame this
4181 time, and leave the event in the queue for next time. */
4185 frame
= event
->frame_or_window
;
4187 frame
= XCAR (frame
);
4188 else if (WINDOWP (frame
))
4189 frame
= WINDOW_FRAME (XWINDOW (frame
));
4191 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4195 if (! EQ (frame
, internal_last_event_frame
)
4196 && !EQ (frame
, selected_frame
))
4197 obj
= make_lispy_switch_frame (frame
);
4198 internal_last_event_frame
= frame
;
4200 /* If we didn't decide to make a switch-frame event, go ahead
4201 and build a real event from the queue entry. */
4205 obj
= make_lispy_event (event
);
4207 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4208 || defined(HAVE_NS) || defined (USE_GTK)
4209 /* If this was a menu selection, then set the flag to inhibit
4210 writing to last_nonmenu_event. Don't do this if the event
4211 we're returning is (menu-bar), though; that indicates the
4212 beginning of the menu sequence, and we might as well leave
4213 that as the `event with parameters' for this selection. */
4215 && !EQ (event
->frame_or_window
, event
->arg
)
4216 && (event
->kind
== MENU_BAR_EVENT
4217 || event
->kind
== TOOL_BAR_EVENT
))
4218 *used_mouse_menu
= 1;
4221 /* certain system events are non-key events */
4223 && event
->kind
== NS_NONKEY_EVENT
)
4224 *used_mouse_menu
= 1;
4227 /* Wipe out this event, to catch bugs. */
4228 clear_event (event
);
4229 kbd_fetch_ptr
= event
+ 1;
4233 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4234 /* Try generating a mouse motion event. */
4235 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4237 FRAME_PTR f
= some_mouse_moved ();
4238 Lisp_Object bar_window
;
4239 enum scroll_bar_part part
;
4243 *kbp
= current_kboard
;
4244 /* Note that this uses F to determine which terminal to look at.
4245 If there is no valid info, it does not store anything
4246 so x remains nil. */
4249 /* XXX Can f or mouse_position_hook be NULL here? */
4250 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4251 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4252 &part
, &x
, &y
, &time
);
4256 /* Decide if we should generate a switch-frame event. Don't
4257 generate switch-frame events for motion outside of all Emacs
4263 frame
= FRAME_FOCUS_FRAME (f
);
4265 XSETFRAME (frame
, f
);
4267 if (! EQ (frame
, internal_last_event_frame
)
4268 && !EQ (frame
, selected_frame
))
4269 obj
= make_lispy_switch_frame (frame
);
4270 internal_last_event_frame
= frame
;
4273 /* If we didn't decide to make a switch-frame event, go ahead and
4274 return a mouse-motion event. */
4275 if (!NILP (x
) && NILP (obj
))
4276 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4278 #endif /* HAVE_MOUSE || HAVE GPM */
4280 /* We were promised by the above while loop that there was
4281 something for us to read! */
4284 input_pending
= readable_events (0);
4286 Vlast_event_frame
= internal_last_event_frame
;
4291 /* Process any events that are not user-visible,
4292 then return, without reading any user-visible events. */
4295 swallow_events (int do_display
)
4299 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4301 struct input_event
*event
;
4303 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4307 last_event_timestamp
= event
->timestamp
;
4309 /* These two kinds of events get special handling
4310 and don't actually appear to the command loop. */
4311 if (event
->kind
== SELECTION_REQUEST_EVENT
4312 || event
->kind
== SELECTION_CLEAR_EVENT
)
4315 struct input_event copy
;
4317 /* Remove it from the buffer before processing it,
4318 since otherwise swallow_events called recursively could see it
4319 and process it again. */
4321 kbd_fetch_ptr
= event
+ 1;
4322 input_pending
= readable_events (0);
4323 x_handle_selection_event (©
);
4325 /* We're getting selection request events, but we don't have
4334 old_timers_run
= timers_run
;
4335 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4337 if (timers_run
!= old_timers_run
&& do_display
)
4338 redisplay_preserve_echo_area (7);
4341 /* Record the start of when Emacs is idle,
4342 for the sake of running idle-time timers. */
4345 timer_start_idle (void)
4349 /* If we are already in the idle state, do nothing. */
4350 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4353 EMACS_GET_TIME (timer_idleness_start_time
);
4355 timer_last_idleness_start_time
= timer_idleness_start_time
;
4357 /* Mark all idle-time timers as once again candidates for running. */
4358 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4362 timer
= XCAR (timers
);
4364 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4366 XVECTOR (timer
)->contents
[0] = Qnil
;
4370 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4373 timer_stop_idle (void)
4375 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4378 /* Resume idle timer from last idle start time. */
4381 timer_resume_idle (void)
4383 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4386 timer_idleness_start_time
= timer_last_idleness_start_time
;
4389 /* This is only for debugging. */
4390 struct input_event last_timer_event
;
4392 /* List of elisp functions to call, delayed because they were generated in
4393 a context where Elisp could not be safely run (e.g. redisplay, signal,
4394 ...). Each element has the form (FUN . ARGS). */
4395 Lisp_Object pending_funcalls
;
4397 /* Check whether a timer has fired. To prevent larger problems we simply
4398 disregard elements that are not proper timers. Do not make a circular
4399 timer list for the time being.
4401 Returns the time to wait until the next timer fires. If a
4402 timer is triggering now, return zero.
4403 If no timer is active, return -1.
4405 If a timer is ripe, we run it, with quitting turned off.
4406 In that case we return 0 to indicate that a new timer_check_2 call
4410 timer_check_2 (void)
4412 EMACS_TIME nexttime
;
4413 EMACS_TIME now
, idleness_now
;
4414 Lisp_Object timers
, idle_timers
, chosen_timer
;
4415 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4417 EMACS_SET_SECS (nexttime
, -1);
4418 EMACS_SET_USECS (nexttime
, -1);
4420 /* Always consider the ordinary timers. */
4421 timers
= Vtimer_list
;
4422 /* Consider the idle timers only if Emacs is idle. */
4423 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4424 idle_timers
= Vtimer_idle_list
;
4427 chosen_timer
= Qnil
;
4428 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4430 /* First run the code that was delayed. */
4431 while (CONSP (pending_funcalls
))
4433 Lisp_Object funcall
= XCAR (pending_funcalls
);
4434 pending_funcalls
= XCDR (pending_funcalls
);
4435 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4438 if (CONSP (timers
) || CONSP (idle_timers
))
4440 EMACS_GET_TIME (now
);
4441 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4442 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4445 while (CONSP (timers
) || CONSP (idle_timers
))
4447 Lisp_Object
*vector
;
4448 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4449 EMACS_TIME timer_time
, idle_timer_time
;
4450 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4452 /* Skip past invalid timers and timers already handled. */
4455 timer
= XCAR (timers
);
4456 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4458 timers
= XCDR (timers
);
4461 vector
= XVECTOR (timer
)->contents
;
4463 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4464 || !INTEGERP (vector
[3])
4465 || ! NILP (vector
[0]))
4467 timers
= XCDR (timers
);
4471 if (!NILP (idle_timers
))
4473 timer
= XCAR (idle_timers
);
4474 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4476 idle_timers
= XCDR (idle_timers
);
4479 vector
= XVECTOR (timer
)->contents
;
4481 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4482 || !INTEGERP (vector
[3])
4483 || ! NILP (vector
[0]))
4485 idle_timers
= XCDR (idle_timers
);
4490 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4491 based on the next ordinary timer.
4492 TIMER_DIFFERENCE is the distance in time from NOW to when
4493 this timer becomes ripe (negative if it's already ripe). */
4496 timer
= XCAR (timers
);
4497 vector
= XVECTOR (timer
)->contents
;
4498 EMACS_SET_SECS (timer_time
,
4499 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4500 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4501 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4504 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4505 based on the next idle timer. */
4506 if (!NILP (idle_timers
))
4508 idle_timer
= XCAR (idle_timers
);
4509 vector
= XVECTOR (idle_timer
)->contents
;
4510 EMACS_SET_SECS (idle_timer_time
,
4511 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4512 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4513 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4516 /* Decide which timer is the next timer,
4517 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4518 Also step down the list where we found that timer. */
4520 if (! NILP (timers
) && ! NILP (idle_timers
))
4523 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4524 if (EMACS_TIME_NEG_P (temp
))
4526 chosen_timer
= timer
;
4527 timers
= XCDR (timers
);
4528 difference
= timer_difference
;
4532 chosen_timer
= idle_timer
;
4533 idle_timers
= XCDR (idle_timers
);
4534 difference
= idle_timer_difference
;
4537 else if (! NILP (timers
))
4539 chosen_timer
= timer
;
4540 timers
= XCDR (timers
);
4541 difference
= timer_difference
;
4545 chosen_timer
= idle_timer
;
4546 idle_timers
= XCDR (idle_timers
);
4547 difference
= idle_timer_difference
;
4549 vector
= XVECTOR (chosen_timer
)->contents
;
4551 /* If timer is ripe, run it if it hasn't been run. */
4552 if (EMACS_TIME_NEG_P (difference
)
4553 || (EMACS_SECS (difference
) == 0
4554 && EMACS_USECS (difference
) == 0))
4556 if (NILP (vector
[0]))
4558 int count
= SPECPDL_INDEX ();
4559 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4561 /* Mark the timer as triggered to prevent problems if the lisp
4562 code fails to reschedule it right. */
4565 specbind (Qinhibit_quit
, Qt
);
4567 call1 (Qtimer_event_handler
, chosen_timer
);
4568 Vdeactivate_mark
= old_deactivate_mark
;
4570 unbind_to (count
, Qnil
);
4572 /* Since we have handled the event,
4573 we don't need to tell the caller to wake up and do it. */
4574 /* But the caller must still wait for the next timer, so
4575 return 0 to indicate that. */
4578 EMACS_SET_SECS (nexttime
, 0);
4579 EMACS_SET_USECS (nexttime
, 0);
4582 /* When we encounter a timer that is still waiting,
4583 return the amount of time to wait before it is ripe. */
4590 /* No timers are pending in the future. */
4591 /* Return 0 if we generated an event, and -1 if not. */
4597 /* Check whether a timer has fired. To prevent larger problems we simply
4598 disregard elements that are not proper timers. Do not make a circular
4599 timer list for the time being.
4601 Returns the time to wait until the next timer fires.
4602 If no timer is active, return -1.
4604 As long as any timer is ripe, we run it.
4606 DO_IT_NOW is now ignored. It used to mean that we should
4607 run the timer directly instead of queueing a timer-event.
4608 Now we always run timers directly. */
4611 timer_check (int do_it_now
)
4613 EMACS_TIME nexttime
;
4617 nexttime
= timer_check_2 ();
4619 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4624 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4625 doc
: /* Return the current length of Emacs idleness, or nil.
4626 The value when Emacs is idle is a list of three integers. The first has
4627 the most significant 16 bits of the seconds, while the second has the least
4628 significant 16 bits. The third integer gives the microsecond count.
4630 The value when Emacs is not idle is nil.
4632 The microsecond count is zero on systems that do not provide
4633 resolution finer than a second. */)
4636 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4638 EMACS_TIME now
, idleness_now
;
4640 EMACS_GET_TIME (now
);
4641 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4643 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4644 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4645 make_number (EMACS_USECS (idleness_now
)));
4651 /* Caches for modify_event_symbol. */
4652 static Lisp_Object accent_key_syms
;
4653 static Lisp_Object func_key_syms
;
4654 static Lisp_Object mouse_syms
;
4655 static Lisp_Object wheel_syms
;
4656 static Lisp_Object drag_n_drop_syms
;
4658 /* This is a list of keysym codes for special "accent" characters.
4659 It parallels lispy_accent_keys. */
4661 static const int lispy_accent_codes
[] =
4663 #ifdef XK_dead_circumflex
4668 #ifdef XK_dead_grave
4673 #ifdef XK_dead_tilde
4678 #ifdef XK_dead_diaeresis
4683 #ifdef XK_dead_macron
4688 #ifdef XK_dead_degree
4693 #ifdef XK_dead_acute
4698 #ifdef XK_dead_cedilla
4703 #ifdef XK_dead_breve
4708 #ifdef XK_dead_ogonek
4713 #ifdef XK_dead_caron
4718 #ifdef XK_dead_doubleacute
4719 XK_dead_doubleacute
,
4723 #ifdef XK_dead_abovedot
4728 #ifdef XK_dead_abovering
4738 #ifdef XK_dead_belowdot
4743 #ifdef XK_dead_voiced_sound
4744 XK_dead_voiced_sound
,
4748 #ifdef XK_dead_semivoiced_sound
4749 XK_dead_semivoiced_sound
,
4765 /* This is a list of Lisp names for special "accent" characters.
4766 It parallels lispy_accent_codes. */
4768 static const char *lispy_accent_keys
[] =
4786 "dead-voiced-sound",
4787 "dead-semivoiced-sound",
4793 #define FUNCTION_KEY_OFFSET 0x0
4795 char const *lispy_function_keys
[] =
4799 0, /* VK_LBUTTON 0x01 */
4800 0, /* VK_RBUTTON 0x02 */
4801 "cancel", /* VK_CANCEL 0x03 */
4802 0, /* VK_MBUTTON 0x04 */
4804 0, 0, 0, /* 0x05 .. 0x07 */
4806 "backspace", /* VK_BACK 0x08 */
4807 "tab", /* VK_TAB 0x09 */
4809 0, 0, /* 0x0A .. 0x0B */
4811 "clear", /* VK_CLEAR 0x0C */
4812 "return", /* VK_RETURN 0x0D */
4814 0, 0, /* 0x0E .. 0x0F */
4816 0, /* VK_SHIFT 0x10 */
4817 0, /* VK_CONTROL 0x11 */
4818 0, /* VK_MENU 0x12 */
4819 "pause", /* VK_PAUSE 0x13 */
4820 "capslock", /* VK_CAPITAL 0x14 */
4821 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4823 "junja", /* VK_JUNJA 0x17 */
4824 "final", /* VK_FINAL 0x18 */
4825 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4827 "escape", /* VK_ESCAPE 0x1B */
4828 "convert", /* VK_CONVERT 0x1C */
4829 "non-convert", /* VK_NONCONVERT 0x1D */
4830 "accept", /* VK_ACCEPT 0x1E */
4831 "mode-change", /* VK_MODECHANGE 0x1F */
4832 0, /* VK_SPACE 0x20 */
4833 "prior", /* VK_PRIOR 0x21 */
4834 "next", /* VK_NEXT 0x22 */
4835 "end", /* VK_END 0x23 */
4836 "home", /* VK_HOME 0x24 */
4837 "left", /* VK_LEFT 0x25 */
4838 "up", /* VK_UP 0x26 */
4839 "right", /* VK_RIGHT 0x27 */
4840 "down", /* VK_DOWN 0x28 */
4841 "select", /* VK_SELECT 0x29 */
4842 "print", /* VK_PRINT 0x2A */
4843 "execute", /* VK_EXECUTE 0x2B */
4844 "snapshot", /* VK_SNAPSHOT 0x2C */
4845 "insert", /* VK_INSERT 0x2D */
4846 "delete", /* VK_DELETE 0x2E */
4847 "help", /* VK_HELP 0x2F */
4849 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4851 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4853 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4855 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4857 0, 0, 0, 0, 0, 0, 0, 0, 0,
4858 0, 0, 0, 0, 0, 0, 0, 0, 0,
4859 0, 0, 0, 0, 0, 0, 0, 0,
4861 "lwindow", /* VK_LWIN 0x5B */
4862 "rwindow", /* VK_RWIN 0x5C */
4863 "apps", /* VK_APPS 0x5D */
4866 "kp-0", /* VK_NUMPAD0 0x60 */
4867 "kp-1", /* VK_NUMPAD1 0x61 */
4868 "kp-2", /* VK_NUMPAD2 0x62 */
4869 "kp-3", /* VK_NUMPAD3 0x63 */
4870 "kp-4", /* VK_NUMPAD4 0x64 */
4871 "kp-5", /* VK_NUMPAD5 0x65 */
4872 "kp-6", /* VK_NUMPAD6 0x66 */
4873 "kp-7", /* VK_NUMPAD7 0x67 */
4874 "kp-8", /* VK_NUMPAD8 0x68 */
4875 "kp-9", /* VK_NUMPAD9 0x69 */
4876 "kp-multiply", /* VK_MULTIPLY 0x6A */
4877 "kp-add", /* VK_ADD 0x6B */
4878 "kp-separator", /* VK_SEPARATOR 0x6C */
4879 "kp-subtract", /* VK_SUBTRACT 0x6D */
4880 "kp-decimal", /* VK_DECIMAL 0x6E */
4881 "kp-divide", /* VK_DIVIDE 0x6F */
4882 "f1", /* VK_F1 0x70 */
4883 "f2", /* VK_F2 0x71 */
4884 "f3", /* VK_F3 0x72 */
4885 "f4", /* VK_F4 0x73 */
4886 "f5", /* VK_F5 0x74 */
4887 "f6", /* VK_F6 0x75 */
4888 "f7", /* VK_F7 0x76 */
4889 "f8", /* VK_F8 0x77 */
4890 "f9", /* VK_F9 0x78 */
4891 "f10", /* VK_F10 0x79 */
4892 "f11", /* VK_F11 0x7A */
4893 "f12", /* VK_F12 0x7B */
4894 "f13", /* VK_F13 0x7C */
4895 "f14", /* VK_F14 0x7D */
4896 "f15", /* VK_F15 0x7E */
4897 "f16", /* VK_F16 0x7F */
4898 "f17", /* VK_F17 0x80 */
4899 "f18", /* VK_F18 0x81 */
4900 "f19", /* VK_F19 0x82 */
4901 "f20", /* VK_F20 0x83 */
4902 "f21", /* VK_F21 0x84 */
4903 "f22", /* VK_F22 0x85 */
4904 "f23", /* VK_F23 0x86 */
4905 "f24", /* VK_F24 0x87 */
4907 0, 0, 0, 0, /* 0x88 .. 0x8B */
4908 0, 0, 0, 0, /* 0x8C .. 0x8F */
4910 "kp-numlock", /* VK_NUMLOCK 0x90 */
4911 "scroll", /* VK_SCROLL 0x91 */
4912 /* Not sure where the following block comes from.
4913 Windows headers have NEC and Fujitsu specific keys in
4914 this block, but nothing generic. */
4915 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4916 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4917 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4918 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4919 "kp-end", /* VK_NUMPAD_END 0x96 */
4920 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4921 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4922 "kp-up", /* VK_NUMPAD_UP 0x99 */
4923 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4924 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4925 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4926 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4928 0, 0, /* 0x9E .. 0x9F */
4931 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4932 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4933 * No other API or message will distinguish left and right keys this way.
4938 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4939 to enable them selectively, and gives access to a few more functions.
4940 See lispy_multimedia_keys below. */
4941 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4942 0, 0, 0, /* 0xAD .. 0xAF Volume */
4943 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4944 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4946 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4947 0, 0, 0, 0, 0, 0, 0, 0, 0,
4949 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4950 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4951 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4954 "ax", /* VK_OEM_AX 0xE1 */
4955 0, /* VK_OEM_102 0xE2 */
4956 "ico-help", /* VK_ICO_HELP 0xE3 */
4957 "ico-00", /* VK_ICO_00 0xE4 */
4958 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4959 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4960 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4962 "reset", /* VK_OEM_RESET 0xE9 */
4963 "jump", /* VK_OEM_JUMP 0xEA */
4964 "oem-pa1", /* VK_OEM_PA1 0xEB */
4965 "oem-pa2", /* VK_OEM_PA2 0xEC */
4966 "oem-pa3", /* VK_OEM_PA3 0xED */
4967 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4968 "cusel", /* VK_OEM_CUSEL 0xEF */
4969 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4970 "finish", /* VK_OEM_FINISH 0xF1 */
4971 "copy", /* VK_OEM_COPY 0xF2 */
4972 "auto", /* VK_OEM_AUTO 0xF3 */
4973 "enlw", /* VK_OEM_ENLW 0xF4 */
4974 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4975 "attn", /* VK_ATTN 0xF6 */
4976 "crsel", /* VK_CRSEL 0xF7 */
4977 "exsel", /* VK_EXSEL 0xF8 */
4978 "ereof", /* VK_EREOF 0xF9 */
4979 "play", /* VK_PLAY 0xFA */
4980 "zoom", /* VK_ZOOM 0xFB */
4981 "noname", /* VK_NONAME 0xFC */
4982 "pa1", /* VK_PA1 0xFD */
4983 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4987 /* Some of these duplicate the "Media keys" on newer keyboards,
4988 but they are delivered to the application in a different way. */
4989 static const char *lispy_multimedia_keys
[] =
4997 "browser-favorites",
5034 "toggle-dictate-command",
5040 "media-fast-forward",
5043 "media-channel-down"
5046 #else /* not HAVE_NTGUI */
5048 /* This should be dealt with in XTread_socket now, and that doesn't
5049 depend on the client system having the Kana syms defined. See also
5050 the XK_kana_A case below. */
5053 static const char *lispy_kana_keys
[] =
5055 /* X Keysym value */
5056 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5057 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5058 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5059 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5060 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5061 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5062 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5063 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5064 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5065 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5066 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5067 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5068 "kana-i", "kana-u", "kana-e", "kana-o",
5069 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5070 "prolongedsound", "kana-A", "kana-I", "kana-U",
5071 "kana-E", "kana-O", "kana-KA", "kana-KI",
5072 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5073 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5074 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5075 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5076 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5077 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5078 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5079 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5080 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5081 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5082 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5083 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5085 #endif /* XK_kana_A */
5088 #define FUNCTION_KEY_OFFSET 0xff00
5090 /* You'll notice that this table is arranged to be conveniently
5091 indexed by X Windows keysym values. */
5092 static const char *lispy_function_keys
[] =
5094 /* X Keysym value */
5096 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5097 "backspace", "tab", "linefeed", "clear",
5099 0, 0, 0, "pause", /* 0xff10...1f */
5100 0, 0, 0, 0, 0, 0, 0, "escape",
5102 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5103 "romaji", "hiragana", "katakana", "hiragana-katakana",
5104 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5105 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5106 "eisu-toggle", /* 0xff30...3f */
5107 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5108 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5110 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5111 "down", "prior", "next", "end",
5112 "begin", 0, 0, 0, 0, 0, 0, 0,
5113 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5124 "break", /* 0xff6b */
5127 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5128 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5129 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5130 0, 0, 0, 0, 0, 0, 0, 0,
5131 "kp-tab", /* 0xff89 */
5133 "kp-enter", /* 0xff8d */
5135 "kp-f1", /* 0xff91 */
5139 "kp-home", /* 0xff95 */
5144 "kp-prior", /* kp-page-up */
5145 "kp-next", /* kp-page-down */
5151 0, 0, 0, 0, 0, 0, 0, 0, 0,
5152 "kp-multiply", /* 0xffaa */
5157 "kp-divide", /* 0xffaf */
5158 "kp-0", /* 0xffb0 */
5159 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5162 "kp-equal", /* 0xffbd */
5163 "f1", /* 0xffbe */ /* IsFunctionKey */
5165 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5166 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5167 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5168 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5169 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5170 0, 0, 0, 0, 0, 0, 0, 0,
5171 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5172 0, 0, 0, 0, 0, 0, 0, "delete"
5175 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5176 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5178 static const char *iso_lispy_function_keys
[] =
5180 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5181 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5182 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5183 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5184 "iso-lefttab", /* 0xfe20 */
5185 "iso-move-line-up", "iso-move-line-down",
5186 "iso-partial-line-up", "iso-partial-line-down",
5187 "iso-partial-space-left", "iso-partial-space-right",
5188 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5189 "iso-release-margin-left", "iso-release-margin-right",
5190 "iso-release-both-margins",
5191 "iso-fast-cursor-left", "iso-fast-cursor-right",
5192 "iso-fast-cursor-up", "iso-fast-cursor-down",
5193 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5194 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5197 #endif /* not HAVE_NTGUI */
5199 Lisp_Object Vlispy_mouse_stem
;
5201 static const char *lispy_wheel_names
[] =
5203 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5206 /* drag-n-drop events are generated when a set of selected files are
5207 dragged from another application and dropped onto an Emacs window. */
5208 static const char *lispy_drag_n_drop_names
[] =
5213 /* Scroll bar parts. */
5214 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5215 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5216 Lisp_Object Qtop
, Qratio
;
5218 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5219 const Lisp_Object
*scroll_bar_parts
[] = {
5220 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5221 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5224 /* A vector, indexed by button number, giving the down-going location
5225 of currently depressed buttons, both scroll bar and non-scroll bar.
5227 The elements have the form
5228 (BUTTON-NUMBER MODIFIER-MASK . REST)
5229 where REST is the cdr of a position as it would be reported in the event.
5231 The make_lispy_event function stores positions here to tell the
5232 difference between click and drag events, and to store the starting
5233 location to be included in drag events. */
5235 static Lisp_Object button_down_location
;
5237 /* Information about the most recent up-going button event: Which
5238 button, what location, and what time. */
5240 static int last_mouse_button
;
5241 static int last_mouse_x
;
5242 static int last_mouse_y
;
5243 static unsigned long button_down_time
;
5245 /* The maximum time between clicks to make a double-click, or Qnil to
5246 disable double-click detection, or Qt for no time limit. */
5248 Lisp_Object Vdouble_click_time
;
5250 /* Maximum number of pixels the mouse may be moved between clicks
5251 to make a double-click. */
5253 EMACS_INT double_click_fuzz
;
5255 /* The number of clicks in this multiple-click. */
5257 int double_click_count
;
5259 /* Return position of a mouse click or wheel event */
5262 make_lispy_position (struct frame
*f
, Lisp_Object
*x
, Lisp_Object
*y
,
5266 enum window_part part
;
5267 Lisp_Object posn
= Qnil
;
5268 Lisp_Object extra_info
= Qnil
;
5271 /* Set `window' to the window under frame pixel coordinates (x,y) */
5273 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5274 &part
, &wx
, &wy
, 0);
5278 if (WINDOWP (window
))
5280 /* It's a click in window window at frame coordinates (x,y) */
5281 struct window
*w
= XWINDOW (window
);
5282 Lisp_Object string_info
= Qnil
;
5283 EMACS_INT textpos
= -1;
5284 int rx
= -1, ry
= -1;
5285 int dx
= -1, dy
= -1;
5286 int width
= -1, height
= -1;
5287 Lisp_Object object
= Qnil
;
5289 /* Set event coordinates to window-relative coordinates
5290 for constructing the Lisp event below. */
5294 if (part
== ON_TEXT
)
5296 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5298 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5300 /* Mode line or header line. Look for a string under
5301 the mouse that may have a `local-map' property. */
5305 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5307 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5308 &object
, &dx
, &dy
, &width
, &height
);
5309 if (STRINGP (string
))
5310 string_info
= Fcons (string
, make_number (charpos
));
5311 if (w
== XWINDOW (selected_window
)
5312 && current_buffer
== XBUFFER (w
->buffer
))
5315 textpos
= XMARKER (w
->pointm
)->charpos
;
5317 else if (part
== ON_VERTICAL_BORDER
)
5319 posn
= Qvertical_line
;
5324 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5329 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5331 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5332 &object
, &dx
, &dy
, &width
, &height
);
5333 if (STRINGP (string
))
5334 string_info
= Fcons (string
, make_number (charpos
));
5335 if (part
== ON_LEFT_MARGIN
)
5338 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5340 else if (part
== ON_LEFT_FRINGE
)
5342 posn
= Qleft_fringe
;
5345 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5347 : window_box_width (w
, LEFT_MARGIN_AREA
));
5350 else if (part
== ON_RIGHT_FRINGE
)
5352 posn
= Qright_fringe
;
5355 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5356 + window_box_width (w
, TEXT_AREA
)
5357 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5358 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5364 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5365 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5370 Lisp_Object string2
, object2
= Qnil
;
5371 struct display_pos p
;
5373 int width2
, height2
;
5374 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5375 &object2
, &dx2
, &dy2
,
5377 textpos
= CHARPOS (p
.pos
);
5378 if (rx
< 0) rx
= wx
;
5379 if (ry
< 0) ry
= wy
;
5380 if (dx
< 0) dx
= dx2
;
5381 if (dy
< 0) dy
= dy2
;
5382 if (width
< 0) width
= width2
;
5383 if (height
< 0) height
= height2
;
5387 posn
= make_number (textpos
);
5388 if (STRINGP (string2
))
5389 string_info
= Fcons (string2
,
5390 make_number (CHARPOS (p
.string_pos
)));
5396 #ifdef HAVE_WINDOW_SYSTEM
5397 if (IMAGEP (object
))
5399 Lisp_Object image_map
, hotspot
;
5400 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5402 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5404 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5405 posn
= XCAR (hotspot
);
5410 extra_info
= Fcons (object
,
5411 Fcons (Fcons (make_number (dx
),
5413 Fcons (Fcons (make_number (width
),
5414 make_number (height
)),
5418 extra_info
= Fcons (string_info
,
5419 Fcons (make_number (textpos
),
5420 Fcons (Fcons (make_number (rx
),
5426 XSETFRAME (window
, f
);
5431 XSETFASTINT (*x
, 0);
5432 XSETFASTINT (*y
, 0);
5435 return Fcons (window
,
5437 Fcons (Fcons (*x
, *y
),
5438 Fcons (make_number (time
),
5442 /* Given a struct input_event, build the lisp event which represents
5443 it. If EVENT is 0, build a mouse movement event from the mouse
5444 movement buffer, which should have a movement event in it.
5446 Note that events must be passed to this function in the order they
5447 are received; this function stores the location of button presses
5448 in order to build drag events when the button is released. */
5451 make_lispy_event (struct input_event
*event
)
5455 switch (SWITCH_ENUM_CAST (event
->kind
))
5457 /* A simple keystroke. */
5458 case ASCII_KEYSTROKE_EVENT
:
5459 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5461 Lisp_Object lispy_c
;
5462 EMACS_INT c
= event
->code
;
5463 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5466 eassert (c
== event
->code
);
5467 /* Turn ASCII characters into control characters
5469 if (event
->modifiers
& ctrl_modifier
)
5471 c
= make_ctrl_char (c
);
5472 event
->modifiers
&= ~ctrl_modifier
;
5476 /* Add in the other modifier bits. The shift key was taken care
5477 of by the X code. */
5478 c
|= (event
->modifiers
5479 & (meta_modifier
| alt_modifier
5480 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5481 /* Distinguish Shift-SPC from SPC. */
5482 if ((event
->code
) == 040
5483 && event
->modifiers
& shift_modifier
)
5484 c
|= shift_modifier
;
5485 button_down_time
= 0;
5486 XSETFASTINT (lispy_c
, c
);
5491 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5492 except that they are non-key events (last-nonmenu-event is nil). */
5493 case NS_NONKEY_EVENT
:
5496 /* A function key. The symbol may need to have modifier prefixes
5498 case NON_ASCII_KEYSTROKE_EVENT
:
5499 button_down_time
= 0;
5501 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5502 if (event
->code
== lispy_accent_codes
[i
])
5503 return modify_event_symbol (i
,
5505 Qfunction_key
, Qnil
,
5506 lispy_accent_keys
, &accent_key_syms
,
5507 (sizeof (lispy_accent_keys
)
5508 / sizeof (lispy_accent_keys
[0])));
5512 if (event
->code
>= 0x400 && event
->code
< 0x500)
5513 return modify_event_symbol (event
->code
- 0x400,
5514 event
->modifiers
& ~shift_modifier
,
5515 Qfunction_key
, Qnil
,
5516 lispy_kana_keys
, &func_key_syms
,
5517 (sizeof (lispy_kana_keys
)
5518 / sizeof (lispy_kana_keys
[0])));
5519 #endif /* XK_kana_A */
5522 #ifdef ISO_FUNCTION_KEY_OFFSET
5523 if (event
->code
< FUNCTION_KEY_OFFSET
5524 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5525 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5527 Qfunction_key
, Qnil
,
5528 iso_lispy_function_keys
, &func_key_syms
,
5529 (sizeof (iso_lispy_function_keys
)
5530 / sizeof (iso_lispy_function_keys
[0])));
5533 /* Handle system-specific or unknown keysyms. */
5534 if (event
->code
& (1 << 28)
5535 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5536 || (event
->code
- FUNCTION_KEY_OFFSET
5537 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5538 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5540 /* We need to use an alist rather than a vector as the cache
5541 since we can't make a vector long enuf. */
5542 if (NILP (current_kboard
->system_key_syms
))
5543 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5544 return modify_event_symbol (event
->code
,
5547 current_kboard
->Vsystem_key_alist
,
5548 0, ¤t_kboard
->system_key_syms
,
5552 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5554 Qfunction_key
, Qnil
,
5555 lispy_function_keys
, &func_key_syms
,
5556 (sizeof (lispy_function_keys
)
5557 / sizeof (lispy_function_keys
[0])));
5560 case MULTIMEDIA_KEY_EVENT
:
5561 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5562 / sizeof (lispy_multimedia_keys
[0]))
5563 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5565 return modify_event_symbol (event
->code
, event
->modifiers
,
5566 Qfunction_key
, Qnil
,
5567 lispy_multimedia_keys
, &func_key_syms
,
5568 (sizeof (lispy_multimedia_keys
)
5569 / sizeof (lispy_multimedia_keys
[0])));
5575 /* A mouse click. Figure out where it is, decide whether it's
5576 a press, click or drag, and build the appropriate structure. */
5577 case MOUSE_CLICK_EVENT
:
5578 #ifndef USE_TOOLKIT_SCROLL_BARS
5579 case SCROLL_BAR_CLICK_EVENT
:
5582 int button
= event
->code
;
5584 Lisp_Object position
;
5585 Lisp_Object
*start_pos_ptr
;
5586 Lisp_Object start_pos
;
5590 /* Build the position as appropriate for this mouse click. */
5591 if (event
->kind
== MOUSE_CLICK_EVENT
)
5593 struct frame
*f
= XFRAME (event
->frame_or_window
);
5594 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5598 /* Ignore mouse events that were made on frame that
5599 have been deleted. */
5600 if (! FRAME_LIVE_P (f
))
5603 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5604 /* EVENT->x and EVENT->y are frame-relative pixel
5605 coordinates at this place. Under old redisplay, COLUMN
5606 and ROW are set to frame relative glyph coordinates
5607 which are then used to determine whether this click is
5608 in a menu (non-toolkit version). */
5609 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5610 &column
, &row
, NULL
, 1);
5612 /* In the non-toolkit version, clicks on the menu bar
5613 are ordinary button events in the event buffer.
5614 Distinguish them, and invoke the menu.
5616 (In the toolkit version, the toolkit handles the menu bar
5617 and Emacs doesn't know about it until after the user
5618 makes a selection.) */
5619 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5620 && (event
->modifiers
& down_modifier
))
5622 Lisp_Object items
, item
;
5627 /* Activate the menu bar on the down event. If the
5628 up event comes in before the menu code can deal with it,
5630 if (! (event
->modifiers
& down_modifier
))
5634 /* Find the menu bar item under `column'. */
5636 items
= FRAME_MENU_BAR_ITEMS (f
);
5637 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5639 Lisp_Object pos
, string
;
5640 string
= AREF (items
, i
+ 1);
5641 pos
= AREF (items
, i
+ 3);
5644 if (column
>= XINT (pos
)
5645 && column
< XINT (pos
) + SCHARS (string
))
5647 item
= AREF (items
, i
);
5652 /* ELisp manual 2.4b says (x y) are window relative but
5653 code says they are frame-relative. */
5655 = Fcons (event
->frame_or_window
,
5657 Fcons (Fcons (event
->x
, event
->y
),
5658 Fcons (make_number (event
->timestamp
),
5661 return Fcons (item
, Fcons (position
, Qnil
));
5663 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5665 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5668 #ifndef USE_TOOLKIT_SCROLL_BARS
5671 /* It's a scrollbar click. */
5673 Lisp_Object portion_whole
;
5676 window
= event
->frame_or_window
;
5677 portion_whole
= Fcons (event
->x
, event
->y
);
5678 part
= *scroll_bar_parts
[(int) event
->part
];
5682 Fcons (Qvertical_scroll_bar
,
5683 Fcons (portion_whole
,
5684 Fcons (make_number (event
->timestamp
),
5685 Fcons (part
, Qnil
)))));
5687 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5689 if (button
>= ASIZE (button_down_location
))
5691 button_down_location
= larger_vector (button_down_location
,
5693 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5696 start_pos_ptr
= &AREF (button_down_location
, button
);
5697 start_pos
= *start_pos_ptr
;
5698 *start_pos_ptr
= Qnil
;
5701 /* On window-system frames, use the value of
5702 double-click-fuzz as is. On other frames, interpret it
5703 as a multiple of 1/8 characters. */
5707 if (WINDOWP (event
->frame_or_window
))
5708 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5709 else if (FRAMEP (event
->frame_or_window
))
5710 f
= XFRAME (event
->frame_or_window
);
5714 if (FRAME_WINDOW_P (f
))
5715 fuzz
= double_click_fuzz
;
5717 fuzz
= double_click_fuzz
/ 8;
5719 is_double
= (button
== last_mouse_button
5720 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5721 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5722 && button_down_time
!= 0
5723 && (EQ (Vdouble_click_time
, Qt
)
5724 || (INTEGERP (Vdouble_click_time
)
5725 && ((int)(event
->timestamp
- button_down_time
)
5726 < XINT (Vdouble_click_time
)))));
5729 last_mouse_button
= button
;
5730 last_mouse_x
= XINT (event
->x
);
5731 last_mouse_y
= XINT (event
->y
);
5733 /* If this is a button press, squirrel away the location, so
5734 we can decide later whether it was a click or a drag. */
5735 if (event
->modifiers
& down_modifier
)
5739 double_click_count
++;
5740 event
->modifiers
|= ((double_click_count
> 2)
5745 double_click_count
= 1;
5746 button_down_time
= event
->timestamp
;
5747 *start_pos_ptr
= Fcopy_alist (position
);
5748 ignore_mouse_drag_p
= 0;
5751 /* Now we're releasing a button - check the co-ordinates to
5752 see if this was a click or a drag. */
5753 else if (event
->modifiers
& up_modifier
)
5755 /* If we did not see a down before this up, ignore the up.
5756 Probably this happened because the down event chose a
5757 menu item. It would be an annoyance to treat the
5758 release of the button that chose the menu item as a
5761 if (!CONSP (start_pos
))
5764 event
->modifiers
&= ~up_modifier
;
5765 #if 0 /* Formerly we treated an up with no down as a click event. */
5766 if (!CONSP (start_pos
))
5767 event
->modifiers
|= click_modifier
;
5772 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5774 /* The third element of every position
5775 should be the (x,y) pair. */
5776 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5778 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5780 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5781 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5784 if (ignore_mouse_drag_p
)
5786 event
->modifiers
|= click_modifier
;
5787 ignore_mouse_drag_p
= 0;
5789 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5790 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5791 /* Maybe the mouse has moved a lot, caused scrolling, and
5792 eventually ended up at the same screen position (but
5793 not buffer position) in which case it is a drag, not
5795 /* FIXME: OTOH if the buffer position has changed
5796 because of a timer or process filter rather than
5797 because of mouse movement, it should be considered as
5798 a click. But mouse-drag-region completely ignores
5799 this case and it hasn't caused any real problem, so
5800 it's probably OK to ignore it as well. */
5801 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5802 /* Mouse hasn't moved (much). */
5803 event
->modifiers
|= click_modifier
;
5806 button_down_time
= 0;
5807 event
->modifiers
|= drag_modifier
;
5810 /* Don't check is_double; treat this as multiple
5811 if the down-event was multiple. */
5812 if (double_click_count
> 1)
5813 event
->modifiers
|= ((double_click_count
> 2)
5819 /* Every mouse event should either have the down_modifier or
5820 the up_modifier set. */
5824 /* Get the symbol we should use for the mouse click. */
5827 head
= modify_event_symbol (button
,
5829 Qmouse_click
, Vlispy_mouse_stem
,
5832 XVECTOR (mouse_syms
)->size
);
5833 if (event
->modifiers
& drag_modifier
)
5838 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5841 Fcons (make_number (double_click_count
),
5851 case HORIZ_WHEEL_EVENT
:
5853 Lisp_Object position
;
5856 /* Build the position as appropriate for this mouse click. */
5857 struct frame
*f
= XFRAME (event
->frame_or_window
);
5859 /* Ignore wheel events that were made on frame that have been
5861 if (! FRAME_LIVE_P (f
))
5864 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5867 /* Set double or triple modifiers to indicate the wheel speed. */
5869 /* On window-system frames, use the value of
5870 double-click-fuzz as is. On other frames, interpret it
5871 as a multiple of 1/8 characters. */
5877 if (WINDOWP (event
->frame_or_window
))
5878 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5879 else if (FRAMEP (event
->frame_or_window
))
5880 f
= XFRAME (event
->frame_or_window
);
5884 if (FRAME_WINDOW_P (f
))
5885 fuzz
= double_click_fuzz
;
5887 fuzz
= double_click_fuzz
/ 8;
5889 if (event
->modifiers
& up_modifier
)
5891 /* Emit a wheel-up event. */
5892 event
->modifiers
&= ~up_modifier
;
5895 else if (event
->modifiers
& down_modifier
)
5897 /* Emit a wheel-down event. */
5898 event
->modifiers
&= ~down_modifier
;
5902 /* Every wheel event should either have the down_modifier or
5903 the up_modifier set. */
5906 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5909 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5910 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5911 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5912 && button_down_time
!= 0
5913 && (EQ (Vdouble_click_time
, Qt
)
5914 || (INTEGERP (Vdouble_click_time
)
5915 && ((int)(event
->timestamp
- button_down_time
)
5916 < XINT (Vdouble_click_time
)))));
5919 double_click_count
++;
5920 event
->modifiers
|= ((double_click_count
> 2)
5926 double_click_count
= 1;
5927 event
->modifiers
|= click_modifier
;
5930 button_down_time
= event
->timestamp
;
5931 /* Use a negative value to distinguish wheel from mouse button. */
5932 last_mouse_button
= - (1 + symbol_num
);
5933 last_mouse_x
= XINT (event
->x
);
5934 last_mouse_y
= XINT (event
->y
);
5936 /* Get the symbol we should use for the wheel event. */
5937 head
= modify_event_symbol (symbol_num
,
5943 ASIZE (wheel_syms
));
5946 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5949 Fcons (make_number (double_click_count
),
5958 #ifdef USE_TOOLKIT_SCROLL_BARS
5960 /* We don't have down and up events if using toolkit scroll bars,
5961 so make this always a click event. Store in the `part' of
5962 the Lisp event a symbol which maps to the following actions:
5964 `above_handle' page up
5965 `below_handle' page down
5969 `bottom' bottom of buffer
5970 `handle' thumb has been dragged.
5971 `end-scroll' end of interaction with scroll bar
5973 The incoming input_event contains in its `part' member an
5974 index of type `enum scroll_bar_part' which we can use as an
5975 index in scroll_bar_parts to get the appropriate symbol. */
5977 case SCROLL_BAR_CLICK_EVENT
:
5979 Lisp_Object position
, head
, window
, portion_whole
, part
;
5981 window
= event
->frame_or_window
;
5982 portion_whole
= Fcons (event
->x
, event
->y
);
5983 part
= *scroll_bar_parts
[(int) event
->part
];
5987 Fcons (Qvertical_scroll_bar
,
5988 Fcons (portion_whole
,
5989 Fcons (make_number (event
->timestamp
),
5990 Fcons (part
, Qnil
)))));
5992 /* Always treat scroll bar events as clicks. */
5993 event
->modifiers
|= click_modifier
;
5994 event
->modifiers
&= ~up_modifier
;
5996 if (event
->code
>= ASIZE (mouse_syms
))
5997 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5999 /* Get the symbol we should use for the mouse click. */
6000 head
= modify_event_symbol (event
->code
,
6005 XVECTOR (mouse_syms
)->size
);
6006 return Fcons (head
, Fcons (position
, Qnil
));
6009 #endif /* USE_TOOLKIT_SCROLL_BARS */
6011 case DRAG_N_DROP_EVENT
:
6014 Lisp_Object head
, position
;
6017 f
= XFRAME (event
->frame_or_window
);
6020 /* Ignore mouse events that were made on frames that
6021 have been deleted. */
6022 if (! FRAME_LIVE_P (f
))
6025 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6028 head
= modify_event_symbol (0, event
->modifiers
,
6030 lispy_drag_n_drop_names
,
6031 &drag_n_drop_syms
, 1);
6037 #endif /* HAVE_MOUSE */
6039 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6040 || defined(HAVE_NS) || defined (USE_GTK)
6041 case MENU_BAR_EVENT
:
6042 if (EQ (event
->arg
, event
->frame_or_window
))
6043 /* This is the prefix key. We translate this to
6044 `(menu_bar)' because the code in keyboard.c for menu
6045 events, which we use, relies on this. */
6046 return Fcons (Qmenu_bar
, Qnil
);
6050 case SELECT_WINDOW_EVENT
:
6051 /* Make an event (select-window (WINDOW)). */
6052 return Fcons (Qselect_window
,
6053 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6056 case TOOL_BAR_EVENT
:
6057 if (EQ (event
->arg
, event
->frame_or_window
))
6058 /* This is the prefix key. We translate this to
6059 `(tool_bar)' because the code in keyboard.c for tool bar
6060 events, which we use, relies on this. */
6061 return Fcons (Qtool_bar
, Qnil
);
6062 else if (SYMBOLP (event
->arg
))
6063 return apply_modifiers (event
->modifiers
, event
->arg
);
6066 case USER_SIGNAL_EVENT
:
6067 /* A user signal. */
6069 char *name
= find_user_signal_name (event
->code
);
6072 return intern (name
);
6075 case SAVE_SESSION_EVENT
:
6076 return Qsave_session
;
6081 return Fcons (Qdbus_event
, event
->arg
);
6083 #endif /* HAVE_DBUS */
6085 case CONFIG_CHANGED_EVENT
:
6086 return Fcons (Qconfig_changed_event
,
6088 Fcons (event
->frame_or_window
, Qnil
)));
6090 case GPM_CLICK_EVENT
:
6092 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6093 Lisp_Object head
, position
;
6094 Lisp_Object
*start_pos_ptr
;
6095 Lisp_Object start_pos
;
6096 int button
= event
->code
;
6098 if (button
>= ASIZE (button_down_location
))
6100 button_down_location
= larger_vector (button_down_location
,
6102 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6105 start_pos_ptr
= &AREF (button_down_location
, button
);
6106 start_pos
= *start_pos_ptr
;
6108 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6111 if (event
->modifiers
& down_modifier
)
6112 *start_pos_ptr
= Fcopy_alist (position
);
6113 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6115 if (!CONSP (start_pos
))
6117 event
->modifiers
&= ~up_modifier
;
6120 head
= modify_event_symbol (button
,
6122 Qmouse_click
, Vlispy_mouse_stem
,
6125 XVECTOR (mouse_syms
)->size
);
6127 if (event
->modifiers
& drag_modifier
)
6132 else if (event
->modifiers
& double_modifier
)
6135 Fcons (make_number (2),
6137 else if (event
->modifiers
& triple_modifier
)
6140 Fcons (make_number (3),
6147 #endif /* HAVE_GPM */
6149 /* The 'kind' field of the event is something we don't recognize. */
6155 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6158 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6159 Lisp_Object x
, Lisp_Object y
, unsigned long time
)
6161 /* Is it a scroll bar movement? */
6162 if (frame
&& ! NILP (bar_window
))
6164 Lisp_Object part_sym
;
6166 part_sym
= *scroll_bar_parts
[(int) part
];
6167 return Fcons (Qscroll_bar_movement
,
6168 (Fcons (Fcons (bar_window
,
6169 Fcons (Qvertical_scroll_bar
,
6170 Fcons (Fcons (x
, y
),
6171 Fcons (make_number (time
),
6177 /* Or is it an ordinary mouse movement? */
6180 Lisp_Object position
;
6182 position
= make_lispy_position (frame
, &x
, &y
, time
);
6184 return Fcons (Qmouse_movement
,
6190 #endif /* HAVE_MOUSE || HAVE GPM */
6192 /* Construct a switch frame event. */
6194 make_lispy_switch_frame (Lisp_Object frame
)
6196 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6199 /* Manipulating modifiers. */
6201 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6203 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6204 SYMBOL's name of the end of the modifiers; the string from this
6205 position is the unmodified symbol name.
6207 This doesn't use any caches. */
6210 parse_modifiers_uncached (Lisp_Object symbol
, int *modifier_end
)
6216 CHECK_SYMBOL (symbol
);
6219 name
= SYMBOL_NAME (symbol
);
6221 for (i
= 0; i
+2 <= SBYTES (name
); )
6223 int this_mod_end
= 0;
6226 /* See if the name continues with a modifier word.
6227 Check that the word appears, but don't check what follows it.
6228 Set this_mod and this_mod_end to record what we find. */
6230 switch (SREF (name
, i
))
6232 #define SINGLE_LETTER_MOD(BIT) \
6233 (this_mod_end = i + 1, this_mod = BIT)
6236 SINGLE_LETTER_MOD (alt_modifier
);
6240 SINGLE_LETTER_MOD (ctrl_modifier
);
6244 SINGLE_LETTER_MOD (hyper_modifier
);
6248 SINGLE_LETTER_MOD (meta_modifier
);
6252 SINGLE_LETTER_MOD (shift_modifier
);
6256 SINGLE_LETTER_MOD (super_modifier
);
6259 #undef SINGLE_LETTER_MOD
6261 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6262 if (i + LEN + 1 <= SBYTES (name) \
6263 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6265 this_mod_end = i + LEN; \
6270 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6271 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6272 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6276 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6278 #undef MULTI_LETTER_MOD
6282 /* If we found no modifier, stop looking for them. */
6283 if (this_mod_end
== 0)
6286 /* Check there is a dash after the modifier, so that it
6287 really is a modifier. */
6288 if (this_mod_end
>= SBYTES (name
)
6289 || SREF (name
, this_mod_end
) != '-')
6292 /* This modifier is real; look for another. */
6293 modifiers
|= this_mod
;
6294 i
= this_mod_end
+ 1;
6297 /* Should we include the `click' modifier? */
6298 if (! (modifiers
& (down_modifier
| drag_modifier
6299 | double_modifier
| triple_modifier
))
6300 && i
+ 7 == SBYTES (name
)
6301 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6302 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6303 modifiers
|= click_modifier
;
6305 if (! (modifiers
& (double_modifier
| triple_modifier
))
6306 && i
+ 6 < SBYTES (name
)
6307 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6308 modifiers
|= click_modifier
;
6316 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6317 prepended to the string BASE[0..BASE_LEN-1].
6318 This doesn't use any caches. */
6320 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6322 /* Since BASE could contain nulls, we can't use intern here; we have
6323 to use Fintern, which expects a genuine Lisp_String, and keeps a
6326 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6332 /* Only the event queue may use the `up' modifier; it should always
6333 be turned into a click or drag event before presented to lisp code. */
6334 if (modifiers
& up_modifier
)
6337 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6338 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6339 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6340 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6341 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6342 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6343 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6344 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6345 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6346 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6347 /* The click modifier is denoted by the absence of other modifiers. */
6351 mod_len
= p
- new_mods
;
6355 Lisp_Object new_name
;
6357 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6358 mod_len
+ base_len_byte
);
6359 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6360 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6362 return Fintern (new_name
, Qnil
);
6367 static const char *modifier_names
[] =
6369 "up", "down", "drag", "click", "double", "triple", 0, 0,
6370 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6371 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6373 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6375 static Lisp_Object modifier_symbols
;
6377 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6379 lispy_modifier_list (int modifiers
)
6381 Lisp_Object modifier_list
;
6384 modifier_list
= Qnil
;
6385 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6386 if (modifiers
& (1<<i
))
6387 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6390 return modifier_list
;
6394 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6395 where UNMODIFIED is the unmodified form of SYMBOL,
6396 MASK is the set of modifiers present in SYMBOL's name.
6397 This is similar to parse_modifiers_uncached, but uses the cache in
6398 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6399 Qevent_symbol_elements property. */
6401 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6404 parse_modifiers (Lisp_Object symbol
)
6406 Lisp_Object elements
;
6408 if (INTEGERP (symbol
))
6409 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6410 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6412 else if (!SYMBOLP (symbol
))
6415 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6416 if (CONSP (elements
))
6421 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6422 Lisp_Object unmodified
;
6425 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6426 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6429 if (modifiers
& ~INTMASK
)
6431 XSETFASTINT (mask
, modifiers
);
6432 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6434 /* Cache the parsing results on SYMBOL. */
6435 Fput (symbol
, Qevent_symbol_element_mask
,
6437 Fput (symbol
, Qevent_symbol_elements
,
6438 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6440 /* Since we know that SYMBOL is modifiers applied to unmodified,
6441 it would be nice to put that in unmodified's cache.
6442 But we can't, since we're not sure that parse_modifiers is
6449 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6450 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6451 doc
: /* Parse the event symbol. For internal use. */)
6452 (Lisp_Object symbol
)
6454 /* Fill the cache if needed. */
6455 parse_modifiers (symbol
);
6456 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6457 and use the Lispier representation stored on Qevent_symbol_elements
6459 return Fget (symbol
, Qevent_symbol_elements
);
6462 /* Apply the modifiers MODIFIERS to the symbol BASE.
6463 BASE must be unmodified.
6465 This is like apply_modifiers_uncached, but uses BASE's
6466 Qmodifier_cache property, if present. It also builds
6467 Qevent_symbol_elements properties, since it has that info anyway.
6469 apply_modifiers copies the value of BASE's Qevent_kind property to
6470 the modified symbol. */
6472 apply_modifiers (int modifiers
, Lisp_Object base
)
6474 Lisp_Object cache
, index
, entry
, new_symbol
;
6476 /* Mask out upper bits. We don't know where this value's been. */
6477 modifiers
&= INTMASK
;
6479 if (INTEGERP (base
))
6480 return make_number (XINT (base
) | modifiers
);
6482 /* The click modifier never figures into cache indices. */
6483 cache
= Fget (base
, Qmodifier_cache
);
6484 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6485 entry
= assq_no_quit (index
, cache
);
6488 new_symbol
= XCDR (entry
);
6491 /* We have to create the symbol ourselves. */
6492 new_symbol
= apply_modifiers_uncached (modifiers
,
6493 SDATA (SYMBOL_NAME (base
)),
6494 SCHARS (SYMBOL_NAME (base
)),
6495 SBYTES (SYMBOL_NAME (base
)));
6497 /* Add the new symbol to the base's cache. */
6498 entry
= Fcons (index
, new_symbol
);
6499 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6501 /* We have the parsing info now for free, so we could add it to
6503 XSETFASTINT (index, modifiers);
6504 Fput (new_symbol, Qevent_symbol_element_mask,
6505 Fcons (base, Fcons (index, Qnil)));
6506 Fput (new_symbol, Qevent_symbol_elements,
6507 Fcons (base, lispy_modifier_list (modifiers)));
6508 Sadly, this is only correct if `base' is indeed a base event,
6509 which is not necessarily the case. -stef */
6512 /* Make sure this symbol is of the same kind as BASE.
6514 You'd think we could just set this once and for all when we
6515 intern the symbol above, but reorder_modifiers may call us when
6516 BASE's property isn't set right; we can't assume that just
6517 because it has a Qmodifier_cache property it must have its
6518 Qevent_kind set right as well. */
6519 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6523 kind
= Fget (base
, Qevent_kind
);
6525 Fput (new_symbol
, Qevent_kind
, kind
);
6532 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6533 return a symbol with the modifiers placed in the canonical order.
6534 Canonical order is alphabetical, except for down and drag, which
6535 always come last. The 'click' modifier is never written out.
6537 Fdefine_key calls this to make sure that (for example) C-M-foo
6538 and M-C-foo end up being equivalent in the keymap. */
6541 reorder_modifiers (Lisp_Object symbol
)
6543 /* It's hopefully okay to write the code this way, since everything
6544 will soon be in caches, and no consing will be done at all. */
6547 parsed
= parse_modifiers (symbol
);
6548 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6553 /* For handling events, we often want to produce a symbol whose name
6554 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6555 to some base, like the name of a function key or mouse button.
6556 modify_event_symbol produces symbols of this sort.
6558 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6559 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6562 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6563 into symbol names, or a string specifying a name stem used to
6564 construct a symbol name or the form `STEM-N', where N is the decimal
6565 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6566 non-nil; otherwise NAME_TABLE is used.
6568 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6569 persist between calls to modify_event_symbol that it can use to
6570 store a cache of the symbols it's generated for this NAME_TABLE
6571 before. The object stored there may be a vector or an alist.
6573 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6575 MODIFIERS is a set of modifier bits (as given in struct input_events)
6576 whose prefixes should be applied to the symbol name.
6578 SYMBOL_KIND is the value to be placed in the event_kind property of
6579 the returned symbol.
6581 The symbols we create are supposed to have an
6582 `event-symbol-elements' property, which lists the modifiers present
6583 in the symbol's name. */
6586 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6587 Lisp_Object name_alist_or_stem
, const char **name_table
,
6588 Lisp_Object
*symbol_table
, unsigned int table_size
)
6591 Lisp_Object symbol_int
;
6593 /* Get rid of the "vendor-specific" bit here. */
6594 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6596 /* Is this a request for a valid symbol? */
6597 if (symbol_num
< 0 || symbol_num
>= table_size
)
6600 if (CONSP (*symbol_table
))
6601 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6603 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6604 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6605 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6606 we've never used that symbol before. */
6609 if (! VECTORP (*symbol_table
)
6610 || XVECTOR (*symbol_table
)->size
!= table_size
)
6614 XSETFASTINT (size
, table_size
);
6615 *symbol_table
= Fmake_vector (size
, Qnil
);
6618 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6621 /* Have we already used this symbol before? */
6624 /* No; let's create it. */
6625 if (CONSP (name_alist_or_stem
))
6626 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6627 else if (STRINGP (name_alist_or_stem
))
6629 int len
= SBYTES (name_alist_or_stem
);
6630 char *buf
= (char *) alloca (len
+ 50);
6631 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6632 (long) XINT (symbol_int
) + 1);
6633 value
= intern (buf
);
6635 else if (name_table
!= 0 && name_table
[symbol_num
])
6636 value
= intern (name_table
[symbol_num
]);
6638 #ifdef HAVE_WINDOW_SYSTEM
6641 char *name
= x_get_keysym_name (symbol_num
);
6643 value
= intern (name
);
6650 sprintf (buf
, "key-%ld", (long)symbol_num
);
6651 value
= intern (buf
);
6654 if (CONSP (*symbol_table
))
6655 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6657 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6659 /* Fill in the cache entries for this symbol; this also
6660 builds the Qevent_symbol_elements property, which the user
6662 apply_modifiers (modifiers
& click_modifier
, value
);
6663 Fput (value
, Qevent_kind
, symbol_kind
);
6666 /* Apply modifiers to that symbol. */
6667 return apply_modifiers (modifiers
, value
);
6670 /* Convert a list that represents an event type,
6671 such as (ctrl meta backspace), into the usual representation of that
6672 event type as a number or a symbol. */
6674 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6675 doc
: /* Convert the event description list EVENT-DESC to an event type.
6676 EVENT-DESC should contain one base event type (a character or symbol)
6677 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6678 drag, down, double or triple). The base must be last.
6679 The return value is an event type (a character or symbol) which
6680 has the same base event type and all the specified modifiers. */)
6681 (Lisp_Object event_desc
)
6689 while (CONSP (rest
))
6697 /* Given a symbol, see if it is a modifier name. */
6698 if (SYMBOLP (elt
) && CONSP (rest
))
6699 this = parse_solitary_modifier (elt
);
6703 else if (!NILP (base
))
6704 error ("Two bases given in one event");
6710 /* Let the symbol A refer to the character A. */
6711 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6712 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6714 if (INTEGERP (base
))
6716 /* Turn (shift a) into A. */
6717 if ((modifiers
& shift_modifier
) != 0
6718 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6720 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6721 modifiers
&= ~shift_modifier
;
6724 /* Turn (control a) into C-a. */
6725 if (modifiers
& ctrl_modifier
)
6726 return make_number ((modifiers
& ~ctrl_modifier
)
6727 | make_ctrl_char (XINT (base
)));
6729 return make_number (modifiers
| XINT (base
));
6731 else if (SYMBOLP (base
))
6732 return apply_modifiers (modifiers
, base
);
6735 error ("Invalid base event");
6740 /* Try to recognize SYMBOL as a modifier name.
6741 Return the modifier flag bit, or 0 if not recognized. */
6744 parse_solitary_modifier (Lisp_Object symbol
)
6746 Lisp_Object name
= SYMBOL_NAME (symbol
);
6748 switch (SREF (name
, 0))
6750 #define SINGLE_LETTER_MOD(BIT) \
6751 if (SBYTES (name) == 1) \
6754 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6755 if (LEN == SBYTES (name) \
6756 && ! strncmp (SDATA (name), NAME, LEN)) \
6760 SINGLE_LETTER_MOD (alt_modifier
);
6764 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6768 SINGLE_LETTER_MOD (ctrl_modifier
);
6772 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6773 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6777 SINGLE_LETTER_MOD (hyper_modifier
);
6781 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6785 SINGLE_LETTER_MOD (meta_modifier
);
6789 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6793 SINGLE_LETTER_MOD (shift_modifier
);
6797 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6798 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6799 SINGLE_LETTER_MOD (super_modifier
);
6803 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6804 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6805 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6809 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6812 #undef SINGLE_LETTER_MOD
6813 #undef MULTI_LETTER_MOD
6819 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6820 Such a list is not valid as an event,
6821 but it can be a Lucid-style event type list. */
6824 lucid_event_type_list_p (Lisp_Object object
)
6828 if (! CONSP (object
))
6831 if (EQ (XCAR (object
), Qhelp_echo
)
6832 || EQ (XCAR (object
), Qvertical_line
)
6833 || EQ (XCAR (object
), Qmode_line
)
6834 || EQ (XCAR (object
), Qheader_line
))
6837 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6841 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6848 /* Store into *addr a value nonzero if terminal input chars are available.
6849 Serves the purpose of ioctl (0, FIONREAD, addr)
6850 but works even if FIONREAD does not exist.
6851 (In fact, this may actually read some input.)
6853 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6854 timer events that are ripe.
6855 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6856 events (FOCUS_IN_EVENT).
6857 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6858 movements and toolkit scroll bar thumb drags. */
6861 get_input_pending (int *addr
, int flags
)
6863 /* First of all, have we already counted some input? */
6864 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6866 /* If input is being read as it arrives, and we have none, there is none. */
6867 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6870 /* Try to read some input and see how much we get. */
6872 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6875 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6878 gobble_input (int expected
)
6881 /* Read D-Bus messages. */
6882 xd_read_queued_messages ();
6883 #endif /* HAVE_DBUS */
6886 if (interrupt_input
)
6889 mask
= sigblock (sigmask (SIGIO
));
6890 read_avail_input (expected
);
6894 #ifdef POLL_FOR_INPUT
6895 /* XXX This condition was (read_socket_hook && !interrupt_input),
6896 but read_socket_hook is not global anymore. Let's pretend that
6898 if (!interrupt_input
&& poll_suppress_count
== 0)
6901 mask
= sigblock (sigmask (SIGALRM
));
6902 read_avail_input (expected
);
6908 read_avail_input (expected
);
6911 /* Put a BUFFER_SWITCH_EVENT in the buffer
6912 so that read_key_sequence will notice the new current buffer. */
6915 record_asynch_buffer_change (void)
6917 struct input_event event
;
6921 event
.kind
= BUFFER_SWITCH_EVENT
;
6922 event
.frame_or_window
= Qnil
;
6925 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6926 The purpose of the event is to make read_key_sequence look up the
6927 keymaps again. If we aren't in read_key_sequence, we don't need one,
6928 and the event could cause trouble by messing up (input-pending-p).
6929 Note: Fwaiting_for_user_input_p always returns nil when async
6930 subprocesses aren't supported. */
6931 tem
= Fwaiting_for_user_input_p ();
6935 /* Make sure no interrupt happens while storing the event. */
6937 if (interrupt_input
)
6940 mask
= sigblock (sigmask (SIGIO
));
6941 kbd_buffer_store_event (&event
);
6948 kbd_buffer_store_event (&event
);
6953 /* Read any terminal input already buffered up by the system
6954 into the kbd_buffer, but do not wait.
6956 EXPECTED should be nonzero if the caller knows there is some input.
6958 Returns the number of keyboard chars read, or -1 meaning
6959 this is a bad time to try to read input. */
6962 read_avail_input (int expected
)
6968 /* Store pending user signal events, if any. */
6969 if (store_user_signal_events ())
6972 /* Loop through the available terminals, and call their input hooks. */
6976 struct terminal
*next
= t
->next_terminal
;
6978 if (t
->read_socket_hook
)
6981 struct input_event hold_quit
;
6983 EVENT_INIT (hold_quit
);
6984 hold_quit
.kind
= NO_EVENT
;
6986 /* No need for FIONREAD or fcntl; just say don't wait. */
6987 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6993 if (nr
== -1) /* Not OK to read input now. */
6997 else if (nr
== -2) /* Non-transient error. */
6999 /* The terminal device terminated; it should be closed. */
7001 /* Kill Emacs if this was our last terminal. */
7002 if (!terminal_list
->next_terminal
)
7003 /* Formerly simply reported no input, but that
7004 sometimes led to a failure of Emacs to terminate.
7005 SIGHUP seems appropriate if we can't reach the
7007 /* ??? Is it really right to send the signal just to
7008 this process rather than to the whole process
7009 group? Perhaps on systems with FIONREAD Emacs is
7010 alone in its group. */
7011 kill (getpid (), SIGHUP
);
7013 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7016 XSETTERMINAL (tmp
, t
);
7017 Fdelete_terminal (tmp
, Qnoelisp
);
7021 if (hold_quit
.kind
!= NO_EVENT
)
7022 kbd_buffer_store_event (&hold_quit
);
7031 frame_make_pointer_visible ();
7037 decode_keyboard_code (struct tty_display_info
*tty
,
7038 struct coding_system
*coding
,
7039 unsigned char *buf
, int nbytes
)
7041 unsigned char *src
= buf
;
7042 const unsigned char *p
;
7047 if (tty
->meta_key
!= 2)
7048 for (i
= 0; i
< nbytes
; i
++)
7050 if (coding
->carryover_bytes
> 0)
7052 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7053 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7054 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7055 nbytes
+= coding
->carryover_bytes
;
7057 coding
->destination
= alloca (nbytes
* 4);
7058 coding
->dst_bytes
= nbytes
* 4;
7059 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7060 if (coding
->produced_char
== 0)
7062 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7064 struct input_event buf
;
7067 buf
.code
= STRING_CHAR_ADVANCE (p
);
7068 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7069 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7070 /* See the comment in tty_read_avail_input. */
7071 buf
.frame_or_window
= tty
->top_frame
;
7073 kbd_buffer_store_event (&buf
);
7077 /* This is the tty way of reading available input.
7079 Note that each terminal device has its own `struct terminal' object,
7080 and so this function is called once for each individual termcap
7081 terminal. The first parameter indicates which terminal to read from. */
7084 tty_read_avail_input (struct terminal
*terminal
,
7086 struct input_event
*hold_quit
)
7088 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7089 the kbd_buffer can really hold. That may prevent loss
7090 of characters on some systems when input is stuffed at us. */
7091 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7093 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7095 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7097 if (kbd_on_hold_p () || buffer_free
<= 0)
7100 if (!terminal
->name
) /* Don't read from a dead terminal. */
7103 if (terminal
->type
!= output_termcap
7104 && terminal
->type
!= output_msdos_raw
)
7107 /* XXX I think the following code should be moved to separate hook
7108 functions in system-dependent files. */
7111 #else /* not WINDOWSNT */
7112 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7116 return 0; /* The terminal is suspended. */
7119 n_to_read
= dos_keysns ();
7123 cbuf
[0] = dos_keyread ();
7126 #else /* not MSDOS */
7131 struct input_event hold_quit
;
7132 int gpm
, fd
= gpm_fd
;
7134 EVENT_INIT (hold_quit
);
7135 hold_quit
.kind
= NO_EVENT
;
7137 /* gpm==1 if event received.
7138 gpm==0 if the GPM daemon has closed the connection, in which case
7139 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7140 we save it in `fd' so close_gpm can remove it from the
7142 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7143 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7144 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7147 /* Presumably the GPM daemon has closed the connection. */
7149 if (hold_quit
.kind
!= NO_EVENT
)
7150 kbd_buffer_store_event (&hold_quit
);
7154 #endif /* HAVE_GPM */
7156 /* Determine how many characters we should *try* to read. */
7158 /* Find out how much input is available. */
7159 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7161 if (! noninteractive
)
7162 return -2; /* Close this terminal. */
7168 if (n_to_read
> sizeof cbuf
)
7169 n_to_read
= sizeof cbuf
;
7170 #else /* no FIONREAD */
7171 #if defined (USG) || defined(CYGWIN)
7172 /* Read some input if available, but don't wait. */
7173 n_to_read
= sizeof cbuf
;
7174 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7180 /* Don't read more than we can store. */
7181 if (n_to_read
> buffer_free
)
7182 n_to_read
= buffer_free
;
7184 /* Now read; for one reason or another, this will not block.
7185 NREAD is set to the number of chars read. */
7188 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7189 /* POSIX infers that processes which are not in the session leader's
7190 process group won't get SIGHUP's at logout time. BSDI adheres to
7191 this part standard and returns -1 from read (0) with errno==EIO
7192 when the control tty is taken away.
7193 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7194 if (nread
== -1 && errno
== EIO
)
7195 return -2; /* Close this terminal. */
7196 #if defined (AIX) && defined (_BSD)
7197 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7198 This looks incorrect, but it isn't, because _BSD causes
7199 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7200 and that causes a value other than 0 when there is no input. */
7202 return -2; /* Close this terminal. */
7206 /* We used to retry the read if it was interrupted.
7207 But this does the wrong thing when O_NDELAY causes
7208 an EAGAIN error. Does anybody know of a situation
7209 where a retry is actually needed? */
7211 nread
< 0 && (errno
== EAGAIN
7225 #if defined (USG) || defined (CYGWIN)
7226 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7227 #endif /* USG or CYGWIN */
7228 #endif /* no FIONREAD */
7233 #endif /* not MSDOS */
7234 #endif /* not WINDOWSNT */
7236 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7237 & CODING_REQUIRE_DECODING_MASK
)
7239 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7242 /* Decode the key sequence except for those with meta
7244 for (i
= from
= 0; ; i
++)
7245 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7247 struct input_event buf
;
7249 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7254 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7255 buf
.modifiers
= meta_modifier
;
7256 buf
.code
= cbuf
[i
] & ~0x80;
7257 /* See the comment below. */
7258 buf
.frame_or_window
= tty
->top_frame
;
7260 kbd_buffer_store_event (&buf
);
7266 for (i
= 0; i
< nread
; i
++)
7268 struct input_event buf
;
7270 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7272 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7273 buf
.modifiers
= meta_modifier
;
7274 if (tty
->meta_key
!= 2)
7278 /* Set the frame corresponding to the active tty. Note that the
7279 value of selected_frame is not reliable here, redisplay tends
7280 to temporarily change it. */
7281 buf
.frame_or_window
= tty
->top_frame
;
7284 kbd_buffer_store_event (&buf
);
7285 /* Don't look at input that follows a C-g too closely.
7286 This reduces lossage due to autorepeat on C-g. */
7287 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7288 && buf
.code
== quit_char
)
7296 handle_async_input (void)
7298 interrupt_input_pending
= 0;
7300 pending_signals
= pending_atimers
;
7302 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7303 doing anything dangerous. */
7310 nread
= read_avail_input (1);
7311 /* -1 means it's not ok to read the input now.
7312 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7313 0 means there was no keyboard input available. */
7323 process_pending_signals (void)
7325 if (interrupt_input_pending
)
7326 handle_async_input ();
7327 do_pending_atimers ();
7330 #ifdef SIGIO /* for entire page */
7331 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7334 input_available_signal (int signo
)
7336 /* Must preserve main program's value of errno. */
7337 int old_errno
= errno
;
7338 SIGNAL_THREAD_CHECK (signo
);
7341 interrupt_input_pending
= 1;
7342 pending_signals
= 1;
7345 if (input_available_clear_time
)
7346 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7349 handle_async_input ();
7356 /* Send ourselves a SIGIO.
7358 This function exists so that the UNBLOCK_INPUT macro in
7359 blockinput.h can have some way to take care of input we put off
7360 dealing with, without assuming that every file which uses
7361 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7363 reinvoke_input_signal (void)
7366 handle_async_input ();
7372 /* User signal events. */
7374 struct user_signal_info
7376 /* Signal number. */
7379 /* Name of the signal. */
7382 /* Number of pending signals. */
7385 struct user_signal_info
*next
;
7388 /* List of user signals. */
7389 static struct user_signal_info
*user_signals
= NULL
;
7392 add_user_signal (int sig
, const char *name
)
7394 struct user_signal_info
*p
;
7396 for (p
= user_signals
; p
; p
= p
->next
)
7398 /* Already added. */
7401 p
= xmalloc (sizeof (struct user_signal_info
));
7403 p
->name
= xstrdup (name
);
7405 p
->next
= user_signals
;
7408 signal (sig
, handle_user_signal
);
7412 handle_user_signal (int sig
)
7414 int old_errno
= errno
;
7415 struct user_signal_info
*p
;
7417 SIGNAL_THREAD_CHECK (sig
);
7419 for (p
= user_signals
; p
; p
= p
->next
)
7424 if (interrupt_input
)
7425 kill (getpid (), SIGIO
);
7429 /* Tell wait_reading_process_output that it needs to wake
7430 up and look around. */
7431 if (input_available_clear_time
)
7432 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7441 find_user_signal_name (int sig
)
7443 struct user_signal_info
*p
;
7445 for (p
= user_signals
; p
; p
= p
->next
)
7453 store_user_signal_events (void)
7455 struct user_signal_info
*p
;
7456 struct input_event buf
;
7459 for (p
= user_signals
; p
; p
= p
->next
)
7460 if (p
->npending
> 0)
7466 memset (&buf
, 0, sizeof buf
);
7467 buf
.kind
= USER_SIGNAL_EVENT
;
7468 buf
.frame_or_window
= selected_frame
;
7470 nstored
+= p
->npending
;
7472 mask
= sigblock (sigmask (p
->sig
));
7476 kbd_buffer_store_event (&buf
);
7479 while (p
->npending
> 0);
7487 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7488 static Lisp_Object menu_bar_one_keymap_changed_items
;
7490 /* These variables hold the vector under construction within
7491 menu_bar_items and its subroutines, and the current index
7492 for storing into that vector. */
7493 static Lisp_Object menu_bar_items_vector
;
7494 static int menu_bar_items_index
;
7496 /* Return a vector of menu items for a menu bar, appropriate
7497 to the current buffer. Each item has three elements in the vector:
7500 OLD is an old vector we can optionally reuse, or nil. */
7503 menu_bar_items (Lisp_Object old
)
7505 /* The number of keymaps we're scanning right now, and the number of
7506 keymaps we have allocated space for. */
7509 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7510 in the current keymaps, or nil where it is not a prefix. */
7513 Lisp_Object def
, tail
;
7522 /* In order to build the menus, we need to call the keymap
7523 accessors. They all call QUIT. But this function is called
7524 during redisplay, during which a quit is fatal. So inhibit
7525 quitting while building the menus.
7526 We do this instead of specbind because (1) errors will clear it anyway
7527 and (2) this avoids risk of specpdl overflow. */
7528 oquit
= Vinhibit_quit
;
7532 menu_bar_items_vector
= old
;
7534 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7535 menu_bar_items_index
= 0;
7537 /* Build our list of keymaps.
7538 If we recognize a function key and replace its escape sequence in
7539 keybuf with its symbol, or if the sequence starts with a mouse
7540 click and we need to switch buffers, we jump back here to rebuild
7541 the initial keymaps from the current buffer. */
7545 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7546 if (!NILP (Voverriding_local_map_menu_flag
))
7548 /* Yes, use them (if non-nil) as well as the global map. */
7549 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7551 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7552 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7553 if (!NILP (Voverriding_local_map
))
7554 maps
[nmaps
++] = Voverriding_local_map
;
7558 /* No, so use major and minor mode keymaps and keymap property.
7559 Note that menu-bar bindings in the local-map and keymap
7560 properties may not work reliable, as they are only
7561 recognized when the menu-bar (or mode-line) is updated,
7562 which does not normally happen after every command. */
7565 nminor
= current_minor_maps (NULL
, &tmaps
);
7566 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7568 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7569 maps
[nmaps
++] = tem
;
7570 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7572 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7574 maps
[nmaps
++] = current_global_map
;
7577 /* Look up in each map the dummy prefix key `menu-bar'. */
7581 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7582 if (!NILP (maps
[mapno
]))
7584 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7588 menu_bar_one_keymap_changed_items
= Qnil
;
7589 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7593 /* Move to the end those items that should be at the end. */
7595 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7598 int end
= menu_bar_items_index
;
7600 for (i
= 0; i
< end
; i
+= 4)
7601 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7603 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7604 /* Move the item at index I to the end,
7605 shifting all the others forward. */
7606 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7607 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7608 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7609 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7611 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7612 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7613 (end
- i
- 4) * sizeof (Lisp_Object
));
7614 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7615 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7616 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7617 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7622 /* Add nil, nil, nil, nil at the end. */
7623 i
= menu_bar_items_index
;
7624 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7625 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7626 /* Add this item. */
7627 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7628 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7629 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7630 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7631 menu_bar_items_index
= i
;
7633 Vinhibit_quit
= oquit
;
7634 return menu_bar_items_vector
;
7637 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7638 If there's already an item for KEY, add this DEF to it. */
7640 Lisp_Object item_properties
;
7643 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7645 struct gcpro gcpro1
;
7649 if (EQ (item
, Qundefined
))
7651 /* If a map has an explicit `undefined' as definition,
7652 discard any previously made menu bar item. */
7654 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7655 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7657 if (menu_bar_items_index
> i
+ 4)
7658 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7659 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7660 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7661 menu_bar_items_index
-= 4;
7665 /* If this keymap has already contributed to this KEY,
7666 don't contribute to it a second time. */
7667 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7668 if (!NILP (tem
) || NILP (item
))
7671 menu_bar_one_keymap_changed_items
7672 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7674 /* We add to menu_bar_one_keymap_changed_items before doing the
7675 parse_menu_item, so that if it turns out it wasn't a menu item,
7676 it still correctly hides any further menu item. */
7678 i
= parse_menu_item (item
, 1);
7683 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7685 /* Find any existing item for this KEY. */
7686 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7687 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7690 /* If we did not find this KEY, add it at the end. */
7691 if (i
== menu_bar_items_index
)
7693 /* If vector is too small, get a bigger one. */
7694 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7695 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7696 /* Add this item. */
7697 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7698 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7699 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7700 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7701 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7702 menu_bar_items_index
= i
;
7704 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7708 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7709 /* If the new and the old items are not both keymaps,
7710 the lookup will only find `item'. */
7711 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7712 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7716 /* This is used as the handler when calling menu_item_eval_property. */
7718 menu_item_eval_property_1 (Lisp_Object arg
)
7720 /* If we got a quit from within the menu computation,
7721 quit all the way out of it. This takes care of C-] in the debugger. */
7722 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7723 Fsignal (Qquit
, Qnil
);
7728 /* Evaluate an expression and return the result (or nil if something
7729 went wrong). Used to evaluate dynamic parts of menu items. */
7731 menu_item_eval_property (Lisp_Object sexpr
)
7733 int count
= SPECPDL_INDEX ();
7735 specbind (Qinhibit_redisplay
, Qt
);
7736 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7737 menu_item_eval_property_1
);
7738 return unbind_to (count
, val
);
7741 /* This function parses a menu item and leaves the result in the
7742 vector item_properties.
7743 ITEM is a key binding, a possible menu item.
7744 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7746 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7747 parse_menu_item returns true if the item is a menu item and false
7751 parse_menu_item (Lisp_Object item
, int inmenubar
)
7753 Lisp_Object def
, tem
, item_string
, start
;
7755 Lisp_Object keyhint
;
7764 /* Create item_properties vector if necessary. */
7765 if (NILP (item_properties
))
7767 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7769 /* Initialize optional entries. */
7770 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7771 ASET (item_properties
, i
, Qnil
);
7772 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7774 /* Save the item here to protect it from GC. */
7775 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7777 item_string
= XCAR (item
);
7781 if (STRINGP (item_string
))
7783 /* Old format menu item. */
7784 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7786 /* Maybe help string. */
7787 if (CONSP (item
) && STRINGP (XCAR (item
)))
7789 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7794 /* Maybe an obsolete key binding cache. */
7795 if (CONSP (item
) && CONSP (XCAR (item
))
7796 && (NILP (XCAR (XCAR (item
)))
7797 || VECTORP (XCAR (XCAR (item
)))))
7800 /* This is the real definition--the function to run. */
7801 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7803 /* Get enable property, if any. */
7806 tem
= Fget (item
, Qmenu_enable
);
7807 if (!NILP (Venable_disabled_menus_and_buttons
))
7808 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7809 else if (!NILP (tem
))
7810 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7813 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7815 /* New format menu item. */
7816 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7817 start
= XCDR (item
);
7820 /* We have a real binding. */
7821 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7823 item
= XCDR (start
);
7824 /* Is there an obsolete cache list with key equivalences. */
7825 if (CONSP (item
) && CONSP (XCAR (item
)))
7828 /* Parse properties. */
7829 while (CONSP (item
) && CONSP (XCDR (item
)))
7834 if (EQ (tem
, QCenable
))
7836 if (!NILP (Venable_disabled_menus_and_buttons
))
7837 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7839 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7841 else if (EQ (tem
, QCvisible
))
7843 /* If got a visible property and that evaluates to nil
7844 then ignore this item. */
7845 tem
= menu_item_eval_property (XCAR (item
));
7849 else if (EQ (tem
, QChelp
))
7850 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7851 else if (EQ (tem
, QCfilter
))
7853 else if (EQ (tem
, QCkey_sequence
))
7856 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7857 /* Be GC protected. Set keyhint to item instead of tem. */
7860 else if (EQ (tem
, QCkeys
))
7863 if (CONSP (tem
) || STRINGP (tem
))
7864 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7866 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7871 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7873 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7875 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7881 else if (inmenubar
|| !NILP (start
))
7885 return 0; /* not a menu item */
7887 /* If item string is not a string, evaluate it to get string.
7888 If we don't get a string, skip this item. */
7889 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7890 if (!(STRINGP (item_string
)))
7892 item_string
= menu_item_eval_property (item_string
);
7893 if (!STRINGP (item_string
))
7895 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7898 /* If got a filter apply it on definition. */
7899 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7902 def
= menu_item_eval_property (list2 (XCAR (filter
),
7903 list2 (Qquote
, def
)));
7905 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7908 /* Enable or disable selection of item. */
7909 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7912 tem
= menu_item_eval_property (tem
);
7913 if (inmenubar
&& NILP (tem
))
7914 return 0; /* Ignore disabled items in menu bar. */
7915 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7918 /* If we got no definition, this item is just unselectable text which
7919 is OK in a submenu but not in the menubar. */
7921 return (inmenubar
? 0 : 1);
7923 /* See if this is a separate pane or a submenu. */
7924 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7925 tem
= get_keymap (def
, 0, 1);
7926 /* For a subkeymap, just record its details and exit. */
7929 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7930 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7934 /* At the top level in the menu bar, do likewise for commands also.
7935 The menu bar does not display equivalent key bindings anyway.
7936 ITEM_PROPERTY_DEF is already set up properly. */
7940 { /* This is a command. See if there is an equivalent key binding. */
7941 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7943 /* The previous code preferred :key-sequence to :keys, so we
7944 preserve this behavior. */
7945 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7946 keyeq
= Fsubstitute_command_keys (keyeq
);
7949 Lisp_Object prefix
= keyeq
;
7950 Lisp_Object keys
= Qnil
;
7954 def
= XCAR (prefix
);
7955 prefix
= XCDR (prefix
);
7958 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7960 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7962 keys
= XCAR (keyhint
);
7963 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7965 /* We have a suggested key. Is it bound to the command? */
7968 /* If the command is an alias for another
7969 (such as lmenu.el set it up), check if the
7970 original command matches the cached command. */
7971 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7976 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7980 tem
= Fkey_description (keys
, Qnil
);
7983 if (STRINGP (XCAR (prefix
)))
7984 tem
= concat2 (XCAR (prefix
), tem
);
7985 if (STRINGP (XCDR (prefix
)))
7986 tem
= concat2 (tem
, XCDR (prefix
));
7988 keyeq
= concat2 (build_string (" "), tem
);
7989 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7995 /* If we have an equivalent key binding, use that. */
7996 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7999 /* Include this when menu help is implemented.
8000 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8001 if (!(NILP (tem) || STRINGP (tem)))
8003 tem = menu_item_eval_property (tem);
8006 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8010 /* Handle radio buttons or toggle boxes. */
8011 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8013 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8014 menu_item_eval_property (tem
));
8021 /***********************************************************************
8023 ***********************************************************************/
8025 /* A vector holding tool bar items while they are parsed in function
8026 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8029 static Lisp_Object tool_bar_items_vector
;
8031 /* A vector holding the result of parse_tool_bar_item. Layout is like
8032 the one for a single item in tool_bar_items_vector. */
8034 static Lisp_Object tool_bar_item_properties
;
8036 /* Next free index in tool_bar_items_vector. */
8038 static int ntool_bar_items
;
8040 /* The symbols `:image' and `:rtl'. */
8042 Lisp_Object QCimage
;
8045 /* Function prototypes. */
8047 static void init_tool_bar_items (Lisp_Object
);
8048 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8049 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8050 static void append_tool_bar_item (void);
8053 /* Return a vector of tool bar items for keymaps currently in effect.
8054 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8055 tool bar items found. */
8058 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8067 /* In order to build the menus, we need to call the keymap
8068 accessors. They all call QUIT. But this function is called
8069 during redisplay, during which a quit is fatal. So inhibit
8070 quitting while building the menus. We do this instead of
8071 specbind because (1) errors will clear it anyway and (2) this
8072 avoids risk of specpdl overflow. */
8073 oquit
= Vinhibit_quit
;
8076 /* Initialize tool_bar_items_vector and protect it from GC. */
8077 init_tool_bar_items (reuse
);
8079 /* Build list of keymaps in maps. Set nmaps to the number of maps
8082 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8083 if (!NILP (Voverriding_local_map_menu_flag
))
8085 /* Yes, use them (if non-nil) as well as the global map. */
8086 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8088 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8089 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8090 if (!NILP (Voverriding_local_map
))
8091 maps
[nmaps
++] = Voverriding_local_map
;
8095 /* No, so use major and minor mode keymaps and keymap property.
8096 Note that tool-bar bindings in the local-map and keymap
8097 properties may not work reliable, as they are only
8098 recognized when the tool-bar (or mode-line) is updated,
8099 which does not normally happen after every command. */
8102 nminor
= current_minor_maps (NULL
, &tmaps
);
8103 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8105 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8106 maps
[nmaps
++] = tem
;
8107 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8109 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8112 /* Add global keymap at the end. */
8113 maps
[nmaps
++] = current_global_map
;
8115 /* Process maps in reverse order and look up in each map the prefix
8117 for (i
= nmaps
- 1; i
>= 0; --i
)
8118 if (!NILP (maps
[i
]))
8122 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8124 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8127 Vinhibit_quit
= oquit
;
8128 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8129 return tool_bar_items_vector
;
8133 /* Process the definition of KEY which is DEF. */
8136 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8139 struct gcpro gcpro1
, gcpro2
;
8141 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8145 if (EQ (def
, Qundefined
))
8147 /* If a map has an explicit `undefined' as definition,
8148 discard any previously made item. */
8149 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8151 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8153 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8155 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8156 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8157 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8158 * sizeof (Lisp_Object
)));
8159 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8164 else if (parse_tool_bar_item (key
, def
))
8165 /* Append a new tool bar item to tool_bar_items_vector. Accept
8166 more than one definition for the same key. */
8167 append_tool_bar_item ();
8173 /* Parse a tool bar item specification ITEM for key KEY and return the
8174 result in tool_bar_item_properties. Value is zero if ITEM is
8177 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8179 CAPTION is the caption of the item, If it's not a string, it is
8180 evaluated to get a string.
8182 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8183 as binding are currently ignored.
8185 The following properties are recognized:
8189 FORM is evaluated and specifies whether the tool bar item is
8190 enabled or disabled.
8194 FORM is evaluated and specifies whether the tool bar item is visible.
8196 - `:filter FUNCTION'
8198 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8199 result is stored as the new binding.
8201 - `:button (TYPE SELECTED)'
8203 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8204 and specifies whether the button is selected (pressed) or not.
8208 IMAGES is either a single image specification or a vector of four
8209 image specifications. See enum tool_bar_item_images.
8211 - `:help HELP-STRING'.
8213 Gives a help string to display for the tool bar item.
8215 - `:label LABEL-STRING'.
8217 A text label to show with the tool bar button if labels are enabled. */
8220 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8222 /* Access slot with index IDX of vector tool_bar_item_properties. */
8223 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8225 Lisp_Object filter
= Qnil
;
8226 Lisp_Object caption
;
8227 int i
, have_label
= 0;
8229 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8230 Rule out items that aren't lists, don't start with
8231 `menu-item' or whose rest following `tool-bar-item' is not a
8234 || !EQ (XCAR (item
), Qmenu_item
)
8235 || (item
= XCDR (item
),
8239 /* Create tool_bar_item_properties vector if necessary. Reset it to
8241 if (VECTORP (tool_bar_item_properties
))
8243 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8247 tool_bar_item_properties
8248 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8251 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8252 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8254 /* Get the caption of the item. If the caption is not a string,
8255 evaluate it to get a string. If we don't get a string, skip this
8257 caption
= XCAR (item
);
8258 if (!STRINGP (caption
))
8260 caption
= menu_item_eval_property (caption
);
8261 if (!STRINGP (caption
))
8264 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8266 /* Give up if rest following the caption is not a list. */
8271 /* Store the binding. */
8272 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8275 /* Ignore cached key binding, if any. */
8276 if (CONSP (item
) && CONSP (XCAR (item
)))
8279 /* Process the rest of the properties. */
8280 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8282 Lisp_Object key
, value
;
8285 value
= XCAR (XCDR (item
));
8287 if (EQ (key
, QCenable
))
8289 /* `:enable FORM'. */
8290 if (!NILP (Venable_disabled_menus_and_buttons
))
8291 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8293 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8295 else if (EQ (key
, QCvisible
))
8297 /* `:visible FORM'. If got a visible property and that
8298 evaluates to nil then ignore this item. */
8299 if (NILP (menu_item_eval_property (value
)))
8302 else if (EQ (key
, QChelp
))
8303 /* `:help HELP-STRING'. */
8304 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8305 else if (EQ (key
, QClabel
))
8307 const char *bad_label
= "!!?GARBLED ITEM?!!";
8308 /* `:label LABEL-STRING'. */
8309 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8311 : make_string (bad_label
, strlen (bad_label
));
8314 else if (EQ (key
, QCfilter
))
8315 /* ':filter FORM'. */
8317 else if (EQ (key
, QCbutton
) && CONSP (value
))
8319 /* `:button (TYPE . SELECTED)'. */
8320 Lisp_Object type
, selected
;
8322 type
= XCAR (value
);
8323 selected
= XCDR (value
);
8324 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8326 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8327 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8330 else if (EQ (key
, QCimage
)
8332 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8333 /* Value is either a single image specification or a vector
8334 of 4 such specifications for the different button states. */
8335 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8336 else if (EQ (key
, Qrtl
))
8338 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8344 /* Try to make one from caption and key. */
8345 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8346 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8347 const char *label
= SYMBOLP (key
) ? (char *) SDATA (SYMBOL_NAME (key
)) : "";
8348 const char *caption
= STRINGP (capt
) ? (char *) SDATA (capt
) : "";
8349 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8350 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8351 Lisp_Object new_lbl
;
8352 size_t caption_len
= strlen (caption
);
8354 if (caption_len
<= max_lbl
&& caption
[0] != '\0')
8356 strcpy (buf
, caption
);
8357 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8359 buf
[caption_len
] = '\0';
8360 label
= caption
= buf
;
8363 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8367 strcpy (buf
, label
);
8369 for (i
= 0; buf
[i
] != '\0'; ++i
)
8378 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8379 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8380 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8382 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8386 /* If got a filter apply it on binding. */
8388 PROP (TOOL_BAR_ITEM_BINDING
)
8389 = menu_item_eval_property (list2 (filter
,
8391 PROP (TOOL_BAR_ITEM_BINDING
))));
8393 /* See if the binding is a keymap. Give up if it is. */
8394 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8397 /* Enable or disable selection of item. */
8398 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8399 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8400 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8402 /* Handle radio buttons or toggle boxes. */
8403 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8404 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8405 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8413 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8414 that can be reused. */
8417 init_tool_bar_items (Lisp_Object reuse
)
8419 if (VECTORP (reuse
))
8420 tool_bar_items_vector
= reuse
;
8422 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8423 ntool_bar_items
= 0;
8427 /* Append parsed tool bar item properties from
8428 tool_bar_item_properties */
8431 append_tool_bar_item (void)
8433 Lisp_Object
*to
, *from
;
8435 /* Enlarge tool_bar_items_vector if necessary. */
8436 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8437 >= XVECTOR (tool_bar_items_vector
)->size
)
8438 tool_bar_items_vector
8439 = larger_vector (tool_bar_items_vector
,
8440 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8442 /* Append entries from tool_bar_item_properties to the end of
8443 tool_bar_items_vector. */
8444 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8445 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8446 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8447 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8454 /* Read a character using menus based on maps in the array MAPS.
8455 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8456 Return t if we displayed a menu but the user rejected it.
8458 PREV_EVENT is the previous input event, or nil if we are reading
8459 the first event of a key sequence.
8461 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8462 if we used a mouse menu to read the input, or zero otherwise. If
8463 USED_MOUSE_MENU is null, we don't dereference it.
8465 The prompting is done based on the prompt-string of the map
8466 and the strings associated with various map elements.
8468 This can be done with X menus or with menus put in the minibuf.
8469 These are done in different ways, depending on how the input will be read.
8470 Menus using X are done after auto-saving in read-char, getting the input
8471 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8472 and do auto-saving in the inner call of read_char. */
8475 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8476 int *used_mouse_menu
)
8480 if (used_mouse_menu
)
8481 *used_mouse_menu
= 0;
8483 /* Use local over global Menu maps */
8485 if (! menu_prompting
)
8488 /* Optionally disregard all but the global map. */
8489 if (inhibit_local_menu_bar_menus
)
8491 maps
+= (nmaps
- 1);
8496 /* If we got to this point via a mouse click,
8497 use a real menu for mouse selection. */
8498 if (EVENT_HAS_PARAMETERS (prev_event
)
8499 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8500 && !EQ (XCAR (prev_event
), Qtool_bar
))
8502 /* Display the menu and get the selection. */
8503 Lisp_Object
*realmaps
8504 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8508 /* Use the maps that are not nil. */
8509 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8510 if (!NILP (maps
[mapno
]))
8511 realmaps
[nmaps1
++] = maps
[mapno
];
8513 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8518 record_menu_key (XCAR (value
));
8520 /* If we got multiple events, unread all but
8522 There is no way to prevent those unread events
8523 from showing up later in last_nonmenu_event.
8524 So turn symbol and integer events into lists,
8525 to indicate that they came from a mouse menu,
8526 so that when present in last_nonmenu_event
8527 they won't confuse things. */
8528 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8530 record_menu_key (XCAR (tem
));
8531 if (SYMBOLP (XCAR (tem
))
8532 || INTEGERP (XCAR (tem
)))
8533 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8536 /* If we got more than one event, put all but the first
8537 onto this list to be read later.
8538 Return just the first event now. */
8539 Vunread_command_events
8540 = nconc2 (XCDR (value
), Vunread_command_events
);
8541 value
= XCAR (value
);
8543 else if (NILP (value
))
8545 if (used_mouse_menu
)
8546 *used_mouse_menu
= 1;
8549 #endif /* HAVE_MENUS */
8553 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8554 We make this bigger when necessary, and never free it. */
8555 static char *read_char_minibuf_menu_text
;
8556 /* Size of that buffer. */
8557 static int read_char_minibuf_menu_width
;
8560 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8563 register Lisp_Object name
;
8565 /* FIXME: Use the minibuffer's frame width. */
8566 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8569 Lisp_Object rest
, vector
;
8575 if (! menu_prompting
)
8578 /* Get the menu name from the first map that has one (a prompt string). */
8579 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8581 name
= Fkeymap_prompt (maps
[mapno
]);
8586 /* If we don't have any menus, just read a character normally. */
8587 if (!STRINGP (name
))
8590 /* Make sure we have a big enough buffer for the menu text. */
8591 width
= max (width
, SBYTES (name
));
8592 if (read_char_minibuf_menu_text
== 0)
8594 read_char_minibuf_menu_width
= width
+ 4;
8595 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8597 else if (width
+ 4 > read_char_minibuf_menu_width
)
8599 read_char_minibuf_menu_width
= width
+ 4;
8600 read_char_minibuf_menu_text
8601 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8603 menu
= read_char_minibuf_menu_text
;
8605 /* Prompt string always starts with map's prompt, and a space. */
8606 strcpy (menu
, SDATA (name
));
8607 nlength
= SBYTES (name
);
8608 menu
[nlength
++] = ':';
8609 menu
[nlength
++] = ' ';
8612 /* Start prompting at start of first map. */
8616 /* Present the documented bindings, a line at a time. */
8623 Lisp_Object orig_defn_macro
;
8625 /* Loop over elements of map. */
8630 /* If reached end of map, start at beginning of next map. */
8634 /* At end of last map, wrap around to first map if just starting,
8635 or end this line if already have something on it. */
8639 if (notfirst
|| nobindings
) break;
8644 /* Look at the next element of the map. */
8646 elt
= XVECTOR (vector
)->contents
[idx
];
8648 elt
= Fcar_safe (rest
);
8650 if (idx
< 0 && VECTORP (elt
))
8652 /* If we found a dense table in the keymap,
8653 advanced past it, but start scanning its contents. */
8654 rest
= Fcdr_safe (rest
);
8660 /* An ordinary element. */
8661 Lisp_Object event
, tem
;
8665 event
= Fcar_safe (elt
); /* alist */
8666 elt
= Fcdr_safe (elt
);
8670 XSETINT (event
, idx
); /* vector */
8673 /* Ignore the element if it has no prompt string. */
8674 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8676 /* 1 if the char to type matches the string. */
8678 Lisp_Object upcased_event
, downcased_event
;
8679 Lisp_Object desc
= Qnil
;
8681 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8683 upcased_event
= Fupcase (event
);
8684 downcased_event
= Fdowncase (event
);
8685 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8686 || XINT (downcased_event
) == SREF (s
, 0));
8688 desc
= Fsingle_key_description (event
, Qnil
);
8690 #if 0 /* It is redundant to list the equivalent key bindings because
8691 the prefix is what the user has already typed. */
8693 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8695 /* Insert equivalent keybinding. */
8696 s
= concat2 (s
, tem
);
8699 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8700 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8702 /* Insert button prefix. */
8703 Lisp_Object selected
8704 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8705 if (EQ (tem
, QCradio
))
8706 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8708 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8709 s
= concat2 (tem
, s
);
8713 /* If we have room for the prompt string, add it to this line.
8714 If this is the first on the line, always add it. */
8715 if ((SCHARS (s
) + i
+ 2
8716 + (char_matches
? 0 : SCHARS (desc
) + 3))
8722 /* Punctuate between strings. */
8725 strcpy (menu
+ i
, ", ");
8731 /* If the char to type doesn't match the string's
8732 first char, explicitly show what char to type. */
8735 /* Add as much of string as fits. */
8736 thiswidth
= SCHARS (desc
);
8737 if (thiswidth
+ i
> width
)
8738 thiswidth
= width
- i
;
8739 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8741 strcpy (menu
+ i
, " = ");
8745 /* Add as much of string as fits. */
8746 thiswidth
= SCHARS (s
);
8747 if (thiswidth
+ i
> width
)
8748 thiswidth
= width
- i
;
8749 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8755 /* If this element does not fit, end the line now,
8756 and save the element for the next line. */
8757 strcpy (menu
+ i
, "...");
8762 /* Move past this element. */
8763 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8764 /* Handle reaching end of dense table. */
8769 rest
= Fcdr_safe (rest
);
8773 /* Prompt with that and read response. */
8774 message2_nolog (menu
, strlen (menu
),
8775 ! NILP (current_buffer
->enable_multibyte_characters
));
8777 /* Make believe its not a keyboard macro in case the help char
8778 is pressed. Help characters are not recorded because menu prompting
8779 is not used on replay.
8781 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8782 current_kboard
->defining_kbd_macro
= Qnil
;
8784 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8785 while (BUFFERP (obj
));
8786 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8788 if (!INTEGERP (obj
))
8790 else if (XINT (obj
) == -2)
8795 if (! EQ (obj
, menu_prompt_more_char
)
8796 && (!INTEGERP (menu_prompt_more_char
)
8797 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8799 if (!NILP (current_kboard
->defining_kbd_macro
))
8800 store_kbd_macro_char (obj
);
8803 /* Help char - go round again */
8807 /* Reading key sequences. */
8809 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8810 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8811 keymap, or nil otherwise. Return the index of the first keymap in
8812 which KEY has any binding, or NMAPS if no map has a binding.
8814 If KEY is a meta ASCII character, treat it like meta-prefix-char
8815 followed by the corresponding non-meta character. Keymaps in
8816 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8819 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8822 NEXT may be the same array as CURRENT. */
8825 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8828 int i
, first_binding
;
8830 first_binding
= nmaps
;
8831 for (i
= nmaps
- 1; i
>= 0; i
--)
8833 if (! NILP (current
[i
]))
8835 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8836 if (! NILP (defs
[i
]))
8843 /* Given the set of bindings we've found, produce the next set of maps. */
8844 if (first_binding
< nmaps
)
8845 for (i
= 0; i
< nmaps
; i
++)
8846 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8848 return first_binding
;
8851 /* Structure used to keep track of partial application of key remapping
8852 such as Vfunction_key_map and Vkey_translation_map. */
8853 typedef struct keyremap
8855 /* This is the map originally specified for this use. */
8857 /* This is a submap reached by looking up, in PARENT,
8858 the events from START to END. */
8860 /* Positions [START, END) in the key sequence buffer
8861 are the key that we have scanned so far.
8862 Those events are the ones that we will replace
8863 if PAREHT maps them into a key sequence. */
8867 /* Lookup KEY in MAP.
8868 MAP is a keymap mapping keys to key vectors or functions.
8869 If the mapping is a function and DO_FUNCTION is non-zero, then
8870 the function is called with PROMPT as parameter and its return
8871 value is used as the return value of this function (after checking
8872 that it is indeed a vector). */
8875 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8880 next
= access_keymap (map
, key
, 1, 0, 1);
8882 /* Handle symbol with autoload definition. */
8883 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8884 && CONSP (XSYMBOL (next
)->function
)
8885 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8886 do_autoload (XSYMBOL (next
)->function
, next
);
8888 /* Handle a symbol whose function definition is a keymap
8890 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8891 && (ARRAYP (XSYMBOL (next
)->function
)
8892 || KEYMAPP (XSYMBOL (next
)->function
)))
8893 next
= XSYMBOL (next
)->function
;
8895 /* If the keymap gives a function, not an
8896 array, then call the function with one arg and use
8897 its value instead. */
8898 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8903 next
= call1 (next
, prompt
);
8904 /* If the function returned something invalid,
8905 barf--don't ignore it.
8906 (To ignore it safely, we would need to gcpro a bunch of
8907 other variables.) */
8908 if (! (VECTORP (next
) || STRINGP (next
)))
8909 error ("Function %s returns invalid key sequence", tem
);
8914 /* Do one step of the key remapping used for function-key-map and
8915 key-translation-map:
8916 KEYBUF is the buffer holding the input events.
8917 BUFSIZE is its maximum size.
8918 FKEY is a pointer to the keyremap structure to use.
8919 INPUT is the index of the last element in KEYBUF.
8920 DOIT if non-zero says that the remapping can actually take place.
8921 DIFF is used to return the number of keys added/removed by the remapping.
8922 PARENT is the root of the keymap.
8923 PROMPT is the prompt to use if the remapping happens through a function.
8924 The return value is non-zero if the remapping actually took place. */
8927 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8928 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8930 Lisp_Object next
, key
;
8932 key
= keybuf
[fkey
->end
++];
8934 if (KEYMAPP (fkey
->parent
))
8935 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8939 /* If keybuf[fkey->start..fkey->end] is bound in the
8940 map and we're in a position to do the key remapping, replace it with
8941 the binding and restart with fkey->start at the end. */
8942 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8944 int len
= XFASTINT (Flength (next
));
8947 *diff
= len
- (fkey
->end
- fkey
->start
);
8949 if (input
+ *diff
>= bufsize
)
8950 error ("Key sequence too long");
8952 /* Shift the keys that follow fkey->end. */
8954 for (i
= fkey
->end
; i
< input
; i
++)
8955 keybuf
[i
+ *diff
] = keybuf
[i
];
8957 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8958 keybuf
[i
+ *diff
] = keybuf
[i
];
8959 /* Overwrite the old keys with the new ones. */
8960 for (i
= 0; i
< len
; i
++)
8961 keybuf
[fkey
->start
+ i
]
8962 = Faref (next
, make_number (i
));
8964 fkey
->start
= fkey
->end
+= *diff
;
8965 fkey
->map
= fkey
->parent
;
8970 fkey
->map
= get_keymap (next
, 0, 1);
8972 /* If we no longer have a bound suffix, try a new position for
8974 if (!CONSP (fkey
->map
))
8976 fkey
->end
= ++fkey
->start
;
8977 fkey
->map
= fkey
->parent
;
8982 /* Read a sequence of keys that ends with a non prefix character,
8983 storing it in KEYBUF, a buffer of size BUFSIZE.
8985 Return the length of the key sequence stored.
8986 Return -1 if the user rejected a command menu.
8988 Echo starting immediately unless `prompt' is 0.
8990 Where a key sequence ends depends on the currently active keymaps.
8991 These include any minor mode keymaps active in the current buffer,
8992 the current buffer's local map, and the global map.
8994 If a key sequence has no other bindings, we check Vfunction_key_map
8995 to see if some trailing subsequence might be the beginning of a
8996 function key's sequence. If so, we try to read the whole function
8997 key, and substitute its symbolic name into the key sequence.
8999 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9000 `double-' events into similar click events, if that would make them
9001 bound. We try to turn `triple-' events first into `double-' events,
9004 If we get a mouse click in a mode line, vertical divider, or other
9005 non-text area, we treat the click as if it were prefixed by the
9006 symbol denoting that area - `mode-line', `vertical-line', or
9009 If the sequence starts with a mouse click, we read the key sequence
9010 with respect to the buffer clicked on, not the current buffer.
9012 If the user switches frames in the midst of a key sequence, we put
9013 off the switch-frame event until later; the next call to
9014 read_char will return it.
9016 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9017 from the selected window's buffer. */
9020 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9021 int dont_downcase_last
, int can_return_switch_frame
,
9022 int fix_current_buffer
)
9024 Lisp_Object from_string
;
9025 int count
= SPECPDL_INDEX ();
9027 /* How many keys there are in the current key sequence. */
9030 /* The length of the echo buffer when we started reading, and
9031 the length of this_command_keys when we started reading. */
9035 /* The number of keymaps we're scanning right now, and the number of
9036 keymaps we have allocated space for. */
9038 int nmaps_allocated
= 0;
9040 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9041 the current keymaps. */
9042 Lisp_Object
*defs
= NULL
;
9044 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9045 in the current keymaps, or nil where it is not a prefix. */
9046 Lisp_Object
*submaps
= NULL
;
9048 /* The local map to start out with at start of key sequence. */
9049 Lisp_Object orig_local_map
;
9051 /* The map from the `keymap' property to start out with at start of
9053 Lisp_Object orig_keymap
;
9055 /* 1 if we have already considered switching to the local-map property
9056 of the place where a mouse click occurred. */
9057 int localized_local_map
= 0;
9059 /* The index in submaps[] of the first keymap that has a binding for
9060 this key sequence. In other words, the lowest i such that
9061 submaps[i] is non-nil. */
9063 /* Index of the first key that has no binding.
9064 It is useless to try fkey.start larger than that. */
9067 /* If t < mock_input, then KEYBUF[t] should be read as the next
9070 We use this to recover after recognizing a function key. Once we
9071 realize that a suffix of the current key sequence is actually a
9072 function key's escape sequence, we replace the suffix with the
9073 function key's binding from Vfunction_key_map. Now keybuf
9074 contains a new and different key sequence, so the echo area,
9075 this_command_keys, and the submaps and defs arrays are wrong. In
9076 this situation, we set mock_input to t, set t to 0, and jump to
9077 restart_sequence; the loop will read keys from keybuf up until
9078 mock_input, thus rebuilding the state; and then it will resume
9079 reading characters from the keyboard. */
9082 /* If the sequence is unbound in submaps[], then
9083 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9084 and fkey.map is its binding.
9086 These might be > t, indicating that all function key scanning
9087 should hold off until t reaches them. We do this when we've just
9088 recognized a function key, to avoid searching for the function
9089 key's again in Vfunction_key_map. */
9092 /* Likewise, for key_translation_map and input-decode-map. */
9093 keyremap keytran
, indec
;
9095 /* Non-zero if we are trying to map a key by changing an upper-case
9096 letter to lower case, or a shifted function key to an unshifted
9098 int shift_translated
= 0;
9100 /* If we receive a `switch-frame' or `select-window' event in the middle of
9101 a key sequence, we put it off for later.
9102 While we're reading, we keep the event here. */
9103 Lisp_Object delayed_switch_frame
;
9105 /* See the comment below... */
9106 #if defined (GOBBLE_FIRST_EVENT)
9107 Lisp_Object first_event
;
9110 Lisp_Object original_uppercase
;
9111 int original_uppercase_position
= -1;
9113 /* Gets around Microsoft compiler limitations. */
9116 struct buffer
*starting_buffer
;
9118 /* List of events for which a fake prefix key has been generated. */
9119 Lisp_Object fake_prefixed_keys
= Qnil
;
9121 #if defined (GOBBLE_FIRST_EVENT)
9125 struct gcpro gcpro1
;
9127 GCPRO1 (fake_prefixed_keys
);
9128 raw_keybuf_count
= 0;
9130 last_nonmenu_event
= Qnil
;
9132 delayed_switch_frame
= Qnil
;
9137 echo_prompt (prompt
);
9138 else if (cursor_in_echo_area
9139 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9140 && NILP (Fzerop (Vecho_keystrokes
)))
9141 /* This doesn't put in a dash if the echo buffer is empty, so
9142 you don't always see a dash hanging out in the minibuffer. */
9146 /* Record the initial state of the echo area and this_command_keys;
9147 we will need to restore them if we replay a key sequence. */
9149 echo_start
= echo_length ();
9150 keys_start
= this_command_key_count
;
9151 this_single_command_key_start
= keys_start
;
9153 #if defined (GOBBLE_FIRST_EVENT)
9154 /* This doesn't quite work, because some of the things that read_char
9155 does cannot safely be bypassed. It seems too risky to try to make
9158 /* Read the first char of the sequence specially, before setting
9159 up any keymaps, in case a filter runs and switches buffers on us. */
9160 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9162 #endif /* GOBBLE_FIRST_EVENT */
9164 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9165 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9168 /* We jump here when we need to reinitialize fkey and keytran; this
9169 happens if we switch keyboards between rescans. */
9170 replay_entire_sequence
:
9172 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9173 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9174 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9175 indec
.start
= indec
.end
= 0;
9176 fkey
.start
= fkey
.end
= 0;
9177 keytran
.start
= keytran
.end
= 0;
9179 /* We jump here when the key sequence has been thoroughly changed, and
9180 we need to rescan it starting from the beginning. When we jump here,
9181 keybuf[0..mock_input] holds the sequence we should reread. */
9184 starting_buffer
= current_buffer
;
9185 first_unbound
= bufsize
+ 1;
9187 /* Build our list of keymaps.
9188 If we recognize a function key and replace its escape sequence in
9189 keybuf with its symbol, or if the sequence starts with a mouse
9190 click and we need to switch buffers, we jump back here to rebuild
9191 the initial keymaps from the current buffer. */
9194 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9196 if (2 > nmaps_allocated
)
9198 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9199 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9200 nmaps_allocated
= 2;
9202 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9204 else if (!NILP (Voverriding_local_map
))
9206 if (2 > nmaps_allocated
)
9208 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9209 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9210 nmaps_allocated
= 2;
9212 submaps
[nmaps
++] = Voverriding_local_map
;
9220 nminor
= current_minor_maps (0, &maps
);
9221 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9223 if (total
> nmaps_allocated
)
9225 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9226 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9227 nmaps_allocated
= total
;
9230 if (!NILP (orig_keymap
))
9231 submaps
[nmaps
++] = orig_keymap
;
9233 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9237 submaps
[nmaps
++] = orig_local_map
;
9239 submaps
[nmaps
++] = current_global_map
;
9241 /* Find an accurate initial value for first_binding. */
9242 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9243 if (! NILP (submaps
[first_binding
]))
9246 /* Start from the beginning in keybuf. */
9249 /* These are no-ops the first time through, but if we restart, they
9250 revert the echo area and this_command_keys to their original state. */
9251 this_command_key_count
= keys_start
;
9252 if (INTERACTIVE
&& t
< mock_input
)
9253 echo_truncate (echo_start
);
9255 /* If the best binding for the current key sequence is a keymap, or
9256 we may be looking at a function key's escape sequence, keep on
9258 while (first_binding
< nmaps
9259 /* Keep reading as long as there's a prefix binding. */
9260 ? !NILP (submaps
[first_binding
])
9261 /* Don't return in the middle of a possible function key sequence,
9262 if the only bindings we found were via case conversion.
9263 Thus, if ESC O a has a function-key-map translation
9264 and ESC o has a binding, don't return after ESC O,
9265 so that we can translate ESC O plus the next character. */
9266 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9269 int used_mouse_menu
= 0;
9271 /* Where the last real key started. If we need to throw away a
9272 key that has expanded into more than one element of keybuf
9273 (say, a mouse click on the mode line which is being treated
9274 as [mode-line (mouse-...)], then we backtrack to this point
9276 int last_real_key_start
;
9278 /* These variables are analogous to echo_start and keys_start;
9279 while those allow us to restart the entire key sequence,
9280 echo_local_start and keys_local_start allow us to throw away
9282 int echo_local_start
, keys_local_start
, local_first_binding
;
9284 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9285 eassert (indec
.start
<= indec
.end
);
9286 eassert (fkey
.start
<= fkey
.end
);
9287 eassert (keytran
.start
<= keytran
.end
);
9288 /* key-translation-map is applied *after* function-key-map
9289 which is itself applied *after* input-decode-map. */
9290 eassert (fkey
.end
<= indec
.start
);
9291 eassert (keytran
.end
<= fkey
.start
);
9293 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9294 first_unbound
< keytran
.start
)
9295 { /* The prefix upto first_unbound has no binding and has
9296 no translation left to do either, so we know it's unbound.
9297 If we don't stop now, we risk staying here indefinitely
9298 (if the user keeps entering fkey or keytran prefixes
9299 like C-c ESC ESC ESC ESC ...) */
9301 for (i
= first_unbound
+ 1; i
< t
; i
++)
9302 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9303 mock_input
= t
- first_unbound
- 1;
9304 indec
.end
= indec
.start
-= first_unbound
+ 1;
9305 indec
.map
= indec
.parent
;
9306 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9307 fkey
.map
= fkey
.parent
;
9308 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9309 keytran
.map
= keytran
.parent
;
9310 goto replay_sequence
;
9314 error ("Key sequence too long");
9317 echo_local_start
= echo_length ();
9318 keys_local_start
= this_command_key_count
;
9319 local_first_binding
= first_binding
;
9322 /* These are no-ops, unless we throw away a keystroke below and
9323 jumped back up to replay_key; in that case, these restore the
9324 variables to their original state, allowing us to replay the
9326 if (INTERACTIVE
&& t
< mock_input
)
9327 echo_truncate (echo_local_start
);
9328 this_command_key_count
= keys_local_start
;
9329 first_binding
= local_first_binding
;
9331 /* By default, assume each event is "real". */
9332 last_real_key_start
= t
;
9334 /* Does mock_input indicate that we are re-reading a key sequence? */
9338 add_command_key (key
);
9339 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9340 && NILP (Fzerop (Vecho_keystrokes
)))
9344 /* If not, we should actually read a character. */
9348 KBOARD
*interrupted_kboard
= current_kboard
;
9349 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9350 key
= read_char (NILP (prompt
), nmaps
,
9351 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9352 &used_mouse_menu
, NULL
);
9353 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9354 /* When switching to a new tty (with a new keyboard),
9355 read_char returns the new buffer, rather than -2
9356 (Bug#5095). This is because `terminal-init-xterm'
9357 calls read-char, which eats the wrong_kboard_jmpbuf
9358 return. Any better way to fix this? -- cyd */
9359 || (interrupted_kboard
!= current_kboard
))
9364 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9365 if (k
== interrupted_kboard
)
9370 /* Don't touch interrupted_kboard when it's been
9372 delayed_switch_frame
= Qnil
;
9373 goto replay_entire_sequence
;
9376 if (!NILP (delayed_switch_frame
))
9378 interrupted_kboard
->kbd_queue
9379 = Fcons (delayed_switch_frame
,
9380 interrupted_kboard
->kbd_queue
);
9381 delayed_switch_frame
= Qnil
;
9385 interrupted_kboard
->kbd_queue
9386 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9388 /* If the side queue is non-empty, ensure it begins with a
9389 switch-frame, so we'll replay it in the right context. */
9390 if (CONSP (interrupted_kboard
->kbd_queue
)
9391 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9392 !(EVENT_HAS_PARAMETERS (key
)
9393 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9397 XSETFRAME (frame
, interrupted_frame
);
9398 interrupted_kboard
->kbd_queue
9399 = Fcons (make_lispy_switch_frame (frame
),
9400 interrupted_kboard
->kbd_queue
);
9403 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9404 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9405 goto replay_entire_sequence
;
9409 /* read_char returns t when it shows a menu and the user rejects it.
9413 unbind_to (count
, Qnil
);
9418 /* read_char returns -1 at the end of a macro.
9419 Emacs 18 handles this by returning immediately with a
9420 zero, so that's what we'll do. */
9421 if (INTEGERP (key
) && XINT (key
) == -1)
9424 /* The Microsoft C compiler can't handle the goto that
9430 /* If the current buffer has been changed from under us, the
9431 keymap may have changed, so replay the sequence. */
9434 timer_resume_idle ();
9437 /* Reset the current buffer from the selected window
9438 in case something changed the former and not the latter.
9439 This is to be more consistent with the behavior
9440 of the command_loop_1. */
9441 if (fix_current_buffer
)
9443 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9445 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9446 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9449 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9450 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9451 goto replay_sequence
;
9454 /* If we have a quit that was typed in another frame, and
9455 quit_throw_to_read_char switched buffers,
9456 replay to get the right keymap. */
9458 && XINT (key
) == quit_char
9459 && current_buffer
!= starting_buffer
)
9462 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9466 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9467 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9468 goto replay_sequence
;
9473 if (EVENT_HAS_PARAMETERS (key
)
9474 /* Either a `switch-frame' or a `select-window' event. */
9475 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9477 /* If we're at the beginning of a key sequence, and the caller
9478 says it's okay, go ahead and return this event. If we're
9479 in the midst of a key sequence, delay it until the end. */
9480 if (t
> 0 || !can_return_switch_frame
)
9482 delayed_switch_frame
= key
;
9488 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9492 /* Clicks in non-text areas get prefixed by the symbol
9493 in their CHAR-ADDRESS field. For example, a click on
9494 the mode line is prefixed by the symbol `mode-line'.
9496 Furthermore, key sequences beginning with mouse clicks
9497 are read using the keymaps of the buffer clicked on, not
9498 the current buffer. So we may have to switch the buffer
9501 When we turn one event into two events, we must make sure
9502 that neither of the two looks like the original--so that,
9503 if we replay the events, they won't be expanded again.
9504 If not for this, such reexpansion could happen either here
9505 or when user programs play with this-command-keys. */
9506 if (EVENT_HAS_PARAMETERS (key
))
9511 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9512 if (EQ (kind
, Qmouse_click
))
9514 Lisp_Object window
, posn
;
9516 window
= POSN_WINDOW (EVENT_START (key
));
9517 posn
= POSN_POSN (EVENT_START (key
));
9520 || (!NILP (fake_prefixed_keys
)
9521 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9523 /* We're looking a second time at an event for which
9524 we generated a fake prefix key. Set
9525 last_real_key_start appropriately. */
9527 last_real_key_start
= t
- 1;
9530 /* Key sequences beginning with mouse clicks are
9531 read using the keymaps in the buffer clicked on,
9532 not the current buffer. If we're at the
9533 beginning of a key sequence, switch buffers. */
9534 if (last_real_key_start
== 0
9536 && BUFFERP (XWINDOW (window
)->buffer
)
9537 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9539 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9543 /* Arrange to go back to the original buffer once we're
9544 done reading the key sequence. Note that we can't
9545 use save_excursion_{save,restore} here, because they
9546 save point as well as the current buffer; we don't
9547 want to save point, because redisplay may change it,
9548 to accommodate a Fset_window_start or something. We
9549 don't want to do this at the top of the function,
9550 because we may get input from a subprocess which
9551 wants to change the selected window and stuff (say,
9553 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9555 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9557 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9558 orig_local_map
= get_local_map (PT
, current_buffer
,
9560 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9561 goto replay_sequence
;
9564 /* For a mouse click, get the local text-property keymap
9565 of the place clicked on, rather than point. */
9566 if (last_real_key_start
== 0
9567 && CONSP (XCDR (key
))
9568 && ! localized_local_map
)
9570 Lisp_Object map_here
, start
, pos
;
9572 localized_local_map
= 1;
9573 start
= EVENT_START (key
);
9575 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9577 pos
= POSN_BUFFER_POSN (start
);
9579 && XINT (pos
) >= BEGV
9580 && XINT (pos
) <= ZV
)
9582 map_here
= get_local_map (XINT (pos
),
9583 current_buffer
, Qlocal_map
);
9584 if (!EQ (map_here
, orig_local_map
))
9586 orig_local_map
= map_here
;
9587 ++localized_local_map
;
9590 map_here
= get_local_map (XINT (pos
),
9591 current_buffer
, Qkeymap
);
9592 if (!EQ (map_here
, orig_keymap
))
9594 orig_keymap
= map_here
;
9595 ++localized_local_map
;
9598 if (localized_local_map
> 1)
9603 goto replay_sequence
;
9609 /* Expand mode-line and scroll-bar events into two events:
9610 use posn as a fake prefix key. */
9612 && (NILP (fake_prefixed_keys
)
9613 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9615 if (t
+ 1 >= bufsize
)
9616 error ("Key sequence too long");
9619 keybuf
[t
+ 1] = key
;
9622 /* Record that a fake prefix key has been generated
9623 for KEY. Don't modify the event; this would
9624 prevent proper action when the event is pushed
9625 back into unread-command-events. */
9626 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9628 /* If on a mode line string with a local keymap,
9629 reconsider the key sequence with that keymap. */
9630 if (string
= POSN_STRING (EVENT_START (key
)),
9631 (CONSP (string
) && STRINGP (XCAR (string
))))
9633 Lisp_Object pos
, map
, map2
;
9635 pos
= XCDR (string
);
9636 string
= XCAR (string
);
9638 && XINT (pos
) < SCHARS (string
))
9640 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9642 orig_local_map
= map
;
9643 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9646 if (!NILP (map
) || !NILP (map2
))
9647 goto replay_sequence
;
9653 else if (NILP (from_string
)
9654 && (string
= POSN_STRING (EVENT_START (key
)),
9655 (CONSP (string
) && STRINGP (XCAR (string
)))))
9657 /* For a click on a string, i.e. overlay string or a
9658 string displayed via the `display' property,
9659 consider `local-map' and `keymap' properties of
9661 Lisp_Object pos
, map
, map2
;
9663 pos
= XCDR (string
);
9664 string
= XCAR (string
);
9666 && XINT (pos
) < SCHARS (string
))
9668 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9670 orig_local_map
= map
;
9671 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9675 if (!NILP (map
) || !NILP (map2
))
9677 from_string
= string
;
9680 goto replay_sequence
;
9685 else if (CONSP (XCDR (key
))
9686 && CONSP (EVENT_START (key
))
9687 && CONSP (XCDR (EVENT_START (key
))))
9691 posn
= POSN_POSN (EVENT_START (key
));
9692 /* Handle menu-bar events:
9693 insert the dummy prefix event `menu-bar'. */
9694 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9696 if (t
+ 1 >= bufsize
)
9697 error ("Key sequence too long");
9701 /* Zap the position in key, so we know that we've
9702 expanded it, and don't try to do so again. */
9703 POSN_SET_POSN (EVENT_START (key
),
9704 Fcons (posn
, Qnil
));
9707 goto replay_sequence
;
9709 else if (CONSP (posn
))
9711 /* We're looking at the second event of a
9712 sequence which we expanded before. Set
9713 last_real_key_start appropriately. */
9714 if (last_real_key_start
== t
&& t
> 0)
9715 last_real_key_start
= t
- 1;
9720 /* We have finally decided that KEY is something we might want
9722 first_binding
= (follow_key (key
,
9723 nmaps
- first_binding
,
9724 submaps
+ first_binding
,
9725 defs
+ first_binding
,
9726 submaps
+ first_binding
)
9729 /* If KEY wasn't bound, we'll try some fallbacks. */
9730 if (first_binding
< nmaps
)
9731 /* This is needed for the following scenario:
9732 event 0: a down-event that gets dropped by calling replay_key.
9733 event 1: some normal prefix like C-h.
9734 After event 0, first_unbound is 0, after event 1 indec.start,
9735 fkey.start, and keytran.start are all 1, so when we see that
9736 C-h is bound, we need to update first_unbound. */
9737 first_unbound
= max (t
+ 1, first_unbound
);
9742 /* Remember the position to put an upper bound on indec.start. */
9743 first_unbound
= min (t
, first_unbound
);
9745 head
= EVENT_HEAD (key
);
9746 if (help_char_p (head
) && t
> 0)
9748 read_key_sequence_cmd
= Vprefix_help_command
;
9750 last_nonmenu_event
= key
;
9751 /* The Microsoft C compiler can't handle the goto that
9759 Lisp_Object breakdown
;
9762 breakdown
= parse_modifiers (head
);
9763 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9764 /* Attempt to reduce an unbound mouse event to a simpler
9765 event that is bound:
9766 Drags reduce to clicks.
9767 Double-clicks reduce to clicks.
9768 Triple-clicks reduce to double-clicks, then to clicks.
9769 Down-clicks are eliminated.
9770 Double-downs reduce to downs, then are eliminated.
9771 Triple-downs reduce to double-downs, then to downs,
9772 then are eliminated. */
9773 if (modifiers
& (down_modifier
| drag_modifier
9774 | double_modifier
| triple_modifier
))
9776 while (modifiers
& (down_modifier
| drag_modifier
9777 | double_modifier
| triple_modifier
))
9779 Lisp_Object new_head
, new_click
;
9780 if (modifiers
& triple_modifier
)
9781 modifiers
^= (double_modifier
| triple_modifier
);
9782 else if (modifiers
& double_modifier
)
9783 modifiers
&= ~double_modifier
;
9784 else if (modifiers
& drag_modifier
)
9785 modifiers
&= ~drag_modifier
;
9788 /* Dispose of this `down' event by simply jumping
9789 back to replay_key, to get another event.
9791 Note that if this event came from mock input,
9792 then just jumping back to replay_key will just
9793 hand it to us again. So we have to wipe out any
9796 We could delete keybuf[t] and shift everything
9797 after that to the left by one spot, but we'd also
9798 have to fix up any variable that points into
9799 keybuf, and shifting isn't really necessary
9802 Adding prefixes for non-textual mouse clicks
9803 creates two characters of mock input, and both
9804 must be thrown away. If we're only looking at
9805 the prefix now, we can just jump back to
9806 replay_key. On the other hand, if we've already
9807 processed the prefix, and now the actual click
9808 itself is giving us trouble, then we've lost the
9809 state of the keymaps we want to backtrack to, and
9810 we need to replay the whole sequence to rebuild
9813 Beyond that, only function key expansion could
9814 create more than two keys, but that should never
9815 generate mouse events, so it's okay to zero
9816 mock_input in that case too.
9818 FIXME: The above paragraph seems just plain
9819 wrong, if you consider things like
9820 xterm-mouse-mode. -stef
9822 Isn't this just the most wonderful code ever? */
9824 /* If mock_input > t + 1, the above simplification
9825 will actually end up dropping keys on the floor.
9826 This is probably OK for now, but even
9827 if mock_input <= t + 1, we need to adjust indec,
9829 Typical case [header-line down-mouse-N]:
9830 mock_input = 2, t = 1, fkey.end = 1,
9831 last_real_key_start = 0. */
9832 if (indec
.end
> last_real_key_start
)
9834 indec
.end
= indec
.start
9835 = min (last_real_key_start
, indec
.start
);
9836 indec
.map
= indec
.parent
;
9837 if (fkey
.end
> last_real_key_start
)
9839 fkey
.end
= fkey
.start
9840 = min (last_real_key_start
, fkey
.start
);
9841 fkey
.map
= fkey
.parent
;
9842 if (keytran
.end
> last_real_key_start
)
9844 keytran
.end
= keytran
.start
9845 = min (last_real_key_start
, keytran
.start
);
9846 keytran
.map
= keytran
.parent
;
9850 if (t
== last_real_key_start
)
9857 mock_input
= last_real_key_start
;
9858 goto replay_sequence
;
9863 = apply_modifiers (modifiers
, XCAR (breakdown
));
9865 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9867 /* Look for a binding for this new key. follow_key
9868 promises that it didn't munge submaps the
9869 last time we called it, since key was unbound. */
9871 = (follow_key (new_click
,
9872 nmaps
- local_first_binding
,
9873 submaps
+ local_first_binding
,
9874 defs
+ local_first_binding
,
9875 submaps
+ local_first_binding
)
9876 + local_first_binding
);
9878 /* If that click is bound, go for it. */
9879 if (first_binding
< nmaps
)
9884 /* Otherwise, we'll leave key set to the drag event. */
9891 /* Normally, last_nonmenu_event gets the previous key we read.
9892 But when a mouse popup menu is being used,
9893 we don't update last_nonmenu_event; it continues to hold the mouse
9894 event that preceded the first level of menu. */
9895 if (!used_mouse_menu
)
9896 last_nonmenu_event
= key
;
9898 /* Record what part of this_command_keys is the current key sequence. */
9899 this_single_command_key_start
= this_command_key_count
- t
;
9901 /* Look for this sequence in input-decode-map.
9902 Scan from indec.end until we find a bound suffix. */
9903 while (indec
.end
< t
)
9905 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9908 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9909 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9914 mock_input
= diff
+ max (t
, mock_input
);
9915 goto replay_sequence
;
9919 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9920 && indec
.start
>= t
)
9921 /* There is a binding and it's not a prefix.
9922 (and it doesn't have any input-decode-map translation pending).
9923 There is thus no function-key in this sequence.
9924 Moving fkey.start is important in this case to allow keytran.start
9925 to go over the sequence before we return (since we keep the
9926 invariant that keytran.end <= fkey.start). */
9929 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9932 /* If the sequence is unbound, see if we can hang a function key
9933 off the end of it. */
9934 /* Continue scan from fkey.end until we find a bound suffix. */
9935 while (fkey
.end
< indec
.start
)
9937 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9940 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9941 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9942 max (t
, mock_input
),
9943 /* If there's a binding (i.e.
9944 first_binding >= nmaps) we don't want
9945 to apply this function-key-mapping. */
9946 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9951 mock_input
= diff
+ max (t
, mock_input
);
9952 /* Adjust the input-decode-map counters. */
9954 indec
.start
+= diff
;
9956 goto replay_sequence
;
9960 /* Look for this sequence in key-translation-map.
9961 Scan from keytran.end until we find a bound suffix. */
9962 while (keytran
.end
< fkey
.start
)
9964 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9967 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9968 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9973 mock_input
= diff
+ max (t
, mock_input
);
9974 /* Adjust the function-key-map and input-decode-map counters. */
9976 indec
.start
+= diff
;
9980 goto replay_sequence
;
9984 /* If KEY is not defined in any of the keymaps,
9985 and cannot be part of a function key or translation,
9986 and is an upper case letter
9987 use the corresponding lower-case letter instead. */
9988 if (first_binding
>= nmaps
9989 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9991 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9992 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9993 || (XINT (key
) & shift_modifier
)))
9995 Lisp_Object new_key
;
9997 original_uppercase
= key
;
9998 original_uppercase_position
= t
- 1;
10000 if (XINT (key
) & shift_modifier
)
10001 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10003 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10004 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10006 /* We have to do this unconditionally, regardless of whether
10007 the lower-case char is defined in the keymaps, because they
10008 might get translated through function-key-map. */
10009 keybuf
[t
- 1] = new_key
;
10010 mock_input
= max (t
, mock_input
);
10011 shift_translated
= 1;
10013 goto replay_sequence
;
10015 /* If KEY is not defined in any of the keymaps,
10016 and cannot be part of a function key or translation,
10017 and is a shifted function key,
10018 use the corresponding unshifted function key instead. */
10019 if (first_binding
>= nmaps
10020 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10022 Lisp_Object breakdown
= parse_modifiers (key
);
10024 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10026 if (modifiers
& shift_modifier
10027 /* Treat uppercase keys as shifted. */
10029 && (KEY_TO_CHAR (key
)
10030 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10031 && UPPERCASEP (KEY_TO_CHAR (key
))))
10033 Lisp_Object new_key
10034 = (modifiers
& shift_modifier
10035 ? apply_modifiers (modifiers
& ~shift_modifier
,
10037 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10039 original_uppercase
= key
;
10040 original_uppercase_position
= t
- 1;
10042 /* We have to do this unconditionally, regardless of whether
10043 the lower-case char is defined in the keymaps, because they
10044 might get translated through function-key-map. */
10045 keybuf
[t
- 1] = new_key
;
10046 mock_input
= max (t
, mock_input
);
10047 /* Reset fkey (and consequently keytran) to apply
10048 function-key-map on the result, so that S-backspace is
10049 correctly mapped to DEL (via backspace). OTOH,
10050 input-decode-map doesn't need to go through it again. */
10051 fkey
.start
= fkey
.end
= 0;
10052 keytran
.start
= keytran
.end
= 0;
10053 shift_translated
= 1;
10055 goto replay_sequence
;
10060 read_key_sequence_cmd
= (first_binding
< nmaps
10061 ? defs
[first_binding
]
10064 unread_switch_frame
= delayed_switch_frame
;
10065 unbind_to (count
, Qnil
);
10067 /* Don't downcase the last character if the caller says don't.
10068 Don't downcase it if the result is undefined, either. */
10069 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10071 && t
- 1 == original_uppercase_position
)
10073 keybuf
[t
- 1] = original_uppercase
;
10074 shift_translated
= 0;
10077 if (shift_translated
)
10078 Vthis_command_keys_shift_translated
= Qt
;
10080 /* Occasionally we fabricate events, perhaps by expanding something
10081 according to function-key-map, or by adding a prefix symbol to a
10082 mouse click in the scroll bar or modeline. In this cases, return
10083 the entire generated key sequence, even if we hit an unbound
10084 prefix or a definition before the end. This means that you will
10085 be able to push back the event properly, and also means that
10086 read-key-sequence will always return a logical unit.
10089 for (; t
< mock_input
; t
++)
10091 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10092 && NILP (Fzerop (Vecho_keystrokes
)))
10093 echo_char (keybuf
[t
]);
10094 add_command_key (keybuf
[t
]);
10101 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10102 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10103 The sequence is sufficient to specify a non-prefix command in the
10104 current local and global maps.
10106 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10107 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10108 as a continuation of the previous key.
10110 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10111 convert the last event to lower case. (Normally any upper case event
10112 is converted to lower case if the original event is undefined and the lower
10113 case equivalent is defined.) A non-nil value is appropriate for reading
10114 a key sequence to be defined.
10116 A C-g typed while in this function is treated like any other character,
10117 and `quit-flag' is not set.
10119 If the key sequence starts with a mouse click, then the sequence is read
10120 using the keymaps of the buffer of the window clicked in, not the buffer
10121 of the selected window as normal.
10123 `read-key-sequence' drops unbound button-down events, since you normally
10124 only care about the click or drag events which follow them. If a drag
10125 or multi-click event is unbound, but the corresponding click event would
10126 be bound, `read-key-sequence' turns the event into a click event at the
10127 drag's starting position. This means that you don't have to distinguish
10128 between click and drag, double, or triple events unless you want to.
10130 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10131 lines separating windows, and scroll bars with imaginary keys
10132 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10134 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10135 function will process a switch-frame event if the user switches frames
10136 before typing anything. If the user switches frames in the middle of a
10137 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10138 is nil, then the event will be put off until after the current key sequence.
10140 `read-key-sequence' checks `function-key-map' for function key
10141 sequences, where they wouldn't conflict with ordinary bindings. See
10142 `function-key-map' for more details.
10144 The optional fifth argument COMMAND-LOOP, if non-nil, means
10145 that this key sequence is being read by something that will
10146 read commands one after another. It should be nil if the caller
10147 will read just one key sequence. */)
10148 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10150 Lisp_Object keybuf
[30];
10152 struct gcpro gcpro1
;
10153 int count
= SPECPDL_INDEX ();
10155 if (!NILP (prompt
))
10156 CHECK_STRING (prompt
);
10159 specbind (Qinput_method_exit_on_first_char
,
10160 (NILP (command_loop
) ? Qt
: Qnil
));
10161 specbind (Qinput_method_use_echo_area
,
10162 (NILP (command_loop
) ? Qt
: Qnil
));
10164 memset (keybuf
, 0, sizeof keybuf
);
10165 GCPRO1 (keybuf
[0]);
10166 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10168 if (NILP (continue_echo
))
10170 this_command_key_count
= 0;
10171 this_command_key_count_reset
= 0;
10172 this_single_command_key_start
= 0;
10175 #ifdef HAVE_WINDOW_SYSTEM
10176 if (display_hourglass_p
)
10177 cancel_hourglass ();
10180 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10181 prompt
, ! NILP (dont_downcase_last
),
10182 ! NILP (can_return_switch_frame
), 0);
10184 #if 0 /* The following is fine for code reading a key sequence and
10185 then proceeding with a lenghty computation, but it's not good
10186 for code reading keys in a loop, like an input method. */
10187 #ifdef HAVE_WINDOW_SYSTEM
10188 if (display_hourglass_p
)
10189 start_hourglass ();
10199 return unbind_to (count
, make_event_array (i
, keybuf
));
10202 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10203 Sread_key_sequence_vector
, 1, 5, 0,
10204 doc
: /* Like `read-key-sequence' but always return a vector. */)
10205 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10207 Lisp_Object keybuf
[30];
10209 struct gcpro gcpro1
;
10210 int count
= SPECPDL_INDEX ();
10212 if (!NILP (prompt
))
10213 CHECK_STRING (prompt
);
10216 specbind (Qinput_method_exit_on_first_char
,
10217 (NILP (command_loop
) ? Qt
: Qnil
));
10218 specbind (Qinput_method_use_echo_area
,
10219 (NILP (command_loop
) ? Qt
: Qnil
));
10221 memset (keybuf
, 0, sizeof keybuf
);
10222 GCPRO1 (keybuf
[0]);
10223 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10225 if (NILP (continue_echo
))
10227 this_command_key_count
= 0;
10228 this_command_key_count_reset
= 0;
10229 this_single_command_key_start
= 0;
10232 #ifdef HAVE_WINDOW_SYSTEM
10233 if (display_hourglass_p
)
10234 cancel_hourglass ();
10237 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10238 prompt
, ! NILP (dont_downcase_last
),
10239 ! NILP (can_return_switch_frame
), 0);
10241 #ifdef HAVE_WINDOW_SYSTEM
10242 if (display_hourglass_p
)
10243 start_hourglass ();
10252 return unbind_to (count
, Fvector (i
, keybuf
));
10255 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10256 doc
: /* Execute CMD as an editor command.
10257 CMD must be a symbol that satisfies the `commandp' predicate.
10258 Optional second arg RECORD-FLAG non-nil
10259 means unconditionally put this command in `command-history'.
10260 Otherwise, that is done only if an arg is read using the minibuffer.
10261 The argument KEYS specifies the value to use instead of (this-command-keys)
10262 when reading the arguments; if it is nil, (this-command-keys) is used.
10263 The argument SPECIAL, if non-nil, means that this command is executing
10264 a special event, so ignore the prefix argument and don't clear it. */)
10265 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10267 register Lisp_Object final
;
10268 register Lisp_Object tem
;
10269 Lisp_Object prefixarg
;
10271 debug_on_next_call
= 0;
10273 if (NILP (special
))
10275 prefixarg
= current_kboard
->Vprefix_arg
;
10276 Vcurrent_prefix_arg
= prefixarg
;
10277 current_kboard
->Vprefix_arg
= Qnil
;
10284 tem
= Fget (cmd
, Qdisabled
);
10285 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10287 tem
= Fsymbol_value (Qdisabled_command_function
);
10289 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10295 final
= Findirect_function (cmd
, Qnil
);
10297 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10299 struct gcpro gcpro1
, gcpro2
;
10301 GCPRO2 (cmd
, prefixarg
);
10302 do_autoload (final
, cmd
);
10309 if (STRINGP (final
) || VECTORP (final
))
10311 /* If requested, place the macro in the command history. For
10312 other sorts of commands, call-interactively takes care of
10314 if (!NILP (record_flag
))
10317 = Fcons (Fcons (Qexecute_kbd_macro
,
10318 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10321 /* Don't keep command history around forever. */
10322 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10324 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10326 XSETCDR (tem
, Qnil
);
10330 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10333 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10334 /* Don't call Fcall_interactively directly because we want to make
10335 sure the backtrace has an entry for `call-interactively'.
10336 For the same reason, pass `cmd' rather than `final'. */
10337 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10344 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10346 doc
: /* Read function name, then read its arguments and call it.
10348 To pass a numeric argument to the command you are invoking with, specify
10349 the numeric argument to this command.
10351 Noninteractively, the argument PREFIXARG is the prefix argument to
10352 give to the command you invoke, if it asks for an argument. */)
10353 (Lisp_Object prefixarg
)
10355 Lisp_Object function
;
10356 EMACS_INT saved_last_point_position
;
10357 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10358 Lisp_Object bindings
, value
;
10359 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10360 #ifdef HAVE_WINDOW_SYSTEM
10361 /* The call to Fcompleting_read will start and cancel the hourglass,
10362 but if the hourglass was already scheduled, this means that no
10363 hourglass will be shown for the actual M-x command itself.
10364 So we restart it if it is already scheduled. Note that checking
10365 hourglass_shown_p is not enough, normally the hourglass is not shown,
10366 just scheduled to be shown. */
10367 int hstarted
= hourglass_started ();
10370 saved_keys
= Fvector (this_command_key_count
,
10371 XVECTOR (this_command_keys
)->contents
);
10372 saved_last_point_position_buffer
= last_point_position_buffer
;
10373 saved_last_point_position
= last_point_position
;
10374 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10376 function
= call0 (intern ("read-extended-command"));
10378 #ifdef HAVE_WINDOW_SYSTEM
10379 if (hstarted
) start_hourglass ();
10382 if (STRINGP (function
) && SCHARS (function
) == 0)
10383 error ("No command name given");
10385 /* Set this_command_keys to the concatenation of saved_keys and
10386 function, followed by a RET. */
10391 this_command_key_count
= 0;
10392 this_command_key_count_reset
= 0;
10393 this_single_command_key_start
= 0;
10395 keys
= XVECTOR (saved_keys
)->contents
;
10396 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10397 add_command_key (keys
[i
]);
10399 for (i
= 0; i
< SCHARS (function
); i
++)
10400 add_command_key (Faref (function
, make_number (i
)));
10402 add_command_key (make_number ('\015'));
10405 last_point_position
= saved_last_point_position
;
10406 last_point_position_buffer
= saved_last_point_position_buffer
;
10410 function
= Fintern (function
, Qnil
);
10411 current_kboard
->Vprefix_arg
= prefixarg
;
10412 Vthis_command
= function
;
10413 real_this_command
= function
;
10415 /* If enabled, show which key runs this command. */
10416 if (!NILP (Vsuggest_key_bindings
)
10417 && NILP (Vexecuting_kbd_macro
)
10418 && SYMBOLP (function
))
10419 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10425 GCPRO3 (bindings
, value
, function
);
10426 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10428 /* If the command has a key binding, print it now. */
10429 if (!NILP (bindings
)
10430 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10433 /* But first wait, and skip the message if there is input. */
10434 Lisp_Object waited
;
10436 /* If this command displayed something in the echo area;
10437 wait a few seconds, then display our suggestion message. */
10438 if (NILP (echo_area_buffer
[0]))
10439 waited
= sit_for (make_number (0), 0, 2);
10440 else if (NUMBERP (Vsuggest_key_bindings
))
10441 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10443 waited
= sit_for (make_number (2), 0, 2);
10445 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10447 Lisp_Object binding
;
10449 int message_p
= push_message ();
10450 int count
= SPECPDL_INDEX ();
10452 record_unwind_protect (pop_message_unwind
, Qnil
);
10453 binding
= Fkey_description (bindings
, Qnil
);
10456 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10459 sprintf (newmessage
, "You can run the command `%s' with %s",
10460 SDATA (SYMBOL_NAME (function
)),
10462 message2_nolog (newmessage
,
10463 strlen (newmessage
),
10464 STRING_MULTIBYTE (binding
));
10465 if (NUMBERP (Vsuggest_key_bindings
))
10466 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10468 waited
= sit_for (make_number (2), 0, 2);
10470 if (!NILP (waited
) && message_p
)
10471 restore_message ();
10473 unbind_to (count
, Qnil
);
10477 RETURN_UNGCPRO (value
);
10481 /* Return nonzero if input events are pending. */
10484 detect_input_pending (void)
10486 if (!input_pending
)
10487 get_input_pending (&input_pending
, 0);
10489 return input_pending
;
10492 /* Return nonzero if input events other than mouse movements are
10496 detect_input_pending_ignore_squeezables (void)
10498 if (!input_pending
)
10499 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10501 return input_pending
;
10504 /* Return nonzero if input events are pending, and run any pending timers. */
10507 detect_input_pending_run_timers (int do_display
)
10509 int old_timers_run
= timers_run
;
10511 if (!input_pending
)
10512 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10514 if (old_timers_run
!= timers_run
&& do_display
)
10516 redisplay_preserve_echo_area (8);
10517 /* The following fixes a bug when using lazy-lock with
10518 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10519 from an idle timer function. The symptom of the bug is that
10520 the cursor sometimes doesn't become visible until the next X
10521 event is processed. --gerd. */
10523 Lisp_Object tail
, frame
;
10524 FOR_EACH_FRAME (tail
, frame
)
10525 if (FRAME_RIF (XFRAME (frame
)))
10526 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10530 return input_pending
;
10533 /* This is called in some cases before a possible quit.
10534 It cases the next call to detect_input_pending to recompute input_pending.
10535 So calling this function unnecessarily can't do any harm. */
10538 clear_input_pending (void)
10543 /* Return nonzero if there are pending requeued events.
10544 This isn't used yet. The hope is to make wait_reading_process_output
10545 call it, and return if it runs Lisp code that unreads something.
10546 The problem is, kbd_buffer_get_event needs to be fixed to know what
10547 to do in that case. It isn't trivial. */
10550 requeued_events_pending_p (void)
10552 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10556 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10557 doc
: /* Return t if command input is currently available with no wait.
10558 Actually, the value is nil only if we can be sure that no input is available;
10559 if there is a doubt, the value is t. */)
10562 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10563 || !NILP (Vunread_post_input_method_events
)
10564 || !NILP (Vunread_input_method_events
))
10567 get_input_pending (&input_pending
,
10568 READABLE_EVENTS_DO_TIMERS_NOW
10569 | READABLE_EVENTS_FILTER_EVENTS
);
10570 return input_pending
> 0 ? Qt
: Qnil
;
10573 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10574 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10577 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10580 if (total_keys
< NUM_RECENT_KEYS
)
10581 return Fvector (total_keys
, keys
);
10584 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10585 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10586 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10587 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10588 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10593 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10594 doc
: /* Return the key sequence that invoked this command.
10595 However, if the command has called `read-key-sequence', it returns
10596 the last key sequence that has been read.
10597 The value is a string or a vector.
10599 See also `this-command-keys-vector'. */)
10602 return make_event_array (this_command_key_count
,
10603 XVECTOR (this_command_keys
)->contents
);
10606 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10607 doc
: /* Return the key sequence that invoked this command, as a vector.
10608 However, if the command has called `read-key-sequence', it returns
10609 the last key sequence that has been read.
10611 See also `this-command-keys'. */)
10614 return Fvector (this_command_key_count
,
10615 XVECTOR (this_command_keys
)->contents
);
10618 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10619 Sthis_single_command_keys
, 0, 0, 0,
10620 doc
: /* Return the key sequence that invoked this command.
10621 More generally, it returns the last key sequence read, either by
10622 the command loop or by `read-key-sequence'.
10623 Unlike `this-command-keys', this function's value
10624 does not include prefix arguments.
10625 The value is always a vector. */)
10628 return Fvector (this_command_key_count
10629 - this_single_command_key_start
,
10630 (XVECTOR (this_command_keys
)->contents
10631 + this_single_command_key_start
));
10634 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10635 Sthis_single_command_raw_keys
, 0, 0, 0,
10636 doc
: /* Return the raw events that were read for this command.
10637 More generally, it returns the last key sequence read, either by
10638 the command loop or by `read-key-sequence'.
10639 Unlike `this-single-command-keys', this function's value
10640 shows the events before all translations (except for input methods).
10641 The value is always a vector. */)
10644 return Fvector (raw_keybuf_count
,
10645 (XVECTOR (raw_keybuf
)->contents
));
10648 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10649 Sreset_this_command_lengths
, 0, 0, 0,
10650 doc
: /* Make the unread events replace the last command and echo.
10651 Used in `universal-argument-other-key'.
10653 `universal-argument-other-key' rereads the event just typed.
10654 It then gets translated through `function-key-map'.
10655 The translated event has to replace the real events,
10656 both in the value of (this-command-keys) and in echoing.
10657 To achieve this, `universal-argument-other-key' calls
10658 `reset-this-command-lengths', which discards the record of reading
10659 these events the first time. */)
10662 this_command_key_count
= before_command_key_count
;
10663 if (this_command_key_count
< this_single_command_key_start
)
10664 this_single_command_key_start
= this_command_key_count
;
10666 echo_truncate (before_command_echo_length
);
10668 /* Cause whatever we put into unread-command-events
10669 to echo as if it were being freshly read from the keyboard. */
10670 this_command_key_count_reset
= 1;
10675 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10676 Sclear_this_command_keys
, 0, 1, 0,
10677 doc
: /* Clear out the vector that `this-command-keys' returns.
10678 Also clear the record of the last 100 events, unless optional arg
10679 KEEP-RECORD is non-nil. */)
10680 (Lisp_Object keep_record
)
10684 this_command_key_count
= 0;
10685 this_command_key_count_reset
= 0;
10687 if (NILP (keep_record
))
10689 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10690 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10692 recent_keys_index
= 0;
10697 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10698 doc
: /* Return the current depth in recursive edits. */)
10702 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10706 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10707 "FOpen dribble file: ",
10708 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10709 If FILE is nil, close any open dribble file. */)
10721 file
= Fexpand_file_name (file
, Qnil
);
10722 dribble
= fopen (SDATA (file
), "w");
10724 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10729 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10730 doc
: /* Discard the contents of the terminal input buffer.
10731 Also end any kbd macro being defined. */)
10734 if (!NILP (current_kboard
->defining_kbd_macro
))
10736 /* Discard the last command from the macro. */
10737 Fcancel_kbd_macro_events ();
10741 update_mode_lines
++;
10743 Vunread_command_events
= Qnil
;
10744 unread_command_char
= -1;
10746 discard_tty_input ();
10748 kbd_fetch_ptr
= kbd_store_ptr
;
10754 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10755 doc
: /* Stop Emacs and return to superior process. You can resume later.
10756 If `cannot-suspend' is non-nil, or if the system doesn't support job
10757 control, run a subshell instead.
10759 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10760 to be read as terminal input by Emacs's parent, after suspension.
10762 Before suspending, run the normal hook `suspend-hook'.
10763 After resumption run the normal hook `suspend-resume-hook'.
10765 Some operating systems cannot stop the Emacs process and resume it later.
10766 On such systems, Emacs starts a subshell instead of suspending. */)
10767 (Lisp_Object stuffstring
)
10769 int count
= SPECPDL_INDEX ();
10770 int old_height
, old_width
;
10772 struct gcpro gcpro1
;
10774 if (tty_list
&& tty_list
->next
)
10775 error ("There are other tty frames open; close them before suspending Emacs");
10777 if (!NILP (stuffstring
))
10778 CHECK_STRING (stuffstring
);
10780 /* Run the functions in suspend-hook. */
10781 if (!NILP (Vrun_hooks
))
10782 call1 (Vrun_hooks
, intern ("suspend-hook"));
10784 GCPRO1 (stuffstring
);
10785 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10786 reset_all_sys_modes ();
10787 /* sys_suspend can get an error if it tries to fork a subshell
10788 and the system resources aren't available for that. */
10789 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10791 stuff_buffered_input (stuffstring
);
10792 if (cannot_suspend
)
10796 unbind_to (count
, Qnil
);
10798 /* Check if terminal/window size has changed.
10799 Note that this is not useful when we are running directly
10800 with a window system; but suspend should be disabled in that case. */
10801 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10802 if (width
!= old_width
|| height
!= old_height
)
10803 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10805 /* Run suspend-resume-hook. */
10806 if (!NILP (Vrun_hooks
))
10807 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10813 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10814 Then in any case stuff anything Emacs has read ahead and not used. */
10817 stuff_buffered_input (Lisp_Object stuffstring
)
10819 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10820 register unsigned char *p
;
10822 if (STRINGP (stuffstring
))
10824 register EMACS_INT count
;
10826 p
= SDATA (stuffstring
);
10827 count
= SBYTES (stuffstring
);
10828 while (count
-- > 0)
10833 /* Anything we have read ahead, put back for the shell to read. */
10834 /* ?? What should this do when we have multiple keyboards??
10835 Should we ignore anything that was typed in at the "wrong" kboard?
10837 rms: we should stuff everything back into the kboard
10839 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10842 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10843 kbd_fetch_ptr
= kbd_buffer
;
10844 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10845 stuff_char (kbd_fetch_ptr
->code
);
10847 clear_event (kbd_fetch_ptr
);
10851 #endif /* SIGTSTP */
10855 set_waiting_for_input (struct timeval
*time_to_clear
)
10857 input_available_clear_time
= time_to_clear
;
10859 /* Tell handle_interrupt to throw back to read_char, */
10860 waiting_for_input
= 1;
10862 /* If handle_interrupt was called before and buffered a C-g,
10863 make it run again now, to avoid timing error. */
10864 if (!NILP (Vquit_flag
))
10865 quit_throw_to_read_char ();
10869 clear_waiting_for_input (void)
10871 /* Tell handle_interrupt not to throw back to read_char, */
10872 waiting_for_input
= 0;
10873 input_available_clear_time
= 0;
10876 /* The SIGINT handler.
10878 If we have a frame on the controlling tty, we assume that the
10879 SIGINT was generated by C-g, so we call handle_interrupt.
10880 Otherwise, the handler kills Emacs. */
10883 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10884 /* compilers complain in signal calls. */
10886 /* Must preserve main program's value of errno. */
10887 int old_errno
= errno
;
10888 struct terminal
*terminal
;
10890 SIGNAL_THREAD_CHECK (signalnum
);
10892 /* See if we have an active terminal on our controlling tty. */
10893 terminal
= get_named_tty ("/dev/tty");
10896 /* If there are no frames there, let's pretend that we are a
10897 well-behaving UN*X program and quit. */
10898 Fkill_emacs (Qnil
);
10902 /* Otherwise, the SIGINT was probably generated by C-g. */
10904 /* Set internal_last_event_frame to the top frame of the
10905 controlling tty, if we have a frame there. We disable the
10906 interrupt key on secondary ttys, so the SIGINT must have come
10907 from the controlling tty. */
10908 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10910 handle_interrupt ();
10916 /* This routine is called at interrupt level in response to C-g.
10918 It is called from the SIGINT handler or kbd_buffer_store_event.
10920 If `waiting_for_input' is non zero, then unless `echoing' is
10921 nonzero, immediately throw back to read_char.
10923 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10924 eval to throw, when it gets a chance. If quit-flag is already
10925 non-nil, it stops the job right away. */
10928 handle_interrupt (void)
10934 /* XXX This code needs to be revised for multi-tty support. */
10935 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10937 /* If SIGINT isn't blocked, don't let us be interrupted by
10938 another SIGINT, it might be harmful due to non-reentrancy
10939 in I/O functions. */
10940 sigblock (sigmask (SIGINT
));
10943 reset_all_sys_modes ();
10945 #ifdef SIGTSTP /* Support possible in later USG versions */
10947 * On systems which can suspend the current process and return to the original
10948 * shell, this command causes the user to end up back at the shell.
10949 * The "Auto-save" and "Abort" questions are not asked until
10950 * the user elects to return to emacs, at which point he can save the current
10951 * job and either dump core or continue.
10955 /* Perhaps should really fork an inferior shell?
10956 But that would not provide any way to get back
10957 to the original shell, ever. */
10958 printf ("No support for stopping a process on this operating system;\n");
10959 printf ("you can continue or abort.\n");
10960 #endif /* not SIGTSTP */
10962 /* We must remain inside the screen area when the internal terminal
10963 is used. Note that [Enter] is not echoed by dos. */
10964 cursor_to (SELECTED_FRAME (), 0, 0);
10966 /* It doesn't work to autosave while GC is in progress;
10967 the code used for auto-saving doesn't cope with the mark bit. */
10968 if (!gc_in_progress
)
10970 printf ("Auto-save? (y or n) ");
10972 if (((c
= getchar ()) & ~040) == 'Y')
10974 Fdo_auto_save (Qt
, Qnil
);
10976 printf ("\r\nAuto-save done");
10977 #else /* not MSDOS */
10978 printf ("Auto-save done\n");
10979 #endif /* not MSDOS */
10981 while (c
!= '\n') c
= getchar ();
10985 /* During GC, it must be safe to reenable quitting again. */
10986 Vinhibit_quit
= Qnil
;
10989 #endif /* not MSDOS */
10990 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10991 printf ("but will instead do a real quit after garbage collection ends\r\n");
10996 printf ("\r\nAbort? (y or n) ");
10997 #else /* not MSDOS */
10998 printf ("Abort (and dump core)? (y or n) ");
10999 #endif /* not MSDOS */
11001 if (((c
= getchar ()) & ~040) == 'Y')
11003 while (c
!= '\n') c
= getchar ();
11005 printf ("\r\nContinuing...\r\n");
11006 #else /* not MSDOS */
11007 printf ("Continuing...\n");
11008 #endif /* not MSDOS */
11010 init_all_sys_modes ();
11015 /* If executing a function that wants to be interrupted out of
11016 and the user has not deferred quitting by binding `inhibit-quit'
11017 then quit right away. */
11018 if (immediate_quit
&& NILP (Vinhibit_quit
))
11020 struct gl_state_s saved
;
11021 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11023 immediate_quit
= 0;
11026 GCPRO4 (saved
.object
, saved
.global_code
,
11027 saved
.current_syntax_table
, saved
.old_prop
);
11028 Fsignal (Qquit
, Qnil
);
11029 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11034 /* Else request quit when it's safe */
11038 /* TODO: The longjmp in this call throws the NS event loop integration off,
11039 and it seems to do fine without this. Probably some attention
11040 needs to be paid to the setting of waiting_for_input in
11041 wait_reading_process_output() under HAVE_NS because of the call
11042 to ns_select there (needed because otherwise events aren't picked up
11043 outside of polling since we don't get SIGIO like X and we don't have a
11044 separate event loop thread like W32. */
11046 if (waiting_for_input
&& !echoing
)
11047 quit_throw_to_read_char ();
11051 /* Handle a C-g by making read_char return C-g. */
11054 quit_throw_to_read_char (void)
11057 /* Prevent another signal from doing this before we finish. */
11058 clear_waiting_for_input ();
11061 Vunread_command_events
= Qnil
;
11062 unread_command_char
= -1;
11064 #if 0 /* Currently, sit_for is called from read_char without turning
11065 off polling. And that can call set_waiting_for_input.
11066 It seems to be harmless. */
11067 #ifdef POLL_FOR_INPUT
11068 /* May be > 1 if in recursive minibuffer. */
11069 if (poll_suppress_count
== 0)
11073 if (FRAMEP (internal_last_event_frame
)
11074 && !EQ (internal_last_event_frame
, selected_frame
))
11075 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11078 _longjmp (getcjmp
, 1);
11081 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11082 doc
: /* Set interrupt mode of reading keyboard input.
11083 If INTERRUPT is non-nil, Emacs will use input interrupts;
11084 otherwise Emacs uses CBREAK mode.
11086 See also `current-input-mode'. */)
11087 (Lisp_Object interrupt
)
11089 int new_interrupt_input
;
11091 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11092 #ifdef HAVE_X_WINDOWS
11093 if (x_display_list
!= NULL
)
11095 /* When using X, don't give the user a real choice,
11096 because we haven't implemented the mechanisms to support it. */
11097 new_interrupt_input
= 1;
11100 #endif /* HAVE_X_WINDOWS */
11101 new_interrupt_input
= !NILP (interrupt
);
11102 #else /* not SIGIO */
11103 new_interrupt_input
= 0;
11104 #endif /* not SIGIO */
11106 if (new_interrupt_input
!= interrupt_input
)
11108 #ifdef POLL_FOR_INPUT
11112 /* this causes startup screen to be restored and messes with the mouse */
11113 reset_all_sys_modes ();
11115 interrupt_input
= new_interrupt_input
;
11117 init_all_sys_modes ();
11120 #ifdef POLL_FOR_INPUT
11121 poll_suppress_count
= 1;
11128 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11129 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11130 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11131 C-q in key sequences.
11133 This setting only has an effect on tty terminals and only when
11134 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11136 See also `current-input-mode'. */)
11137 (Lisp_Object flow
, Lisp_Object terminal
)
11139 struct terminal
*t
= get_terminal (terminal
, 1);
11140 struct tty_display_info
*tty
;
11141 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11143 tty
= t
->display_info
.tty
;
11145 if (tty
->flow_control
!= !NILP (flow
))
11148 /* this causes startup screen to be restored and messes with the mouse */
11149 reset_sys_modes (tty
);
11152 tty
->flow_control
= !NILP (flow
);
11155 init_sys_modes (tty
);
11161 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11162 doc
: /* Enable or disable 8-bit input on TERMINAL.
11163 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11164 bit as the Meta modifier.
11166 If META is nil, Emacs will ignore the top bit, on the assumption it is
11169 Otherwise, Emacs will accept and pass through 8-bit input without
11170 specially interpreting the top bit.
11172 This setting only has an effect on tty terminal devices.
11174 Optional parameter TERMINAL specifies the tty terminal device to use.
11175 It may be a terminal object, a frame, or nil for the terminal used by
11176 the currently selected frame.
11178 See also `current-input-mode'. */)
11179 (Lisp_Object meta
, Lisp_Object terminal
)
11181 struct terminal
*t
= get_terminal (terminal
, 1);
11182 struct tty_display_info
*tty
;
11185 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11187 tty
= t
->display_info
.tty
;
11191 else if (EQ (meta
, Qt
))
11196 if (tty
->meta_key
!= new_meta
)
11199 /* this causes startup screen to be restored and messes with the mouse */
11200 reset_sys_modes (tty
);
11203 tty
->meta_key
= new_meta
;
11206 init_sys_modes (tty
);
11212 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11213 doc
: /* Specify character used for quitting.
11214 QUIT must be an ASCII character.
11216 This function only has an effect on the controlling tty of the Emacs
11219 See also `current-input-mode'. */)
11222 struct terminal
*t
= get_named_tty ("/dev/tty");
11223 struct tty_display_info
*tty
;
11224 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11226 tty
= t
->display_info
.tty
;
11228 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11229 error ("QUIT must be an ASCII character");
11232 /* this causes startup screen to be restored and messes with the mouse */
11233 reset_sys_modes (tty
);
11236 /* Don't let this value be out of range. */
11237 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11240 init_sys_modes (tty
);
11246 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11247 doc
: /* Set mode of reading keyboard input.
11248 First arg INTERRUPT non-nil means use input interrupts;
11249 nil means use CBREAK mode.
11250 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11251 (no effect except in CBREAK mode).
11252 Third arg META t means accept 8-bit input (for a Meta key).
11253 META nil means ignore the top bit, on the assumption it is parity.
11254 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11255 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11256 See also `current-input-mode'. */)
11257 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11259 Fset_input_interrupt_mode (interrupt
);
11260 Fset_output_flow_control (flow
, Qnil
);
11261 Fset_input_meta_mode (meta
, Qnil
);
11263 Fset_quit_char (quit
);
11267 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11268 doc
: /* Return information about the way Emacs currently reads keyboard input.
11269 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11270 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11271 nil, Emacs is using CBREAK mode.
11272 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11273 terminal; this does not apply if Emacs uses interrupt-driven input.
11274 META is t if accepting 8-bit input with 8th bit as Meta flag.
11275 META nil means ignoring the top bit, on the assumption it is parity.
11276 META is neither t nor nil if accepting 8-bit input and using
11277 all 8 bits as the character code.
11278 QUIT is the character Emacs currently uses to quit.
11279 The elements of this list correspond to the arguments of
11280 `set-input-mode'. */)
11283 Lisp_Object val
[4];
11284 struct frame
*sf
= XFRAME (selected_frame
);
11286 val
[0] = interrupt_input
? Qt
: Qnil
;
11287 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11289 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11290 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11292 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11299 XSETFASTINT (val
[3], quit_char
);
11301 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11304 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11305 doc
: /* Return position information for pixel coordinates X and Y.
11306 By default, X and Y are relative to text area of the selected window.
11307 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11308 If optional fourth arg WHOLE is non-nil, X is relative to the left
11309 edge of the window.
11311 The return value is similar to a mouse click position:
11312 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11313 IMAGE (DX . DY) (WIDTH . HEIGHT))
11314 The `posn-' functions access elements of such lists. */)
11315 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11320 if (NILP (frame_or_window
))
11321 frame_or_window
= selected_window
;
11323 if (WINDOWP (frame_or_window
))
11327 CHECK_LIVE_WINDOW (frame_or_window
);
11329 w
= XWINDOW (frame_or_window
);
11330 XSETINT (x
, (XINT (x
)
11331 + WINDOW_LEFT_EDGE_X (w
)
11333 ? window_box_left_offset (w
, TEXT_AREA
)
11335 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11336 frame_or_window
= w
->frame
;
11339 CHECK_LIVE_FRAME (frame_or_window
);
11341 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11344 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11345 doc
: /* Return position information for buffer POS in WINDOW.
11346 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11348 Return nil if position is not visible in window. Otherwise,
11349 the return value is similar to that returned by `event-start' for
11350 a mouse click at the upper left corner of the glyph corresponding
11351 to the given buffer position:
11352 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11353 IMAGE (DX . DY) (WIDTH . HEIGHT))
11354 The `posn-' functions access elements of such lists. */)
11355 (Lisp_Object pos
, Lisp_Object window
)
11360 window
= selected_window
;
11362 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11365 Lisp_Object x
= XCAR (tem
);
11366 Lisp_Object y
= XCAR (XCDR (tem
));
11368 /* Point invisible due to hscrolling? */
11371 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11379 * Set up a new kboard object with reasonable initial values.
11382 init_kboard (KBOARD
*kb
)
11384 kb
->Voverriding_terminal_local_map
= Qnil
;
11385 kb
->Vlast_command
= Qnil
;
11386 kb
->Vreal_last_command
= Qnil
;
11387 kb
->Vkeyboard_translate_table
= Qnil
;
11388 kb
->Vlast_repeatable_command
= Qnil
;
11389 kb
->Vprefix_arg
= Qnil
;
11390 kb
->Vlast_prefix_arg
= Qnil
;
11391 kb
->kbd_queue
= Qnil
;
11392 kb
->kbd_queue_has_data
= 0;
11393 kb
->immediate_echo
= 0;
11394 kb
->echo_string
= Qnil
;
11395 kb
->echo_after_prompt
= -1;
11396 kb
->kbd_macro_buffer
= 0;
11397 kb
->kbd_macro_bufsize
= 0;
11398 kb
->defining_kbd_macro
= Qnil
;
11399 kb
->Vlast_kbd_macro
= Qnil
;
11400 kb
->reference_count
= 0;
11401 kb
->Vsystem_key_alist
= Qnil
;
11402 kb
->system_key_syms
= Qnil
;
11403 kb
->Vwindow_system
= Qt
; /* Unset. */
11404 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11405 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11406 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11407 kb
->Vdefault_minibuffer_frame
= Qnil
;
11411 * Destroy the contents of a kboard object, but not the object itself.
11412 * We use this just before deleting it, or if we're going to initialize
11413 * it a second time.
11416 wipe_kboard (KBOARD
*kb
)
11418 xfree (kb
->kbd_macro_buffer
);
11421 /* Free KB and memory referenced from it. */
11424 delete_kboard (KBOARD
*kb
)
11428 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11431 *kbp
= kb
->next_kboard
;
11433 /* Prevent a dangling reference to KB. */
11434 if (kb
== current_kboard
11435 && FRAMEP (selected_frame
)
11436 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11438 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11440 if (current_kboard
== kb
)
11449 init_keyboard (void)
11451 /* This is correct before outermost invocation of the editor loop */
11452 command_loop_level
= -1;
11453 immediate_quit
= 0;
11454 quit_char
= Ctl ('g');
11455 Vunread_command_events
= Qnil
;
11456 unread_command_char
= -1;
11457 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11459 recent_keys_index
= 0;
11460 kbd_fetch_ptr
= kbd_buffer
;
11461 kbd_store_ptr
= kbd_buffer
;
11462 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11463 do_mouse_tracking
= Qnil
;
11466 interrupt_input_blocked
= 0;
11467 interrupt_input_pending
= 0;
11469 pending_signals
= 0;
11472 /* This means that command_loop_1 won't try to select anything the first
11474 internal_last_event_frame
= Qnil
;
11475 Vlast_event_frame
= internal_last_event_frame
;
11477 current_kboard
= initial_kboard
;
11478 /* Re-initialize the keyboard again. */
11479 wipe_kboard (current_kboard
);
11480 init_kboard (current_kboard
);
11481 /* A value of nil for Vwindow_system normally means a tty, but we also use
11482 it for the initial terminal since there is no window system there. */
11483 current_kboard
->Vwindow_system
= Qnil
;
11485 if (!noninteractive
)
11487 /* Before multi-tty support, these handlers used to be installed
11488 only if the current session was a tty session. Now an Emacs
11489 session may have multiple display types, so we always handle
11490 SIGINT. There is special code in interrupt_signal to exit
11491 Emacs on SIGINT when there are no termcap frames on the
11492 controlling terminal. */
11493 signal (SIGINT
, interrupt_signal
);
11495 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11496 SIGQUIT and we can't tell which one it will give us. */
11497 signal (SIGQUIT
, interrupt_signal
);
11498 #endif /* not DOS_NT */
11500 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11502 if (!noninteractive
)
11503 signal (SIGIO
, input_available_signal
);
11506 /* Use interrupt input by default, if it works and noninterrupt input
11507 has deficiencies. */
11509 #ifdef INTERRUPT_INPUT
11510 interrupt_input
= 1;
11512 interrupt_input
= 0;
11518 if (keyboard_init_hook
)
11519 (*keyboard_init_hook
) ();
11521 #ifdef POLL_FOR_INPUT
11523 poll_suppress_count
= 1;
11528 /* This type's only use is in syms_of_keyboard, to initialize the
11529 event header symbols and put properties on them. */
11530 struct event_head
{
11536 static const struct event_head head_table
[] = {
11537 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11538 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11539 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11540 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11541 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11542 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11543 /* `select-window' should be handled just like `switch-frame'
11544 in read_key_sequence. */
11545 {&Qselect_window
, "select-window", &Qswitch_frame
}
11549 syms_of_keyboard (void)
11551 pending_funcalls
= Qnil
;
11552 staticpro (&pending_funcalls
);
11554 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11555 staticpro (&Vlispy_mouse_stem
);
11558 QCimage
= intern_c_string (":image");
11559 staticpro (&QCimage
);
11561 staticpro (&Qhelp_echo
);
11562 Qhelp_echo
= intern_c_string ("help-echo");
11565 Qrtl
= intern_c_string (":rtl");
11567 staticpro (&item_properties
);
11568 item_properties
= Qnil
;
11570 staticpro (&tool_bar_item_properties
);
11571 tool_bar_item_properties
= Qnil
;
11572 staticpro (&tool_bar_items_vector
);
11573 tool_bar_items_vector
= Qnil
;
11575 staticpro (&real_this_command
);
11576 real_this_command
= Qnil
;
11578 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11579 staticpro (&Qtimer_event_handler
);
11581 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11582 staticpro (&Qdisabled_command_function
);
11584 Qself_insert_command
= intern_c_string ("self-insert-command");
11585 staticpro (&Qself_insert_command
);
11587 Qforward_char
= intern_c_string ("forward-char");
11588 staticpro (&Qforward_char
);
11590 Qbackward_char
= intern_c_string ("backward-char");
11591 staticpro (&Qbackward_char
);
11593 Qdisabled
= intern_c_string ("disabled");
11594 staticpro (&Qdisabled
);
11596 Qundefined
= intern_c_string ("undefined");
11597 staticpro (&Qundefined
);
11599 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11600 staticpro (&Qpre_command_hook
);
11602 Qpost_command_hook
= intern_c_string ("post-command-hook");
11603 staticpro (&Qpost_command_hook
);
11605 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11606 staticpro (&Qdeferred_action_function
);
11608 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11609 staticpro (&Qcommand_hook_internal
);
11611 Qfunction_key
= intern_c_string ("function-key");
11612 staticpro (&Qfunction_key
);
11613 Qmouse_click
= intern_c_string ("mouse-click");
11614 staticpro (&Qmouse_click
);
11615 #if defined (WINDOWSNT)
11616 Qlanguage_change
= intern_c_string ("language-change");
11617 staticpro (&Qlanguage_change
);
11619 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11620 staticpro (&Qdrag_n_drop
);
11622 Qsave_session
= intern_c_string ("save-session");
11623 staticpro (&Qsave_session
);
11626 Qdbus_event
= intern_c_string ("dbus-event");
11627 staticpro (&Qdbus_event
);
11630 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11631 staticpro (&Qconfig_changed_event
);
11633 Qmenu_enable
= intern_c_string ("menu-enable");
11634 staticpro (&Qmenu_enable
);
11635 QCenable
= intern_c_string (":enable");
11636 staticpro (&QCenable
);
11637 QCvisible
= intern_c_string (":visible");
11638 staticpro (&QCvisible
);
11639 QChelp
= intern_c_string (":help");
11640 staticpro (&QChelp
);
11641 QCfilter
= intern_c_string (":filter");
11642 staticpro (&QCfilter
);
11643 QCbutton
= intern_c_string (":button");
11644 staticpro (&QCbutton
);
11645 QCkeys
= intern_c_string (":keys");
11646 staticpro (&QCkeys
);
11647 QCkey_sequence
= intern_c_string (":key-sequence");
11648 staticpro (&QCkey_sequence
);
11649 QCtoggle
= intern_c_string (":toggle");
11650 staticpro (&QCtoggle
);
11651 QCradio
= intern_c_string (":radio");
11652 staticpro (&QCradio
);
11653 QClabel
= intern_c_string (":label");
11654 staticpro (&QClabel
);
11656 Qmode_line
= intern_c_string ("mode-line");
11657 staticpro (&Qmode_line
);
11658 Qvertical_line
= intern_c_string ("vertical-line");
11659 staticpro (&Qvertical_line
);
11660 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11661 staticpro (&Qvertical_scroll_bar
);
11662 Qmenu_bar
= intern_c_string ("menu-bar");
11663 staticpro (&Qmenu_bar
);
11665 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11666 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11667 staticpro (&Qmouse_fixup_help_message
);
11670 Qabove_handle
= intern_c_string ("above-handle");
11671 staticpro (&Qabove_handle
);
11672 Qhandle
= intern_c_string ("handle");
11673 staticpro (&Qhandle
);
11674 Qbelow_handle
= intern_c_string ("below-handle");
11675 staticpro (&Qbelow_handle
);
11676 Qup
= intern_c_string ("up");
11678 Qdown
= intern_c_string ("down");
11679 staticpro (&Qdown
);
11680 Qtop
= intern_c_string ("top");
11682 Qbottom
= intern_c_string ("bottom");
11683 staticpro (&Qbottom
);
11684 Qend_scroll
= intern_c_string ("end-scroll");
11685 staticpro (&Qend_scroll
);
11686 Qratio
= intern_c_string ("ratio");
11687 staticpro (&Qratio
);
11689 Qevent_kind
= intern_c_string ("event-kind");
11690 staticpro (&Qevent_kind
);
11691 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11692 staticpro (&Qevent_symbol_elements
);
11693 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11694 staticpro (&Qevent_symbol_element_mask
);
11695 Qmodifier_cache
= intern_c_string ("modifier-cache");
11696 staticpro (&Qmodifier_cache
);
11698 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11699 staticpro (&Qrecompute_lucid_menubar
);
11700 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11701 staticpro (&Qactivate_menubar_hook
);
11703 Qpolling_period
= intern_c_string ("polling-period");
11704 staticpro (&Qpolling_period
);
11706 Qinput_method_function
= intern_c_string ("input-method-function");
11707 staticpro (&Qinput_method_function
);
11709 Qx_set_selection
= intern_c_string ("x-set-selection");
11710 staticpro (&Qx_set_selection
);
11711 QPRIMARY
= intern_c_string ("PRIMARY");
11712 staticpro (&QPRIMARY
);
11713 Qhandle_switch_frame
= intern_c_string ("handle-switch-frame");
11714 staticpro (&Qhandle_switch_frame
);
11716 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11717 staticpro (&Qinput_method_exit_on_first_char
);
11718 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11719 staticpro (&Qinput_method_use_echo_area
);
11721 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11722 Fset (Qinput_method_use_echo_area
, Qnil
);
11724 last_point_position_buffer
= Qnil
;
11725 last_point_position_window
= Qnil
;
11728 const struct event_head
*p
;
11730 for (p
= head_table
;
11731 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11734 *p
->var
= intern_c_string (p
->name
);
11735 staticpro (p
->var
);
11736 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11737 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11741 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11742 staticpro (&button_down_location
);
11743 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11744 staticpro (&mouse_syms
);
11745 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11746 / sizeof (lispy_wheel_names
[0])),
11748 staticpro (&wheel_syms
);
11752 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11754 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11755 for (i
= 0; i
< len
; i
++)
11756 if (modifier_names
[i
])
11757 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11758 staticpro (&modifier_symbols
);
11761 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11762 staticpro (&recent_keys
);
11764 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11765 staticpro (&this_command_keys
);
11767 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11768 staticpro (&raw_keybuf
);
11770 Qextended_command_history
= intern_c_string ("extended-command-history");
11771 Fset (Qextended_command_history
, Qnil
);
11772 staticpro (&Qextended_command_history
);
11774 accent_key_syms
= Qnil
;
11775 staticpro (&accent_key_syms
);
11777 func_key_syms
= Qnil
;
11778 staticpro (&func_key_syms
);
11780 drag_n_drop_syms
= Qnil
;
11781 staticpro (&drag_n_drop_syms
);
11783 unread_switch_frame
= Qnil
;
11784 staticpro (&unread_switch_frame
);
11786 internal_last_event_frame
= Qnil
;
11787 staticpro (&internal_last_event_frame
);
11789 read_key_sequence_cmd
= Qnil
;
11790 staticpro (&read_key_sequence_cmd
);
11792 menu_bar_one_keymap_changed_items
= Qnil
;
11793 staticpro (&menu_bar_one_keymap_changed_items
);
11795 menu_bar_items_vector
= Qnil
;
11796 staticpro (&menu_bar_items_vector
);
11798 help_form_saved_window_configs
= Qnil
;
11799 staticpro (&help_form_saved_window_configs
);
11801 defsubr (&Scurrent_idle_time
);
11802 defsubr (&Sevent_symbol_parse_modifiers
);
11803 defsubr (&Sevent_convert_list
);
11804 defsubr (&Sread_key_sequence
);
11805 defsubr (&Sread_key_sequence_vector
);
11806 defsubr (&Srecursive_edit
);
11807 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11808 defsubr (&Strack_mouse
);
11810 defsubr (&Sinput_pending_p
);
11811 defsubr (&Scommand_execute
);
11812 defsubr (&Srecent_keys
);
11813 defsubr (&Sthis_command_keys
);
11814 defsubr (&Sthis_command_keys_vector
);
11815 defsubr (&Sthis_single_command_keys
);
11816 defsubr (&Sthis_single_command_raw_keys
);
11817 defsubr (&Sreset_this_command_lengths
);
11818 defsubr (&Sclear_this_command_keys
);
11819 defsubr (&Ssuspend_emacs
);
11820 defsubr (&Sabort_recursive_edit
);
11821 defsubr (&Sexit_recursive_edit
);
11822 defsubr (&Srecursion_depth
);
11823 defsubr (&Stop_level
);
11824 defsubr (&Sdiscard_input
);
11825 defsubr (&Sopen_dribble_file
);
11826 defsubr (&Sset_input_interrupt_mode
);
11827 defsubr (&Sset_output_flow_control
);
11828 defsubr (&Sset_input_meta_mode
);
11829 defsubr (&Sset_quit_char
);
11830 defsubr (&Sset_input_mode
);
11831 defsubr (&Scurrent_input_mode
);
11832 defsubr (&Sexecute_extended_command
);
11833 defsubr (&Sposn_at_point
);
11834 defsubr (&Sposn_at_x_y
);
11836 DEFVAR_LISP ("last-command-event", &last_command_event
,
11837 doc
: /* Last input event that was part of a command. */);
11839 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11840 doc
: /* Last input event in a command, except for mouse menu events.
11841 Mouse menus give back keys that don't look like mouse events;
11842 this variable holds the actual mouse event that led to the menu,
11843 so that you can determine whether the command was run by mouse or not. */);
11845 DEFVAR_LISP ("last-input-event", &last_input_event
,
11846 doc
: /* Last input event. */);
11848 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11849 doc
: /* List of events to be read as the command input.
11850 These events are processed first, before actual keyboard input.
11851 Events read from this list are not normally added to `this-command-keys',
11852 as they will already have been added once as they were read for the first time.
11853 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11854 Vunread_command_events
= Qnil
;
11856 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11857 doc
: /* If not -1, an object to be read as next command input event. */);
11859 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11860 doc
: /* List of events to be processed as input by input methods.
11861 These events are processed before `unread-command-events'
11862 and actual keyboard input, but are not given to `input-method-function'. */);
11863 Vunread_post_input_method_events
= Qnil
;
11865 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11866 doc
: /* List of events to be processed as input by input methods.
11867 These events are processed after `unread-command-events', but
11868 before actual keyboard input.
11869 If there's an active input method, the events are given to
11870 `input-method-function'. */);
11871 Vunread_input_method_events
= Qnil
;
11873 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11874 doc
: /* Meta-prefix character code.
11875 Meta-foo as command input turns into this character followed by foo. */);
11876 XSETINT (meta_prefix_char
, 033);
11878 DEFVAR_KBOARD ("last-command", Vlast_command
,
11879 doc
: /* The last command executed.
11880 Normally a symbol with a function definition, but can be whatever was found
11881 in the keymap, or whatever the variable `this-command' was set to by that
11884 The value `mode-exit' is special; it means that the previous command
11885 read an event that told it to exit, and it did so and unread that event.
11886 In other words, the present command is the event that made the previous
11889 The value `kill-region' is special; it means that the previous command
11890 was a kill command.
11892 `last-command' has a separate binding for each terminal device.
11893 See Info node `(elisp)Multiple Terminals'. */);
11895 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11896 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11898 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11899 doc
: /* Last command that may be repeated.
11900 The last command executed that was not bound to an input event.
11901 This is the command `repeat' will try to repeat. */);
11903 DEFVAR_LISP ("this-command", &Vthis_command
,
11904 doc
: /* The command now being executed.
11905 The command can set this variable; whatever is put here
11906 will be in `last-command' during the following command. */);
11907 Vthis_command
= Qnil
;
11909 DEFVAR_LISP ("this-command-keys-shift-translated",
11910 &Vthis_command_keys_shift_translated
,
11911 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11912 Shift-translation occurs when there is no binding for the key sequence
11913 as entered, but a binding was found by changing an upper-case letter
11914 to lower-case, or a shifted function key to an unshifted one. */);
11915 Vthis_command_keys_shift_translated
= Qnil
;
11917 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11918 doc
: /* The command bound to the current key sequence before remapping.
11919 It equals `this-command' if the original command was not remapped through
11920 any of the active keymaps. Otherwise, the value of `this-command' is the
11921 result of looking up the original command in the active keymaps. */);
11922 Vthis_original_command
= Qnil
;
11924 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11925 doc
: /* *Number of input events between auto-saves.
11926 Zero means disable autosaving due to number of characters typed. */);
11927 auto_save_interval
= 300;
11929 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11930 doc
: /* *Number of seconds idle time before auto-save.
11931 Zero or nil means disable auto-saving due to idleness.
11932 After auto-saving due to this many seconds of idle time,
11933 Emacs also does a garbage collection if that seems to be warranted. */);
11934 XSETFASTINT (Vauto_save_timeout
, 30);
11936 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11937 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11938 The value may be integer or floating point. */);
11939 Vecho_keystrokes
= make_number (1);
11941 DEFVAR_INT ("polling-period", &polling_period
,
11942 doc
: /* *Interval between polling for input during Lisp execution.
11943 The reason for polling is to make C-g work to stop a running program.
11944 Polling is needed only when using X windows and SIGIO does not work.
11945 Polling is automatically disabled in all other cases. */);
11946 polling_period
= 2;
11948 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11949 doc
: /* *Maximum time between mouse clicks to make a double-click.
11950 Measured in milliseconds. The value nil means disable double-click
11951 recognition; t means double-clicks have no time limit and are detected
11952 by position only. */);
11953 Vdouble_click_time
= make_number (500);
11955 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11956 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11957 On window-system frames, value is the number of pixels the mouse may have
11958 moved horizontally or vertically between two clicks to make a double-click.
11959 On non window-system frames, value is interpreted in units of 1/8 characters
11962 This variable is also the threshold for motion of the mouse
11963 to count as a drag. */);
11964 double_click_fuzz
= 3;
11966 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11967 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11968 inhibit_local_menu_bar_menus
= 0;
11970 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11971 doc
: /* Number of complete key sequences read as input so far.
11972 This includes key sequences read from keyboard macros.
11973 The number is effectively the number of interactive command invocations. */);
11974 num_input_keys
= 0;
11976 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11977 doc
: /* Number of input events read from the keyboard so far.
11978 This does not include events generated by keyboard macros. */);
11979 num_nonmacro_input_events
= 0;
11981 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11982 doc
: /* The frame in which the most recently read event occurred.
11983 If the last event came from a keyboard macro, this is set to `macro'. */);
11984 Vlast_event_frame
= Qnil
;
11986 /* This variable is set up in sysdep.c. */
11987 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11988 doc
: /* The ERASE character as set by the user with stty. */);
11990 DEFVAR_LISP ("help-char", &Vhelp_char
,
11991 doc
: /* Character to recognize as meaning Help.
11992 When it is read, do `(eval help-form)', and display result if it's a string.
11993 If the value of `help-form' is nil, this char can be read normally. */);
11994 XSETINT (Vhelp_char
, Ctl ('H'));
11996 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11997 doc
: /* List of input events to recognize as meaning Help.
11998 These work just like the value of `help-char' (see that). */);
11999 Vhelp_event_list
= Qnil
;
12001 DEFVAR_LISP ("help-form", &Vhelp_form
,
12002 doc
: /* Form to execute when character `help-char' is read.
12003 If the form returns a string, that string is displayed.
12004 If `help-form' is nil, the help char is not recognized. */);
12007 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12008 doc
: /* Command to run when `help-char' character follows a prefix key.
12009 This command is used only when there is no actual binding
12010 for that character after that prefix key. */);
12011 Vprefix_help_command
= Qnil
;
12013 DEFVAR_LISP ("top-level", &Vtop_level
,
12014 doc
: /* Form to evaluate when Emacs starts up.
12015 Useful to set before you dump a modified Emacs. */);
12018 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12019 doc
: /* Translate table for local keyboard input, or nil.
12020 If non-nil, the value should be a char-table. Each character read
12021 from the keyboard is looked up in this char-table. If the value found
12022 there is non-nil, then it is used instead of the actual input character.
12024 The value can also be a string or vector, but this is considered obsolete.
12025 If it is a string or vector of length N, character codes N and up are left
12026 untranslated. In a vector, an element which is nil means "no translation".
12028 This is applied to the characters supplied to input methods, not their
12029 output. See also `translation-table-for-input'.
12031 This variable has a separate binding for each terminal.
12032 See Info node `(elisp)Multiple Terminals'. */);
12034 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12035 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12036 \(Even if the operating system has support for stopping a process.\) */);
12037 cannot_suspend
= 0;
12039 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12040 doc
: /* Non-nil means prompt with menus when appropriate.
12041 This is done when reading from a keymap that has a prompt string,
12042 for elements that have prompt strings.
12043 The menu is displayed on the screen
12044 if X menus were enabled at configuration
12045 time and the previous event was a mouse click prefix key.
12046 Otherwise, menu prompting uses the echo area. */);
12047 menu_prompting
= 1;
12049 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12050 doc
: /* Character to see next line of menu prompt.
12051 Type this character while in a menu prompt to rotate around the lines of it. */);
12052 XSETINT (menu_prompt_more_char
, ' ');
12054 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12055 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12056 Emacs applies the modifiers of the character stored here to each keyboard
12057 character it reads. For example, after evaluating the expression
12058 (setq extra-keyboard-modifiers ?\\C-x)
12059 all input characters will have the control modifier applied to them.
12061 Note that the character ?\\C-@, equivalent to the integer zero, does
12062 not count as a control character; rather, it counts as a character
12063 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12064 cancels any modification. */);
12065 extra_keyboard_modifiers
= 0;
12067 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12068 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12069 The command loop sets this to nil before each command,
12070 and tests the value when the command returns.
12071 Buffer modification stores t in this variable. */);
12072 Vdeactivate_mark
= Qnil
;
12073 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12074 staticpro (&Qdeactivate_mark
);
12076 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12077 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12078 Vcommand_hook_internal
= Qnil
;
12080 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12081 doc
: /* Normal hook run before each command is executed.
12082 If an unhandled error happens in running this hook,
12083 the hook value is set to nil, since otherwise the error
12084 might happen repeatedly and make Emacs nonfunctional. */);
12085 Vpre_command_hook
= Qnil
;
12087 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12088 doc
: /* Normal hook run after each command is executed.
12089 If an unhandled error happens in running this hook,
12090 the hook value is set to nil, since otherwise the error
12091 might happen repeatedly and make Emacs nonfunctional. */);
12092 Vpost_command_hook
= Qnil
;
12095 DEFVAR_LISP ("echo-area-clear-hook", ...,
12096 doc
: /* Normal hook run when clearing the echo area. */);
12098 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12099 staticpro (&Qecho_area_clear_hook
);
12100 Fset (Qecho_area_clear_hook
, Qnil
);
12102 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12103 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12104 Vlucid_menu_bar_dirty_flag
= Qnil
;
12106 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12107 doc
: /* List of menu bar items to move to the end of the menu bar.
12108 The elements of the list are event types that may have menu bar bindings. */);
12109 Vmenu_bar_final_items
= Qnil
;
12111 DEFVAR_KBOARD ("overriding-terminal-local-map",
12112 Voverriding_terminal_local_map
,
12113 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12114 If this variable is non-nil, it is used as a keymap instead of the
12115 buffer's local map, and the minor mode keymaps and text property keymaps.
12116 It also replaces `overriding-local-map'.
12118 This variable is intended to let commands such as `universal-argument'
12119 set up a different keymap for reading the next command.
12121 `overriding-terminal-local-map' has a separate binding for each
12123 See Info node `(elisp)Multiple Terminals'. */);
12125 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12126 doc
: /* Keymap that overrides all other local keymaps.
12127 If this variable is non-nil, it is used as a keymap--replacing the
12128 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12129 Voverriding_local_map
= Qnil
;
12131 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12132 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12133 Otherwise, the menu bar continues to reflect the buffer's local map
12134 and the minor mode maps regardless of `overriding-local-map'. */);
12135 Voverriding_local_map_menu_flag
= Qnil
;
12137 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12138 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12139 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12141 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12142 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12144 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12145 doc
: /* Alist of system-specific X windows key symbols.
12146 Each element should have the form (N . SYMBOL) where N is the
12147 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12148 and SYMBOL is its name.
12150 `system-key-alist' has a separate binding for each terminal device.
12151 See Info node `(elisp)Multiple Terminals'. */);
12153 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12154 doc
: /* Keymap that translates key sequences to key sequences during input.
12155 This is used mainly for mapping key sequences into some preferred
12156 key events (symbols).
12158 The `read-key-sequence' function replaces any subsequence bound by
12159 `local-function-key-map' with its binding. More precisely, when the
12160 active keymaps have no binding for the current key sequence but
12161 `local-function-key-map' binds a suffix of the sequence to a vector or
12162 string, `read-key-sequence' replaces the matching suffix with its
12163 binding, and continues with the new sequence.
12165 If the binding is a function, it is called with one argument (the prompt)
12166 and its return value (a key sequence) is used.
12168 The events that come from bindings in `local-function-key-map' are not
12169 themselves looked up in `local-function-key-map'.
12171 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12172 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12173 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12174 typing `ESC O P x' would return [f1 x].
12176 `local-function-key-map' has a separate binding for each terminal
12177 device. See Info node `(elisp)Multiple Terminals'. If you need to
12178 define a binding on all terminals, change `function-key-map'
12179 instead. Initially, `local-function-key-map' is an empty keymap that
12180 has `function-key-map' as its parent on all terminal devices. */);
12182 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12183 doc
: /* Keymap that decodes input escape sequences.
12184 This is used mainly for mapping ASCII function key sequences into
12185 real Emacs function key events (symbols).
12187 The `read-key-sequence' function replaces any subsequence bound by
12188 `input-decode-map' with its binding. Contrary to `function-key-map',
12189 this map applies its rebinding regardless of the presence of an ordinary
12190 binding. So it is more like `key-translation-map' except that it applies
12191 before `function-key-map' rather than after.
12193 If the binding is a function, it is called with one argument (the prompt)
12194 and its return value (a key sequence) is used.
12196 The events that come from bindings in `input-decode-map' are not
12197 themselves looked up in `input-decode-map'.
12199 This variable is keyboard-local. */);
12201 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12202 doc
: /* The parent keymap of all `local-function-key-map' instances.
12203 Function key definitions that apply to all terminal devices should go
12204 here. If a mapping is defined in both the current
12205 `local-function-key-map' binding and this variable, then the local
12206 definition will take precendence. */);
12207 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12209 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12210 doc
: /* Keymap of key translations that can override keymaps.
12211 This keymap works like `function-key-map', but comes after that,
12212 and its non-prefix bindings override ordinary bindings.
12213 Another difference is that it is global rather than keyboard-local. */);
12214 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12216 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12217 doc
: /* List of deferred actions to be performed at a later time.
12218 The precise format isn't relevant here; we just check whether it is nil. */);
12219 Vdeferred_action_list
= Qnil
;
12221 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12222 doc
: /* Function to call to handle deferred actions, after each command.
12223 This function is called with no arguments after each command
12224 whenever `deferred-action-list' is non-nil. */);
12225 Vdeferred_action_function
= Qnil
;
12227 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12228 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12229 The value can be a length of time to show the message for.
12230 If the value is non-nil and not a number, we wait 2 seconds. */);
12231 Vsuggest_key_bindings
= Qt
;
12233 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12234 doc
: /* List of active absolute time timers in order of increasing time. */);
12235 Vtimer_list
= Qnil
;
12237 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12238 doc
: /* List of active idle-time timers in order of increasing time. */);
12239 Vtimer_idle_list
= Qnil
;
12241 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12242 doc
: /* If non-nil, the function that implements the current input method.
12243 It's called with one argument, a printing character that was just read.
12244 \(That means a character with code 040...0176.)
12245 Typically this function uses `read-event' to read additional events.
12246 When it does so, it should first bind `input-method-function' to nil
12247 so it will not be called recursively.
12249 The function should return a list of zero or more events
12250 to be used as input. If it wants to put back some events
12251 to be reconsidered, separately, by the input method,
12252 it can add them to the beginning of `unread-command-events'.
12254 The input method function can find in `input-method-previous-message'
12255 the previous echo area message.
12257 The input method function should refer to the variables
12258 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12259 for guidance on what to do. */);
12260 Vinput_method_function
= Qnil
;
12262 DEFVAR_LISP ("input-method-previous-message",
12263 &Vinput_method_previous_message
,
12264 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12265 This variable exists because `read-event' clears the echo area
12266 before running the input method. It is nil if there was no message. */);
12267 Vinput_method_previous_message
= Qnil
;
12269 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12270 doc
: /* If non-nil, the function that implements the display of help.
12271 It's called with one argument, the help string to display. */);
12272 Vshow_help_function
= Qnil
;
12274 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12275 doc
: /* If non-nil, suppress point adjustment after executing a command.
12277 After a command is executed, if point is moved into a region that has
12278 special properties (e.g. composition, display), we adjust point to
12279 the boundary of the region. But, when a command sets this variable to
12280 non-nil, we suppress the point adjustment.
12282 This variable is set to nil before reading a command, and is checked
12283 just after executing the command. */);
12284 Vdisable_point_adjustment
= Qnil
;
12286 DEFVAR_LISP ("global-disable-point-adjustment",
12287 &Vglobal_disable_point_adjustment
,
12288 doc
: /* *If non-nil, always suppress point adjustment.
12290 The default value is nil, in which case, point adjustment are
12291 suppressed only after special commands that set
12292 `disable-point-adjustment' (which see) to non-nil. */);
12293 Vglobal_disable_point_adjustment
= Qnil
;
12295 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12296 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12297 If the value is not a number, such messages don't time out. */);
12298 Vminibuffer_message_timeout
= make_number (2);
12300 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12301 doc
: /* If non-nil, any keyboard input throws to this symbol.
12302 The value of that variable is passed to `quit-flag' and later causes a
12303 peculiar kind of quitting. */);
12304 Vthrow_on_input
= Qnil
;
12306 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12307 doc
: /* If non-nil, function to output error messages.
12308 The arguments are the error data, a list of the form
12309 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12310 such as just as `condition-case' would bind its variable to,
12311 the context (a string which normally goes at the start of the message),
12312 and the Lisp function within which the error was signaled. */);
12313 Vcommand_error_function
= Qnil
;
12315 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12316 &Venable_disabled_menus_and_buttons
,
12317 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12319 Help functions bind this to allow help on disabled menu items
12320 and tool-bar buttons. */);
12321 Venable_disabled_menus_and_buttons
= Qnil
;
12323 DEFVAR_LISP ("select-active-regions",
12324 &Vselect_active_regions
,
12325 doc
: /* If non-nil, an active region automatically becomes the window selection.
12326 If the value is `only', only temporarily active regions (usually made
12327 by mouse-dragging or shift-selection) set the window selection.
12329 This takes effect only when Transient Mark mode is enabled. */);
12330 Vselect_active_regions
= Qt
;
12332 DEFVAR_LISP ("saved-region-selection",
12333 &Vsaved_region_selection
,
12334 doc
: /* Contents of active region prior to buffer modification.
12335 If `select-active-regions' is non-nil, Emacs sets this to the
12336 text in the region before modifying the buffer. The next
12337 `deactivate-mark' call uses this to set the window selection. */);
12338 Vsaved_region_selection
= Qnil
;
12340 /* Create the initial keyboard. */
12341 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12342 init_kboard (initial_kboard
);
12343 /* Vwindow_system is left at t for now. */
12344 initial_kboard
->next_kboard
= all_kboards
;
12345 all_kboards
= initial_kboard
;
12349 keys_of_keyboard (void)
12351 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12352 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12353 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12354 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12355 initial_define_key (meta_map
, 'x', "execute-extended-command");
12357 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12358 "handle-delete-frame");
12359 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12360 "ns-put-working-text");
12361 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12362 "ns-unput-working-text");
12363 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12364 current-prefix-arg, as is done in `handle-switch-frame'.
12365 But `handle-switch-frame is not run from the special-map.
12366 Commands from that map are run in a special way that automatically
12367 preserves the prefix-arg. Restoring the prefix arg here is not just
12368 redundant but harmful:
12370 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12371 - after the first prompt, the exit-minibuffer-hook is run which may
12372 iconify a frame and thus push a `iconify-frame' event.
12373 - after running exit-minibuffer-hook, current-prefix-arg is
12374 restored to the non-nil value it had before the prompt.
12375 - we enter the second prompt.
12376 current-prefix-arg is non-nil, prefix-arg is nil.
12377 - before running the first real event, we run the special iconify-frame
12378 event, but we pass the `special' arg to execute-command so
12379 current-prefix-arg and prefix-arg are left untouched.
12380 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12381 - the next key event will have a spuriously non-nil current-prefix-arg. */
12382 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12384 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12386 /* Handling it at such a low-level causes read_key_sequence to get
12387 * confused because it doesn't realize that the current_buffer was
12388 * changed by read_char.
12390 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12391 * "handle-select-window"); */
12392 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12393 "handle-save-session");
12396 /* Define a special event which is raised for dbus callback
12398 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12399 "dbus-handle-event");
12402 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12406 /* Mark the pointers in the kboard objects.
12407 Called by the Fgarbage_collector. */
12409 mark_kboards (void)
12413 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12415 if (kb
->kbd_macro_buffer
)
12416 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12418 mark_object (kb
->Voverriding_terminal_local_map
);
12419 mark_object (kb
->Vlast_command
);
12420 mark_object (kb
->Vreal_last_command
);
12421 mark_object (kb
->Vkeyboard_translate_table
);
12422 mark_object (kb
->Vlast_repeatable_command
);
12423 mark_object (kb
->Vprefix_arg
);
12424 mark_object (kb
->Vlast_prefix_arg
);
12425 mark_object (kb
->kbd_queue
);
12426 mark_object (kb
->defining_kbd_macro
);
12427 mark_object (kb
->Vlast_kbd_macro
);
12428 mark_object (kb
->Vsystem_key_alist
);
12429 mark_object (kb
->system_key_syms
);
12430 mark_object (kb
->Vwindow_system
);
12431 mark_object (kb
->Vinput_decode_map
);
12432 mark_object (kb
->Vlocal_function_key_map
);
12433 mark_object (kb
->Vdefault_minibuffer_frame
);
12434 mark_object (kb
->echo_string
);
12437 struct input_event
*event
;
12438 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12440 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12441 event
= kbd_buffer
;
12442 if (event
->kind
!= SELECTION_REQUEST_EVENT
12443 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12445 mark_object (event
->x
);
12446 mark_object (event
->y
);
12448 mark_object (event
->frame_or_window
);
12449 mark_object (event
->arg
);
12454 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12455 (do not change this comment) */