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 extern Lisp_Object current_global_map
;
250 extern int minibuf_level
;
252 /* If non-nil, this is a map that overrides all other local maps. */
253 Lisp_Object Voverriding_local_map
;
255 /* If non-nil, Voverriding_local_map applies to the menu bar. */
256 Lisp_Object Voverriding_local_map_menu_flag
;
258 /* Keymap that defines special misc events that should
259 be processed immediately at a low level. */
260 Lisp_Object Vspecial_event_map
;
262 /* Current depth in recursive edits. */
263 int command_loop_level
;
265 /* Total number of times command_loop has read a key sequence. */
266 EMACS_INT num_input_keys
;
268 /* Last input event read as a command. */
269 Lisp_Object last_command_event
;
271 /* Last input character read as a command, not counting menus
272 reached by the mouse. */
273 Lisp_Object last_nonmenu_event
;
275 /* Last input event read for any purpose. */
276 Lisp_Object last_input_event
;
278 /* If not Qnil, a list of objects to be read as subsequent command input. */
279 Lisp_Object Vunread_command_events
;
281 /* If not Qnil, a list of objects to be read as subsequent command input
282 including input method processing. */
283 Lisp_Object Vunread_input_method_events
;
285 /* If not Qnil, a list of objects to be read as subsequent command input
286 but NOT including input method processing. */
287 Lisp_Object Vunread_post_input_method_events
;
289 /* If not -1, an event to be read as subsequent command input. */
290 EMACS_INT unread_command_char
;
292 /* If not Qnil, this is a switch-frame event which we decided to put
293 off until the end of a key sequence. This should be read as the
294 next command input, after any unread_command_events.
296 read_key_sequence uses this to delay switch-frame events until the
297 end of the key sequence; Fread_char uses it to put off switch-frame
298 events until a non-ASCII event is acceptable as input. */
299 Lisp_Object unread_switch_frame
;
301 /* A mask of extra modifier bits to put into every keyboard char. */
302 EMACS_INT extra_keyboard_modifiers
;
304 /* Char to use as prefix when a meta character is typed in.
305 This is bound on entry to minibuffer in case ESC is changed there. */
307 Lisp_Object meta_prefix_char
;
309 /* Last size recorded for a current buffer which is not a minibuffer. */
310 static int last_non_minibuf_size
;
312 /* Number of idle seconds before an auto-save and garbage collection. */
313 static Lisp_Object Vauto_save_timeout
;
315 /* Total number of times read_char has returned. */
316 int num_input_events
;
318 /* Total number of times read_char has returned, outside of macros. */
319 EMACS_INT num_nonmacro_input_events
;
321 /* Auto-save automatically when this many characters have been typed
322 since the last time. */
324 static EMACS_INT auto_save_interval
;
326 /* Value of num_nonmacro_input_events as of last auto save. */
330 /* The command being executed by the command loop.
331 Commands may set this, and the value set will be copied into
332 current_kboard->Vlast_command instead of the actual command. */
333 Lisp_Object Vthis_command
;
335 /* This is like Vthis_command, except that commands never set it. */
336 Lisp_Object real_this_command
;
338 /* If the lookup of the command returns a binding, the original
339 command is stored in this-original-command. It is nil otherwise. */
340 Lisp_Object Vthis_original_command
;
342 /* The value of point when the last command was started. */
343 int last_point_position
;
345 /* The buffer that was current when the last command was started. */
346 Lisp_Object last_point_position_buffer
;
348 /* The window that was selected when the last command was started. */
349 Lisp_Object last_point_position_window
;
351 /* The frame in which the last input event occurred, or Qmacro if the
352 last event came from a macro. We use this to determine when to
353 generate switch-frame events. This may be cleared by functions
354 like Fselect_frame, to make sure that a switch-frame event is
355 generated by the next character. */
356 Lisp_Object internal_last_event_frame
;
358 /* A user-visible version of the above, intended to allow users to
359 figure out where the last event came from, if the event doesn't
360 carry that information itself (i.e. if it was a character). */
361 Lisp_Object Vlast_event_frame
;
363 /* The timestamp of the last input event we received from the X server.
364 X Windows wants this for selection ownership. */
365 unsigned long last_event_timestamp
;
367 Lisp_Object Qself_insert_command
;
368 Lisp_Object Qforward_char
;
369 Lisp_Object Qbackward_char
;
370 Lisp_Object Qundefined
;
371 Lisp_Object Qtimer_event_handler
;
373 /* read_key_sequence stores here the command definition of the
374 key sequence that it reads. */
375 Lisp_Object read_key_sequence_cmd
;
377 /* Echo unfinished commands after this many seconds of pause. */
378 Lisp_Object Vecho_keystrokes
;
380 /* Form to evaluate (if non-nil) when Emacs is started. */
381 Lisp_Object Vtop_level
;
383 /* If non-nil, this implements the current input method. */
384 Lisp_Object Vinput_method_function
;
385 Lisp_Object Qinput_method_function
;
387 /* When we call Vinput_method_function,
388 this holds the echo area message that was just erased. */
389 Lisp_Object Vinput_method_previous_message
;
391 /* Non-nil means deactivate the mark at end of this command. */
392 Lisp_Object Vdeactivate_mark
;
393 Lisp_Object Qdeactivate_mark
;
395 /* Menu bar specified in Lucid Emacs fashion. */
397 Lisp_Object Vlucid_menu_bar_dirty_flag
;
398 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
400 Lisp_Object Qecho_area_clear_hook
;
402 /* Hooks to run before and after each command. */
403 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
404 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
405 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
407 /* Parent keymap of terminal-local function-key-map instances. */
408 Lisp_Object Vfunction_key_map
;
410 /* Keymap of key translations that can override keymaps. */
411 Lisp_Object Vkey_translation_map
;
413 /* List of deferred actions to be performed at a later time.
414 The precise format isn't relevant here; we just check whether it is nil. */
415 Lisp_Object Vdeferred_action_list
;
417 /* Function to call to handle deferred actions, when there are any. */
418 Lisp_Object Vdeferred_action_function
;
419 Lisp_Object Qdeferred_action_function
;
421 Lisp_Object Qinput_method_exit_on_first_char
;
422 Lisp_Object Qinput_method_use_echo_area
;
424 /* File in which we write all commands we read. */
427 /* Nonzero if input is available. */
430 extern char *pending_malloc_warning
;
432 /* Circular buffer for pre-read keyboard input. */
434 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
436 /* Pointer to next available character in kbd_buffer.
437 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
438 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
439 next available char is in kbd_buffer[0]. */
440 static struct input_event
*kbd_fetch_ptr
;
442 /* Pointer to next place to store character in kbd_buffer. This
443 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
444 character should go in kbd_buffer[0]. */
445 static struct input_event
* volatile kbd_store_ptr
;
447 /* The above pair of variables forms a "queue empty" flag. When we
448 enqueue a non-hook event, we increment kbd_store_ptr. When we
449 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
450 there is input available if the two pointers are not equal.
452 Why not just have a flag set and cleared by the enqueuing and
453 dequeuing functions? Such a flag could be screwed up by interrupts
454 at inopportune times. */
456 /* If this flag is non-nil, we check mouse_moved to see when the
457 mouse moves, and motion events will appear in the input stream.
458 Otherwise, mouse motion is ignored. */
459 Lisp_Object do_mouse_tracking
;
461 /* Symbols to head events. */
462 Lisp_Object Qmouse_movement
;
463 Lisp_Object Qscroll_bar_movement
;
464 Lisp_Object Qswitch_frame
;
465 Lisp_Object Qdelete_frame
;
466 Lisp_Object Qiconify_frame
;
467 Lisp_Object Qmake_frame_visible
;
468 Lisp_Object Qselect_window
;
469 Lisp_Object Qhelp_echo
;
471 extern Lisp_Object Qremap
;
473 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
474 Lisp_Object Qmouse_fixup_help_message
;
477 /* Symbols to denote kinds of events. */
478 Lisp_Object Qfunction_key
;
479 Lisp_Object Qmouse_click
;
480 #if defined (WINDOWSNT)
481 Lisp_Object Qlanguage_change
;
483 Lisp_Object Qdrag_n_drop
;
484 Lisp_Object Qsave_session
;
486 Lisp_Object Qdbus_event
;
488 Lisp_Object Qxwidget_event
;
489 Lisp_Object Qconfig_changed_event
;
491 /* Lisp_Object Qmouse_movement; - also an event header */
493 /* Properties of event headers. */
494 Lisp_Object Qevent_kind
;
495 Lisp_Object Qevent_symbol_elements
;
497 /* menu item parts */
498 Lisp_Object Qmenu_enable
;
499 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
500 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
;
501 extern Lisp_Object Qmenu_item
;
503 /* An event header symbol HEAD may have a property named
504 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
505 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
506 mask of modifiers applied to it. If present, this is used to help
507 speed up parse_modifiers. */
508 Lisp_Object Qevent_symbol_element_mask
;
510 /* An unmodified event header BASE may have a property named
511 Qmodifier_cache, which is an alist mapping modifier masks onto
512 modified versions of BASE. If present, this helps speed up
514 Lisp_Object Qmodifier_cache
;
516 /* Symbols to use for parts of windows. */
517 Lisp_Object Qmode_line
;
518 Lisp_Object Qvertical_line
;
519 Lisp_Object Qvertical_scroll_bar
;
520 Lisp_Object Qmenu_bar
;
521 extern Lisp_Object Qleft_margin
, Qright_margin
;
522 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
523 extern Lisp_Object QCmap
;
525 Lisp_Object
recursive_edit_unwind (), command_loop ();
526 Lisp_Object
Fthis_command_keys ();
527 Lisp_Object Qextended_command_history
;
528 EMACS_TIME
timer_check ();
530 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
532 extern char *x_get_keysym_name ();
534 static void record_menu_key ();
535 static int echo_length ();
537 Lisp_Object Qpolling_period
;
539 /* List of absolute timers. Appears in order of next scheduled event. */
540 Lisp_Object Vtimer_list
;
542 /* List of idle time timers. Appears in order of next scheduled event. */
543 Lisp_Object Vtimer_idle_list
;
545 /* Incremented whenever a timer is run. */
548 extern Lisp_Object Vprint_level
, Vprint_length
;
550 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
552 EMACS_TIME
*input_available_clear_time
;
554 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
555 Default is 1 if INTERRUPT_INPUT is defined. */
558 /* Nonzero while interrupts are temporarily deferred during redisplay. */
559 int interrupts_deferred
;
561 /* Allow m- file to inhibit use of FIONREAD. */
562 #ifdef BROKEN_FIONREAD
566 /* We are unable to use interrupts if FIONREAD is not available,
567 so flush SIGIO so we won't try. */
568 #if !defined (FIONREAD)
574 /* If we support a window system, turn on the code to poll periodically
575 to detect C-g. It isn't actually used when doing interrupt input. */
576 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
577 #define POLL_FOR_INPUT
580 /* After a command is executed, if point is moved into a region that
581 has specific properties (e.g. composition, display), we adjust
582 point to the boundary of the region. But, if a command sets this
583 variable to non-nil, we suppress this point adjustment. This
584 variable is set to nil before reading a command. */
586 Lisp_Object Vdisable_point_adjustment
;
588 /* If non-nil, always disable point adjustment. */
590 Lisp_Object Vglobal_disable_point_adjustment
;
592 /* The time when Emacs started being idle. */
594 static EMACS_TIME timer_idleness_start_time
;
596 /* After Emacs stops being idle, this saves the last value
597 of timer_idleness_start_time from when it was idle. */
599 static EMACS_TIME timer_last_idleness_start_time
;
601 /* If non-nil, events produced by disabled menu items and tool-bar
602 buttons are not ignored. Help functions bind this to allow help on
603 those items and buttons. */
604 Lisp_Object Venable_disabled_menus_and_buttons
;
607 /* Global variable declarations. */
609 /* Flags for readable_events. */
610 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
611 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
612 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
614 /* Function for init_keyboard to call with no args (if nonzero). */
615 void (*keyboard_init_hook
) ();
617 static int read_avail_input
P_ ((int));
618 static void get_input_pending
P_ ((int *, int));
619 static int readable_events
P_ ((int));
620 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
621 Lisp_Object
, int *));
622 static Lisp_Object
read_char_x_menu_prompt ();
623 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
625 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
626 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
627 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
628 enum scroll_bar_part
,
629 Lisp_Object
, Lisp_Object
,
632 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
633 Lisp_Object
, char **,
634 Lisp_Object
*, unsigned));
635 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
636 static void save_getcjmp
P_ ((jmp_buf));
637 static void save_getcjmp ();
638 static void restore_getcjmp
P_ ((jmp_buf));
639 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
640 static void clear_event
P_ ((struct input_event
*));
641 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
642 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
643 static void handle_interrupt
P_ ((void));
644 static void timer_start_idle
P_ ((void));
645 static void timer_stop_idle
P_ ((void));
646 static void timer_resume_idle
P_ ((void));
647 static SIGTYPE handle_user_signal
P_ ((int));
648 static char *find_user_signal_name
P_ ((int));
649 static int store_user_signal_events
P_ ((void));
651 /* Nonzero means don't try to suspend even if the operating system seems
653 static int cannot_suspend
;
655 extern Lisp_Object Qidentity
, Qonly
;
657 /* Install the string STR as the beginning of the string of echoing,
658 so that it serves as a prompt for the next character.
659 Also start echoing. */
665 current_kboard
->echo_string
= str
;
666 current_kboard
->echo_after_prompt
= SCHARS (str
);
670 /* Add C to the echo string, if echoing is going on.
671 C can be a character, which is printed prettily ("M-C-x" and all that
672 jazz), or a symbol, whose name is printed. */
678 if (current_kboard
->immediate_echo
)
680 int size
= KEY_DESCRIPTION_SIZE
+ 100;
681 char *buffer
= (char *) alloca (size
);
683 Lisp_Object echo_string
;
685 echo_string
= current_kboard
->echo_string
;
687 /* If someone has passed us a composite event, use its head symbol. */
692 ptr
= push_key_description (XINT (c
), ptr
, 1);
694 else if (SYMBOLP (c
))
696 Lisp_Object name
= SYMBOL_NAME (c
);
697 int nbytes
= SBYTES (name
);
699 if (size
- (ptr
- buffer
) < nbytes
)
701 int offset
= ptr
- buffer
;
702 size
= max (2 * size
, size
+ nbytes
);
703 buffer
= (char *) alloca (size
);
704 ptr
= buffer
+ offset
;
707 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
708 STRING_MULTIBYTE (name
), 1);
711 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
714 const char *text
= " (Type ? for further options)";
715 int len
= strlen (text
);
717 if (size
- (ptr
- buffer
) < len
)
719 int offset
= ptr
- buffer
;
721 buffer
= (char *) alloca (size
);
722 ptr
= buffer
+ offset
;
725 bcopy (text
, ptr
, len
);
729 /* Replace a dash from echo_dash with a space, otherwise
730 add a space at the end as a separator between keys. */
731 if (STRINGP (echo_string
)
732 && SCHARS (echo_string
) > 1)
734 Lisp_Object last_char
, prev_char
, idx
;
736 idx
= make_number (SCHARS (echo_string
) - 2);
737 prev_char
= Faref (echo_string
, idx
);
739 idx
= make_number (SCHARS (echo_string
) - 1);
740 last_char
= Faref (echo_string
, idx
);
742 /* We test PREV_CHAR to make sure this isn't the echoing
744 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
745 Faset (echo_string
, idx
, make_number (' '));
747 echo_string
= concat2 (echo_string
, build_string (" "));
749 else if (STRINGP (echo_string
))
750 echo_string
= concat2 (echo_string
, build_string (" "));
752 current_kboard
->echo_string
753 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
759 /* Temporarily add a dash to the end of the echo string if it's not
760 empty, so that it serves as a mini-prompt for the very next character. */
765 /* Do nothing if not echoing at all. */
766 if (NILP (current_kboard
->echo_string
))
769 if (!current_kboard
->immediate_echo
770 && SCHARS (current_kboard
->echo_string
) == 0)
773 /* Do nothing if we just printed a prompt. */
774 if (current_kboard
->echo_after_prompt
775 == SCHARS (current_kboard
->echo_string
))
778 /* Do nothing if we have already put a dash at the end. */
779 if (SCHARS (current_kboard
->echo_string
) > 1)
781 Lisp_Object last_char
, prev_char
, idx
;
783 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
784 prev_char
= Faref (current_kboard
->echo_string
, idx
);
786 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
787 last_char
= Faref (current_kboard
->echo_string
, idx
);
789 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
793 /* Put a dash at the end of the buffer temporarily,
794 but make it go away when the next character is added. */
795 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
800 /* Display the current echo string, and begin echoing if not already
806 if (!current_kboard
->immediate_echo
)
809 current_kboard
->immediate_echo
= 1;
811 for (i
= 0; i
< this_command_key_count
; i
++)
815 /* Set before_command_echo_length to the value that would
816 have been saved before the start of this subcommand in
817 command_loop_1, if we had already been echoing then. */
818 if (i
== this_single_command_key_start
)
819 before_command_echo_length
= echo_length ();
821 c
= XVECTOR (this_command_keys
)->contents
[i
];
822 if (! (EVENT_HAS_PARAMETERS (c
)
823 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
827 /* Set before_command_echo_length to the value that would
828 have been saved before the start of this subcommand in
829 command_loop_1, if we had already been echoing then. */
830 if (this_command_key_count
== this_single_command_key_start
)
831 before_command_echo_length
= echo_length ();
833 /* Put a dash at the end to invite the user to type more. */
838 message3_nolog (current_kboard
->echo_string
,
839 SBYTES (current_kboard
->echo_string
),
840 STRING_MULTIBYTE (current_kboard
->echo_string
));
843 /* Record in what buffer we echoed, and from which kboard. */
844 echo_message_buffer
= echo_area_buffer
[0];
845 echo_kboard
= current_kboard
;
847 if (waiting_for_input
&& !NILP (Vquit_flag
))
848 quit_throw_to_read_char ();
851 /* Turn off echoing, for the start of a new command. */
856 current_kboard
->immediate_echo
= 0;
857 current_kboard
->echo_after_prompt
= -1;
858 current_kboard
->echo_string
= Qnil
;
859 ok_to_echo_at_next_pause
= NULL
;
861 echo_message_buffer
= Qnil
;
864 /* Return the length of the current echo string. */
869 return (STRINGP (current_kboard
->echo_string
)
870 ? SCHARS (current_kboard
->echo_string
)
874 /* Truncate the current echo message to its first LEN chars.
875 This and echo_char get used by read_key_sequence when the user
876 switches frames while entering a key sequence. */
879 echo_truncate (nchars
)
882 if (STRINGP (current_kboard
->echo_string
))
883 current_kboard
->echo_string
884 = Fsubstring (current_kboard
->echo_string
,
885 make_number (0), make_number (nchars
));
886 truncate_echo_area (nchars
);
890 /* Functions for manipulating this_command_keys. */
892 add_command_key (key
)
895 #if 0 /* Not needed after we made Freset_this_command_lengths
896 do the job immediately. */
897 /* If reset-this-command-length was called recently, obey it now.
898 See the doc string of that function for an explanation of why. */
899 if (before_command_restore_flag
)
901 this_command_key_count
= before_command_key_count_1
;
902 if (this_command_key_count
< this_single_command_key_start
)
903 this_single_command_key_start
= this_command_key_count
;
904 echo_truncate (before_command_echo_length_1
);
905 before_command_restore_flag
= 0;
909 if (this_command_key_count
>= ASIZE (this_command_keys
))
910 this_command_keys
= larger_vector (this_command_keys
,
911 2 * ASIZE (this_command_keys
),
914 ASET (this_command_keys
, this_command_key_count
, key
);
915 ++this_command_key_count
;
922 int count
= SPECPDL_INDEX ();
925 if (command_loop_level
> 0)
927 specbind (Qstandard_output
, Qt
);
928 specbind (Qstandard_input
, Qt
);
931 #ifdef HAVE_WINDOW_SYSTEM
932 /* The command loop has started an hourglass timer, so we have to
933 cancel it here, otherwise it will fire because the recursive edit
934 can take some time. Do not check for display_hourglass_p here,
935 because it could already be nil. */
939 /* This function may have been called from a debugger called from
940 within redisplay, for instance by Edebugging a function called
941 from fontification-functions. We want to allow redisplay in
942 the debugging session.
944 The recursive edit is left with a `(throw exit ...)'. The `exit'
945 tag is not caught anywhere in redisplay, i.e. when we leave the
946 recursive edit, the original redisplay leading to the recursive
947 edit will be unwound. The outcome should therefore be safe. */
948 specbind (Qinhibit_redisplay
, Qnil
);
951 val
= command_loop ();
953 Fsignal (Qquit
, Qnil
);
954 /* Handle throw from read_minibuf when using minibuffer
955 while it's active but we're in another window. */
957 xsignal1 (Qerror
, val
);
959 return unbind_to (count
, Qnil
);
962 /* When an auto-save happens, record the "time", and don't do again soon. */
967 last_auto_save
= num_nonmacro_input_events
;
970 /* Make an auto save happen as soon as possible at command level. */
973 force_auto_save_soon ()
975 last_auto_save
= - auto_save_interval
- 1;
977 record_asynch_buffer_change ();
980 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
981 doc
: /* Invoke the editor command loop recursively.
982 To get out of the recursive edit, a command can do `(throw 'exit nil)';
983 that tells this function to return.
984 Alternatively, `(throw 'exit t)' makes this function signal an error.
985 This function is called by the editor initialization to begin editing. */)
988 int count
= SPECPDL_INDEX ();
991 /* If we enter while input is blocked, don't lock up here.
992 This may happen through the debugger during redisplay. */
996 command_loop_level
++;
997 update_mode_lines
= 1;
999 if (command_loop_level
1000 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1001 buffer
= Fcurrent_buffer ();
1005 /* If we leave recursive_edit_1 below with a `throw' for instance,
1006 like it is done in the splash screen display, we have to
1007 make sure that we restore single_kboard as command_loop_1
1008 would have done if it were left normally. */
1009 if (command_loop_level
> 0)
1010 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1011 record_unwind_protect (recursive_edit_unwind
, buffer
);
1013 recursive_edit_1 ();
1014 return unbind_to (count
, Qnil
);
1018 recursive_edit_unwind (buffer
)
1021 if (BUFFERP (buffer
))
1022 Fset_buffer (buffer
);
1024 command_loop_level
--;
1025 update_mode_lines
= 1;
1030 #if 0 /* These two functions are now replaced with
1031 temporarily_switch_to_single_kboard. */
1035 #if 0 /* Theory: if there's anything in Vunread_command_events,
1036 it will right away be read by read_key_sequence,
1037 and then if we do switch KBOARDS, it will go into the side
1038 queue then. So we don't need to do anything special here -- rms. */
1039 if (CONSP (Vunread_command_events
))
1041 current_kboard
->kbd_queue
1042 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1043 current_kboard
->kbd_queue_has_data
= 1;
1045 Vunread_command_events
= Qnil
;
1050 /* Switch to the single-kboard state, making current_kboard
1051 the only KBOARD from which further input is accepted. */
1054 single_kboard_state ()
1060 /* If we're in single_kboard state for kboard KBOARD,
1064 not_single_kboard_state (kboard
)
1067 if (kboard
== current_kboard
)
1071 /* Maintain a stack of kboards, so other parts of Emacs
1072 can switch temporarily to the kboard of a given frame
1073 and then revert to the previous status. */
1078 struct kboard_stack
*next
;
1081 static struct kboard_stack
*kboard_stack
;
1087 struct kboard_stack
*p
1088 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1090 p
->next
= kboard_stack
;
1091 p
->kboard
= current_kboard
;
1101 struct kboard_stack
*p
= kboard_stack
;
1103 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1105 if (t
->kboard
== p
->kboard
)
1107 current_kboard
= p
->kboard
;
1114 /* The terminal we remembered has been deleted. */
1115 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1118 kboard_stack
= p
->next
;
1122 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1123 from which further input is accepted. If F is non-nil, set its
1124 KBOARD as the current keyboard.
1126 This function uses record_unwind_protect to return to the previous
1129 If Emacs is already in single_kboard mode, and F's keyboard is
1130 locked, then this function will throw an errow. */
1133 temporarily_switch_to_single_kboard (f
)
1136 int was_locked
= single_kboard
;
1139 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1140 /* We can not switch keyboards while in single_kboard mode.
1141 In rare cases, Lisp code may call `recursive-edit' (or
1142 `read-minibuffer' or `y-or-n-p') after it switched to a
1143 locked frame. For example, this is likely to happen
1144 when server.el connects to a new terminal while Emacs is in
1145 single_kboard mode. It is best to throw an error instead
1146 of presenting the user with a frozen screen. */
1147 error ("Terminal %d is locked, cannot read from it",
1148 FRAME_TERMINAL (f
)->id
);
1150 /* This call is unnecessary, but helps
1151 `restore_kboard_configuration' discover if somebody changed
1152 `current_kboard' behind our back. */
1153 push_kboard (current_kboard
);
1156 current_kboard
= FRAME_KBOARD (f
);
1158 record_unwind_protect (restore_kboard_configuration
,
1159 (was_locked
? Qt
: Qnil
));
1162 #if 0 /* This function is not needed anymore. */
1164 record_single_kboard_state ()
1167 push_kboard (current_kboard
);
1168 record_unwind_protect (restore_kboard_configuration
,
1169 (single_kboard
? Qt
: Qnil
));
1174 restore_kboard_configuration (was_locked
)
1175 Lisp_Object was_locked
;
1177 if (NILP (was_locked
))
1181 struct kboard
*prev
= current_kboard
;
1184 /* The pop should not change the kboard. */
1185 if (single_kboard
&& current_kboard
!= prev
)
1192 /* Handle errors that are not handled at inner levels
1193 by printing an error message and returning to the editor command loop. */
1199 Lisp_Object old_level
, old_length
;
1200 char macroerror
[50];
1202 #ifdef HAVE_WINDOW_SYSTEM
1203 if (display_hourglass_p
)
1204 cancel_hourglass ();
1207 if (!NILP (executing_kbd_macro
))
1209 if (executing_kbd_macro_iterations
== 1)
1210 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1212 sprintf (macroerror
, "After %d kbd macro iterations: ",
1213 executing_kbd_macro_iterations
);
1218 Vstandard_output
= Qt
;
1219 Vstandard_input
= Qt
;
1220 Vexecuting_kbd_macro
= Qnil
;
1221 executing_kbd_macro
= Qnil
;
1222 current_kboard
->Vprefix_arg
= Qnil
;
1223 current_kboard
->Vlast_prefix_arg
= Qnil
;
1226 /* Avoid unquittable loop if data contains a circular list. */
1227 old_level
= Vprint_level
;
1228 old_length
= Vprint_length
;
1229 XSETFASTINT (Vprint_level
, 10);
1230 XSETFASTINT (Vprint_length
, 10);
1231 cmd_error_internal (data
, macroerror
);
1232 Vprint_level
= old_level
;
1233 Vprint_length
= old_length
;
1237 Vinhibit_quit
= Qnil
;
1238 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1239 if (command_loop_level
== 0 && minibuf_level
== 0)
1240 any_kboard_state ();
1243 return make_number (0);
1246 /* Take actions on handling an error. DATA is the data that describes
1249 CONTEXT is a C-string containing ASCII characters only which
1250 describes the context in which the error happened. If we need to
1251 generalize CONTEXT to allow multibyte characters, make it a Lisp
1255 cmd_error_internal (data
, context
)
1259 struct frame
*sf
= SELECTED_FRAME ();
1261 /* The immediate context is not interesting for Quits,
1262 since they are asyncronous. */
1263 if (EQ (XCAR (data
), Qquit
))
1264 Vsignaling_function
= Qnil
;
1269 /* Use user's specified output function if any. */
1270 if (!NILP (Vcommand_error_function
))
1271 call3 (Vcommand_error_function
, data
,
1272 context
? build_string (context
) : empty_unibyte_string
,
1273 Vsignaling_function
);
1274 /* If the window system or terminal frame hasn't been initialized
1275 yet, or we're not interactive, write the message to stderr and exit. */
1276 else if (!sf
->glyphs_initialized_p
1277 /* The initial frame is a special non-displaying frame. It
1278 will be current in daemon mode when there are no frames
1279 to display, and in non-daemon mode before the real frame
1280 has finished initializing. If an error is thrown in the
1281 latter case while creating the frame, then the frame
1282 will never be displayed, so the safest thing to do is
1283 write to stderr and quit. In daemon mode, there are
1284 many other potential errors that do not prevent frames
1285 from being created, so continuing as normal is better in
1287 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1290 print_error_message (data
, Qexternal_debugging_output
,
1291 context
, Vsignaling_function
);
1292 Fterpri (Qexternal_debugging_output
);
1293 Fkill_emacs (make_number (-1));
1297 clear_message (1, 0);
1299 message_log_maybe_newline ();
1302 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1305 Vsignaling_function
= Qnil
;
1308 Lisp_Object
command_loop_1 ();
1309 Lisp_Object
command_loop_2 ();
1310 Lisp_Object
top_level_1 ();
1312 /* Entry to editor-command-loop.
1313 This level has the catches for exiting/returning to editor command loop.
1314 It returns nil to exit recursive edit, t to abort it. */
1319 if (command_loop_level
> 0 || minibuf_level
> 0)
1322 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1323 executing_kbd_macro
= Qnil
;
1329 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1330 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1331 /* Reset single_kboard in case top-level set it while
1332 evaluating an -f option, or we are stuck there for some
1334 any_kboard_state ();
1336 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1337 executing_kbd_macro
= Qnil
;
1339 /* End of file in -batch run causes exit here. */
1345 /* Here we catch errors in execution of commands within the
1346 editing loop, and reenter the editing loop.
1347 When there is an error, cmd_error runs and returns a non-nil
1348 value to us. A value of nil means that command_loop_1 itself
1349 returned due to end of file (or end of kbd macro). */
1354 register Lisp_Object val
;
1357 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1358 while (!NILP (val
));
1366 return Feval (Vtop_level
);
1372 /* On entry to the outer level, run the startup file */
1373 if (!NILP (Vtop_level
))
1374 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1375 else if (!NILP (Vpurify_flag
))
1376 message ("Bare impure Emacs (standard Lisp code not loaded)");
1378 message ("Bare Emacs (standard Lisp code not loaded)");
1382 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1383 doc
: /* Exit all recursive editing levels.
1384 This also exits all active minibuffers. */)
1387 #ifdef HAVE_WINDOW_SYSTEM
1388 if (display_hourglass_p
)
1389 cancel_hourglass ();
1392 /* Unblock input if we enter with input blocked. This may happen if
1393 redisplay traps e.g. during tool-bar update with input blocked. */
1394 while (INPUT_BLOCKED_P
)
1397 return Fthrow (Qtop_level
, Qnil
);
1400 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1401 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1404 if (command_loop_level
> 0 || minibuf_level
> 0)
1405 Fthrow (Qexit
, Qnil
);
1407 error ("No recursive edit is in progress");
1411 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1412 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1415 if (command_loop_level
> 0 || minibuf_level
> 0)
1418 error ("No recursive edit is in progress");
1422 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1424 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1425 of this function. */
1428 tracking_off (old_value
)
1429 Lisp_Object old_value
;
1431 do_mouse_tracking
= old_value
;
1432 if (NILP (old_value
))
1434 /* Redisplay may have been preempted because there was input
1435 available, and it assumes it will be called again after the
1436 input has been processed. If the only input available was
1437 the sort that we have just disabled, then we need to call
1439 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1441 redisplay_preserve_echo_area (6);
1442 get_input_pending (&input_pending
,
1443 READABLE_EVENTS_DO_TIMERS_NOW
);
1449 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1450 doc
: /* Evaluate BODY with mouse movement events enabled.
1451 Within a `track-mouse' form, mouse motion generates input events that
1452 you can read with `read-event'.
1453 Normally, mouse motion is ignored.
1454 usage: (track-mouse BODY...) */)
1458 int count
= SPECPDL_INDEX ();
1461 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1463 do_mouse_tracking
= Qt
;
1465 val
= Fprogn (args
);
1466 return unbind_to (count
, val
);
1469 /* If mouse has moved on some frame, return one of those frames.
1473 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1474 after resizing the tool-bar window. */
1476 int ignore_mouse_drag_p
;
1481 Lisp_Object tail
, frame
;
1483 if (ignore_mouse_drag_p
)
1485 /* ignore_mouse_drag_p = 0; */
1489 FOR_EACH_FRAME (tail
, frame
)
1491 if (XFRAME (frame
)->mouse_moved
)
1492 return XFRAME (frame
);
1498 #endif /* HAVE_MOUSE || HAVE_GPM */
1500 /* This is the actual command reading loop,
1501 sans error-handling encapsulation. */
1503 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1505 void safe_run_hooks
P_ ((Lisp_Object
));
1506 static void adjust_point_for_property
P_ ((int, int));
1508 /* Cancel hourglass from protect_unwind.
1510 #ifdef HAVE_WINDOW_SYSTEM
1512 cancel_hourglass_unwind (arg
)
1515 cancel_hourglass ();
1524 Lisp_Object keybuf
[30];
1526 int prev_modiff
= 0;
1527 struct buffer
*prev_buffer
= NULL
;
1528 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1529 int was_locked
= single_kboard
;
1531 int already_adjusted
= 0;
1533 current_kboard
->Vprefix_arg
= Qnil
;
1534 current_kboard
->Vlast_prefix_arg
= Qnil
;
1535 Vdeactivate_mark
= Qnil
;
1536 waiting_for_input
= 0;
1539 this_command_key_count
= 0;
1540 this_command_key_count_reset
= 0;
1541 this_single_command_key_start
= 0;
1543 if (NILP (Vmemory_full
))
1545 /* Make sure this hook runs after commands that get errors and
1546 throw to top level. */
1547 /* Note that the value cell will never directly contain nil
1548 if the symbol is a local variable. */
1549 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1550 safe_run_hooks (Qpost_command_hook
);
1552 /* If displaying a message, resize the echo area window to fit
1553 that message's size exactly. */
1554 if (!NILP (echo_area_buffer
[0]))
1555 resize_echo_area_exactly ();
1557 if (!NILP (Vdeferred_action_list
))
1558 safe_run_hooks (Qdeferred_action_function
);
1561 /* Do this after running Vpost_command_hook, for consistency. */
1562 current_kboard
->Vlast_command
= Vthis_command
;
1563 current_kboard
->Vreal_last_command
= real_this_command
;
1564 if (!CONSP (last_command_event
))
1565 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1569 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1572 /* Make sure the current window's buffer is selected. */
1573 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1574 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1576 /* Display any malloc warning that just came out. Use while because
1577 displaying one warning can cause another. */
1579 while (pending_malloc_warning
)
1580 display_malloc_warning ();
1582 Vdeactivate_mark
= Qnil
;
1584 /* If minibuffer on and echo area in use,
1585 wait a short time and redraw minibuffer. */
1588 && !NILP (echo_area_buffer
[0])
1589 && EQ (minibuf_window
, echo_area_window
)
1590 && NUMBERP (Vminibuffer_message_timeout
))
1592 /* Bind inhibit-quit to t so that C-g gets read in
1593 rather than quitting back to the minibuffer. */
1594 int count
= SPECPDL_INDEX ();
1595 specbind (Qinhibit_quit
, Qt
);
1597 sit_for (Vminibuffer_message_timeout
, 0, 2);
1599 /* Clear the echo area. */
1601 safe_run_hooks (Qecho_area_clear_hook
);
1603 unbind_to (count
, Qnil
);
1605 /* If a C-g came in before, treat it as input now. */
1606 if (!NILP (Vquit_flag
))
1609 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1614 /* Select the frame that the last event came from. Usually,
1615 switch-frame events will take care of this, but if some lisp
1616 code swallows a switch-frame event, we'll fix things up here.
1617 Is this a good idea? */
1618 if (FRAMEP (internal_last_event_frame
)
1619 && !EQ (internal_last_event_frame
, selected_frame
))
1620 Fselect_frame (internal_last_event_frame
, Qnil
);
1622 /* If it has changed current-menubar from previous value,
1623 really recompute the menubar from the value. */
1624 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1625 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1626 call0 (Qrecompute_lucid_menubar
);
1628 before_command_key_count
= this_command_key_count
;
1629 before_command_echo_length
= echo_length ();
1631 Vthis_command
= Qnil
;
1632 real_this_command
= Qnil
;
1633 Vthis_original_command
= Qnil
;
1634 Vthis_command_keys_shift_translated
= Qnil
;
1636 /* Read next key sequence; i gets its length. */
1637 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1640 /* A filter may have run while we were reading the input. */
1641 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1643 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1644 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1648 /* Now we have read a key sequence of length I,
1649 or else I is 0 and we found end of file. */
1651 if (i
== 0) /* End of file -- happens only in */
1652 return Qnil
; /* a kbd macro, at the end. */
1653 /* -1 means read_key_sequence got a menu that was rejected.
1654 Just loop around and read another command. */
1658 this_command_key_count
= 0;
1659 this_command_key_count_reset
= 0;
1660 this_single_command_key_start
= 0;
1664 last_command_event
= keybuf
[i
- 1];
1666 /* If the previous command tried to force a specific window-start,
1667 forget about that, in case this command moves point far away
1668 from that position. But also throw away beg_unchanged and
1669 end_unchanged information in that case, so that redisplay will
1670 update the whole window properly. */
1671 if (!NILP (XWINDOW (selected_window
)->force_start
))
1674 XWINDOW (selected_window
)->force_start
= Qnil
;
1675 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1676 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1679 cmd
= read_key_sequence_cmd
;
1680 if (!NILP (Vexecuting_kbd_macro
))
1682 if (!NILP (Vquit_flag
))
1684 Vexecuting_kbd_macro
= Qt
;
1685 QUIT
; /* Make some noise. */
1686 /* Will return since macro now empty. */
1690 /* Do redisplay processing after this command except in special
1691 cases identified below. */
1692 prev_buffer
= current_buffer
;
1693 prev_modiff
= MODIFF
;
1694 last_point_position
= PT
;
1695 last_point_position_window
= selected_window
;
1696 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1698 /* By default, we adjust point to a boundary of a region that
1699 has such a property that should be treated intangible
1700 (e.g. composition, display). But, some commands will set
1701 this variable differently. */
1702 Vdisable_point_adjustment
= Qnil
;
1704 /* Process filters and timers may have messed with deactivate-mark.
1705 reset it before we execute the command. */
1706 Vdeactivate_mark
= Qnil
;
1708 /* Remap command through active keymaps */
1709 Vthis_original_command
= cmd
;
1713 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1717 /* Execute the command. */
1719 Vthis_command
= cmd
;
1720 real_this_command
= cmd
;
1721 /* Note that the value cell will never directly contain nil
1722 if the symbol is a local variable. */
1723 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1724 safe_run_hooks (Qpre_command_hook
);
1726 already_adjusted
= 0;
1728 if (NILP (Vthis_command
))
1730 /* nil means key is undefined. */
1731 Lisp_Object keys
= Fvector (i
, keybuf
);
1732 keys
= Fkey_description (keys
, Qnil
);
1734 message_with_string ("%s is undefined", keys
, 0);
1735 current_kboard
->defining_kbd_macro
= Qnil
;
1736 update_mode_lines
= 1;
1737 current_kboard
->Vprefix_arg
= Qnil
;
1741 /* Here for a command that isn't executed directly */
1743 #ifdef HAVE_WINDOW_SYSTEM
1744 int scount
= SPECPDL_INDEX ();
1746 if (display_hourglass_p
1747 && NILP (Vexecuting_kbd_macro
))
1749 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1754 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1756 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1758 #ifdef HAVE_WINDOW_SYSTEM
1759 /* Do not check display_hourglass_p here, because
1760 Fcommand_execute could change it, but we should cancel
1761 hourglass cursor anyway.
1762 But don't cancel the hourglass within a macro
1763 just because a command in the macro finishes. */
1764 if (NILP (Vexecuting_kbd_macro
))
1765 unbind_to (scount
, Qnil
);
1768 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1770 /* Note that the value cell will never directly contain nil
1771 if the symbol is a local variable. */
1772 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1773 safe_run_hooks (Qpost_command_hook
);
1775 /* If displaying a message, resize the echo area window to fit
1776 that message's size exactly. */
1777 if (!NILP (echo_area_buffer
[0]))
1778 resize_echo_area_exactly ();
1780 if (!NILP (Vdeferred_action_list
))
1781 safe_run_hooks (Qdeferred_action_function
);
1783 /* If there is a prefix argument,
1784 1) We don't want Vlast_command to be ``universal-argument''
1785 (that would be dumb), so don't set Vlast_command,
1786 2) we want to leave echoing on so that the prefix will be
1787 echoed as part of this key sequence, so don't call
1789 3) we want to leave this_command_key_count non-zero, so that
1790 read_char will realize that it is re-reading a character, and
1791 not echo it a second time.
1793 If the command didn't actually create a prefix arg,
1794 but is merely a frame event that is transparent to prefix args,
1795 then the above doesn't apply. */
1796 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1798 current_kboard
->Vlast_command
= Vthis_command
;
1799 current_kboard
->Vreal_last_command
= real_this_command
;
1800 if (!CONSP (last_command_event
))
1801 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1803 this_command_key_count
= 0;
1804 this_command_key_count_reset
= 0;
1805 this_single_command_key_start
= 0;
1808 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1810 /* In Emacs 22, setting transient-mark-mode to `only' was a
1811 way of turning it on for just one command. This usage is
1812 obsolete, but support it anyway. */
1813 if (EQ (Vtransient_mark_mode
, Qidentity
))
1814 Vtransient_mark_mode
= Qnil
;
1815 else if (EQ (Vtransient_mark_mode
, Qonly
))
1816 Vtransient_mark_mode
= Qidentity
;
1818 if (!NILP (Vdeactivate_mark
))
1819 call0 (Qdeactivate_mark
);
1820 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1821 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1826 if (current_buffer
== prev_buffer
1827 && last_point_position
!= PT
1828 && NILP (Vdisable_point_adjustment
)
1829 && NILP (Vglobal_disable_point_adjustment
))
1831 if (last_point_position
> BEGV
1832 && last_point_position
< ZV
1833 && (composition_adjust_point (last_point_position
,
1834 last_point_position
)
1835 != last_point_position
))
1836 /* The last point was temporarily set within a grapheme
1837 cluster to prevent automatic composition. To recover
1838 the automatic composition, we must update the
1840 windows_or_buffers_changed
++;
1841 if (!already_adjusted
)
1842 adjust_point_for_property (last_point_position
,
1843 MODIFF
!= prev_modiff
);
1846 /* Install chars successfully executed in kbd macro. */
1848 if (!NILP (current_kboard
->defining_kbd_macro
)
1849 && NILP (current_kboard
->Vprefix_arg
))
1850 finalize_kbd_macro_chars ();
1851 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1853 any_kboard_state ();
1858 extern Lisp_Object Qcomposition
, Qdisplay
;
1860 /* Adjust point to a boundary of a region that has such a property
1861 that should be treated intangible. For the moment, we check
1862 `composition', `display' and `invisible' properties.
1863 LAST_PT is the last position of point. */
1865 extern Lisp_Object Qafter_string
, Qbefore_string
;
1866 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1869 adjust_point_for_property (last_pt
, modified
)
1874 Lisp_Object val
, overlay
, tmp
;
1875 /* When called after buffer modification, we should temporarily
1876 suppress the point adjustment for automatic composition so that a
1877 user can keep inserting another character at point or keep
1878 deleting characters around point. */
1879 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1882 /* FIXME: cycling is probably not necessary because these properties
1883 can't be usefully combined anyway. */
1884 while (check_composition
|| check_display
|| check_invisible
)
1886 /* FIXME: check `intangible'. */
1887 if (check_composition
1888 && PT
> BEGV
&& PT
< ZV
1889 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1892 check_display
= check_invisible
= 1;
1894 check_composition
= 0;
1896 && PT
> BEGV
&& PT
< ZV
1897 && !NILP (val
= get_char_property_and_overlay
1898 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1899 && display_prop_intangible_p (val
)
1900 && (!OVERLAYP (overlay
)
1901 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1902 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1903 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1904 && (beg
< PT
/* && end > PT <- It's always the case. */
1905 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1908 SET_PT (PT
< last_pt
1909 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1911 check_composition
= check_invisible
= 1;
1914 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1916 int inv
, ellipsis
= 0;
1919 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1922 /* FIXME: We should stop if we find a spot between
1923 two runs of `invisible' where inserted text would
1924 be visible. This is important when we have two
1925 invisible boundaries that enclose an area: if the
1926 area is empty, we need this test in order to make
1927 it possible to place point in the middle rather
1928 than skip both boundaries. However, this code
1929 also stops anywhere in a non-sticky text-property,
1930 which breaks (e.g.) Org mode. */
1931 && (val
= get_pos_property (make_number (end
),
1933 TEXT_PROP_MEANS_INVISIBLE (val
))
1935 && !NILP (val
= get_char_property_and_overlay
1936 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1937 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1939 ellipsis
= ellipsis
|| inv
> 1
1940 || (OVERLAYP (overlay
)
1941 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1942 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1943 tmp
= Fnext_single_char_property_change
1944 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1945 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1949 && (val
= get_pos_property (make_number (beg
),
1951 TEXT_PROP_MEANS_INVISIBLE (val
))
1953 && !NILP (val
= get_char_property_and_overlay
1954 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1955 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1957 ellipsis
= ellipsis
|| inv
> 1
1958 || (OVERLAYP (overlay
)
1959 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1960 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1961 tmp
= Fprevious_single_char_property_change
1962 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1963 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1966 /* Move away from the inside area. */
1967 if (beg
< PT
&& end
> PT
)
1969 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1970 /* We haven't moved yet (so we don't need to fear
1971 infinite-looping) and we were outside the range
1972 before (so either end of the range still corresponds
1973 to a move in the right direction): pretend we moved
1974 less than we actually did, so that we still have
1975 more freedom below in choosing which end of the range
1977 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1978 /* We either have moved already or the last point
1979 was already in the range: we don't get to choose
1980 which end of the range we have to go to. */
1981 : (PT
< last_pt
? beg
: end
));
1982 check_composition
= check_display
= 1;
1984 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1985 the point to something other than its argument, due to
1986 point-motion hooks, intangibility, etc. */
1987 xassert (PT
== beg
|| PT
== end
);
1990 /* Pretend the area doesn't exist if the buffer is not
1992 if (!modified
&& !ellipsis
&& beg
< end
)
1994 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1995 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1996 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1997 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1998 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1999 /* We've already moved as far as we can. Trying to go
2000 to the other end would mean moving backwards and thus
2001 could lead to an infinite loop. */
2003 else if (val
= get_pos_property (make_number (PT
),
2005 TEXT_PROP_MEANS_INVISIBLE (val
)
2006 && (val
= get_pos_property
2007 (make_number (PT
== beg
? end
: beg
),
2009 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2010 (check_composition
= check_display
= 1,
2011 SET_PT (PT
== beg
? end
: beg
));
2014 check_invisible
= 0;
2018 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2021 safe_run_hooks_1 (hook
)
2024 if (NILP (Vrun_hooks
))
2026 return call1 (Vrun_hooks
, Vinhibit_quit
);
2029 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2032 safe_run_hooks_error (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 (hook
)
2051 int count
= SPECPDL_INDEX ();
2052 specbind (Qinhibit_quit
, hook
);
2054 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2056 unbind_to (count
, Qnil
);
2060 /* Number of seconds between polling for input. This is a Lisp
2061 variable that can be bound. */
2063 EMACS_INT polling_period
;
2065 /* Nonzero means polling for input is temporarily suppressed. */
2067 int poll_suppress_count
;
2069 /* Asynchronous timer for polling. */
2071 struct atimer
*poll_timer
;
2074 #ifdef POLL_FOR_INPUT
2076 /* Poll for input, so that we catch a C-g if it comes in. This
2077 function is called from x_make_frame_visible, see comment
2083 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2084 doing anything dangerous. */
2088 if (interrupt_input_blocked
== 0
2089 && !waiting_for_input
)
2090 read_avail_input (0);
2096 /* Timer callback function for poll_timer. TIMER is equal to
2100 poll_for_input (timer
)
2101 struct atimer
*timer
;
2103 if (poll_suppress_count
== 0)
2106 interrupt_input_pending
= 1;
2107 pending_signals
= 1;
2109 poll_for_input_1 ();
2114 #endif /* POLL_FOR_INPUT */
2116 /* Begin signals to poll for input, if they are appropriate.
2117 This function is called unconditionally from various places. */
2122 #ifdef POLL_FOR_INPUT
2123 /* XXX This condition was (read_socket_hook && !interrupt_input),
2124 but read_socket_hook is not global anymore. Let's pretend that
2126 if (!interrupt_input
)
2128 /* Turn alarm handling on unconditionally. It might have
2129 been turned off in process.c. */
2130 turn_on_atimers (1);
2132 /* If poll timer doesn't exist, are we need one with
2133 a different interval, start a new one. */
2134 if (poll_timer
== NULL
2135 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2137 EMACS_TIME interval
;
2140 cancel_atimer (poll_timer
);
2142 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2143 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2144 poll_for_input
, NULL
);
2147 /* Let the timer's callback function poll for input
2148 if this becomes zero. */
2149 --poll_suppress_count
;
2154 /* Nonzero if we are using polling to handle input asynchronously. */
2157 input_polling_used ()
2159 #ifdef POLL_FOR_INPUT
2160 /* XXX This condition was (read_socket_hook && !interrupt_input),
2161 but read_socket_hook is not global anymore. Let's pretend that
2163 return !interrupt_input
;
2169 /* Turn off polling. */
2174 #ifdef POLL_FOR_INPUT
2175 /* XXX This condition was (read_socket_hook && !interrupt_input),
2176 but read_socket_hook is not global anymore. Let's pretend that
2178 if (!interrupt_input
)
2179 ++poll_suppress_count
;
2183 /* Set the value of poll_suppress_count to COUNT
2184 and start or stop polling accordingly. */
2187 set_poll_suppress_count (count
)
2190 #ifdef POLL_FOR_INPUT
2191 if (count
== 0 && poll_suppress_count
!= 0)
2193 poll_suppress_count
= 1;
2196 else if (count
!= 0 && poll_suppress_count
== 0)
2200 poll_suppress_count
= count
;
2204 /* Bind polling_period to a value at least N.
2205 But don't decrease it. */
2208 bind_polling_period (n
)
2211 #ifdef POLL_FOR_INPUT
2212 int new = polling_period
;
2217 stop_other_atimers (poll_timer
);
2219 specbind (Qpolling_period
, make_number (new));
2220 /* Start a new alarm with the new period. */
2225 /* Apply the control modifier to CHARACTER. */
2231 /* Save the upper bits here. */
2232 int upper
= c
& ~0177;
2234 if (! ASCII_BYTE_P (c
))
2235 return c
|= ctrl_modifier
;
2239 /* Everything in the columns containing the upper-case letters
2240 denotes a control character. */
2241 if (c
>= 0100 && c
< 0140)
2245 /* Set the shift modifier for a control char
2246 made from a shifted letter. But only for letters! */
2247 if (oc
>= 'A' && oc
<= 'Z')
2248 c
|= shift_modifier
;
2251 /* The lower-case letters denote control characters too. */
2252 else if (c
>= 'a' && c
<= 'z')
2255 /* Include the bits for control and shift
2256 only if the basic ASCII code can't indicate them. */
2260 /* Replace the high bits. */
2261 c
|= (upper
& ~ctrl_modifier
);
2266 /* Display the help-echo property of the character after the mouse pointer.
2267 Either show it in the echo area, or call show-help-function to display
2268 it by other means (maybe in a tooltip).
2270 If HELP is nil, that means clear the previous help echo.
2272 If HELP is a string, display that string. If HELP is a function,
2273 call it with OBJECT and POS as arguments; the function should
2274 return a help string or nil for none. For all other types of HELP,
2275 evaluate it to obtain a string.
2277 WINDOW is the window in which the help was generated, if any.
2278 It is nil if not in a window.
2280 If OBJECT is a buffer, POS is the position in the buffer where the
2281 `help-echo' text property was found.
2283 If OBJECT is an overlay, that overlay has a `help-echo' property,
2284 and POS is the position in the overlay's buffer under the mouse.
2286 If OBJECT is a string (an overlay string or a string displayed with
2287 the `display' property). POS is the position in that string under
2290 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2291 echo overwrites a keystroke echo currently displayed in the echo
2294 Note: this function may only be called with HELP nil or a string
2295 from X code running asynchronously. */
2298 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2299 Lisp_Object help
, window
, object
, pos
;
2300 int ok_to_overwrite_keystroke_echo
;
2302 if (!NILP (help
) && !STRINGP (help
))
2304 if (FUNCTIONP (help
))
2306 Lisp_Object args
[4];
2311 help
= safe_call (4, args
);
2314 help
= safe_eval (help
);
2316 if (!STRINGP (help
))
2320 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2321 if (!noninteractive
&& STRINGP (help
))
2323 /* The mouse-fixup-help-message Lisp function can call
2324 mouse_position_hook, which resets the mouse_moved flags.
2325 This causes trouble if we are trying to read a mouse motion
2326 event (i.e., if we are inside a `track-mouse' form), so we
2327 restore the mouse_moved flag. */
2328 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2329 help
= call1 (Qmouse_fixup_help_message
, help
);
2335 if (STRINGP (help
) || NILP (help
))
2337 if (!NILP (Vshow_help_function
))
2338 call1 (Vshow_help_function
, help
);
2339 help_echo_showing_p
= STRINGP (help
);
2345 /* Input of single characters from keyboard */
2347 Lisp_Object
print_help ();
2348 static Lisp_Object
kbd_buffer_get_event ();
2349 static void record_char ();
2351 static Lisp_Object help_form_saved_window_configs
;
2353 read_char_help_form_unwind (Lisp_Object arg
)
2355 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2356 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2357 if (!NILP (window_config
))
2358 Fset_window_configuration (window_config
);
2362 #define STOP_POLLING \
2363 do { if (! polling_stopped_here) stop_polling (); \
2364 polling_stopped_here = 1; } while (0)
2366 #define RESUME_POLLING \
2367 do { if (polling_stopped_here) start_polling (); \
2368 polling_stopped_here = 0; } while (0)
2370 /* read a character from the keyboard; call the redisplay if needed */
2371 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2372 -1 means do not do redisplay, but do do autosaving.
2375 /* The arguments MAPS and NMAPS are for menu prompting.
2376 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2378 PREV_EVENT is the previous input event, or nil if we are reading
2379 the first event of a key sequence (or not reading a key sequence).
2380 If PREV_EVENT is t, that is a "magic" value that says
2381 not to run input methods, but in other respects to act as if
2382 not reading a key sequence.
2384 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2385 if we used a mouse menu to read the input, or zero otherwise. If
2386 USED_MOUSE_MENU is null, we don't dereference it.
2388 Value is -2 when we find input on another keyboard. A second call
2389 to read_char will read it.
2391 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2392 specifying the maximum time to wait until. If no input arrives by
2393 that time, stop waiting and return nil.
2395 Value is t if we showed a menu and the user rejected it. */
2398 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2402 Lisp_Object prev_event
;
2403 int *used_mouse_menu
;
2404 EMACS_TIME
*end_time
;
2406 volatile Lisp_Object c
;
2407 int count
, jmpcount
;
2408 jmp_buf local_getcjmp
;
2410 volatile int key_already_recorded
= 0;
2411 Lisp_Object tem
, save
;
2412 volatile Lisp_Object previous_echo_area_message
;
2413 volatile Lisp_Object also_record
;
2414 volatile int reread
;
2415 struct gcpro gcpro1
, gcpro2
;
2416 int polling_stopped_here
= 0;
2417 struct kboard
*orig_kboard
= current_kboard
;
2421 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2422 before_command_key_count
= this_command_key_count
;
2423 before_command_echo_length
= echo_length ();
2426 previous_echo_area_message
= Qnil
;
2428 GCPRO2 (c
, previous_echo_area_message
);
2433 if (CONSP (Vunread_post_input_method_events
))
2435 c
= XCAR (Vunread_post_input_method_events
);
2436 Vunread_post_input_method_events
2437 = XCDR (Vunread_post_input_method_events
);
2439 /* Undo what read_char_x_menu_prompt did when it unread
2440 additional keys returned by Fx_popup_menu. */
2442 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2450 if (unread_command_char
!= -1)
2452 XSETINT (c
, unread_command_char
);
2453 unread_command_char
= -1;
2459 if (CONSP (Vunread_command_events
))
2461 int was_disabled
= 0;
2463 c
= XCAR (Vunread_command_events
);
2464 Vunread_command_events
= XCDR (Vunread_command_events
);
2468 /* Undo what sit-for did when it unread additional keys
2469 inside universal-argument. */
2472 && EQ (XCAR (c
), Qt
))
2478 /* Undo what read_char_x_menu_prompt did when it unread
2479 additional keys returned by Fx_popup_menu. */
2481 && EQ (XCDR (c
), Qdisabled
)
2482 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2488 /* If the queued event is something that used the mouse,
2489 set used_mouse_menu accordingly. */
2491 /* Also check was_disabled so last-nonmenu-event won't return
2492 a bad value when submenus are involved. (Bug#447) */
2493 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2494 *used_mouse_menu
= 1;
2496 goto reread_for_input_method
;
2499 if (CONSP (Vunread_input_method_events
))
2501 c
= XCAR (Vunread_input_method_events
);
2502 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2504 /* Undo what read_char_x_menu_prompt did when it unread
2505 additional keys returned by Fx_popup_menu. */
2507 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2511 goto reread_for_input_method
;
2514 this_command_key_count_reset
= 0;
2516 if (!NILP (Vexecuting_kbd_macro
))
2518 /* We set this to Qmacro; since that's not a frame, nobody will
2519 try to switch frames on us, and the selected window will
2522 Since this event came from a macro, it would be misleading to
2523 leave internal_last_event_frame set to wherever the last
2524 real event came from. Normally, a switch-frame event selects
2525 internal_last_event_frame after each command is read, but
2526 events read from a macro should never cause a new frame to be
2528 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2530 /* Exit the macro if we are at the end.
2531 Also, some things replace the macro with t
2532 to force an early exit. */
2533 if (EQ (Vexecuting_kbd_macro
, Qt
)
2534 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2540 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2541 if (STRINGP (Vexecuting_kbd_macro
)
2542 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2543 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2545 executing_kbd_macro_index
++;
2550 if (!NILP (unread_switch_frame
))
2552 c
= unread_switch_frame
;
2553 unread_switch_frame
= Qnil
;
2555 /* This event should make it into this_command_keys, and get echoed
2556 again, so we do not set `reread'. */
2560 /* if redisplay was requested */
2561 if (commandflag
>= 0)
2563 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2565 /* If there is pending input, process any events which are not
2566 user-visible, such as X selection_request events. */
2568 || detect_input_pending_run_timers (0))
2569 swallow_events (0); /* may clear input_pending */
2571 /* Redisplay if no pending input. */
2572 while (!input_pending
)
2574 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2575 redisplay_preserve_echo_area (5);
2580 /* Normal case: no input arrived during redisplay. */
2583 /* Input arrived and pre-empted redisplay.
2584 Process any events which are not user-visible. */
2586 /* If that cleared input_pending, try again to redisplay. */
2589 /* Prevent the redisplay we just did
2590 from messing up echoing of the input after the prompt. */
2591 if (commandflag
== 0 && echo_current
)
2592 echo_message_buffer
= echo_area_buffer
[0];
2596 /* Message turns off echoing unless more keystrokes turn it on again.
2598 The code in 20.x for the condition was
2600 1. echo_area_glyphs && *echo_area_glyphs
2601 2. && echo_area_glyphs != current_kboard->echobuf
2602 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2604 (1) means there's a current message displayed
2606 (2) means it's not the message from echoing from the current
2609 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2610 is set to a non-null value. This is done in read_char and it is
2611 set to echo_area_glyphs after a call to echo_char. That means
2612 ok_to_echo_at_next_pause is either null or
2613 current_kboard->echobuf with the appropriate current_kboard at
2616 So, condition (3) means in clear text ok_to_echo_at_next_pause
2617 must be either null, or the current message isn't from echoing at
2618 all, or it's from echoing from a different kboard than the
2621 if (/* There currently is something in the echo area. */
2622 !NILP (echo_area_buffer
[0])
2623 && (/* And it's either not from echoing. */
2624 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2625 /* Or it's an echo from a different kboard. */
2626 || echo_kboard
!= current_kboard
2627 /* Or we explicitly allow overwriting whatever there is. */
2628 || ok_to_echo_at_next_pause
== NULL
))
2633 /* Try reading a character via menu prompting in the minibuf.
2634 Try this before the sit-for, because the sit-for
2635 would do the wrong thing if we are supposed to do
2636 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2637 after a mouse event so don't try a minibuf menu. */
2639 if (nmaps
> 0 && INTERACTIVE
2640 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2641 /* Don't bring up a menu if we already have another event. */
2642 && NILP (Vunread_command_events
)
2643 && unread_command_char
< 0
2644 && !detect_input_pending_run_timers (0))
2646 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2648 if (INTEGERP (c
) && XINT (c
) == -2)
2649 return c
; /* wrong_kboard_jmpbuf */
2653 key_already_recorded
= 1;
2658 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2659 We will do that below, temporarily for short sections of code,
2660 when appropriate. local_getcjmp must be in effect
2661 around any call to sit_for or kbd_buffer_get_event;
2662 it *must not* be in effect when we call redisplay. */
2664 jmpcount
= SPECPDL_INDEX ();
2665 if (_setjmp (local_getcjmp
))
2667 /* Handle quits while reading the keyboard. */
2668 /* We must have saved the outer value of getcjmp here,
2669 so restore it now. */
2670 restore_getcjmp (save_jump
);
2671 unbind_to (jmpcount
, Qnil
);
2672 XSETINT (c
, quit_char
);
2673 internal_last_event_frame
= selected_frame
;
2674 Vlast_event_frame
= internal_last_event_frame
;
2675 /* If we report the quit char as an event,
2676 don't do so more than once. */
2677 if (!NILP (Vinhibit_quit
))
2681 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2682 if (kb
!= current_kboard
)
2684 Lisp_Object link
= kb
->kbd_queue
;
2685 /* We shouldn't get here if we were in single-kboard mode! */
2690 while (CONSP (XCDR (link
)))
2692 if (!NILP (XCDR (link
)))
2696 kb
->kbd_queue
= Fcons (c
, Qnil
);
2698 XSETCDR (link
, Fcons (c
, Qnil
));
2699 kb
->kbd_queue_has_data
= 1;
2700 current_kboard
= kb
;
2701 /* This is going to exit from read_char
2702 so we had better get rid of this frame's stuff. */
2704 return make_number (-2); /* wrong_kboard_jmpbuf */
2710 /* Start idle timers if no time limit is supplied. We don't do it
2711 if a time limit is supplied to avoid an infinite recursion in the
2712 situation where an idle timer calls `sit-for'. */
2715 timer_start_idle ();
2717 /* If in middle of key sequence and minibuffer not active,
2718 start echoing if enough time elapses. */
2720 if (minibuf_level
== 0
2722 && !current_kboard
->immediate_echo
2723 && this_command_key_count
> 0
2725 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2726 && NILP (Fzerop (Vecho_keystrokes
))
2727 && (/* No message. */
2728 NILP (echo_area_buffer
[0])
2729 /* Or empty message. */
2730 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2731 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2732 /* Or already echoing from same kboard. */
2733 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2734 /* Or not echoing before and echoing allowed. */
2735 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2737 /* After a mouse event, start echoing right away.
2738 This is because we are probably about to display a menu,
2739 and we don't want to delay before doing so. */
2740 if (EVENT_HAS_PARAMETERS (prev_event
))
2746 save_getcjmp (save_jump
);
2747 restore_getcjmp (local_getcjmp
);
2748 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2749 restore_getcjmp (save_jump
);
2751 && ! CONSP (Vunread_command_events
))
2756 /* Maybe auto save due to number of keystrokes. */
2758 if (commandflag
!= 0
2759 && auto_save_interval
> 0
2760 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2761 && !detect_input_pending_run_timers (0))
2763 Fdo_auto_save (Qnil
, Qnil
);
2764 /* Hooks can actually change some buffers in auto save. */
2768 /* Try reading using an X menu.
2769 This is never confused with reading using the minibuf
2770 because the recursive call of read_char in read_char_minibuf_menu_prompt
2771 does not pass on any keymaps. */
2773 if (nmaps
> 0 && INTERACTIVE
2774 && !NILP (prev_event
)
2775 && EVENT_HAS_PARAMETERS (prev_event
)
2776 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2777 && !EQ (XCAR (prev_event
), Qtool_bar
)
2778 /* Don't bring up a menu if we already have another event. */
2779 && NILP (Vunread_command_events
)
2780 && unread_command_char
< 0)
2782 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2784 /* Now that we have read an event, Emacs is not idle. */
2791 /* Maybe autosave and/or garbage collect due to idleness. */
2793 if (INTERACTIVE
&& NILP (c
))
2795 int delay_level
, buffer_size
;
2797 /* Slow down auto saves logarithmically in size of current buffer,
2798 and garbage collect while we're at it. */
2799 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2800 last_non_minibuf_size
= Z
- BEG
;
2801 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2803 while (buffer_size
> 64)
2804 delay_level
++, buffer_size
-= buffer_size
>> 2;
2805 if (delay_level
< 4) delay_level
= 4;
2806 /* delay_level is 4 for files under around 50k, 7 at 100k,
2807 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2809 /* Auto save if enough time goes by without input. */
2810 if (commandflag
!= 0
2811 && num_nonmacro_input_events
> last_auto_save
2812 && INTEGERP (Vauto_save_timeout
)
2813 && XINT (Vauto_save_timeout
) > 0)
2816 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2818 save_getcjmp (save_jump
);
2819 restore_getcjmp (local_getcjmp
);
2820 tem0
= sit_for (make_number (timeout
), 1, 1);
2821 restore_getcjmp (save_jump
);
2824 && ! CONSP (Vunread_command_events
))
2826 Fdo_auto_save (Qnil
, Qnil
);
2828 /* If we have auto-saved and there is still no input
2829 available, garbage collect if there has been enough
2830 consing going on to make it worthwhile. */
2831 if (!detect_input_pending_run_timers (0)
2832 && consing_since_gc
> gc_cons_threshold
/ 2)
2833 Fgarbage_collect ();
2840 /* Notify the caller if an autosave hook, or a timer, sentinel or
2841 filter in the sit_for calls above have changed the current
2842 kboard. This could happen if they use the minibuffer or start a
2843 recursive edit, like the fancy splash screen in server.el's
2844 filter. If this longjmp wasn't here, read_key_sequence would
2845 interpret the next key sequence using the wrong translation
2846 tables and function keymaps. */
2847 if (NILP (c
) && current_kboard
!= orig_kboard
)
2850 return make_number (-2); /* wrong_kboard_jmpbuf */
2853 /* If this has become non-nil here, it has been set by a timer
2854 or sentinel or filter. */
2855 if (CONSP (Vunread_command_events
))
2857 c
= XCAR (Vunread_command_events
);
2858 Vunread_command_events
= XCDR (Vunread_command_events
);
2861 /* Read something from current KBOARD's side queue, if possible. */
2865 if (current_kboard
->kbd_queue_has_data
)
2867 if (!CONSP (current_kboard
->kbd_queue
))
2869 c
= XCAR (current_kboard
->kbd_queue
);
2870 current_kboard
->kbd_queue
2871 = XCDR (current_kboard
->kbd_queue
);
2872 if (NILP (current_kboard
->kbd_queue
))
2873 current_kboard
->kbd_queue_has_data
= 0;
2874 input_pending
= readable_events (0);
2875 if (EVENT_HAS_PARAMETERS (c
)
2876 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2877 internal_last_event_frame
= XCAR (XCDR (c
));
2878 Vlast_event_frame
= internal_last_event_frame
;
2882 /* If current_kboard's side queue is empty check the other kboards.
2883 If one of them has data that we have not yet seen here,
2884 switch to it and process the data waiting for it.
2886 Note: if the events queued up for another kboard
2887 have already been seen here, and therefore are not a complete command,
2888 the kbd_queue_has_data field is 0, so we skip that kboard here.
2889 That's to avoid an infinite loop switching between kboards here. */
2890 if (NILP (c
) && !single_kboard
)
2893 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2894 if (kb
->kbd_queue_has_data
)
2896 current_kboard
= kb
;
2897 /* This is going to exit from read_char
2898 so we had better get rid of this frame's stuff. */
2900 return make_number (-2); /* wrong_kboard_jmpbuf */
2908 /* Finally, we read from the main queue,
2909 and if that gives us something we can't use yet, we put it on the
2910 appropriate side queue and try again. */
2919 EMACS_GET_TIME (now
);
2920 if (EMACS_TIME_GE (now
, *end_time
))
2924 /* Actually read a character, waiting if necessary. */
2925 save_getcjmp (save_jump
);
2926 restore_getcjmp (local_getcjmp
);
2928 timer_start_idle ();
2929 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2930 restore_getcjmp (save_jump
);
2932 if (! NILP (c
) && (kb
!= current_kboard
))
2934 Lisp_Object link
= kb
->kbd_queue
;
2937 while (CONSP (XCDR (link
)))
2939 if (!NILP (XCDR (link
)))
2943 kb
->kbd_queue
= Fcons (c
, Qnil
);
2945 XSETCDR (link
, Fcons (c
, Qnil
));
2946 kb
->kbd_queue_has_data
= 1;
2950 current_kboard
= kb
;
2951 /* This is going to exit from read_char
2952 so we had better get rid of this frame's stuff. */
2954 return make_number (-2);
2958 /* Terminate Emacs in batch mode if at eof. */
2959 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2960 Fkill_emacs (make_number (1));
2964 /* Add in any extra modifiers, where appropriate. */
2965 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2966 || ((extra_keyboard_modifiers
& 0177) < ' '
2967 && (extra_keyboard_modifiers
& 0177) != 0))
2968 XSETINT (c
, make_ctrl_char (XINT (c
)));
2970 /* Transfer any other modifier bits directly from
2971 extra_keyboard_modifiers to c. Ignore the actual character code
2972 in the low 16 bits of extra_keyboard_modifiers. */
2973 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2984 if (commandflag
>= 0
2985 && !input_pending
&& !detect_input_pending_run_timers (0))
2993 /* Buffer switch events are only for internal wakeups
2994 so don't show them to the user.
2995 Also, don't record a key if we already did. */
2996 if (BUFFERP (c
) || key_already_recorded
)
2999 /* Process special events within read_char
3000 and loop around to read another event. */
3003 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3008 struct buffer
*prev_buffer
= current_buffer
;
3009 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3010 int was_locked
= single_kboard
;
3011 int count
= SPECPDL_INDEX ();
3012 record_single_kboard_state ();
3015 last_input_event
= c
;
3016 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3018 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3019 /* We stopped being idle for this event; undo that. This
3020 prevents automatic window selection (under
3021 mouse_autoselect_window from acting as a real input event, for
3022 example banishing the mouse under mouse-avoidance-mode. */
3023 timer_resume_idle ();
3025 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3026 /* Resume allowing input from any kboard, if that was true before. */
3028 any_kboard_state ();
3029 unbind_to (count
, Qnil
);
3032 if (current_buffer
!= prev_buffer
)
3034 /* The command may have changed the keymaps. Pretend there
3035 is input in another keyboard and return. This will
3036 recalculate keymaps. */
3037 c
= make_number (-2);
3044 /* Handle things that only apply to characters. */
3047 /* If kbd_buffer_get_event gave us an EOF, return that. */
3051 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3052 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3053 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3054 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3055 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3059 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3060 /* nil in keyboard-translate-table means no translation. */
3066 /* If this event is a mouse click in the menu bar,
3067 return just menu-bar for now. Modify the mouse click event
3068 so we won't do this twice, then queue it up. */
3069 if (EVENT_HAS_PARAMETERS (c
)
3071 && CONSP (EVENT_START (c
))
3072 && CONSP (XCDR (EVENT_START (c
))))
3076 posn
= POSN_POSN (EVENT_START (c
));
3077 /* Handle menu-bar events:
3078 insert the dummy prefix event `menu-bar'. */
3079 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3081 /* Change menu-bar to (menu-bar) as the event "position". */
3082 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3085 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3090 /* Store these characters into recent_keys, the dribble file if any,
3091 and the keyboard macro being defined, if any. */
3093 if (! NILP (also_record
))
3094 record_char (also_record
);
3096 /* Wipe the echo area.
3097 But first, if we are about to use an input method,
3098 save the echo area contents for it to refer to. */
3100 && ! NILP (Vinput_method_function
)
3101 && (unsigned) XINT (c
) >= ' '
3102 && (unsigned) XINT (c
) != 127
3103 && (unsigned) XINT (c
) < 256)
3105 previous_echo_area_message
= Fcurrent_message ();
3106 Vinput_method_previous_message
= previous_echo_area_message
;
3109 /* Now wipe the echo area, except for help events which do their
3110 own stuff with the echo area. */
3112 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3113 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3115 if (!NILP (echo_area_buffer
[0]))
3116 safe_run_hooks (Qecho_area_clear_hook
);
3117 clear_message (1, 0);
3120 reread_for_input_method
:
3122 /* Pass this to the input method, if appropriate. */
3124 && ! NILP (Vinput_method_function
)
3125 /* Don't run the input method within a key sequence,
3126 after the first event of the key sequence. */
3127 && NILP (prev_event
)
3128 && (unsigned) XINT (c
) >= ' '
3129 && (unsigned) XINT (c
) != 127
3130 && (unsigned) XINT (c
) < 256)
3133 int key_count
, key_count_reset
;
3134 struct gcpro gcpro1
;
3135 int count
= SPECPDL_INDEX ();
3137 /* Save the echo status. */
3138 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3139 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3140 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3141 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3144 if (before_command_restore_flag
)
3146 this_command_key_count
= before_command_key_count_1
;
3147 if (this_command_key_count
< this_single_command_key_start
)
3148 this_single_command_key_start
= this_command_key_count
;
3149 echo_truncate (before_command_echo_length_1
);
3150 before_command_restore_flag
= 0;
3154 /* Save the this_command_keys status. */
3155 key_count
= this_command_key_count
;
3156 key_count_reset
= this_command_key_count_reset
;
3159 keys
= Fcopy_sequence (this_command_keys
);
3164 /* Clear out this_command_keys. */
3165 this_command_key_count
= 0;
3166 this_command_key_count_reset
= 0;
3168 /* Now wipe the echo area. */
3169 if (!NILP (echo_area_buffer
[0]))
3170 safe_run_hooks (Qecho_area_clear_hook
);
3171 clear_message (1, 0);
3174 /* If we are not reading a key sequence,
3175 never use the echo area. */
3178 specbind (Qinput_method_use_echo_area
, Qt
);
3181 /* Call the input method. */
3182 tem
= call1 (Vinput_method_function
, c
);
3184 tem
= unbind_to (count
, tem
);
3186 /* Restore the saved echoing state
3187 and this_command_keys state. */
3188 this_command_key_count
= key_count
;
3189 this_command_key_count_reset
= key_count_reset
;
3191 this_command_keys
= keys
;
3194 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3195 current_kboard
->echo_string
= saved_echo_string
;
3196 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3197 if (saved_immediate_echo
)
3202 /* The input method can return no events. */
3205 /* Bring back the previous message, if any. */
3206 if (! NILP (previous_echo_area_message
))
3207 message_with_string ("%s", previous_echo_area_message
, 0);
3210 /* It returned one event or more. */
3212 Vunread_post_input_method_events
3213 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3218 /* Display help if not echoing. */
3219 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3221 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3222 Lisp_Object help
, object
, position
, window
, tem
;
3224 tem
= Fcdr (XCDR (c
));
3227 window
= Fcar (tem
);
3229 object
= Fcar (tem
);
3231 position
= Fcar (tem
);
3233 show_help_echo (help
, window
, object
, position
, 0);
3235 /* We stopped being idle for this event; undo that. */
3237 timer_resume_idle ();
3241 if ((! reread
|| this_command_key_count
== 0
3242 || this_command_key_count_reset
)
3246 /* Don't echo mouse motion events. */
3247 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3248 && NILP (Fzerop (Vecho_keystrokes
))
3249 && ! (EVENT_HAS_PARAMETERS (c
)
3250 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3253 if (! NILP (also_record
))
3254 echo_char (also_record
);
3255 /* Once we reread a character, echoing can happen
3256 the next time we pause to read a new one. */
3257 ok_to_echo_at_next_pause
= current_kboard
;
3260 /* Record this character as part of the current key. */
3261 add_command_key (c
);
3262 if (! NILP (also_record
))
3263 add_command_key (also_record
);
3266 last_input_event
= c
;
3269 /* Process the help character specially if enabled */
3270 if (!NILP (Vhelp_form
) && help_char_p (c
))
3273 count
= SPECPDL_INDEX ();
3275 help_form_saved_window_configs
3276 = Fcons (Fcurrent_window_configuration (Qnil
),
3277 help_form_saved_window_configs
);
3278 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3280 tem0
= Feval (Vhelp_form
);
3282 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3287 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3288 if (EVENT_HAS_PARAMETERS (c
)
3289 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3290 XSETCAR (help_form_saved_window_configs
, Qnil
);
3292 while (BUFFERP (c
));
3293 /* Remove the help from the frame */
3294 unbind_to (count
, Qnil
);
3297 if (EQ (c
, make_number (040)))
3301 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3302 while (BUFFERP (c
));
3311 /* Record a key that came from a mouse menu.
3312 Record it for echoing, for this-command-keys, and so on. */
3318 /* Wipe the echo area. */
3319 clear_message (1, 0);
3324 before_command_key_count
= this_command_key_count
;
3325 before_command_echo_length
= echo_length ();
3328 /* Don't echo mouse motion events. */
3329 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3330 && NILP (Fzerop (Vecho_keystrokes
)))
3334 /* Once we reread a character, echoing can happen
3335 the next time we pause to read a new one. */
3336 ok_to_echo_at_next_pause
= 0;
3339 /* Record this character as part of the current key. */
3340 add_command_key (c
);
3342 /* Re-reading in the middle of a command */
3343 last_input_event
= c
;
3347 /* Return 1 if should recognize C as "the help character". */
3355 if (EQ (c
, Vhelp_char
))
3357 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3358 if (EQ (c
, XCAR (tail
)))
3363 /* Record the input event C in various ways. */
3371 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3373 /* To avoid filling recent_keys with help-echo and mouse-movement
3374 events, we filter out repeated help-echo events, only store the
3375 first and last in a series of mouse-movement events, and don't
3376 store repeated help-echo events which are only separated by
3377 mouse-movement events. */
3379 Lisp_Object ev1
, ev2
, ev3
;
3382 if ((ix1
= recent_keys_index
- 1) < 0)
3383 ix1
= NUM_RECENT_KEYS
- 1;
3384 ev1
= AREF (recent_keys
, ix1
);
3386 if ((ix2
= ix1
- 1) < 0)
3387 ix2
= NUM_RECENT_KEYS
- 1;
3388 ev2
= AREF (recent_keys
, ix2
);
3390 if ((ix3
= ix2
- 1) < 0)
3391 ix3
= NUM_RECENT_KEYS
- 1;
3392 ev3
= AREF (recent_keys
, ix3
);
3394 if (EQ (XCAR (c
), Qhelp_echo
))
3396 /* Don't record `help-echo' in recent_keys unless it shows some help
3397 message, and a different help than the previously recorded
3399 Lisp_Object help
, last_help
;
3401 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3402 if (!STRINGP (help
))
3404 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3405 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3407 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3408 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3409 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3411 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3412 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3413 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3414 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3417 else if (EQ (XCAR (c
), Qmouse_movement
))
3419 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3420 So additional mouse movement events replace the last element. */
3421 Lisp_Object last_window
, window
;
3423 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3424 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3425 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3426 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3427 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3429 ASET (recent_keys
, ix1
, c
);
3435 store_kbd_macro_char (c
);
3440 ASET (recent_keys
, recent_keys_index
, c
);
3441 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3442 recent_keys_index
= 0;
3444 else if (recorded
< 0)
3446 /* We need to remove one or two events from recent_keys.
3447 To do this, we simply put nil at those events and move the
3448 recent_keys_index backwards over those events. Usually,
3449 users will never see those nil events, as they will be
3450 overwritten by the command keys entered to see recent_keys
3453 while (recorded
++ < 0 && total_keys
> 0)
3455 if (total_keys
< NUM_RECENT_KEYS
)
3457 if (--recent_keys_index
< 0)
3458 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3459 ASET (recent_keys
, recent_keys_index
, Qnil
);
3463 num_nonmacro_input_events
++;
3465 /* Write c to the dribble file. If c is a lispy event, write
3466 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3467 If you, dear reader, have a better idea, you've got the source. :-) */
3473 if (XUINT (c
) < 0x100)
3474 putc (XINT (c
), dribble
);
3476 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3480 Lisp_Object dribblee
;
3482 /* If it's a structured event, take the event header. */
3483 dribblee
= EVENT_HEAD (c
);
3485 if (SYMBOLP (dribblee
))
3487 putc ('<', dribble
);
3488 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3489 SBYTES (SYMBOL_NAME (dribblee
)),
3491 putc ('>', dribble
);
3504 struct buffer
*old
= current_buffer
;
3505 Fprinc (object
, Qnil
);
3506 set_buffer_internal (XBUFFER (Vstandard_output
));
3507 call0 (intern ("help-mode"));
3508 set_buffer_internal (old
);
3512 /* Copy out or in the info on where C-g should throw to.
3513 This is used when running Lisp code from within get_char,
3514 in case get_char is called recursively.
3515 See read_process_output. */
3521 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3525 restore_getcjmp (temp
)
3528 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3531 /* Low level keyboard/mouse input.
3532 kbd_buffer_store_event places events in kbd_buffer, and
3533 kbd_buffer_get_event retrieves them. */
3535 /* Return true if there are any events in the queue that read-char
3536 would return. If this returns false, a read-char would block. */
3538 readable_events (flags
)
3542 /* Check whether a D-Bus message has arrived. */
3543 if (xd_pending_messages () > 0)
3545 #endif /* HAVE_DBUS */
3547 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3550 /* If the buffer contains only FOCUS_IN_EVENT events, and
3551 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3552 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3554 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3555 #ifdef USE_TOOLKIT_SCROLL_BARS
3556 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3560 struct input_event
*event
;
3562 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3569 #ifdef USE_TOOLKIT_SCROLL_BARS
3570 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3572 event
->kind
== FOCUS_IN_EVENT
)
3573 #ifdef USE_TOOLKIT_SCROLL_BARS
3574 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3575 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3576 && event
->part
== scroll_bar_handle
3577 && event
->modifiers
== 0)
3582 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3585 while (event
!= kbd_store_ptr
);
3591 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3592 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3593 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3598 if (current_kboard
->kbd_queue_has_data
)
3604 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3605 if (kb
->kbd_queue_has_data
)
3611 /* Set this for debugging, to have a way to get out */
3615 event_to_kboard (event
)
3616 struct input_event
*event
;
3619 frame
= event
->frame_or_window
;
3621 frame
= XCAR (frame
);
3622 else if (WINDOWP (frame
))
3623 frame
= WINDOW_FRAME (XWINDOW (frame
));
3625 /* There are still some events that don't set this field.
3626 For now, just ignore the problem.
3627 Also ignore dead frames here. */
3628 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3631 return FRAME_KBOARD (XFRAME (frame
));
3635 Lisp_Object Vthrow_on_input
;
3637 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3640 kbd_buffer_store_event (event
)
3641 register struct input_event
*event
;
3643 kbd_buffer_store_event_hold (event
, 0);
3646 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3648 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3649 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3650 Else, if EVENT is a quit event, store the quit event
3651 in HOLD_QUIT, and return (thus ignoring further events).
3653 This is used in read_avail_input to postpone the processing
3654 of the quit event until all subsequent input events have been
3655 parsed (and discarded).
3659 kbd_buffer_store_event_hold (event
, hold_quit
)
3660 register struct input_event
*event
;
3661 struct input_event
*hold_quit
;
3663 if (event
->kind
== NO_EVENT
)
3666 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3669 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3671 register int c
= event
->code
& 0377;
3673 if (event
->modifiers
& ctrl_modifier
)
3674 c
= make_ctrl_char (c
);
3676 c
|= (event
->modifiers
3677 & (meta_modifier
| alt_modifier
3678 | hyper_modifier
| super_modifier
));
3682 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3683 struct input_event
*sp
;
3685 if (single_kboard
&& kb
!= current_kboard
)
3688 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3689 Fcons (make_number (c
), Qnil
));
3690 kb
->kbd_queue_has_data
= 1;
3691 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3693 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3696 if (event_to_kboard (sp
) == kb
)
3698 sp
->kind
= NO_EVENT
;
3699 sp
->frame_or_window
= Qnil
;
3708 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3712 /* If this results in a quit_char being returned to Emacs as
3713 input, set Vlast_event_frame properly. If this doesn't
3714 get returned to Emacs as an event, the next event read
3715 will set Vlast_event_frame again, so this is safe to do. */
3719 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3721 focus
= event
->frame_or_window
;
3722 internal_last_event_frame
= focus
;
3723 Vlast_event_frame
= focus
;
3726 last_event_timestamp
= event
->timestamp
;
3727 handle_interrupt ();
3731 if (c
&& c
== stop_character
)
3737 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3738 Just ignore the second one. */
3739 else if (event
->kind
== BUFFER_SWITCH_EVENT
3740 && kbd_fetch_ptr
!= kbd_store_ptr
3741 && ((kbd_store_ptr
== kbd_buffer
3742 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3743 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3746 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3747 kbd_store_ptr
= kbd_buffer
;
3749 /* Don't let the very last slot in the buffer become full,
3750 since that would make the two pointers equal,
3751 and that is indistinguishable from an empty buffer.
3752 Discard the event if it would fill the last slot. */
3753 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3755 *kbd_store_ptr
= *event
;
3759 /* If we're inside while-no-input, and this event qualifies
3760 as input, set quit-flag to cause an interrupt. */
3761 if (!NILP (Vthrow_on_input
)
3762 && event
->kind
!= FOCUS_IN_EVENT
3763 && event
->kind
!= HELP_EVENT
3764 && event
->kind
!= DEICONIFY_EVENT
)
3766 Vquit_flag
= Vthrow_on_input
;
3767 /* If we're inside a function that wants immediate quits,
3769 if (immediate_quit
&& NILP (Vinhibit_quit
))
3779 /* Put an input event back in the head of the event queue. */
3782 kbd_buffer_unget_event (event
)
3783 register struct input_event
*event
;
3785 if (kbd_fetch_ptr
== kbd_buffer
)
3786 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3788 /* Don't let the very last slot in the buffer become full, */
3789 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3792 *kbd_fetch_ptr
= *event
;
3797 /* Generate HELP_EVENT input_events in BUFP which has room for
3798 SIZE events. If there's not enough room in BUFP, ignore this
3801 HELP is the help form.
3803 FRAME is the frame on which the help is generated. OBJECT is the
3804 Lisp object where the help was found (a buffer, a string, an
3805 overlay, or nil if neither from a string nor from a buffer. POS is
3806 the position within OBJECT where the help was found.
3808 Value is the number of input_events generated. */
3811 gen_help_event (help
, frame
, window
, object
, pos
)
3812 Lisp_Object help
, frame
, object
, window
;
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 (frame
, help
)
3833 Lisp_Object frame
, help
;
3835 struct input_event event
;
3837 event
.kind
= HELP_EVENT
;
3838 event
.frame_or_window
= frame
;
3843 kbd_buffer_store_event (&event
);
3847 /* Discard any mouse events in the event buffer by setting them to
3850 discard_mouse_events ()
3852 struct input_event
*sp
;
3853 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3855 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3858 if (sp
->kind
== MOUSE_CLICK_EVENT
3859 || sp
->kind
== WHEEL_EVENT
3860 || sp
->kind
== HORIZ_WHEEL_EVENT
3862 || sp
->kind
== GPM_CLICK_EVENT
3864 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3866 sp
->kind
= NO_EVENT
;
3872 /* Return non-zero if there are any real events waiting in the event
3873 buffer, not counting `NO_EVENT's.
3875 If DISCARD is non-zero, discard NO_EVENT events at the front of
3876 the input queue, possibly leaving the input queue empty if there
3877 are no real input events. */
3880 kbd_buffer_events_waiting (discard
)
3883 struct input_event
*sp
;
3885 for (sp
= kbd_fetch_ptr
;
3886 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3889 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3896 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3900 /* Clear input event EVENT. */
3904 struct input_event
*event
;
3906 event
->kind
= NO_EVENT
;
3910 /* Read one event from the event buffer, waiting if necessary.
3911 The value is a Lisp object representing the event.
3912 The value is nil for an event that should be ignored,
3913 or that was handled here.
3914 We always read and discard one event. */
3917 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
3919 int *used_mouse_menu
;
3920 EMACS_TIME
*end_time
;
3926 /* In case we are running as a daemon, only do this before
3927 detaching from the terminal. */
3928 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3932 *kbp
= current_kboard
;
3936 /* Wait until there is input available. */
3939 /* Break loop if there's an unread command event. Needed in
3940 moused window autoselection which uses a timer to insert such
3942 if (CONSP (Vunread_command_events
))
3945 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3947 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3948 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3952 /* If the quit flag is set, then read_char will return
3953 quit_char, so that counts as "available input." */
3954 if (!NILP (Vquit_flag
))
3955 quit_throw_to_read_char ();
3957 /* One way or another, wait until input is available; then, if
3958 interrupt handlers have not read it, read it now. */
3960 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3964 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3966 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3967 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3972 EMACS_TIME duration
;
3973 EMACS_GET_TIME (duration
);
3974 if (EMACS_TIME_GE (duration
, *end_time
))
3975 return Qnil
; /* finished waiting */
3978 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3979 wait_reading_process_output (EMACS_SECS (duration
),
3980 EMACS_USECS (duration
),
3981 -1, 1, Qnil
, NULL
, 0);
3985 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3987 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3988 /* Pass 1 for EXPECT since we just waited to have input. */
3989 read_avail_input (1);
3992 if (CONSP (Vunread_command_events
))
3995 first
= XCAR (Vunread_command_events
);
3996 Vunread_command_events
= XCDR (Vunread_command_events
);
3997 *kbp
= current_kboard
;
4001 /* At this point, we know that there is a readable event available
4002 somewhere. If the event queue is empty, then there must be a
4003 mouse movement enabled and available. */
4004 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4006 struct input_event
*event
;
4008 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4012 last_event_timestamp
= event
->timestamp
;
4014 *kbp
= event_to_kboard (event
);
4016 *kbp
= current_kboard
; /* Better than returning null ptr? */
4020 /* These two kinds of events get special handling
4021 and don't actually appear to the command loop.
4022 We return nil for them. */
4023 if (event
->kind
== SELECTION_REQUEST_EVENT
4024 || event
->kind
== SELECTION_CLEAR_EVENT
)
4027 struct input_event copy
;
4029 /* Remove it from the buffer before processing it,
4030 since otherwise swallow_events will see it
4031 and process it again. */
4033 kbd_fetch_ptr
= event
+ 1;
4034 input_pending
= readable_events (0);
4035 x_handle_selection_event (©
);
4037 /* We're getting selection request events, but we don't have
4043 #if defined (HAVE_NS)
4044 else if (event
->kind
== NS_TEXT_EVENT
)
4046 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4047 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4049 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4050 kbd_fetch_ptr
= event
+ 1;
4051 if (used_mouse_menu
)
4052 *used_mouse_menu
= 1;
4056 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4057 || defined (HAVE_NS)
4058 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4060 /* Make an event (delete-frame (FRAME)). */
4061 obj
= Fcons (event
->frame_or_window
, Qnil
);
4062 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4063 kbd_fetch_ptr
= event
+ 1;
4066 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4067 || defined (HAVE_NS)
4068 else if (event
->kind
== ICONIFY_EVENT
)
4070 /* Make an event (iconify-frame (FRAME)). */
4071 obj
= Fcons (event
->frame_or_window
, Qnil
);
4072 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4073 kbd_fetch_ptr
= event
+ 1;
4075 else if (event
->kind
== DEICONIFY_EVENT
)
4077 /* Make an event (make-frame-visible (FRAME)). */
4078 obj
= Fcons (event
->frame_or_window
, Qnil
);
4079 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4080 kbd_fetch_ptr
= event
+ 1;
4083 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4085 /* The value doesn't matter here; only the type is tested. */
4086 XSETBUFFER (obj
, current_buffer
);
4087 kbd_fetch_ptr
= event
+ 1;
4089 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4090 || defined(HAVE_NS) || defined (USE_GTK)
4091 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4093 kbd_fetch_ptr
= event
+ 1;
4094 input_pending
= readable_events (0);
4095 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4096 x_activate_menubar (XFRAME (event
->frame_or_window
));
4099 #if defined (WINDOWSNT)
4100 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4102 /* Make an event (language-change (FRAME CHARSET LCID)). */
4103 obj
= Fcons (event
->frame_or_window
, Qnil
);
4104 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4105 kbd_fetch_ptr
= event
+ 1;
4108 else if (event
->kind
== SAVE_SESSION_EVENT
)
4110 obj
= Fcons (Qsave_session
, Qnil
);
4111 kbd_fetch_ptr
= event
+ 1;
4113 /* Just discard these, by returning nil.
4114 With MULTI_KBOARD, these events are used as placeholders
4115 when we need to randomly delete events from the queue.
4116 (They shouldn't otherwise be found in the buffer,
4117 but on some machines it appears they do show up
4118 even without MULTI_KBOARD.) */
4119 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4120 mouse events during a popup-menu call. */
4121 else if (event
->kind
== NO_EVENT
)
4122 kbd_fetch_ptr
= event
+ 1;
4123 else if (event
->kind
== HELP_EVENT
)
4125 Lisp_Object object
, position
, help
, frame
, window
;
4127 frame
= event
->frame_or_window
;
4128 object
= event
->arg
;
4129 position
= make_number (event
->code
);
4132 clear_event (event
);
4134 kbd_fetch_ptr
= event
+ 1;
4135 if (!WINDOWP (window
))
4137 obj
= Fcons (Qhelp_echo
,
4138 list5 (frame
, help
, window
, object
, position
));
4140 else if (event
->kind
== FOCUS_IN_EVENT
)
4142 /* Notification of a FocusIn event. The frame receiving the
4143 focus is in event->frame_or_window. Generate a
4144 switch-frame event if necessary. */
4145 Lisp_Object frame
, focus
;
4147 frame
= event
->frame_or_window
;
4148 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4152 if (!EQ (frame
, internal_last_event_frame
)
4153 && !EQ (frame
, selected_frame
))
4154 obj
= make_lispy_switch_frame (frame
);
4155 internal_last_event_frame
= frame
;
4156 kbd_fetch_ptr
= event
+ 1;
4159 else if (event
->kind
== DBUS_EVENT
)
4161 obj
= make_lispy_event (event
);
4162 kbd_fetch_ptr
= event
+ 1;
4165 else if (event
->kind
== CONFIG_CHANGED_EVENT
|| event
->kind
== XWIDGET_EVENT
)
4167 obj
= make_lispy_event (event
);
4168 kbd_fetch_ptr
= event
+ 1;
4172 /* If this event is on a different frame, return a switch-frame this
4173 time, and leave the event in the queue for next time. */
4177 frame
= event
->frame_or_window
;
4179 frame
= XCAR (frame
);
4180 else if (WINDOWP (frame
))
4181 frame
= WINDOW_FRAME (XWINDOW (frame
));
4183 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4187 if (! EQ (frame
, internal_last_event_frame
)
4188 && !EQ (frame
, selected_frame
))
4189 obj
= make_lispy_switch_frame (frame
);
4190 internal_last_event_frame
= frame
;
4192 /* If we didn't decide to make a switch-frame event, go ahead
4193 and build a real event from the queue entry. */
4197 obj
= make_lispy_event (event
);
4199 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4200 || defined(HAVE_NS) || defined (USE_GTK)
4201 /* If this was a menu selection, then set the flag to inhibit
4202 writing to last_nonmenu_event. Don't do this if the event
4203 we're returning is (menu-bar), though; that indicates the
4204 beginning of the menu sequence, and we might as well leave
4205 that as the `event with parameters' for this selection. */
4207 && !EQ (event
->frame_or_window
, event
->arg
)
4208 && (event
->kind
== MENU_BAR_EVENT
4209 || event
->kind
== TOOL_BAR_EVENT
))
4210 *used_mouse_menu
= 1;
4213 /* certain system events are non-key events */
4215 && event
->kind
== NS_NONKEY_EVENT
)
4216 *used_mouse_menu
= 1;
4219 /* Wipe out this event, to catch bugs. */
4220 clear_event (event
);
4221 kbd_fetch_ptr
= event
+ 1;
4225 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4226 /* Try generating a mouse motion event. */
4227 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4229 FRAME_PTR f
= some_mouse_moved ();
4230 Lisp_Object bar_window
;
4231 enum scroll_bar_part part
;
4235 *kbp
= current_kboard
;
4236 /* Note that this uses F to determine which terminal to look at.
4237 If there is no valid info, it does not store anything
4238 so x remains nil. */
4241 /* XXX Can f or mouse_position_hook be NULL here? */
4242 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4243 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4244 &part
, &x
, &y
, &time
);
4248 /* Decide if we should generate a switch-frame event. Don't
4249 generate switch-frame events for motion outside of all Emacs
4255 frame
= FRAME_FOCUS_FRAME (f
);
4257 XSETFRAME (frame
, f
);
4259 if (! EQ (frame
, internal_last_event_frame
)
4260 && !EQ (frame
, selected_frame
))
4261 obj
= make_lispy_switch_frame (frame
);
4262 internal_last_event_frame
= frame
;
4265 /* If we didn't decide to make a switch-frame event, go ahead and
4266 return a mouse-motion event. */
4267 if (!NILP (x
) && NILP (obj
))
4268 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4270 #endif /* HAVE_MOUSE || HAVE GPM */
4272 /* We were promised by the above while loop that there was
4273 something for us to read! */
4276 input_pending
= readable_events (0);
4278 Vlast_event_frame
= internal_last_event_frame
;
4283 /* Process any events that are not user-visible,
4284 then return, without reading any user-visible events. */
4287 swallow_events (do_display
)
4292 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4294 struct input_event
*event
;
4296 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4300 last_event_timestamp
= event
->timestamp
;
4302 /* These two kinds of events get special handling
4303 and don't actually appear to the command loop. */
4304 if (event
->kind
== SELECTION_REQUEST_EVENT
4305 || event
->kind
== SELECTION_CLEAR_EVENT
)
4308 struct input_event copy
;
4310 /* Remove it from the buffer before processing it,
4311 since otherwise swallow_events called recursively could see it
4312 and process it again. */
4314 kbd_fetch_ptr
= event
+ 1;
4315 input_pending
= readable_events (0);
4316 x_handle_selection_event (©
);
4318 /* We're getting selection request events, but we don't have
4327 old_timers_run
= timers_run
;
4328 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4330 if (timers_run
!= old_timers_run
&& do_display
)
4331 redisplay_preserve_echo_area (7);
4334 /* Record the start of when Emacs is idle,
4335 for the sake of running idle-time timers. */
4342 /* If we are already in the idle state, do nothing. */
4343 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4346 EMACS_GET_TIME (timer_idleness_start_time
);
4348 timer_last_idleness_start_time
= timer_idleness_start_time
;
4350 /* Mark all idle-time timers as once again candidates for running. */
4351 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4355 timer
= XCAR (timers
);
4357 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4359 XVECTOR (timer
)->contents
[0] = Qnil
;
4363 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4368 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4371 /* Resume idle timer from last idle start time. */
4374 timer_resume_idle ()
4376 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4379 timer_idleness_start_time
= timer_last_idleness_start_time
;
4382 /* This is only for debugging. */
4383 struct input_event last_timer_event
;
4385 /* List of elisp functions to call, delayed because they were generated in
4386 a context where Elisp could not be safely run (e.g. redisplay, signal,
4387 ...). Each element has the form (FUN . ARGS). */
4388 Lisp_Object pending_funcalls
;
4390 extern Lisp_Object Qapply
;
4392 /* Check whether a timer has fired. To prevent larger problems we simply
4393 disregard elements that are not proper timers. Do not make a circular
4394 timer list for the time being.
4396 Returns the time to wait until the next timer fires. If a
4397 timer is triggering now, return zero.
4398 If no timer is active, return -1.
4400 If a timer is ripe, we run it, with quitting turned off.
4401 In that case we return 0 to indicate that a new timer_check_2 call
4407 EMACS_TIME nexttime
;
4408 EMACS_TIME now
, idleness_now
;
4409 Lisp_Object timers
, idle_timers
, chosen_timer
;
4410 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4412 EMACS_SET_SECS (nexttime
, -1);
4413 EMACS_SET_USECS (nexttime
, -1);
4415 /* Always consider the ordinary timers. */
4416 timers
= Vtimer_list
;
4417 /* Consider the idle timers only if Emacs is idle. */
4418 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4419 idle_timers
= Vtimer_idle_list
;
4422 chosen_timer
= Qnil
;
4423 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4425 /* First run the code that was delayed. */
4426 while (CONSP (pending_funcalls
))
4428 Lisp_Object funcall
= XCAR (pending_funcalls
);
4429 pending_funcalls
= XCDR (pending_funcalls
);
4430 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4433 if (CONSP (timers
) || CONSP (idle_timers
))
4435 EMACS_GET_TIME (now
);
4436 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4437 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4440 while (CONSP (timers
) || CONSP (idle_timers
))
4442 Lisp_Object
*vector
;
4443 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4444 EMACS_TIME timer_time
, idle_timer_time
;
4445 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4447 /* Skip past invalid timers and timers already handled. */
4450 timer
= XCAR (timers
);
4451 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4453 timers
= XCDR (timers
);
4456 vector
= XVECTOR (timer
)->contents
;
4458 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4459 || !INTEGERP (vector
[3])
4460 || ! NILP (vector
[0]))
4462 timers
= XCDR (timers
);
4466 if (!NILP (idle_timers
))
4468 timer
= XCAR (idle_timers
);
4469 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4471 idle_timers
= XCDR (idle_timers
);
4474 vector
= XVECTOR (timer
)->contents
;
4476 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4477 || !INTEGERP (vector
[3])
4478 || ! NILP (vector
[0]))
4480 idle_timers
= XCDR (idle_timers
);
4485 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4486 based on the next ordinary timer.
4487 TIMER_DIFFERENCE is the distance in time from NOW to when
4488 this timer becomes ripe (negative if it's already ripe). */
4491 timer
= XCAR (timers
);
4492 vector
= XVECTOR (timer
)->contents
;
4493 EMACS_SET_SECS (timer_time
,
4494 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4495 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4496 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4499 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4500 based on the next idle timer. */
4501 if (!NILP (idle_timers
))
4503 idle_timer
= XCAR (idle_timers
);
4504 vector
= XVECTOR (idle_timer
)->contents
;
4505 EMACS_SET_SECS (idle_timer_time
,
4506 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4507 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4508 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4511 /* Decide which timer is the next timer,
4512 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4513 Also step down the list where we found that timer. */
4515 if (! NILP (timers
) && ! NILP (idle_timers
))
4518 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4519 if (EMACS_TIME_NEG_P (temp
))
4521 chosen_timer
= timer
;
4522 timers
= XCDR (timers
);
4523 difference
= timer_difference
;
4527 chosen_timer
= idle_timer
;
4528 idle_timers
= XCDR (idle_timers
);
4529 difference
= idle_timer_difference
;
4532 else if (! NILP (timers
))
4534 chosen_timer
= timer
;
4535 timers
= XCDR (timers
);
4536 difference
= timer_difference
;
4540 chosen_timer
= idle_timer
;
4541 idle_timers
= XCDR (idle_timers
);
4542 difference
= idle_timer_difference
;
4544 vector
= XVECTOR (chosen_timer
)->contents
;
4546 /* If timer is ripe, run it if it hasn't been run. */
4547 if (EMACS_TIME_NEG_P (difference
)
4548 || (EMACS_SECS (difference
) == 0
4549 && EMACS_USECS (difference
) == 0))
4551 if (NILP (vector
[0]))
4553 int count
= SPECPDL_INDEX ();
4554 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4556 /* Mark the timer as triggered to prevent problems if the lisp
4557 code fails to reschedule it right. */
4560 specbind (Qinhibit_quit
, Qt
);
4562 call1 (Qtimer_event_handler
, chosen_timer
);
4563 Vdeactivate_mark
= old_deactivate_mark
;
4565 unbind_to (count
, Qnil
);
4567 /* Since we have handled the event,
4568 we don't need to tell the caller to wake up and do it. */
4569 /* But the caller must still wait for the next timer, so
4570 return 0 to indicate that. */
4573 EMACS_SET_SECS (nexttime
, 0);
4574 EMACS_SET_USECS (nexttime
, 0);
4577 /* When we encounter a timer that is still waiting,
4578 return the amount of time to wait before it is ripe. */
4585 /* No timers are pending in the future. */
4586 /* Return 0 if we generated an event, and -1 if not. */
4592 /* Check whether a timer has fired. To prevent larger problems we simply
4593 disregard elements that are not proper timers. Do not make a circular
4594 timer list for the time being.
4596 Returns the time to wait until the next timer fires.
4597 If no timer is active, return -1.
4599 As long as any timer is ripe, we run it.
4601 DO_IT_NOW is now ignored. It used to mean that we should
4602 run the timer directly instead of queueing a timer-event.
4603 Now we always run timers directly. */
4606 timer_check (do_it_now
)
4609 EMACS_TIME nexttime
;
4613 nexttime
= timer_check_2 ();
4615 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4620 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4621 doc
: /* Return the current length of Emacs idleness, or nil.
4622 The value when Emacs is idle is a list of three integers. The first has
4623 the most significant 16 bits of the seconds, while the second has the least
4624 significant 16 bits. The third integer gives the microsecond count.
4626 The value when Emacs is not idle is nil.
4628 The microsecond count is zero on systems that do not provide
4629 resolution finer than a second. */)
4632 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4634 EMACS_TIME now
, idleness_now
;
4636 EMACS_GET_TIME (now
);
4637 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4639 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4640 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4641 make_number (EMACS_USECS (idleness_now
)));
4647 /* Caches for modify_event_symbol. */
4648 static Lisp_Object accent_key_syms
;
4649 static Lisp_Object func_key_syms
;
4650 static Lisp_Object mouse_syms
;
4651 static Lisp_Object wheel_syms
;
4652 static Lisp_Object drag_n_drop_syms
;
4654 /* This is a list of keysym codes for special "accent" characters.
4655 It parallels lispy_accent_keys. */
4657 static const int lispy_accent_codes
[] =
4659 #ifdef XK_dead_circumflex
4664 #ifdef XK_dead_grave
4669 #ifdef XK_dead_tilde
4674 #ifdef XK_dead_diaeresis
4679 #ifdef XK_dead_macron
4684 #ifdef XK_dead_degree
4689 #ifdef XK_dead_acute
4694 #ifdef XK_dead_cedilla
4699 #ifdef XK_dead_breve
4704 #ifdef XK_dead_ogonek
4709 #ifdef XK_dead_caron
4714 #ifdef XK_dead_doubleacute
4715 XK_dead_doubleacute
,
4719 #ifdef XK_dead_abovedot
4724 #ifdef XK_dead_abovering
4734 #ifdef XK_dead_belowdot
4739 #ifdef XK_dead_voiced_sound
4740 XK_dead_voiced_sound
,
4744 #ifdef XK_dead_semivoiced_sound
4745 XK_dead_semivoiced_sound
,
4761 /* This is a list of Lisp names for special "accent" characters.
4762 It parallels lispy_accent_codes. */
4764 static char *lispy_accent_keys
[] =
4782 "dead-voiced-sound",
4783 "dead-semivoiced-sound",
4789 #define FUNCTION_KEY_OFFSET 0x0
4791 char *lispy_function_keys
[] =
4795 0, /* VK_LBUTTON 0x01 */
4796 0, /* VK_RBUTTON 0x02 */
4797 "cancel", /* VK_CANCEL 0x03 */
4798 0, /* VK_MBUTTON 0x04 */
4800 0, 0, 0, /* 0x05 .. 0x07 */
4802 "backspace", /* VK_BACK 0x08 */
4803 "tab", /* VK_TAB 0x09 */
4805 0, 0, /* 0x0A .. 0x0B */
4807 "clear", /* VK_CLEAR 0x0C */
4808 "return", /* VK_RETURN 0x0D */
4810 0, 0, /* 0x0E .. 0x0F */
4812 0, /* VK_SHIFT 0x10 */
4813 0, /* VK_CONTROL 0x11 */
4814 0, /* VK_MENU 0x12 */
4815 "pause", /* VK_PAUSE 0x13 */
4816 "capslock", /* VK_CAPITAL 0x14 */
4817 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4819 "junja", /* VK_JUNJA 0x17 */
4820 "final", /* VK_FINAL 0x18 */
4821 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4823 "escape", /* VK_ESCAPE 0x1B */
4824 "convert", /* VK_CONVERT 0x1C */
4825 "non-convert", /* VK_NONCONVERT 0x1D */
4826 "accept", /* VK_ACCEPT 0x1E */
4827 "mode-change", /* VK_MODECHANGE 0x1F */
4828 0, /* VK_SPACE 0x20 */
4829 "prior", /* VK_PRIOR 0x21 */
4830 "next", /* VK_NEXT 0x22 */
4831 "end", /* VK_END 0x23 */
4832 "home", /* VK_HOME 0x24 */
4833 "left", /* VK_LEFT 0x25 */
4834 "up", /* VK_UP 0x26 */
4835 "right", /* VK_RIGHT 0x27 */
4836 "down", /* VK_DOWN 0x28 */
4837 "select", /* VK_SELECT 0x29 */
4838 "print", /* VK_PRINT 0x2A */
4839 "execute", /* VK_EXECUTE 0x2B */
4840 "snapshot", /* VK_SNAPSHOT 0x2C */
4841 "insert", /* VK_INSERT 0x2D */
4842 "delete", /* VK_DELETE 0x2E */
4843 "help", /* VK_HELP 0x2F */
4845 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4847 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4849 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4851 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4853 0, 0, 0, 0, 0, 0, 0, 0, 0,
4854 0, 0, 0, 0, 0, 0, 0, 0, 0,
4855 0, 0, 0, 0, 0, 0, 0, 0,
4857 "lwindow", /* VK_LWIN 0x5B */
4858 "rwindow", /* VK_RWIN 0x5C */
4859 "apps", /* VK_APPS 0x5D */
4862 "kp-0", /* VK_NUMPAD0 0x60 */
4863 "kp-1", /* VK_NUMPAD1 0x61 */
4864 "kp-2", /* VK_NUMPAD2 0x62 */
4865 "kp-3", /* VK_NUMPAD3 0x63 */
4866 "kp-4", /* VK_NUMPAD4 0x64 */
4867 "kp-5", /* VK_NUMPAD5 0x65 */
4868 "kp-6", /* VK_NUMPAD6 0x66 */
4869 "kp-7", /* VK_NUMPAD7 0x67 */
4870 "kp-8", /* VK_NUMPAD8 0x68 */
4871 "kp-9", /* VK_NUMPAD9 0x69 */
4872 "kp-multiply", /* VK_MULTIPLY 0x6A */
4873 "kp-add", /* VK_ADD 0x6B */
4874 "kp-separator", /* VK_SEPARATOR 0x6C */
4875 "kp-subtract", /* VK_SUBTRACT 0x6D */
4876 "kp-decimal", /* VK_DECIMAL 0x6E */
4877 "kp-divide", /* VK_DIVIDE 0x6F */
4878 "f1", /* VK_F1 0x70 */
4879 "f2", /* VK_F2 0x71 */
4880 "f3", /* VK_F3 0x72 */
4881 "f4", /* VK_F4 0x73 */
4882 "f5", /* VK_F5 0x74 */
4883 "f6", /* VK_F6 0x75 */
4884 "f7", /* VK_F7 0x76 */
4885 "f8", /* VK_F8 0x77 */
4886 "f9", /* VK_F9 0x78 */
4887 "f10", /* VK_F10 0x79 */
4888 "f11", /* VK_F11 0x7A */
4889 "f12", /* VK_F12 0x7B */
4890 "f13", /* VK_F13 0x7C */
4891 "f14", /* VK_F14 0x7D */
4892 "f15", /* VK_F15 0x7E */
4893 "f16", /* VK_F16 0x7F */
4894 "f17", /* VK_F17 0x80 */
4895 "f18", /* VK_F18 0x81 */
4896 "f19", /* VK_F19 0x82 */
4897 "f20", /* VK_F20 0x83 */
4898 "f21", /* VK_F21 0x84 */
4899 "f22", /* VK_F22 0x85 */
4900 "f23", /* VK_F23 0x86 */
4901 "f24", /* VK_F24 0x87 */
4903 0, 0, 0, 0, /* 0x88 .. 0x8B */
4904 0, 0, 0, 0, /* 0x8C .. 0x8F */
4906 "kp-numlock", /* VK_NUMLOCK 0x90 */
4907 "scroll", /* VK_SCROLL 0x91 */
4908 /* Not sure where the following block comes from.
4909 Windows headers have NEC and Fujitsu specific keys in
4910 this block, but nothing generic. */
4911 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4912 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4913 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4914 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4915 "kp-end", /* VK_NUMPAD_END 0x96 */
4916 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4917 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4918 "kp-up", /* VK_NUMPAD_UP 0x99 */
4919 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4920 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4921 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4922 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4924 0, 0, /* 0x9E .. 0x9F */
4927 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4928 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4929 * No other API or message will distinguish left and right keys this way.
4934 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4935 to enable them selectively, and gives access to a few more functions.
4936 See lispy_multimedia_keys below. */
4937 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4938 0, 0, 0, /* 0xAD .. 0xAF Volume */
4939 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4940 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4942 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4943 0, 0, 0, 0, 0, 0, 0, 0, 0,
4945 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4946 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4947 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4950 "ax", /* VK_OEM_AX 0xE1 */
4951 0, /* VK_OEM_102 0xE2 */
4952 "ico-help", /* VK_ICO_HELP 0xE3 */
4953 "ico-00", /* VK_ICO_00 0xE4 */
4954 0, /* VK_PROCESSKEY 0xE5 */
4955 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4956 "packet", /* VK_PACKET 0xE7 */
4958 "reset", /* VK_OEM_RESET 0xE9 */
4959 "jump", /* VK_OEM_JUMP 0xEA */
4960 "oem-pa1", /* VK_OEM_PA1 0xEB */
4961 "oem-pa2", /* VK_OEM_PA2 0xEC */
4962 "oem-pa3", /* VK_OEM_PA3 0xED */
4963 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4964 "cusel", /* VK_OEM_CUSEL 0xEF */
4965 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4966 "finish", /* VK_OEM_FINISH 0xF1 */
4967 "copy", /* VK_OEM_COPY 0xF2 */
4968 "auto", /* VK_OEM_AUTO 0xF3 */
4969 "enlw", /* VK_OEM_ENLW 0xF4 */
4970 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4971 "attn", /* VK_ATTN 0xF6 */
4972 "crsel", /* VK_CRSEL 0xF7 */
4973 "exsel", /* VK_EXSEL 0xF8 */
4974 "ereof", /* VK_EREOF 0xF9 */
4975 "play", /* VK_PLAY 0xFA */
4976 "zoom", /* VK_ZOOM 0xFB */
4977 "noname", /* VK_NONAME 0xFC */
4978 "pa1", /* VK_PA1 0xFD */
4979 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4983 /* Some of these duplicate the "Media keys" on newer keyboards,
4984 but they are delivered to the application in a different way. */
4985 static char *lispy_multimedia_keys
[] =
4993 "browser-favorites",
5030 "toggle-dictate-command",
5036 "media-fast-forward",
5039 "media-channel-down"
5042 #else /* not HAVE_NTGUI */
5044 /* This should be dealt with in XTread_socket now, and that doesn't
5045 depend on the client system having the Kana syms defined. See also
5046 the XK_kana_A case below. */
5049 static char *lispy_kana_keys
[] =
5051 /* X Keysym value */
5052 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5053 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5054 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5055 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5056 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5057 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5058 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5059 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5060 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5061 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5062 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5063 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5064 "kana-i", "kana-u", "kana-e", "kana-o",
5065 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5066 "prolongedsound", "kana-A", "kana-I", "kana-U",
5067 "kana-E", "kana-O", "kana-KA", "kana-KI",
5068 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5069 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5070 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5071 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5072 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5073 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5074 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5075 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5076 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5077 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5078 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5079 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5081 #endif /* XK_kana_A */
5084 #define FUNCTION_KEY_OFFSET 0xff00
5086 /* You'll notice that this table is arranged to be conveniently
5087 indexed by X Windows keysym values. */
5088 static char *lispy_function_keys
[] =
5090 /* X Keysym value */
5092 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5093 "backspace", "tab", "linefeed", "clear",
5095 0, 0, 0, "pause", /* 0xff10...1f */
5096 0, 0, 0, 0, 0, 0, 0, "escape",
5098 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5099 "romaji", "hiragana", "katakana", "hiragana-katakana",
5100 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5101 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5102 "eisu-toggle", /* 0xff30...3f */
5103 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5104 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5106 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5107 "down", "prior", "next", "end",
5108 "begin", 0, 0, 0, 0, 0, 0, 0,
5109 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5120 "break", /* 0xff6b */
5123 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5124 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5125 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5126 0, 0, 0, 0, 0, 0, 0, 0,
5127 "kp-tab", /* 0xff89 */
5129 "kp-enter", /* 0xff8d */
5131 "kp-f1", /* 0xff91 */
5135 "kp-home", /* 0xff95 */
5140 "kp-prior", /* kp-page-up */
5141 "kp-next", /* kp-page-down */
5147 0, 0, 0, 0, 0, 0, 0, 0, 0,
5148 "kp-multiply", /* 0xffaa */
5153 "kp-divide", /* 0xffaf */
5154 "kp-0", /* 0xffb0 */
5155 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5158 "kp-equal", /* 0xffbd */
5159 "f1", /* 0xffbe */ /* IsFunctionKey */
5161 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5162 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5163 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5164 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5165 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5166 0, 0, 0, 0, 0, 0, 0, 0,
5167 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5168 0, 0, 0, 0, 0, 0, 0, "delete"
5171 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5172 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5174 static char *iso_lispy_function_keys
[] =
5176 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5177 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5178 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5179 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5180 "iso-lefttab", /* 0xfe20 */
5181 "iso-move-line-up", "iso-move-line-down",
5182 "iso-partial-line-up", "iso-partial-line-down",
5183 "iso-partial-space-left", "iso-partial-space-right",
5184 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5185 "iso-release-margin-left", "iso-release-margin-right",
5186 "iso-release-both-margins",
5187 "iso-fast-cursor-left", "iso-fast-cursor-right",
5188 "iso-fast-cursor-up", "iso-fast-cursor-down",
5189 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5190 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5193 #endif /* not HAVE_NTGUI */
5195 Lisp_Object Vlispy_mouse_stem
;
5197 static char *lispy_wheel_names
[] =
5199 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5202 /* drag-n-drop events are generated when a set of selected files are
5203 dragged from another application and dropped onto an Emacs window. */
5204 static char *lispy_drag_n_drop_names
[] =
5209 /* Scroll bar parts. */
5210 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5211 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5212 Lisp_Object Qtop
, Qratio
;
5214 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5215 Lisp_Object
*scroll_bar_parts
[] = {
5216 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5217 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5220 /* A vector, indexed by button number, giving the down-going location
5221 of currently depressed buttons, both scroll bar and non-scroll bar.
5223 The elements have the form
5224 (BUTTON-NUMBER MODIFIER-MASK . REST)
5225 where REST is the cdr of a position as it would be reported in the event.
5227 The make_lispy_event function stores positions here to tell the
5228 difference between click and drag events, and to store the starting
5229 location to be included in drag events. */
5231 static Lisp_Object button_down_location
;
5233 /* Information about the most recent up-going button event: Which
5234 button, what location, and what time. */
5236 static int last_mouse_button
;
5237 static int last_mouse_x
;
5238 static int last_mouse_y
;
5239 static unsigned long button_down_time
;
5241 /* The maximum time between clicks to make a double-click, or Qnil to
5242 disable double-click detection, or Qt for no time limit. */
5244 Lisp_Object Vdouble_click_time
;
5246 /* Maximum number of pixels the mouse may be moved between clicks
5247 to make a double-click. */
5249 EMACS_INT double_click_fuzz
;
5251 /* The number of clicks in this multiple-click. */
5253 int double_click_count
;
5255 /* Return position of a mouse click or wheel event */
5258 make_lispy_position (f
, x
, y
, time
)
5264 enum window_part part
;
5265 Lisp_Object posn
= Qnil
;
5266 Lisp_Object extra_info
= Qnil
;
5269 /* Set `window' to the window under frame pixel coordinates (x,y) */
5271 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5272 &part
, &wx
, &wy
, 0);
5276 if (WINDOWP (window
))
5278 /* It's a click in window window at frame coordinates (x,y) */
5279 struct window
*w
= XWINDOW (window
);
5280 Lisp_Object string_info
= Qnil
;
5281 int textpos
= -1, rx
= -1, ry
= -1;
5282 int dx
= -1, dy
= -1;
5283 int width
= -1, height
= -1;
5284 Lisp_Object object
= Qnil
;
5286 /* Set event coordinates to window-relative coordinates
5287 for constructing the Lisp event below. */
5291 if (part
== ON_TEXT
)
5293 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5295 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5297 /* Mode line or header line. Look for a string under
5298 the mouse that may have a `local-map' property. */
5302 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5304 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5305 &object
, &dx
, &dy
, &width
, &height
);
5306 if (STRINGP (string
))
5307 string_info
= Fcons (string
, make_number (charpos
));
5308 if (w
== XWINDOW (selected_window
)
5309 && current_buffer
== XBUFFER (w
->buffer
))
5312 textpos
= XMARKER (w
->pointm
)->charpos
;
5314 else if (part
== ON_VERTICAL_BORDER
)
5316 posn
= Qvertical_line
;
5321 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5326 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5328 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5329 &object
, &dx
, &dy
, &width
, &height
);
5330 if (STRINGP (string
))
5331 string_info
= Fcons (string
, make_number (charpos
));
5332 if (part
== ON_LEFT_MARGIN
)
5335 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5337 else if (part
== ON_LEFT_FRINGE
)
5339 posn
= Qleft_fringe
;
5342 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5344 : window_box_width (w
, LEFT_MARGIN_AREA
));
5347 else if (part
== ON_RIGHT_FRINGE
)
5349 posn
= Qright_fringe
;
5352 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5353 + window_box_width (w
, TEXT_AREA
)
5354 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5355 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5361 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5362 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5367 Lisp_Object string2
, object2
= Qnil
;
5368 struct display_pos p
;
5370 int width2
, height2
;
5371 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5372 &object2
, &dx2
, &dy2
,
5374 textpos
= CHARPOS (p
.pos
);
5375 if (rx
< 0) rx
= wx
;
5376 if (ry
< 0) ry
= wy
;
5377 if (dx
< 0) dx
= dx2
;
5378 if (dy
< 0) dy
= dy2
;
5379 if (width
< 0) width
= width2
;
5380 if (height
< 0) height
= height2
;
5384 posn
= make_number (textpos
);
5385 if (STRINGP (string2
))
5386 string_info
= Fcons (string2
,
5387 make_number (CHARPOS (p
.string_pos
)));
5393 #ifdef HAVE_WINDOW_SYSTEM
5394 if (IMAGEP (object
))
5396 Lisp_Object image_map
, hotspot
;
5397 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5399 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5401 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5402 posn
= XCAR (hotspot
);
5407 extra_info
= Fcons (object
,
5408 Fcons (Fcons (make_number (dx
),
5410 Fcons (Fcons (make_number (width
),
5411 make_number (height
)),
5415 extra_info
= Fcons (string_info
,
5416 Fcons (make_number (textpos
),
5417 Fcons (Fcons (make_number (rx
),
5423 XSETFRAME (window
, f
);
5428 XSETFASTINT (*x
, 0);
5429 XSETFASTINT (*y
, 0);
5432 return Fcons (window
,
5434 Fcons (Fcons (*x
, *y
),
5435 Fcons (make_number (time
),
5439 /* Given a struct input_event, build the lisp event which represents
5440 it. If EVENT is 0, build a mouse movement event from the mouse
5441 movement buffer, which should have a movement event in it.
5443 Note that events must be passed to this function in the order they
5444 are received; this function stores the location of button presses
5445 in order to build drag events when the button is released. */
5448 make_lispy_event (event
)
5449 struct input_event
*event
;
5453 switch (SWITCH_ENUM_CAST (event
->kind
))
5455 /* A simple keystroke. */
5456 case ASCII_KEYSTROKE_EVENT
:
5457 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5459 Lisp_Object lispy_c
;
5460 int c
= event
->code
;
5461 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5464 eassert (c
== event
->code
);
5465 /* Turn ASCII characters into control characters
5467 if (event
->modifiers
& ctrl_modifier
)
5469 c
= make_ctrl_char (c
);
5470 event
->modifiers
&= ~ctrl_modifier
;
5474 /* Add in the other modifier bits. The shift key was taken care
5475 of by the X code. */
5476 c
|= (event
->modifiers
5477 & (meta_modifier
| alt_modifier
5478 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5479 /* Distinguish Shift-SPC from SPC. */
5480 if ((event
->code
) == 040
5481 && event
->modifiers
& shift_modifier
)
5482 c
|= shift_modifier
;
5483 button_down_time
= 0;
5484 XSETFASTINT (lispy_c
, c
);
5489 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5490 except that they are non-key events (last-nonmenu-event is nil). */
5491 case NS_NONKEY_EVENT
:
5494 /* A function key. The symbol may need to have modifier prefixes
5496 case NON_ASCII_KEYSTROKE_EVENT
:
5497 button_down_time
= 0;
5499 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5500 if (event
->code
== lispy_accent_codes
[i
])
5501 return modify_event_symbol (i
,
5503 Qfunction_key
, Qnil
,
5504 lispy_accent_keys
, &accent_key_syms
,
5505 (sizeof (lispy_accent_keys
)
5506 / sizeof (lispy_accent_keys
[0])));
5510 if (event
->code
>= 0x400 && event
->code
< 0x500)
5511 return modify_event_symbol (event
->code
- 0x400,
5512 event
->modifiers
& ~shift_modifier
,
5513 Qfunction_key
, Qnil
,
5514 lispy_kana_keys
, &func_key_syms
,
5515 (sizeof (lispy_kana_keys
)
5516 / sizeof (lispy_kana_keys
[0])));
5517 #endif /* XK_kana_A */
5520 #ifdef ISO_FUNCTION_KEY_OFFSET
5521 if (event
->code
< FUNCTION_KEY_OFFSET
5522 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5523 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5525 Qfunction_key
, Qnil
,
5526 iso_lispy_function_keys
, &func_key_syms
,
5527 (sizeof (iso_lispy_function_keys
)
5528 / sizeof (iso_lispy_function_keys
[0])));
5531 /* Handle system-specific or unknown keysyms. */
5532 if (event
->code
& (1 << 28)
5533 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5534 || (event
->code
- FUNCTION_KEY_OFFSET
5535 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5536 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5538 /* We need to use an alist rather than a vector as the cache
5539 since we can't make a vector long enuf. */
5540 if (NILP (current_kboard
->system_key_syms
))
5541 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5542 return modify_event_symbol (event
->code
,
5545 current_kboard
->Vsystem_key_alist
,
5546 0, ¤t_kboard
->system_key_syms
,
5550 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5552 Qfunction_key
, Qnil
,
5553 lispy_function_keys
, &func_key_syms
,
5554 (sizeof (lispy_function_keys
)
5555 / sizeof (lispy_function_keys
[0])));
5558 case MULTIMEDIA_KEY_EVENT
:
5559 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5560 / sizeof (lispy_multimedia_keys
[0]))
5561 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5563 return modify_event_symbol (event
->code
, event
->modifiers
,
5564 Qfunction_key
, Qnil
,
5565 lispy_multimedia_keys
, &func_key_syms
,
5566 (sizeof (lispy_multimedia_keys
)
5567 / sizeof (lispy_multimedia_keys
[0])));
5573 /* A mouse click. Figure out where it is, decide whether it's
5574 a press, click or drag, and build the appropriate structure. */
5575 case MOUSE_CLICK_EVENT
:
5576 #ifndef USE_TOOLKIT_SCROLL_BARS
5577 case SCROLL_BAR_CLICK_EVENT
:
5580 int button
= event
->code
;
5582 Lisp_Object position
;
5583 Lisp_Object
*start_pos_ptr
;
5584 Lisp_Object start_pos
;
5588 /* Build the position as appropriate for this mouse click. */
5589 if (event
->kind
== MOUSE_CLICK_EVENT
)
5591 struct frame
*f
= XFRAME (event
->frame_or_window
);
5592 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5596 /* Ignore mouse events that were made on frame that
5597 have been deleted. */
5598 if (! FRAME_LIVE_P (f
))
5601 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5602 /* EVENT->x and EVENT->y are frame-relative pixel
5603 coordinates at this place. Under old redisplay, COLUMN
5604 and ROW are set to frame relative glyph coordinates
5605 which are then used to determine whether this click is
5606 in a menu (non-toolkit version). */
5607 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5608 &column
, &row
, NULL
, 1);
5610 /* In the non-toolkit version, clicks on the menu bar
5611 are ordinary button events in the event buffer.
5612 Distinguish them, and invoke the menu.
5614 (In the toolkit version, the toolkit handles the menu bar
5615 and Emacs doesn't know about it until after the user
5616 makes a selection.) */
5617 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5618 && (event
->modifiers
& down_modifier
))
5620 Lisp_Object items
, item
;
5625 /* Activate the menu bar on the down event. If the
5626 up event comes in before the menu code can deal with it,
5628 if (! (event
->modifiers
& down_modifier
))
5632 /* Find the menu bar item under `column'. */
5634 items
= FRAME_MENU_BAR_ITEMS (f
);
5635 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5637 Lisp_Object pos
, string
;
5638 string
= AREF (items
, i
+ 1);
5639 pos
= AREF (items
, i
+ 3);
5642 if (column
>= XINT (pos
)
5643 && column
< XINT (pos
) + SCHARS (string
))
5645 item
= AREF (items
, i
);
5650 /* ELisp manual 2.4b says (x y) are window relative but
5651 code says they are frame-relative. */
5653 = Fcons (event
->frame_or_window
,
5655 Fcons (Fcons (event
->x
, event
->y
),
5656 Fcons (make_number (event
->timestamp
),
5659 return Fcons (item
, Fcons (position
, Qnil
));
5661 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5663 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5666 #ifndef USE_TOOLKIT_SCROLL_BARS
5669 /* It's a scrollbar click. */
5671 Lisp_Object portion_whole
;
5674 window
= event
->frame_or_window
;
5675 portion_whole
= Fcons (event
->x
, event
->y
);
5676 part
= *scroll_bar_parts
[(int) event
->part
];
5680 Fcons (Qvertical_scroll_bar
,
5681 Fcons (portion_whole
,
5682 Fcons (make_number (event
->timestamp
),
5683 Fcons (part
, Qnil
)))));
5685 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5687 if (button
>= ASIZE (button_down_location
))
5689 button_down_location
= larger_vector (button_down_location
,
5691 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5694 start_pos_ptr
= &AREF (button_down_location
, button
);
5695 start_pos
= *start_pos_ptr
;
5696 *start_pos_ptr
= Qnil
;
5699 /* On window-system frames, use the value of
5700 double-click-fuzz as is. On other frames, interpret it
5701 as a multiple of 1/8 characters. */
5705 if (WINDOWP (event
->frame_or_window
))
5706 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5707 else if (FRAMEP (event
->frame_or_window
))
5708 f
= XFRAME (event
->frame_or_window
);
5712 if (FRAME_WINDOW_P (f
))
5713 fuzz
= double_click_fuzz
;
5715 fuzz
= double_click_fuzz
/ 8;
5717 is_double
= (button
== last_mouse_button
5718 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5719 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5720 && button_down_time
!= 0
5721 && (EQ (Vdouble_click_time
, Qt
)
5722 || (INTEGERP (Vdouble_click_time
)
5723 && ((int)(event
->timestamp
- button_down_time
)
5724 < XINT (Vdouble_click_time
)))));
5727 last_mouse_button
= button
;
5728 last_mouse_x
= XINT (event
->x
);
5729 last_mouse_y
= XINT (event
->y
);
5731 /* If this is a button press, squirrel away the location, so
5732 we can decide later whether it was a click or a drag. */
5733 if (event
->modifiers
& down_modifier
)
5737 double_click_count
++;
5738 event
->modifiers
|= ((double_click_count
> 2)
5743 double_click_count
= 1;
5744 button_down_time
= event
->timestamp
;
5745 *start_pos_ptr
= Fcopy_alist (position
);
5746 ignore_mouse_drag_p
= 0;
5749 /* Now we're releasing a button - check the co-ordinates to
5750 see if this was a click or a drag. */
5751 else if (event
->modifiers
& up_modifier
)
5753 /* If we did not see a down before this up, ignore the up.
5754 Probably this happened because the down event chose a
5755 menu item. It would be an annoyance to treat the
5756 release of the button that chose the menu item as a
5759 if (!CONSP (start_pos
))
5762 event
->modifiers
&= ~up_modifier
;
5763 #if 0 /* Formerly we treated an up with no down as a click event. */
5764 if (!CONSP (start_pos
))
5765 event
->modifiers
|= click_modifier
;
5770 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5772 /* The third element of every position
5773 should be the (x,y) pair. */
5774 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5776 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5778 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5779 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5782 if (ignore_mouse_drag_p
)
5784 event
->modifiers
|= click_modifier
;
5785 ignore_mouse_drag_p
= 0;
5787 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5788 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5789 /* Maybe the mouse has moved a lot, caused scrolling, and
5790 eventually ended up at the same screen position (but
5791 not buffer position) in which case it is a drag, not
5793 /* FIXME: OTOH if the buffer position has changed
5794 because of a timer or process filter rather than
5795 because of mouse movement, it should be considered as
5796 a click. But mouse-drag-region completely ignores
5797 this case and it hasn't caused any real problem, so
5798 it's probably OK to ignore it as well. */
5799 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5800 /* Mouse hasn't moved (much). */
5801 event
->modifiers
|= click_modifier
;
5804 button_down_time
= 0;
5805 event
->modifiers
|= drag_modifier
;
5808 /* Don't check is_double; treat this as multiple
5809 if the down-event was multiple. */
5810 if (double_click_count
> 1)
5811 event
->modifiers
|= ((double_click_count
> 2)
5817 /* Every mouse event should either have the down_modifier or
5818 the up_modifier set. */
5822 /* Get the symbol we should use for the mouse click. */
5825 head
= modify_event_symbol (button
,
5827 Qmouse_click
, Vlispy_mouse_stem
,
5830 XVECTOR (mouse_syms
)->size
);
5831 if (event
->modifiers
& drag_modifier
)
5836 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5839 Fcons (make_number (double_click_count
),
5849 case HORIZ_WHEEL_EVENT
:
5851 Lisp_Object position
;
5854 /* Build the position as appropriate for this mouse click. */
5855 struct frame
*f
= XFRAME (event
->frame_or_window
);
5857 /* Ignore wheel events that were made on frame that have been
5859 if (! FRAME_LIVE_P (f
))
5862 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5865 /* Set double or triple modifiers to indicate the wheel speed. */
5867 /* On window-system frames, use the value of
5868 double-click-fuzz as is. On other frames, interpret it
5869 as a multiple of 1/8 characters. */
5875 if (WINDOWP (event
->frame_or_window
))
5876 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5877 else if (FRAMEP (event
->frame_or_window
))
5878 f
= XFRAME (event
->frame_or_window
);
5882 if (FRAME_WINDOW_P (f
))
5883 fuzz
= double_click_fuzz
;
5885 fuzz
= double_click_fuzz
/ 8;
5887 if (event
->modifiers
& up_modifier
)
5889 /* Emit a wheel-up event. */
5890 event
->modifiers
&= ~up_modifier
;
5893 else if (event
->modifiers
& down_modifier
)
5895 /* Emit a wheel-down event. */
5896 event
->modifiers
&= ~down_modifier
;
5900 /* Every wheel event should either have the down_modifier or
5901 the up_modifier set. */
5904 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5907 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5908 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5909 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5910 && button_down_time
!= 0
5911 && (EQ (Vdouble_click_time
, Qt
)
5912 || (INTEGERP (Vdouble_click_time
)
5913 && ((int)(event
->timestamp
- button_down_time
)
5914 < XINT (Vdouble_click_time
)))));
5917 double_click_count
++;
5918 event
->modifiers
|= ((double_click_count
> 2)
5924 double_click_count
= 1;
5925 event
->modifiers
|= click_modifier
;
5928 button_down_time
= event
->timestamp
;
5929 /* Use a negative value to distinguish wheel from mouse button. */
5930 last_mouse_button
= - (1 + symbol_num
);
5931 last_mouse_x
= XINT (event
->x
);
5932 last_mouse_y
= XINT (event
->y
);
5934 /* Get the symbol we should use for the wheel event. */
5935 head
= modify_event_symbol (symbol_num
,
5941 ASIZE (wheel_syms
));
5944 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5947 Fcons (make_number (double_click_count
),
5956 #ifdef USE_TOOLKIT_SCROLL_BARS
5958 /* We don't have down and up events if using toolkit scroll bars,
5959 so make this always a click event. Store in the `part' of
5960 the Lisp event a symbol which maps to the following actions:
5962 `above_handle' page up
5963 `below_handle' page down
5967 `bottom' bottom of buffer
5968 `handle' thumb has been dragged.
5969 `end-scroll' end of interaction with scroll bar
5971 The incoming input_event contains in its `part' member an
5972 index of type `enum scroll_bar_part' which we can use as an
5973 index in scroll_bar_parts to get the appropriate symbol. */
5975 case SCROLL_BAR_CLICK_EVENT
:
5977 Lisp_Object position
, head
, window
, portion_whole
, part
;
5979 window
= event
->frame_or_window
;
5980 portion_whole
= Fcons (event
->x
, event
->y
);
5981 part
= *scroll_bar_parts
[(int) event
->part
];
5985 Fcons (Qvertical_scroll_bar
,
5986 Fcons (portion_whole
,
5987 Fcons (make_number (event
->timestamp
),
5988 Fcons (part
, Qnil
)))));
5990 /* Always treat scroll bar events as clicks. */
5991 event
->modifiers
|= click_modifier
;
5992 event
->modifiers
&= ~up_modifier
;
5994 if (event
->code
>= ASIZE (mouse_syms
))
5995 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5997 /* Get the symbol we should use for the mouse click. */
5998 head
= modify_event_symbol (event
->code
,
6003 XVECTOR (mouse_syms
)->size
);
6004 return Fcons (head
, Fcons (position
, Qnil
));
6007 #endif /* USE_TOOLKIT_SCROLL_BARS */
6009 case DRAG_N_DROP_EVENT
:
6012 Lisp_Object head
, position
;
6015 f
= XFRAME (event
->frame_or_window
);
6018 /* Ignore mouse events that were made on frames that
6019 have been deleted. */
6020 if (! FRAME_LIVE_P (f
))
6023 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6026 head
= modify_event_symbol (0, event
->modifiers
,
6028 lispy_drag_n_drop_names
,
6029 &drag_n_drop_syms
, 1);
6035 #endif /* HAVE_MOUSE */
6037 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6038 || defined(HAVE_NS) || defined (USE_GTK)
6039 case MENU_BAR_EVENT
:
6040 if (EQ (event
->arg
, event
->frame_or_window
))
6041 /* This is the prefix key. We translate this to
6042 `(menu_bar)' because the code in keyboard.c for menu
6043 events, which we use, relies on this. */
6044 return Fcons (Qmenu_bar
, Qnil
);
6048 case SELECT_WINDOW_EVENT
:
6049 /* Make an event (select-window (WINDOW)). */
6050 return Fcons (Qselect_window
,
6051 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6054 case TOOL_BAR_EVENT
:
6055 if (EQ (event
->arg
, event
->frame_or_window
))
6056 /* This is the prefix key. We translate this to
6057 `(tool_bar)' because the code in keyboard.c for tool bar
6058 events, which we use, relies on this. */
6059 return Fcons (Qtool_bar
, Qnil
);
6060 else if (SYMBOLP (event
->arg
))
6061 return apply_modifiers (event
->modifiers
, event
->arg
);
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 */
6086 printf("cool, an xwidget event arrived in make_lispy_event!\n");
6087 return Fcons (Qxwidget_event
,event
->arg
);
6090 case CONFIG_CHANGED_EVENT
:
6091 return Fcons (Qconfig_changed_event
,
6093 Fcons (event
->frame_or_window
, Qnil
)));
6095 case GPM_CLICK_EVENT
:
6097 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6098 Lisp_Object head
, position
;
6099 Lisp_Object
*start_pos_ptr
;
6100 Lisp_Object start_pos
;
6101 int button
= event
->code
;
6103 if (button
>= ASIZE (button_down_location
))
6105 button_down_location
= larger_vector (button_down_location
,
6107 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6110 start_pos_ptr
= &AREF (button_down_location
, button
);
6111 start_pos
= *start_pos_ptr
;
6113 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6116 if (event
->modifiers
& down_modifier
)
6117 *start_pos_ptr
= Fcopy_alist (position
);
6118 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6120 if (!CONSP (start_pos
))
6122 event
->modifiers
&= ~up_modifier
;
6125 head
= modify_event_symbol (button
,
6127 Qmouse_click
, Vlispy_mouse_stem
,
6130 XVECTOR (mouse_syms
)->size
);
6132 if (event
->modifiers
& drag_modifier
)
6137 else if (event
->modifiers
& double_modifier
)
6140 Fcons (make_number (2),
6142 else if (event
->modifiers
& triple_modifier
)
6145 Fcons (make_number (3),
6152 #endif /* HAVE_GPM */
6154 /* The 'kind' field of the event is something we don't recognize. */
6160 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6163 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6165 Lisp_Object bar_window
;
6166 enum scroll_bar_part part
;
6170 /* Is it a scroll bar movement? */
6171 if (frame
&& ! NILP (bar_window
))
6173 Lisp_Object part_sym
;
6175 part_sym
= *scroll_bar_parts
[(int) part
];
6176 return Fcons (Qscroll_bar_movement
,
6177 (Fcons (Fcons (bar_window
,
6178 Fcons (Qvertical_scroll_bar
,
6179 Fcons (Fcons (x
, y
),
6180 Fcons (make_number (time
),
6186 /* Or is it an ordinary mouse movement? */
6189 Lisp_Object position
;
6191 position
= make_lispy_position (frame
, &x
, &y
, time
);
6193 return Fcons (Qmouse_movement
,
6199 #endif /* HAVE_MOUSE || HAVE GPM */
6201 /* Construct a switch frame event. */
6203 make_lispy_switch_frame (frame
)
6206 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6209 /* Manipulating modifiers. */
6211 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6213 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6214 SYMBOL's name of the end of the modifiers; the string from this
6215 position is the unmodified symbol name.
6217 This doesn't use any caches. */
6220 parse_modifiers_uncached (symbol
, modifier_end
)
6228 CHECK_SYMBOL (symbol
);
6231 name
= SYMBOL_NAME (symbol
);
6233 for (i
= 0; i
+2 <= SBYTES (name
); )
6235 int this_mod_end
= 0;
6238 /* See if the name continues with a modifier word.
6239 Check that the word appears, but don't check what follows it.
6240 Set this_mod and this_mod_end to record what we find. */
6242 switch (SREF (name
, i
))
6244 #define SINGLE_LETTER_MOD(BIT) \
6245 (this_mod_end = i + 1, this_mod = BIT)
6248 SINGLE_LETTER_MOD (alt_modifier
);
6252 SINGLE_LETTER_MOD (ctrl_modifier
);
6256 SINGLE_LETTER_MOD (hyper_modifier
);
6260 SINGLE_LETTER_MOD (meta_modifier
);
6264 SINGLE_LETTER_MOD (shift_modifier
);
6268 SINGLE_LETTER_MOD (super_modifier
);
6271 #undef SINGLE_LETTER_MOD
6273 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6274 if (i + LEN + 1 <= SBYTES (name) \
6275 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6277 this_mod_end = i + LEN; \
6282 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6283 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6284 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6288 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6290 #undef MULTI_LETTER_MOD
6294 /* If we found no modifier, stop looking for them. */
6295 if (this_mod_end
== 0)
6298 /* Check there is a dash after the modifier, so that it
6299 really is a modifier. */
6300 if (this_mod_end
>= SBYTES (name
)
6301 || SREF (name
, this_mod_end
) != '-')
6304 /* This modifier is real; look for another. */
6305 modifiers
|= this_mod
;
6306 i
= this_mod_end
+ 1;
6309 /* Should we include the `click' modifier? */
6310 if (! (modifiers
& (down_modifier
| drag_modifier
6311 | double_modifier
| triple_modifier
))
6312 && i
+ 7 == SBYTES (name
)
6313 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6314 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6315 modifiers
|= click_modifier
;
6317 if (! (modifiers
& (double_modifier
| triple_modifier
))
6318 && i
+ 6 < SBYTES (name
)
6319 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6320 modifiers
|= click_modifier
;
6328 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6329 prepended to the string BASE[0..BASE_LEN-1].
6330 This doesn't use any caches. */
6332 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6335 int base_len
, base_len_byte
;
6337 /* Since BASE could contain nulls, we can't use intern here; we have
6338 to use Fintern, which expects a genuine Lisp_String, and keeps a
6341 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6347 /* Only the event queue may use the `up' modifier; it should always
6348 be turned into a click or drag event before presented to lisp code. */
6349 if (modifiers
& up_modifier
)
6352 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6353 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6354 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6355 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6356 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6357 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6358 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6359 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6360 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6361 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6362 /* The click modifier is denoted by the absence of other modifiers. */
6366 mod_len
= p
- new_mods
;
6370 Lisp_Object new_name
;
6372 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6373 mod_len
+ base_len_byte
);
6374 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6375 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6377 return Fintern (new_name
, Qnil
);
6382 static const char *modifier_names
[] =
6384 "up", "down", "drag", "click", "double", "triple", 0, 0,
6385 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6386 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6388 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6390 static Lisp_Object modifier_symbols
;
6392 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6394 lispy_modifier_list (modifiers
)
6397 Lisp_Object modifier_list
;
6400 modifier_list
= Qnil
;
6401 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6402 if (modifiers
& (1<<i
))
6403 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6406 return modifier_list
;
6410 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6411 where UNMODIFIED is the unmodified form of SYMBOL,
6412 MASK is the set of modifiers present in SYMBOL's name.
6413 This is similar to parse_modifiers_uncached, but uses the cache in
6414 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6415 Qevent_symbol_elements property. */
6417 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6420 parse_modifiers (symbol
)
6423 Lisp_Object elements
;
6425 if (INTEGERP (symbol
))
6426 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6427 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6429 else if (!SYMBOLP (symbol
))
6432 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6433 if (CONSP (elements
))
6438 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6439 Lisp_Object unmodified
;
6442 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6443 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6446 if (modifiers
& ~INTMASK
)
6448 XSETFASTINT (mask
, modifiers
);
6449 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6451 /* Cache the parsing results on SYMBOL. */
6452 Fput (symbol
, Qevent_symbol_element_mask
,
6454 Fput (symbol
, Qevent_symbol_elements
,
6455 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6457 /* Since we know that SYMBOL is modifiers applied to unmodified,
6458 it would be nice to put that in unmodified's cache.
6459 But we can't, since we're not sure that parse_modifiers is
6466 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6467 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6468 doc
: /* Parse the event symbol. For internal use. */)
6472 /* Fill the cache if needed. */
6473 parse_modifiers (symbol
);
6474 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6475 and use the Lispier representation stored on Qevent_symbol_elements
6477 return Fget (symbol
, Qevent_symbol_elements
);
6480 /* Apply the modifiers MODIFIERS to the symbol BASE.
6481 BASE must be unmodified.
6483 This is like apply_modifiers_uncached, but uses BASE's
6484 Qmodifier_cache property, if present. It also builds
6485 Qevent_symbol_elements properties, since it has that info anyway.
6487 apply_modifiers copies the value of BASE's Qevent_kind property to
6488 the modified symbol. */
6490 apply_modifiers (modifiers
, base
)
6494 Lisp_Object cache
, index
, entry
, new_symbol
;
6496 /* Mask out upper bits. We don't know where this value's been. */
6497 modifiers
&= INTMASK
;
6499 if (INTEGERP (base
))
6500 return make_number (XINT (base
) | modifiers
);
6502 /* The click modifier never figures into cache indices. */
6503 cache
= Fget (base
, Qmodifier_cache
);
6504 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6505 entry
= assq_no_quit (index
, cache
);
6508 new_symbol
= XCDR (entry
);
6511 /* We have to create the symbol ourselves. */
6512 new_symbol
= apply_modifiers_uncached (modifiers
,
6513 SDATA (SYMBOL_NAME (base
)),
6514 SCHARS (SYMBOL_NAME (base
)),
6515 SBYTES (SYMBOL_NAME (base
)));
6517 /* Add the new symbol to the base's cache. */
6518 entry
= Fcons (index
, new_symbol
);
6519 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6521 /* We have the parsing info now for free, so we could add it to
6523 XSETFASTINT (index, modifiers);
6524 Fput (new_symbol, Qevent_symbol_element_mask,
6525 Fcons (base, Fcons (index, Qnil)));
6526 Fput (new_symbol, Qevent_symbol_elements,
6527 Fcons (base, lispy_modifier_list (modifiers)));
6528 Sadly, this is only correct if `base' is indeed a base event,
6529 which is not necessarily the case. -stef */
6532 /* Make sure this symbol is of the same kind as BASE.
6534 You'd think we could just set this once and for all when we
6535 intern the symbol above, but reorder_modifiers may call us when
6536 BASE's property isn't set right; we can't assume that just
6537 because it has a Qmodifier_cache property it must have its
6538 Qevent_kind set right as well. */
6539 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6543 kind
= Fget (base
, Qevent_kind
);
6545 Fput (new_symbol
, Qevent_kind
, kind
);
6552 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6553 return a symbol with the modifiers placed in the canonical order.
6554 Canonical order is alphabetical, except for down and drag, which
6555 always come last. The 'click' modifier is never written out.
6557 Fdefine_key calls this to make sure that (for example) C-M-foo
6558 and M-C-foo end up being equivalent in the keymap. */
6561 reorder_modifiers (symbol
)
6564 /* It's hopefully okay to write the code this way, since everything
6565 will soon be in caches, and no consing will be done at all. */
6568 parsed
= parse_modifiers (symbol
);
6569 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6574 /* For handling events, we often want to produce a symbol whose name
6575 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6576 to some base, like the name of a function key or mouse button.
6577 modify_event_symbol produces symbols of this sort.
6579 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6580 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6583 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6584 into symbol names, or a string specifying a name stem used to
6585 construct a symbol name or the form `STEM-N', where N is the decimal
6586 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6587 non-nil; otherwise NAME_TABLE is used.
6589 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6590 persist between calls to modify_event_symbol that it can use to
6591 store a cache of the symbols it's generated for this NAME_TABLE
6592 before. The object stored there may be a vector or an alist.
6594 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6596 MODIFIERS is a set of modifier bits (as given in struct input_events)
6597 whose prefixes should be applied to the symbol name.
6599 SYMBOL_KIND is the value to be placed in the event_kind property of
6600 the returned symbol.
6602 The symbols we create are supposed to have an
6603 `event-symbol-elements' property, which lists the modifiers present
6604 in the symbol's name. */
6607 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6608 name_table
, symbol_table
, table_size
)
6611 Lisp_Object symbol_kind
;
6612 Lisp_Object name_alist_or_stem
;
6614 Lisp_Object
*symbol_table
;
6615 unsigned int table_size
;
6618 Lisp_Object symbol_int
;
6620 /* Get rid of the "vendor-specific" bit here. */
6621 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6623 /* Is this a request for a valid symbol? */
6624 if (symbol_num
< 0 || symbol_num
>= table_size
)
6627 if (CONSP (*symbol_table
))
6628 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6630 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6631 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6632 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6633 we've never used that symbol before. */
6636 if (! VECTORP (*symbol_table
)
6637 || XVECTOR (*symbol_table
)->size
!= table_size
)
6641 XSETFASTINT (size
, table_size
);
6642 *symbol_table
= Fmake_vector (size
, Qnil
);
6645 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6648 /* Have we already used this symbol before? */
6651 /* No; let's create it. */
6652 if (CONSP (name_alist_or_stem
))
6653 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6654 else if (STRINGP (name_alist_or_stem
))
6656 int len
= SBYTES (name_alist_or_stem
);
6657 char *buf
= (char *) alloca (len
+ 50);
6658 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6659 (long) XINT (symbol_int
) + 1);
6660 value
= intern (buf
);
6662 else if (name_table
!= 0 && name_table
[symbol_num
])
6663 value
= intern (name_table
[symbol_num
]);
6665 #ifdef HAVE_WINDOW_SYSTEM
6668 char *name
= x_get_keysym_name (symbol_num
);
6670 value
= intern (name
);
6677 sprintf (buf
, "key-%d", symbol_num
);
6678 value
= intern (buf
);
6681 if (CONSP (*symbol_table
))
6682 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6684 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6686 /* Fill in the cache entries for this symbol; this also
6687 builds the Qevent_symbol_elements property, which the user
6689 apply_modifiers (modifiers
& click_modifier
, value
);
6690 Fput (value
, Qevent_kind
, symbol_kind
);
6693 /* Apply modifiers to that symbol. */
6694 return apply_modifiers (modifiers
, value
);
6697 /* Convert a list that represents an event type,
6698 such as (ctrl meta backspace), into the usual representation of that
6699 event type as a number or a symbol. */
6701 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6702 doc
: /* Convert the event description list EVENT-DESC to an event type.
6703 EVENT-DESC should contain one base event type (a character or symbol)
6704 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6705 drag, down, double or triple). The base must be last.
6706 The return value is an event type (a character or symbol) which
6707 has the same base event type and all the specified modifiers. */)
6709 Lisp_Object event_desc
;
6717 while (CONSP (rest
))
6725 /* Given a symbol, see if it is a modifier name. */
6726 if (SYMBOLP (elt
) && CONSP (rest
))
6727 this = parse_solitary_modifier (elt
);
6731 else if (!NILP (base
))
6732 error ("Two bases given in one event");
6738 /* Let the symbol A refer to the character A. */
6739 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6740 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6742 if (INTEGERP (base
))
6744 /* Turn (shift a) into A. */
6745 if ((modifiers
& shift_modifier
) != 0
6746 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6748 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6749 modifiers
&= ~shift_modifier
;
6752 /* Turn (control a) into C-a. */
6753 if (modifiers
& ctrl_modifier
)
6754 return make_number ((modifiers
& ~ctrl_modifier
)
6755 | make_ctrl_char (XINT (base
)));
6757 return make_number (modifiers
| XINT (base
));
6759 else if (SYMBOLP (base
))
6760 return apply_modifiers (modifiers
, base
);
6763 error ("Invalid base event");
6768 /* Try to recognize SYMBOL as a modifier name.
6769 Return the modifier flag bit, or 0 if not recognized. */
6772 parse_solitary_modifier (Lisp_Object symbol
)
6774 Lisp_Object name
= SYMBOL_NAME (symbol
);
6776 switch (SREF (name
, 0))
6778 #define SINGLE_LETTER_MOD(BIT) \
6779 if (SBYTES (name) == 1) \
6782 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6783 if (LEN == SBYTES (name) \
6784 && ! strncmp (SDATA (name), NAME, LEN)) \
6788 SINGLE_LETTER_MOD (alt_modifier
);
6792 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6796 SINGLE_LETTER_MOD (ctrl_modifier
);
6800 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6801 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6805 SINGLE_LETTER_MOD (hyper_modifier
);
6809 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6813 SINGLE_LETTER_MOD (meta_modifier
);
6817 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6821 SINGLE_LETTER_MOD (shift_modifier
);
6825 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6826 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6827 SINGLE_LETTER_MOD (super_modifier
);
6831 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6832 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6833 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6837 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6840 #undef SINGLE_LETTER_MOD
6841 #undef MULTI_LETTER_MOD
6847 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6848 Such a list is not valid as an event,
6849 but it can be a Lucid-style event type list. */
6852 lucid_event_type_list_p (object
)
6857 if (! CONSP (object
))
6860 if (EQ (XCAR (object
), Qhelp_echo
)
6861 || EQ (XCAR (object
), Qvertical_line
)
6862 || EQ (XCAR (object
), Qmode_line
)
6863 || EQ (XCAR (object
), Qheader_line
))
6866 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6870 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6877 /* Store into *addr a value nonzero if terminal input chars are available.
6878 Serves the purpose of ioctl (0, FIONREAD, addr)
6879 but works even if FIONREAD does not exist.
6880 (In fact, this may actually read some input.)
6882 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6883 timer events that are ripe.
6884 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6885 events (FOCUS_IN_EVENT).
6886 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6887 movements and toolkit scroll bar thumb drags. */
6890 get_input_pending (addr
, flags
)
6894 /* First of all, have we already counted some input? */
6895 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6897 /* If input is being read as it arrives, and we have none, there is none. */
6898 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6901 /* Try to read some input and see how much we get. */
6903 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6906 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6909 gobble_input (expected
)
6913 /* Read D-Bus messages. */
6914 xd_read_queued_messages ();
6915 #endif /* HAVE_DBUS */
6918 if (interrupt_input
)
6921 mask
= sigblock (sigmask (SIGIO
));
6922 read_avail_input (expected
);
6926 #ifdef POLL_FOR_INPUT
6927 /* XXX This condition was (read_socket_hook && !interrupt_input),
6928 but read_socket_hook is not global anymore. Let's pretend that
6930 if (!interrupt_input
&& poll_suppress_count
== 0)
6933 mask
= sigblock (sigmask (SIGALRM
));
6934 read_avail_input (expected
);
6940 read_avail_input (expected
);
6943 /* Put a BUFFER_SWITCH_EVENT in the buffer
6944 so that read_key_sequence will notice the new current buffer. */
6947 record_asynch_buffer_change ()
6949 struct input_event event
;
6953 event
.kind
= BUFFER_SWITCH_EVENT
;
6954 event
.frame_or_window
= Qnil
;
6958 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6959 The purpose of the event is to make read_key_sequence look up the
6960 keymaps again. If we aren't in read_key_sequence, we don't need one,
6961 and the event could cause trouble by messing up (input-pending-p). */
6962 tem
= Fwaiting_for_user_input_p ();
6966 /* We never need these events if we have no asynchronous subprocesses. */
6970 /* Make sure no interrupt happens while storing the event. */
6972 if (interrupt_input
)
6975 mask
= sigblock (sigmask (SIGIO
));
6976 kbd_buffer_store_event (&event
);
6983 kbd_buffer_store_event (&event
);
6988 /* Read any terminal input already buffered up by the system
6989 into the kbd_buffer, but do not wait.
6991 EXPECTED should be nonzero if the caller knows there is some input.
6993 Returns the number of keyboard chars read, or -1 meaning
6994 this is a bad time to try to read input. */
6997 read_avail_input (expected
)
7004 /* Store pending user signal events, if any. */
7005 if (store_user_signal_events ())
7008 /* Loop through the available terminals, and call their input hooks. */
7012 struct terminal
*next
= t
->next_terminal
;
7014 if (t
->read_socket_hook
)
7017 struct input_event hold_quit
;
7019 EVENT_INIT (hold_quit
);
7020 hold_quit
.kind
= NO_EVENT
;
7022 /* No need for FIONREAD or fcntl; just say don't wait. */
7023 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7029 if (nr
== -1) /* Not OK to read input now. */
7033 else if (nr
== -2) /* Non-transient error. */
7035 /* The terminal device terminated; it should be closed. */
7037 /* Kill Emacs if this was our last terminal. */
7038 if (!terminal_list
->next_terminal
)
7039 /* Formerly simply reported no input, but that
7040 sometimes led to a failure of Emacs to terminate.
7041 SIGHUP seems appropriate if we can't reach the
7043 /* ??? Is it really right to send the signal just to
7044 this process rather than to the whole process
7045 group? Perhaps on systems with FIONREAD Emacs is
7046 alone in its group. */
7047 kill (getpid (), SIGHUP
);
7049 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7052 XSETTERMINAL (tmp
, t
);
7053 Fdelete_terminal (tmp
, Qnoelisp
);
7057 if (hold_quit
.kind
!= NO_EVENT
)
7058 kbd_buffer_store_event (&hold_quit
);
7067 frame_make_pointer_visible ();
7073 decode_keyboard_code (struct tty_display_info
*tty
,
7074 struct coding_system
*coding
,
7075 unsigned char *buf
, int nbytes
)
7077 unsigned char *src
= buf
;
7078 const unsigned char *p
;
7083 if (tty
->meta_key
!= 2)
7084 for (i
= 0; i
< nbytes
; i
++)
7086 if (coding
->carryover_bytes
> 0)
7088 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7089 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7090 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7091 nbytes
+= coding
->carryover_bytes
;
7093 coding
->destination
= alloca (nbytes
* 4);
7094 coding
->dst_bytes
= nbytes
* 4;
7095 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7096 if (coding
->produced_char
== 0)
7098 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7100 struct input_event buf
;
7103 buf
.code
= STRING_CHAR_ADVANCE (p
);
7104 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7105 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7106 /* See the comment in tty_read_avail_input. */
7107 buf
.frame_or_window
= tty
->top_frame
;
7109 kbd_buffer_store_event (&buf
);
7113 /* This is the tty way of reading available input.
7115 Note that each terminal device has its own `struct terminal' object,
7116 and so this function is called once for each individual termcap
7117 terminal. The first parameter indicates which terminal to read from. */
7120 tty_read_avail_input (struct terminal
*terminal
,
7122 struct input_event
*hold_quit
)
7124 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7125 the kbd_buffer can really hold. That may prevent loss
7126 of characters on some systems when input is stuffed at us. */
7127 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7129 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7132 if (!terminal
->name
) /* Don't read from a dead terminal. */
7135 if (terminal
->type
!= output_termcap
7136 && terminal
->type
!= output_msdos_raw
)
7139 /* XXX I think the following code should be moved to separate hook
7140 functions in system-dependent files. */
7143 #else /* not WINDOWSNT */
7144 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7148 return 0; /* The terminal is suspended. */
7151 n_to_read
= dos_keysns ();
7155 cbuf
[0] = dos_keyread ();
7158 #else /* not MSDOS */
7163 struct input_event hold_quit
;
7164 int gpm
, fd
= gpm_fd
;
7166 EVENT_INIT (hold_quit
);
7167 hold_quit
.kind
= NO_EVENT
;
7169 /* gpm==1 if event received.
7170 gpm==0 if the GPM daemon has closed the connection, in which case
7171 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7172 we save it in `fd' so close_gpm can remove it from the
7174 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7175 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7176 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7179 /* Presumably the GPM daemon has closed the connection. */
7181 if (hold_quit
.kind
!= NO_EVENT
)
7182 kbd_buffer_store_event (&hold_quit
);
7186 #endif /* HAVE_GPM */
7188 /* Determine how many characters we should *try* to read. */
7190 /* Find out how much input is available. */
7191 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7193 if (! noninteractive
)
7194 return -2; /* Close this terminal. */
7200 if (n_to_read
> sizeof cbuf
)
7201 n_to_read
= sizeof cbuf
;
7202 #else /* no FIONREAD */
7203 #if defined (USG) || defined(CYGWIN)
7204 /* Read some input if available, but don't wait. */
7205 n_to_read
= sizeof cbuf
;
7206 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7212 /* Now read; for one reason or another, this will not block.
7213 NREAD is set to the number of chars read. */
7216 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7217 /* POSIX infers that processes which are not in the session leader's
7218 process group won't get SIGHUP's at logout time. BSDI adheres to
7219 this part standard and returns -1 from read (0) with errno==EIO
7220 when the control tty is taken away.
7221 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7222 if (nread
== -1 && errno
== EIO
)
7223 return -2; /* Close this terminal. */
7224 #if defined (AIX) && defined (_BSD)
7225 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7226 This looks incorrect, but it isn't, because _BSD causes
7227 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7228 and that causes a value other than 0 when there is no input. */
7230 return -2; /* Close this terminal. */
7234 /* We used to retry the read if it was interrupted.
7235 But this does the wrong thing when O_NDELAY causes
7236 an EAGAIN error. Does anybody know of a situation
7237 where a retry is actually needed? */
7239 nread
< 0 && (errno
== EAGAIN
7253 #if defined (USG) || defined (CYGWIN)
7254 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7255 #endif /* USG or CYGWIN */
7256 #endif /* no FIONREAD */
7261 #endif /* not MSDOS */
7262 #endif /* not WINDOWSNT */
7264 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7265 & CODING_REQUIRE_DECODING_MASK
)
7267 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7270 /* Decode the key sequence except for those with meta
7272 for (i
= from
= 0; ; i
++)
7273 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7275 struct input_event buf
;
7277 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7282 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7283 buf
.modifiers
= meta_modifier
;
7284 buf
.code
= cbuf
[i
] & ~0x80;
7285 /* See the comment below. */
7286 buf
.frame_or_window
= tty
->top_frame
;
7288 kbd_buffer_store_event (&buf
);
7294 for (i
= 0; i
< nread
; i
++)
7296 struct input_event buf
;
7298 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7300 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7301 buf
.modifiers
= meta_modifier
;
7302 if (tty
->meta_key
!= 2)
7306 /* Set the frame corresponding to the active tty. Note that the
7307 value of selected_frame is not reliable here, redisplay tends
7308 to temporarily change it. */
7309 buf
.frame_or_window
= tty
->top_frame
;
7312 kbd_buffer_store_event (&buf
);
7313 /* Don't look at input that follows a C-g too closely.
7314 This reduces lossage due to autorepeat on C-g. */
7315 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7316 && buf
.code
== quit_char
)
7324 handle_async_input ()
7326 interrupt_input_pending
= 0;
7328 pending_signals
= pending_atimers
;
7330 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7331 doing anything dangerous. */
7338 nread
= read_avail_input (1);
7339 /* -1 means it's not ok to read the input now.
7340 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7341 0 means there was no keyboard input available. */
7351 process_pending_signals ()
7353 if (interrupt_input_pending
)
7354 handle_async_input ();
7355 do_pending_atimers ();
7358 #ifdef SIGIO /* for entire page */
7359 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7362 input_available_signal (signo
)
7365 /* Must preserve main program's value of errno. */
7366 int old_errno
= errno
;
7367 SIGNAL_THREAD_CHECK (signo
);
7370 interrupt_input_pending
= 1;
7371 pending_signals
= 1;
7374 if (input_available_clear_time
)
7375 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7378 handle_async_input ();
7385 /* Send ourselves a SIGIO.
7387 This function exists so that the UNBLOCK_INPUT macro in
7388 blockinput.h can have some way to take care of input we put off
7389 dealing with, without assuming that every file which uses
7390 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7392 reinvoke_input_signal ()
7395 handle_async_input ();
7401 /* User signal events. */
7403 struct user_signal_info
7405 /* Signal number. */
7408 /* Name of the signal. */
7411 /* Number of pending signals. */
7414 struct user_signal_info
*next
;
7417 /* List of user signals. */
7418 static struct user_signal_info
*user_signals
= NULL
;
7421 add_user_signal (sig
, name
)
7425 struct user_signal_info
*p
;
7427 for (p
= user_signals
; p
; p
= p
->next
)
7429 /* Already added. */
7432 p
= xmalloc (sizeof (struct user_signal_info
));
7434 p
->name
= xstrdup (name
);
7436 p
->next
= user_signals
;
7439 signal (sig
, handle_user_signal
);
7443 handle_user_signal (sig
)
7446 int old_errno
= errno
;
7447 struct user_signal_info
*p
;
7449 SIGNAL_THREAD_CHECK (sig
);
7451 for (p
= user_signals
; p
; p
= p
->next
)
7456 if (interrupt_input
)
7457 kill (getpid (), SIGIO
);
7461 /* Tell wait_reading_process_output that it needs to wake
7462 up and look around. */
7463 if (input_available_clear_time
)
7464 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7473 find_user_signal_name (sig
)
7476 struct user_signal_info
*p
;
7478 for (p
= user_signals
; p
; p
= p
->next
)
7486 store_user_signal_events ()
7488 struct user_signal_info
*p
;
7489 struct input_event buf
;
7492 for (p
= user_signals
; p
; p
= p
->next
)
7493 if (p
->npending
> 0)
7499 bzero (&buf
, sizeof buf
);
7500 buf
.kind
= USER_SIGNAL_EVENT
;
7501 buf
.frame_or_window
= selected_frame
;
7503 nstored
+= p
->npending
;
7505 mask
= sigblock (sigmask (p
->sig
));
7509 kbd_buffer_store_event (&buf
);
7512 while (p
->npending
> 0);
7520 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7521 static Lisp_Object menu_bar_one_keymap_changed_items
;
7523 /* These variables hold the vector under construction within
7524 menu_bar_items and its subroutines, and the current index
7525 for storing into that vector. */
7526 static Lisp_Object menu_bar_items_vector
;
7527 static int menu_bar_items_index
;
7529 /* Return a vector of menu items for a menu bar, appropriate
7530 to the current buffer. Each item has three elements in the vector:
7533 OLD is an old vector we can optionally reuse, or nil. */
7536 menu_bar_items (old
)
7539 /* The number of keymaps we're scanning right now, and the number of
7540 keymaps we have allocated space for. */
7543 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7544 in the current keymaps, or nil where it is not a prefix. */
7547 Lisp_Object def
, tail
;
7556 /* In order to build the menus, we need to call the keymap
7557 accessors. They all call QUIT. But this function is called
7558 during redisplay, during which a quit is fatal. So inhibit
7559 quitting while building the menus.
7560 We do this instead of specbind because (1) errors will clear it anyway
7561 and (2) this avoids risk of specpdl overflow. */
7562 oquit
= Vinhibit_quit
;
7566 menu_bar_items_vector
= old
;
7568 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7569 menu_bar_items_index
= 0;
7571 /* Build our list of keymaps.
7572 If we recognize a function key and replace its escape sequence in
7573 keybuf with its symbol, or if the sequence starts with a mouse
7574 click and we need to switch buffers, we jump back here to rebuild
7575 the initial keymaps from the current buffer. */
7579 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7580 if (!NILP (Voverriding_local_map_menu_flag
))
7582 /* Yes, use them (if non-nil) as well as the global map. */
7583 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7585 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7586 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7587 if (!NILP (Voverriding_local_map
))
7588 maps
[nmaps
++] = Voverriding_local_map
;
7592 /* No, so use major and minor mode keymaps and keymap property.
7593 Note that menu-bar bindings in the local-map and keymap
7594 properties may not work reliable, as they are only
7595 recognized when the menu-bar (or mode-line) is updated,
7596 which does not normally happen after every command. */
7599 nminor
= current_minor_maps (NULL
, &tmaps
);
7600 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7602 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7603 maps
[nmaps
++] = tem
;
7604 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7606 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7608 maps
[nmaps
++] = current_global_map
;
7611 /* Look up in each map the dummy prefix key `menu-bar'. */
7615 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7616 if (!NILP (maps
[mapno
]))
7618 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7622 menu_bar_one_keymap_changed_items
= Qnil
;
7623 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7627 /* Move to the end those items that should be at the end. */
7629 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7632 int end
= menu_bar_items_index
;
7634 for (i
= 0; i
< end
; i
+= 4)
7635 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7637 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7638 /* Move the item at index I to the end,
7639 shifting all the others forward. */
7640 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7641 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7642 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7643 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7645 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7646 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7647 (end
- i
- 4) * sizeof (Lisp_Object
));
7648 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7649 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7650 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7651 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7656 /* Add nil, nil, nil, nil at the end. */
7657 i
= menu_bar_items_index
;
7658 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7659 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7660 /* Add this item. */
7661 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7662 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7663 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7664 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7665 menu_bar_items_index
= i
;
7667 Vinhibit_quit
= oquit
;
7668 return menu_bar_items_vector
;
7671 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7672 If there's already an item for KEY, add this DEF to it. */
7674 Lisp_Object item_properties
;
7677 menu_bar_item (key
, item
, dummy1
, dummy2
)
7678 Lisp_Object key
, item
, dummy1
;
7681 struct gcpro gcpro1
;
7685 if (EQ (item
, Qundefined
))
7687 /* If a map has an explicit `undefined' as definition,
7688 discard any previously made menu bar item. */
7690 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7691 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7693 if (menu_bar_items_index
> i
+ 4)
7694 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7695 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7696 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7697 menu_bar_items_index
-= 4;
7701 /* If this keymap has already contributed to this KEY,
7702 don't contribute to it a second time. */
7703 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7704 if (!NILP (tem
) || NILP (item
))
7707 menu_bar_one_keymap_changed_items
7708 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7710 /* We add to menu_bar_one_keymap_changed_items before doing the
7711 parse_menu_item, so that if it turns out it wasn't a menu item,
7712 it still correctly hides any further menu item. */
7714 i
= parse_menu_item (item
, 1);
7719 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7721 /* Find any existing item for this KEY. */
7722 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7723 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7726 /* If we did not find this KEY, add it at the end. */
7727 if (i
== menu_bar_items_index
)
7729 /* If vector is too small, get a bigger one. */
7730 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7731 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7732 /* Add this item. */
7733 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7734 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7735 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7736 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7737 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7738 menu_bar_items_index
= i
;
7740 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7744 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7745 /* If the new and the old items are not both keymaps,
7746 the lookup will only find `item'. */
7747 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7748 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7752 /* This is used as the handler when calling menu_item_eval_property. */
7754 menu_item_eval_property_1 (arg
)
7757 /* If we got a quit from within the menu computation,
7758 quit all the way out of it. This takes care of C-] in the debugger. */
7759 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7760 Fsignal (Qquit
, Qnil
);
7765 /* Evaluate an expression and return the result (or nil if something
7766 went wrong). Used to evaluate dynamic parts of menu items. */
7768 menu_item_eval_property (sexpr
)
7771 int count
= SPECPDL_INDEX ();
7773 specbind (Qinhibit_redisplay
, Qt
);
7774 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7775 menu_item_eval_property_1
);
7776 return unbind_to (count
, val
);
7779 /* This function parses a menu item and leaves the result in the
7780 vector item_properties.
7781 ITEM is a key binding, a possible menu item.
7782 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7784 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7785 parse_menu_item returns true if the item is a menu item and false
7789 parse_menu_item (item
, inmenubar
)
7793 Lisp_Object def
, tem
, item_string
, start
;
7795 Lisp_Object keyhint
;
7804 /* Create item_properties vector if necessary. */
7805 if (NILP (item_properties
))
7807 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7809 /* Initialize optional entries. */
7810 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7811 ASET (item_properties
, i
, Qnil
);
7812 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7814 /* Save the item here to protect it from GC. */
7815 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7817 item_string
= XCAR (item
);
7821 if (STRINGP (item_string
))
7823 /* Old format menu item. */
7824 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7826 /* Maybe help string. */
7827 if (CONSP (item
) && STRINGP (XCAR (item
)))
7829 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7834 /* Maybe an obsolete key binding cache. */
7835 if (CONSP (item
) && CONSP (XCAR (item
))
7836 && (NILP (XCAR (XCAR (item
)))
7837 || VECTORP (XCAR (XCAR (item
)))))
7840 /* This is the real definition--the function to run. */
7841 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7843 /* Get enable property, if any. */
7846 tem
= Fget (item
, Qmenu_enable
);
7847 if (!NILP (Venable_disabled_menus_and_buttons
))
7848 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7849 else if (!NILP (tem
))
7850 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7853 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7855 /* New format menu item. */
7856 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7857 start
= XCDR (item
);
7860 /* We have a real binding. */
7861 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7863 item
= XCDR (start
);
7864 /* Is there an obsolete cache list with key equivalences. */
7865 if (CONSP (item
) && CONSP (XCAR (item
)))
7868 /* Parse properties. */
7869 while (CONSP (item
) && CONSP (XCDR (item
)))
7874 if (EQ (tem
, QCenable
))
7876 if (!NILP (Venable_disabled_menus_and_buttons
))
7877 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7879 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7881 else if (EQ (tem
, QCvisible
))
7883 /* If got a visible property and that evaluates to nil
7884 then ignore this item. */
7885 tem
= menu_item_eval_property (XCAR (item
));
7889 else if (EQ (tem
, QChelp
))
7890 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7891 else if (EQ (tem
, QCfilter
))
7893 else if (EQ (tem
, QCkey_sequence
))
7896 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7897 /* Be GC protected. Set keyhint to item instead of tem. */
7900 else if (EQ (tem
, QCkeys
))
7903 if (CONSP (tem
) || STRINGP (tem
))
7904 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7906 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7911 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7913 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7915 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7921 else if (inmenubar
|| !NILP (start
))
7925 return 0; /* not a menu item */
7927 /* If item string is not a string, evaluate it to get string.
7928 If we don't get a string, skip this item. */
7929 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7930 if (!(STRINGP (item_string
)))
7932 item_string
= menu_item_eval_property (item_string
);
7933 if (!STRINGP (item_string
))
7935 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7938 /* If got a filter apply it on definition. */
7939 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7942 def
= menu_item_eval_property (list2 (XCAR (filter
),
7943 list2 (Qquote
, def
)));
7945 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7948 /* Enable or disable selection of item. */
7949 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7952 tem
= menu_item_eval_property (tem
);
7953 if (inmenubar
&& NILP (tem
))
7954 return 0; /* Ignore disabled items in menu bar. */
7955 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7958 /* If we got no definition, this item is just unselectable text which
7959 is OK in a submenu but not in the menubar. */
7961 return (inmenubar
? 0 : 1);
7963 /* See if this is a separate pane or a submenu. */
7964 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7965 tem
= get_keymap (def
, 0, 1);
7966 /* For a subkeymap, just record its details and exit. */
7969 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7970 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7974 /* At the top level in the menu bar, do likewise for commands also.
7975 The menu bar does not display equivalent key bindings anyway.
7976 ITEM_PROPERTY_DEF is already set up properly. */
7980 { /* This is a command. See if there is an equivalent key binding. */
7981 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7983 /* The previous code preferred :key-sequence to :keys, so we
7984 preserve this behavior. */
7985 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7986 keyeq
= Fsubstitute_command_keys (keyeq
);
7989 Lisp_Object prefix
= keyeq
;
7990 Lisp_Object keys
= Qnil
;
7994 def
= XCAR (prefix
);
7995 prefix
= XCDR (prefix
);
7998 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8000 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
8002 keys
= XCAR (keyhint
);
8003 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
8005 /* We have a suggested key. Is it bound to the command? */
8008 /* If the command is an alias for another
8009 (such as lmenu.el set it up), check if the
8010 original command matches the cached command. */
8011 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8016 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
8020 tem
= Fkey_description (keys
, Qnil
);
8023 if (STRINGP (XCAR (prefix
)))
8024 tem
= concat2 (XCAR (prefix
), tem
);
8025 if (STRINGP (XCDR (prefix
)))
8026 tem
= concat2 (tem
, XCDR (prefix
));
8028 keyeq
= concat2 (build_string (" "), tem
);
8029 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
8035 /* If we have an equivalent key binding, use that. */
8036 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
8039 /* Include this when menu help is implemented.
8040 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8041 if (!(NILP (tem) || STRINGP (tem)))
8043 tem = menu_item_eval_property (tem);
8046 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8050 /* Handle radio buttons or toggle boxes. */
8051 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8053 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8054 menu_item_eval_property (tem
));
8061 /***********************************************************************
8063 ***********************************************************************/
8065 /* A vector holding tool bar items while they are parsed in function
8066 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8069 static Lisp_Object tool_bar_items_vector
;
8071 /* A vector holding the result of parse_tool_bar_item. Layout is like
8072 the one for a single item in tool_bar_items_vector. */
8074 static Lisp_Object tool_bar_item_properties
;
8076 /* Next free index in tool_bar_items_vector. */
8078 static int ntool_bar_items
;
8080 /* The symbols `tool-bar', `:image' and `:rtl'. */
8082 extern Lisp_Object Qtool_bar
;
8083 Lisp_Object QCimage
;
8086 /* Function prototypes. */
8088 static void init_tool_bar_items
P_ ((Lisp_Object
));
8089 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8090 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8091 static void append_tool_bar_item
P_ ((void));
8094 /* Return a vector of tool bar items for keymaps currently in effect.
8095 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8096 tool bar items found. */
8099 tool_bar_items (reuse
, nitems
)
8110 /* In order to build the menus, we need to call the keymap
8111 accessors. They all call QUIT. But this function is called
8112 during redisplay, during which a quit is fatal. So inhibit
8113 quitting while building the menus. We do this instead of
8114 specbind because (1) errors will clear it anyway and (2) this
8115 avoids risk of specpdl overflow. */
8116 oquit
= Vinhibit_quit
;
8119 /* Initialize tool_bar_items_vector and protect it from GC. */
8120 init_tool_bar_items (reuse
);
8122 /* Build list of keymaps in maps. Set nmaps to the number of maps
8125 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8126 if (!NILP (Voverriding_local_map_menu_flag
))
8128 /* Yes, use them (if non-nil) as well as the global map. */
8129 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8131 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8132 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8133 if (!NILP (Voverriding_local_map
))
8134 maps
[nmaps
++] = Voverriding_local_map
;
8138 /* No, so use major and minor mode keymaps and keymap property.
8139 Note that tool-bar bindings in the local-map and keymap
8140 properties may not work reliable, as they are only
8141 recognized when the tool-bar (or mode-line) is updated,
8142 which does not normally happen after every command. */
8145 nminor
= current_minor_maps (NULL
, &tmaps
);
8146 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8148 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8149 maps
[nmaps
++] = tem
;
8150 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8152 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8155 /* Add global keymap at the end. */
8156 maps
[nmaps
++] = current_global_map
;
8158 /* Process maps in reverse order and look up in each map the prefix
8160 for (i
= nmaps
- 1; i
>= 0; --i
)
8161 if (!NILP (maps
[i
]))
8165 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8167 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8170 Vinhibit_quit
= oquit
;
8171 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8172 return tool_bar_items_vector
;
8176 /* Process the definition of KEY which is DEF. */
8179 process_tool_bar_item (key
, def
, data
, args
)
8180 Lisp_Object key
, def
, data
;
8184 extern Lisp_Object Qundefined
;
8185 struct gcpro gcpro1
, gcpro2
;
8187 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8191 if (EQ (def
, Qundefined
))
8193 /* If a map has an explicit `undefined' as definition,
8194 discard any previously made item. */
8195 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8197 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8199 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8201 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8202 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8203 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8204 * sizeof (Lisp_Object
)));
8205 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8210 else if (parse_tool_bar_item (key
, def
))
8211 /* Append a new tool bar item to tool_bar_items_vector. Accept
8212 more than one definition for the same key. */
8213 append_tool_bar_item ();
8219 /* Parse a tool bar item specification ITEM for key KEY and return the
8220 result in tool_bar_item_properties. Value is zero if ITEM is
8223 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8225 CAPTION is the caption of the item, If it's not a string, it is
8226 evaluated to get a string.
8228 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8229 as binding are currently ignored.
8231 The following properties are recognized:
8235 FORM is evaluated and specifies whether the tool bar item is
8236 enabled or disabled.
8240 FORM is evaluated and specifies whether the tool bar item is visible.
8242 - `:filter FUNCTION'
8244 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8245 result is stored as the new binding.
8247 - `:button (TYPE SELECTED)'
8249 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8250 and specifies whether the button is selected (pressed) or not.
8254 IMAGES is either a single image specification or a vector of four
8255 image specifications. See enum tool_bar_item_images.
8257 - `:help HELP-STRING'.
8259 Gives a help string to display for the tool bar item.
8261 - `:label LABEL-STRING'.
8263 A text label to show with the tool bar button if labels are enabled. */
8266 parse_tool_bar_item (key
, item
)
8267 Lisp_Object key
, item
;
8269 /* Access slot with index IDX of vector tool_bar_item_properties. */
8270 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8272 Lisp_Object filter
= Qnil
;
8273 Lisp_Object caption
;
8274 int i
, have_label
= 0;
8276 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8277 Rule out items that aren't lists, don't start with
8278 `menu-item' or whose rest following `tool-bar-item' is not a
8281 || !EQ (XCAR (item
), Qmenu_item
)
8282 || (item
= XCDR (item
),
8286 /* Create tool_bar_item_properties vector if necessary. Reset it to
8288 if (VECTORP (tool_bar_item_properties
))
8290 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8294 tool_bar_item_properties
8295 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8298 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8299 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8301 /* Get the caption of the item. If the caption is not a string,
8302 evaluate it to get a string. If we don't get a string, skip this
8304 caption
= XCAR (item
);
8305 if (!STRINGP (caption
))
8307 caption
= menu_item_eval_property (caption
);
8308 if (!STRINGP (caption
))
8311 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8313 /* Give up if rest following the caption is not a list. */
8318 /* Store the binding. */
8319 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8322 /* Ignore cached key binding, if any. */
8323 if (CONSP (item
) && CONSP (XCAR (item
)))
8326 /* Process the rest of the properties. */
8327 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8329 Lisp_Object key
, value
;
8332 value
= XCAR (XCDR (item
));
8334 if (EQ (key
, QCenable
))
8336 /* `:enable FORM'. */
8337 if (!NILP (Venable_disabled_menus_and_buttons
))
8338 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8340 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8342 else if (EQ (key
, QCvisible
))
8344 /* `:visible FORM'. If got a visible property and that
8345 evaluates to nil then ignore this item. */
8346 if (NILP (menu_item_eval_property (value
)))
8349 else if (EQ (key
, QChelp
))
8350 /* `:help HELP-STRING'. */
8351 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8352 else if (EQ (key
, QClabel
))
8354 /* `:label LABEL-STRING'. */
8355 PROP (TOOL_BAR_ITEM_LABEL
) = value
;
8358 else if (EQ (key
, QCfilter
))
8359 /* ':filter FORM'. */
8361 else if (EQ (key
, QCbutton
) && CONSP (value
))
8363 /* `:button (TYPE . SELECTED)'. */
8364 Lisp_Object type
, selected
;
8366 type
= XCAR (value
);
8367 selected
= XCDR (value
);
8368 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8370 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8371 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8374 else if (EQ (key
, QCimage
)
8376 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8377 /* Value is either a single image specification or a vector
8378 of 4 such specifications for the different button states. */
8379 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8380 else if (EQ (key
, Qrtl
))
8382 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8388 /* Try to make one from caption and key. */
8389 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8390 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8391 char *label
= SYMBOLP (key
) ? (char *) SDATA (SYMBOL_NAME (key
)) : "";
8392 char *caption
= STRINGP (capt
) ? (char *) SDATA (capt
) : "";
8394 EMACS_INT max_lbl
= 2*tool_bar_max_label_size
;
8395 Lisp_Object new_lbl
;
8397 if (strlen (caption
) < max_lbl
&& caption
[0] != '\0')
8399 strcpy (buf
, caption
);
8400 while (buf
[0] != '\0' && buf
[strlen (buf
) -1] == '.')
8401 buf
[strlen (buf
)-1] = '\0';
8402 if (strlen (buf
) <= max_lbl
)
8406 if (strlen (caption
) <= max_lbl
)
8409 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8412 if (label
!= buf
) strcpy (buf
, label
);
8414 for (i
= 0; i
< strlen (buf
); ++i
)
8416 if (buf
[i
] == '-') buf
[i
] = ' ';
8423 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8424 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8425 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8428 /* If got a filter apply it on binding. */
8430 PROP (TOOL_BAR_ITEM_BINDING
)
8431 = menu_item_eval_property (list2 (filter
,
8433 PROP (TOOL_BAR_ITEM_BINDING
))));
8435 /* See if the binding is a keymap. Give up if it is. */
8436 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8439 /* Enable or disable selection of item. */
8440 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8441 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8442 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8444 /* Handle radio buttons or toggle boxes. */
8445 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8446 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8447 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8455 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8456 that can be reused. */
8459 init_tool_bar_items (reuse
)
8462 if (VECTORP (reuse
))
8463 tool_bar_items_vector
= reuse
;
8465 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8466 ntool_bar_items
= 0;
8470 /* Append parsed tool bar item properties from
8471 tool_bar_item_properties */
8474 append_tool_bar_item ()
8476 Lisp_Object
*to
, *from
;
8478 /* Enlarge tool_bar_items_vector if necessary. */
8479 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8480 >= XVECTOR (tool_bar_items_vector
)->size
)
8481 tool_bar_items_vector
8482 = larger_vector (tool_bar_items_vector
,
8483 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8485 /* Append entries from tool_bar_item_properties to the end of
8486 tool_bar_items_vector. */
8487 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8488 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8489 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8490 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8497 /* Read a character using menus based on maps in the array MAPS.
8498 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8499 Return t if we displayed a menu but the user rejected it.
8501 PREV_EVENT is the previous input event, or nil if we are reading
8502 the first event of a key sequence.
8504 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8505 if we used a mouse menu to read the input, or zero otherwise. If
8506 USED_MOUSE_MENU is null, we don't dereference it.
8508 The prompting is done based on the prompt-string of the map
8509 and the strings associated with various map elements.
8511 This can be done with X menus or with menus put in the minibuf.
8512 These are done in different ways, depending on how the input will be read.
8513 Menus using X are done after auto-saving in read-char, getting the input
8514 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8515 and do auto-saving in the inner call of read_char. */
8518 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8521 Lisp_Object prev_event
;
8522 int *used_mouse_menu
;
8526 if (used_mouse_menu
)
8527 *used_mouse_menu
= 0;
8529 /* Use local over global Menu maps */
8531 if (! menu_prompting
)
8534 /* Optionally disregard all but the global map. */
8535 if (inhibit_local_menu_bar_menus
)
8537 maps
+= (nmaps
- 1);
8542 /* If we got to this point via a mouse click,
8543 use a real menu for mouse selection. */
8544 if (EVENT_HAS_PARAMETERS (prev_event
)
8545 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8546 && !EQ (XCAR (prev_event
), Qtool_bar
))
8548 /* Display the menu and get the selection. */
8549 Lisp_Object
*realmaps
8550 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8554 /* Use the maps that are not nil. */
8555 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8556 if (!NILP (maps
[mapno
]))
8557 realmaps
[nmaps1
++] = maps
[mapno
];
8559 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8564 record_menu_key (XCAR (value
));
8566 /* If we got multiple events, unread all but
8568 There is no way to prevent those unread events
8569 from showing up later in last_nonmenu_event.
8570 So turn symbol and integer events into lists,
8571 to indicate that they came from a mouse menu,
8572 so that when present in last_nonmenu_event
8573 they won't confuse things. */
8574 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8576 record_menu_key (XCAR (tem
));
8577 if (SYMBOLP (XCAR (tem
))
8578 || INTEGERP (XCAR (tem
)))
8579 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8582 /* If we got more than one event, put all but the first
8583 onto this list to be read later.
8584 Return just the first event now. */
8585 Vunread_command_events
8586 = nconc2 (XCDR (value
), Vunread_command_events
);
8587 value
= XCAR (value
);
8589 else if (NILP (value
))
8591 if (used_mouse_menu
)
8592 *used_mouse_menu
= 1;
8595 #endif /* HAVE_MENUS */
8599 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8600 We make this bigger when necessary, and never free it. */
8601 static char *read_char_minibuf_menu_text
;
8602 /* Size of that buffer. */
8603 static int read_char_minibuf_menu_width
;
8606 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8612 register Lisp_Object name
;
8614 /* FIXME: Use the minibuffer's frame width. */
8615 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8618 Lisp_Object rest
, vector
;
8624 if (! menu_prompting
)
8627 /* Get the menu name from the first map that has one (a prompt string). */
8628 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8630 name
= Fkeymap_prompt (maps
[mapno
]);
8635 /* If we don't have any menus, just read a character normally. */
8636 if (!STRINGP (name
))
8639 /* Make sure we have a big enough buffer for the menu text. */
8640 width
= max (width
, SBYTES (name
));
8641 if (read_char_minibuf_menu_text
== 0)
8643 read_char_minibuf_menu_width
= width
+ 4;
8644 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8646 else if (width
+ 4 > read_char_minibuf_menu_width
)
8648 read_char_minibuf_menu_width
= width
+ 4;
8649 read_char_minibuf_menu_text
8650 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8652 menu
= read_char_minibuf_menu_text
;
8654 /* Prompt string always starts with map's prompt, and a space. */
8655 strcpy (menu
, SDATA (name
));
8656 nlength
= SBYTES (name
);
8657 menu
[nlength
++] = ':';
8658 menu
[nlength
++] = ' ';
8661 /* Start prompting at start of first map. */
8665 /* Present the documented bindings, a line at a time. */
8672 Lisp_Object orig_defn_macro
;
8674 /* Loop over elements of map. */
8679 /* If reached end of map, start at beginning of next map. */
8683 /* At end of last map, wrap around to first map if just starting,
8684 or end this line if already have something on it. */
8688 if (notfirst
|| nobindings
) break;
8693 /* Look at the next element of the map. */
8695 elt
= XVECTOR (vector
)->contents
[idx
];
8697 elt
= Fcar_safe (rest
);
8699 if (idx
< 0 && VECTORP (elt
))
8701 /* If we found a dense table in the keymap,
8702 advanced past it, but start scanning its contents. */
8703 rest
= Fcdr_safe (rest
);
8709 /* An ordinary element. */
8710 Lisp_Object event
, tem
;
8714 event
= Fcar_safe (elt
); /* alist */
8715 elt
= Fcdr_safe (elt
);
8719 XSETINT (event
, idx
); /* vector */
8722 /* Ignore the element if it has no prompt string. */
8723 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8725 /* 1 if the char to type matches the string. */
8727 Lisp_Object upcased_event
, downcased_event
;
8728 Lisp_Object desc
= Qnil
;
8730 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8732 upcased_event
= Fupcase (event
);
8733 downcased_event
= Fdowncase (event
);
8734 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8735 || XINT (downcased_event
) == SREF (s
, 0));
8737 desc
= Fsingle_key_description (event
, Qnil
);
8739 #if 0 /* It is redundant to list the equivalent key bindings because
8740 the prefix is what the user has already typed. */
8742 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8744 /* Insert equivalent keybinding. */
8745 s
= concat2 (s
, tem
);
8748 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8749 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8751 /* Insert button prefix. */
8752 Lisp_Object selected
8753 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8754 if (EQ (tem
, QCradio
))
8755 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8757 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8758 s
= concat2 (tem
, s
);
8762 /* If we have room for the prompt string, add it to this line.
8763 If this is the first on the line, always add it. */
8764 if ((SCHARS (s
) + i
+ 2
8765 + (char_matches
? 0 : SCHARS (desc
) + 3))
8771 /* Punctuate between strings. */
8774 strcpy (menu
+ i
, ", ");
8780 /* If the char to type doesn't match the string's
8781 first char, explicitly show what char to type. */
8784 /* Add as much of string as fits. */
8785 thiswidth
= SCHARS (desc
);
8786 if (thiswidth
+ i
> width
)
8787 thiswidth
= width
- i
;
8788 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8790 strcpy (menu
+ i
, " = ");
8794 /* Add as much of string as fits. */
8795 thiswidth
= SCHARS (s
);
8796 if (thiswidth
+ i
> width
)
8797 thiswidth
= width
- i
;
8798 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8804 /* If this element does not fit, end the line now,
8805 and save the element for the next line. */
8806 strcpy (menu
+ i
, "...");
8811 /* Move past this element. */
8812 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8813 /* Handle reaching end of dense table. */
8818 rest
= Fcdr_safe (rest
);
8822 /* Prompt with that and read response. */
8823 message2_nolog (menu
, strlen (menu
),
8824 ! NILP (current_buffer
->enable_multibyte_characters
));
8826 /* Make believe its not a keyboard macro in case the help char
8827 is pressed. Help characters are not recorded because menu prompting
8828 is not used on replay.
8830 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8831 current_kboard
->defining_kbd_macro
= Qnil
;
8833 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8834 while (BUFFERP (obj
));
8835 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8837 if (!INTEGERP (obj
))
8839 else if (XINT (obj
) == -2)
8844 if (! EQ (obj
, menu_prompt_more_char
)
8845 && (!INTEGERP (menu_prompt_more_char
)
8846 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8848 if (!NILP (current_kboard
->defining_kbd_macro
))
8849 store_kbd_macro_char (obj
);
8852 /* Help char - go round again */
8856 /* Reading key sequences. */
8858 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8859 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8860 keymap, or nil otherwise. Return the index of the first keymap in
8861 which KEY has any binding, or NMAPS if no map has a binding.
8863 If KEY is a meta ASCII character, treat it like meta-prefix-char
8864 followed by the corresponding non-meta character. Keymaps in
8865 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8868 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8871 NEXT may be the same array as CURRENT. */
8874 follow_key (key
, nmaps
, current
, defs
, next
)
8876 Lisp_Object
*current
, *defs
, *next
;
8879 int i
, first_binding
;
8881 first_binding
= nmaps
;
8882 for (i
= nmaps
- 1; i
>= 0; i
--)
8884 if (! NILP (current
[i
]))
8886 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8887 if (! NILP (defs
[i
]))
8894 /* Given the set of bindings we've found, produce the next set of maps. */
8895 if (first_binding
< nmaps
)
8896 for (i
= 0; i
< nmaps
; i
++)
8897 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8899 return first_binding
;
8902 /* Structure used to keep track of partial application of key remapping
8903 such as Vfunction_key_map and Vkey_translation_map. */
8904 typedef struct keyremap
8906 /* This is the map originally specified for this use. */
8908 /* This is a submap reached by looking up, in PARENT,
8909 the events from START to END. */
8911 /* Positions [START, END) in the key sequence buffer
8912 are the key that we have scanned so far.
8913 Those events are the ones that we will replace
8914 if PAREHT maps them into a key sequence. */
8918 /* Lookup KEY in MAP.
8919 MAP is a keymap mapping keys to key vectors or functions.
8920 If the mapping is a function and DO_FUNCTION is non-zero, then
8921 the function is called with PROMPT as parameter and its return
8922 value is used as the return value of this function (after checking
8923 that it is indeed a vector). */
8926 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8927 Lisp_Object map
, key
, prompt
;
8932 next
= access_keymap (map
, key
, 1, 0, 1);
8934 /* Handle symbol with autoload definition. */
8935 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8936 && CONSP (XSYMBOL (next
)->function
)
8937 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8938 do_autoload (XSYMBOL (next
)->function
, next
);
8940 /* Handle a symbol whose function definition is a keymap
8942 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8943 && (ARRAYP (XSYMBOL (next
)->function
)
8944 || KEYMAPP (XSYMBOL (next
)->function
)))
8945 next
= XSYMBOL (next
)->function
;
8947 /* If the keymap gives a function, not an
8948 array, then call the function with one arg and use
8949 its value instead. */
8950 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8955 next
= call1 (next
, prompt
);
8956 /* If the function returned something invalid,
8957 barf--don't ignore it.
8958 (To ignore it safely, we would need to gcpro a bunch of
8959 other variables.) */
8960 if (! (VECTORP (next
) || STRINGP (next
)))
8961 error ("Function %s returns invalid key sequence", tem
);
8966 /* Do one step of the key remapping used for function-key-map and
8967 key-translation-map:
8968 KEYBUF is the buffer holding the input events.
8969 BUFSIZE is its maximum size.
8970 FKEY is a pointer to the keyremap structure to use.
8971 INPUT is the index of the last element in KEYBUF.
8972 DOIT if non-zero says that the remapping can actually take place.
8973 DIFF is used to return the number of keys added/removed by the remapping.
8974 PARENT is the root of the keymap.
8975 PROMPT is the prompt to use if the remapping happens through a function.
8976 The return value is non-zero if the remapping actually took place. */
8979 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8980 Lisp_Object
*keybuf
, prompt
;
8982 int input
, doit
, *diff
, bufsize
;
8984 Lisp_Object next
, key
;
8986 key
= keybuf
[fkey
->end
++];
8988 if (KEYMAPP (fkey
->parent
))
8989 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8993 /* If keybuf[fkey->start..fkey->end] is bound in the
8994 map and we're in a position to do the key remapping, replace it with
8995 the binding and restart with fkey->start at the end. */
8996 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8998 int len
= XFASTINT (Flength (next
));
9001 *diff
= len
- (fkey
->end
- fkey
->start
);
9003 if (input
+ *diff
>= bufsize
)
9004 error ("Key sequence too long");
9006 /* Shift the keys that follow fkey->end. */
9008 for (i
= fkey
->end
; i
< input
; i
++)
9009 keybuf
[i
+ *diff
] = keybuf
[i
];
9011 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9012 keybuf
[i
+ *diff
] = keybuf
[i
];
9013 /* Overwrite the old keys with the new ones. */
9014 for (i
= 0; i
< len
; i
++)
9015 keybuf
[fkey
->start
+ i
]
9016 = Faref (next
, make_number (i
));
9018 fkey
->start
= fkey
->end
+= *diff
;
9019 fkey
->map
= fkey
->parent
;
9024 fkey
->map
= get_keymap (next
, 0, 1);
9026 /* If we no longer have a bound suffix, try a new position for
9028 if (!CONSP (fkey
->map
))
9030 fkey
->end
= ++fkey
->start
;
9031 fkey
->map
= fkey
->parent
;
9036 /* Read a sequence of keys that ends with a non prefix character,
9037 storing it in KEYBUF, a buffer of size BUFSIZE.
9039 Return the length of the key sequence stored.
9040 Return -1 if the user rejected a command menu.
9042 Echo starting immediately unless `prompt' is 0.
9044 Where a key sequence ends depends on the currently active keymaps.
9045 These include any minor mode keymaps active in the current buffer,
9046 the current buffer's local map, and the global map.
9048 If a key sequence has no other bindings, we check Vfunction_key_map
9049 to see if some trailing subsequence might be the beginning of a
9050 function key's sequence. If so, we try to read the whole function
9051 key, and substitute its symbolic name into the key sequence.
9053 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9054 `double-' events into similar click events, if that would make them
9055 bound. We try to turn `triple-' events first into `double-' events,
9058 If we get a mouse click in a mode line, vertical divider, or other
9059 non-text area, we treat the click as if it were prefixed by the
9060 symbol denoting that area - `mode-line', `vertical-line', or
9063 If the sequence starts with a mouse click, we read the key sequence
9064 with respect to the buffer clicked on, not the current buffer.
9066 If the user switches frames in the midst of a key sequence, we put
9067 off the switch-frame event until later; the next call to
9068 read_char will return it.
9070 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9071 from the selected window's buffer. */
9074 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9075 can_return_switch_frame
, fix_current_buffer
)
9076 Lisp_Object
*keybuf
;
9079 int dont_downcase_last
;
9080 int can_return_switch_frame
;
9081 int fix_current_buffer
;
9083 volatile Lisp_Object from_string
;
9084 volatile int count
= SPECPDL_INDEX ();
9086 /* How many keys there are in the current key sequence. */
9089 /* The length of the echo buffer when we started reading, and
9090 the length of this_command_keys when we started reading. */
9091 volatile int echo_start
;
9092 volatile int keys_start
;
9094 /* The number of keymaps we're scanning right now, and the number of
9095 keymaps we have allocated space for. */
9097 volatile int nmaps_allocated
= 0;
9099 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9100 the current keymaps. */
9101 Lisp_Object
*volatile defs
= NULL
;
9103 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9104 in the current keymaps, or nil where it is not a prefix. */
9105 Lisp_Object
*volatile submaps
= NULL
;
9107 /* The local map to start out with at start of key sequence. */
9108 volatile Lisp_Object orig_local_map
;
9110 /* The map from the `keymap' property to start out with at start of
9112 volatile Lisp_Object orig_keymap
;
9114 /* 1 if we have already considered switching to the local-map property
9115 of the place where a mouse click occurred. */
9116 volatile int localized_local_map
= 0;
9118 /* The index in submaps[] of the first keymap that has a binding for
9119 this key sequence. In other words, the lowest i such that
9120 submaps[i] is non-nil. */
9121 volatile int first_binding
;
9122 /* Index of the first key that has no binding.
9123 It is useless to try fkey.start larger than that. */
9124 volatile int first_unbound
;
9126 /* If t < mock_input, then KEYBUF[t] should be read as the next
9129 We use this to recover after recognizing a function key. Once we
9130 realize that a suffix of the current key sequence is actually a
9131 function key's escape sequence, we replace the suffix with the
9132 function key's binding from Vfunction_key_map. Now keybuf
9133 contains a new and different key sequence, so the echo area,
9134 this_command_keys, and the submaps and defs arrays are wrong. In
9135 this situation, we set mock_input to t, set t to 0, and jump to
9136 restart_sequence; the loop will read keys from keybuf up until
9137 mock_input, thus rebuilding the state; and then it will resume
9138 reading characters from the keyboard. */
9139 volatile int mock_input
= 0;
9141 /* If the sequence is unbound in submaps[], then
9142 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9143 and fkey.map is its binding.
9145 These might be > t, indicating that all function key scanning
9146 should hold off until t reaches them. We do this when we've just
9147 recognized a function key, to avoid searching for the function
9148 key's again in Vfunction_key_map. */
9149 volatile keyremap fkey
;
9151 /* Likewise, for key_translation_map and input-decode-map. */
9152 volatile keyremap keytran
, indec
;
9154 /* Non-zero if we are trying to map a key by changing an upper-case
9155 letter to lower case, or a shifted function key to an unshifted
9157 volatile int shift_translated
= 0;
9159 /* If we receive a `switch-frame' or `select-window' event in the middle of
9160 a key sequence, we put it off for later.
9161 While we're reading, we keep the event here. */
9162 volatile Lisp_Object delayed_switch_frame
;
9164 /* See the comment below... */
9165 #if defined (GOBBLE_FIRST_EVENT)
9166 Lisp_Object first_event
;
9169 volatile Lisp_Object original_uppercase
;
9170 volatile int original_uppercase_position
= -1;
9172 /* Gets around Microsoft compiler limitations. */
9175 struct buffer
*starting_buffer
;
9177 /* List of events for which a fake prefix key has been generated. */
9178 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9180 #if defined (GOBBLE_FIRST_EVENT)
9184 struct gcpro gcpro1
;
9186 GCPRO1 (fake_prefixed_keys
);
9187 raw_keybuf_count
= 0;
9189 last_nonmenu_event
= Qnil
;
9191 delayed_switch_frame
= Qnil
;
9196 echo_prompt (prompt
);
9197 else if (cursor_in_echo_area
9198 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9199 && NILP (Fzerop (Vecho_keystrokes
)))
9200 /* This doesn't put in a dash if the echo buffer is empty, so
9201 you don't always see a dash hanging out in the minibuffer. */
9205 /* Record the initial state of the echo area and this_command_keys;
9206 we will need to restore them if we replay a key sequence. */
9208 echo_start
= echo_length ();
9209 keys_start
= this_command_key_count
;
9210 this_single_command_key_start
= keys_start
;
9212 #if defined (GOBBLE_FIRST_EVENT)
9213 /* This doesn't quite work, because some of the things that read_char
9214 does cannot safely be bypassed. It seems too risky to try to make
9217 /* Read the first char of the sequence specially, before setting
9218 up any keymaps, in case a filter runs and switches buffers on us. */
9219 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9221 #endif /* GOBBLE_FIRST_EVENT */
9223 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9224 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9227 /* We jump here when we need to reinitialize fkey and keytran; this
9228 happens if we switch keyboards between rescans. */
9229 replay_entire_sequence
:
9231 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9232 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9233 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9234 indec
.start
= indec
.end
= 0;
9235 fkey
.start
= fkey
.end
= 0;
9236 keytran
.start
= keytran
.end
= 0;
9238 /* We jump here when the key sequence has been thoroughly changed, and
9239 we need to rescan it starting from the beginning. When we jump here,
9240 keybuf[0..mock_input] holds the sequence we should reread. */
9243 starting_buffer
= current_buffer
;
9244 first_unbound
= bufsize
+ 1;
9246 /* Build our list of keymaps.
9247 If we recognize a function key and replace its escape sequence in
9248 keybuf with its symbol, or if the sequence starts with a mouse
9249 click and we need to switch buffers, we jump back here to rebuild
9250 the initial keymaps from the current buffer. */
9253 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9255 if (2 > nmaps_allocated
)
9257 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9258 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9259 nmaps_allocated
= 2;
9261 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9263 else if (!NILP (Voverriding_local_map
))
9265 if (2 > nmaps_allocated
)
9267 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9268 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9269 nmaps_allocated
= 2;
9271 submaps
[nmaps
++] = Voverriding_local_map
;
9279 nminor
= current_minor_maps (0, &maps
);
9280 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9282 if (total
> nmaps_allocated
)
9284 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9285 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9286 nmaps_allocated
= total
;
9289 if (!NILP (orig_keymap
))
9290 submaps
[nmaps
++] = orig_keymap
;
9292 bcopy (maps
, (void *) (submaps
+ nmaps
),
9293 nminor
* sizeof (submaps
[0]));
9297 submaps
[nmaps
++] = orig_local_map
;
9299 submaps
[nmaps
++] = current_global_map
;
9301 /* Find an accurate initial value for first_binding. */
9302 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9303 if (! NILP (submaps
[first_binding
]))
9306 /* Start from the beginning in keybuf. */
9309 /* These are no-ops the first time through, but if we restart, they
9310 revert the echo area and this_command_keys to their original state. */
9311 this_command_key_count
= keys_start
;
9312 if (INTERACTIVE
&& t
< mock_input
)
9313 echo_truncate (echo_start
);
9315 /* If the best binding for the current key sequence is a keymap, or
9316 we may be looking at a function key's escape sequence, keep on
9318 while (first_binding
< nmaps
9319 /* Keep reading as long as there's a prefix binding. */
9320 ? !NILP (submaps
[first_binding
])
9321 /* Don't return in the middle of a possible function key sequence,
9322 if the only bindings we found were via case conversion.
9323 Thus, if ESC O a has a function-key-map translation
9324 and ESC o has a binding, don't return after ESC O,
9325 so that we can translate ESC O plus the next character. */
9326 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9329 int used_mouse_menu
= 0;
9331 /* Where the last real key started. If we need to throw away a
9332 key that has expanded into more than one element of keybuf
9333 (say, a mouse click on the mode line which is being treated
9334 as [mode-line (mouse-...)], then we backtrack to this point
9336 volatile int last_real_key_start
;
9338 /* These variables are analogous to echo_start and keys_start;
9339 while those allow us to restart the entire key sequence,
9340 echo_local_start and keys_local_start allow us to throw away
9342 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9344 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9345 eassert (indec
.start
<= indec
.end
);
9346 eassert (fkey
.start
<= fkey
.end
);
9347 eassert (keytran
.start
<= keytran
.end
);
9348 /* key-translation-map is applied *after* function-key-map
9349 which is itself applied *after* input-decode-map. */
9350 eassert (fkey
.end
<= indec
.start
);
9351 eassert (keytran
.end
<= fkey
.start
);
9353 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9354 first_unbound
< keytran
.start
)
9355 { /* The prefix upto first_unbound has no binding and has
9356 no translation left to do either, so we know it's unbound.
9357 If we don't stop now, we risk staying here indefinitely
9358 (if the user keeps entering fkey or keytran prefixes
9359 like C-c ESC ESC ESC ESC ...) */
9361 for (i
= first_unbound
+ 1; i
< t
; i
++)
9362 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9363 mock_input
= t
- first_unbound
- 1;
9364 indec
.end
= indec
.start
-= first_unbound
+ 1;
9365 indec
.map
= indec
.parent
;
9366 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9367 fkey
.map
= fkey
.parent
;
9368 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9369 keytran
.map
= keytran
.parent
;
9370 goto replay_sequence
;
9374 error ("Key sequence too long");
9377 echo_local_start
= echo_length ();
9378 keys_local_start
= this_command_key_count
;
9379 local_first_binding
= first_binding
;
9382 /* These are no-ops, unless we throw away a keystroke below and
9383 jumped back up to replay_key; in that case, these restore the
9384 variables to their original state, allowing us to replay the
9386 if (INTERACTIVE
&& t
< mock_input
)
9387 echo_truncate (echo_local_start
);
9388 this_command_key_count
= keys_local_start
;
9389 first_binding
= local_first_binding
;
9391 /* By default, assume each event is "real". */
9392 last_real_key_start
= t
;
9394 /* Does mock_input indicate that we are re-reading a key sequence? */
9398 add_command_key (key
);
9399 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9400 && NILP (Fzerop (Vecho_keystrokes
)))
9404 /* If not, we should actually read a character. */
9408 KBOARD
*interrupted_kboard
= current_kboard
;
9409 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9410 key
= read_char (NILP (prompt
), nmaps
,
9411 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9412 &used_mouse_menu
, NULL
);
9413 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9414 /* When switching to a new tty (with a new keyboard),
9415 read_char returns the new buffer, rather than -2
9416 (Bug#5095). This is because `terminal-init-xterm'
9417 calls read-char, which eats the wrong_kboard_jmpbuf
9418 return. Any better way to fix this? -- cyd */
9419 || (interrupted_kboard
!= current_kboard
))
9424 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9425 if (k
== interrupted_kboard
)
9430 /* Don't touch interrupted_kboard when it's been
9432 delayed_switch_frame
= Qnil
;
9433 goto replay_entire_sequence
;
9436 if (!NILP (delayed_switch_frame
))
9438 interrupted_kboard
->kbd_queue
9439 = Fcons (delayed_switch_frame
,
9440 interrupted_kboard
->kbd_queue
);
9441 delayed_switch_frame
= Qnil
;
9445 interrupted_kboard
->kbd_queue
9446 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9448 /* If the side queue is non-empty, ensure it begins with a
9449 switch-frame, so we'll replay it in the right context. */
9450 if (CONSP (interrupted_kboard
->kbd_queue
)
9451 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9452 !(EVENT_HAS_PARAMETERS (key
)
9453 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9457 XSETFRAME (frame
, interrupted_frame
);
9458 interrupted_kboard
->kbd_queue
9459 = Fcons (make_lispy_switch_frame (frame
),
9460 interrupted_kboard
->kbd_queue
);
9463 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9464 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9465 goto replay_entire_sequence
;
9469 /* read_char returns t when it shows a menu and the user rejects it.
9473 unbind_to (count
, Qnil
);
9478 /* read_char returns -1 at the end of a macro.
9479 Emacs 18 handles this by returning immediately with a
9480 zero, so that's what we'll do. */
9481 if (INTEGERP (key
) && XINT (key
) == -1)
9484 /* The Microsoft C compiler can't handle the goto that
9490 /* If the current buffer has been changed from under us, the
9491 keymap may have changed, so replay the sequence. */
9494 timer_resume_idle ();
9497 /* Reset the current buffer from the selected window
9498 in case something changed the former and not the latter.
9499 This is to be more consistent with the behavior
9500 of the command_loop_1. */
9501 if (fix_current_buffer
)
9503 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9505 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9506 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9509 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9510 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9511 goto replay_sequence
;
9514 /* If we have a quit that was typed in another frame, and
9515 quit_throw_to_read_char switched buffers,
9516 replay to get the right keymap. */
9518 && XINT (key
) == quit_char
9519 && current_buffer
!= starting_buffer
)
9522 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9526 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9527 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9528 goto replay_sequence
;
9533 if (EVENT_HAS_PARAMETERS (key
)
9534 /* Either a `switch-frame' or a `select-window' event. */
9535 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9537 /* If we're at the beginning of a key sequence, and the caller
9538 says it's okay, go ahead and return this event. If we're
9539 in the midst of a key sequence, delay it until the end. */
9540 if (t
> 0 || !can_return_switch_frame
)
9542 delayed_switch_frame
= key
;
9548 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9552 /* Clicks in non-text areas get prefixed by the symbol
9553 in their CHAR-ADDRESS field. For example, a click on
9554 the mode line is prefixed by the symbol `mode-line'.
9556 Furthermore, key sequences beginning with mouse clicks
9557 are read using the keymaps of the buffer clicked on, not
9558 the current buffer. So we may have to switch the buffer
9561 When we turn one event into two events, we must make sure
9562 that neither of the two looks like the original--so that,
9563 if we replay the events, they won't be expanded again.
9564 If not for this, such reexpansion could happen either here
9565 or when user programs play with this-command-keys. */
9566 if (EVENT_HAS_PARAMETERS (key
))
9571 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9572 if (EQ (kind
, Qmouse_click
))
9574 Lisp_Object window
, posn
;
9576 window
= POSN_WINDOW (EVENT_START (key
));
9577 posn
= POSN_POSN (EVENT_START (key
));
9580 || (!NILP (fake_prefixed_keys
)
9581 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9583 /* We're looking a second time at an event for which
9584 we generated a fake prefix key. Set
9585 last_real_key_start appropriately. */
9587 last_real_key_start
= t
- 1;
9590 /* Key sequences beginning with mouse clicks are
9591 read using the keymaps in the buffer clicked on,
9592 not the current buffer. If we're at the
9593 beginning of a key sequence, switch buffers. */
9594 if (last_real_key_start
== 0
9596 && BUFFERP (XWINDOW (window
)->buffer
)
9597 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9599 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9603 /* Arrange to go back to the original buffer once we're
9604 done reading the key sequence. Note that we can't
9605 use save_excursion_{save,restore} here, because they
9606 save point as well as the current buffer; we don't
9607 want to save point, because redisplay may change it,
9608 to accommodate a Fset_window_start or something. We
9609 don't want to do this at the top of the function,
9610 because we may get input from a subprocess which
9611 wants to change the selected window and stuff (say,
9613 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9615 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9617 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9618 orig_local_map
= get_local_map (PT
, current_buffer
,
9620 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9621 goto replay_sequence
;
9624 /* For a mouse click, get the local text-property keymap
9625 of the place clicked on, rather than point. */
9626 if (last_real_key_start
== 0
9627 && CONSP (XCDR (key
))
9628 && ! localized_local_map
)
9630 Lisp_Object map_here
, start
, pos
;
9632 localized_local_map
= 1;
9633 start
= EVENT_START (key
);
9635 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9637 pos
= POSN_BUFFER_POSN (start
);
9639 && XINT (pos
) >= BEGV
9640 && XINT (pos
) <= ZV
)
9642 map_here
= get_local_map (XINT (pos
),
9643 current_buffer
, Qlocal_map
);
9644 if (!EQ (map_here
, orig_local_map
))
9646 orig_local_map
= map_here
;
9647 ++localized_local_map
;
9650 map_here
= get_local_map (XINT (pos
),
9651 current_buffer
, Qkeymap
);
9652 if (!EQ (map_here
, orig_keymap
))
9654 orig_keymap
= map_here
;
9655 ++localized_local_map
;
9658 if (localized_local_map
> 1)
9663 goto replay_sequence
;
9669 /* Expand mode-line and scroll-bar events into two events:
9670 use posn as a fake prefix key. */
9672 && (NILP (fake_prefixed_keys
)
9673 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9675 if (t
+ 1 >= bufsize
)
9676 error ("Key sequence too long");
9679 keybuf
[t
+ 1] = key
;
9682 /* Record that a fake prefix key has been generated
9683 for KEY. Don't modify the event; this would
9684 prevent proper action when the event is pushed
9685 back into unread-command-events. */
9686 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9688 /* If on a mode line string with a local keymap,
9689 reconsider the key sequence with that keymap. */
9690 if (string
= POSN_STRING (EVENT_START (key
)),
9691 (CONSP (string
) && STRINGP (XCAR (string
))))
9693 Lisp_Object pos
, map
, map2
;
9695 pos
= XCDR (string
);
9696 string
= XCAR (string
);
9698 && XINT (pos
) < SCHARS (string
))
9700 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9702 orig_local_map
= map
;
9703 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9706 if (!NILP (map
) || !NILP (map2
))
9707 goto replay_sequence
;
9713 else if (NILP (from_string
)
9714 && (string
= POSN_STRING (EVENT_START (key
)),
9715 (CONSP (string
) && STRINGP (XCAR (string
)))))
9717 /* For a click on a string, i.e. overlay string or a
9718 string displayed via the `display' property,
9719 consider `local-map' and `keymap' properties of
9721 Lisp_Object pos
, map
, map2
;
9723 pos
= XCDR (string
);
9724 string
= XCAR (string
);
9726 && XINT (pos
) < SCHARS (string
))
9728 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9730 orig_local_map
= map
;
9731 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9735 if (!NILP (map
) || !NILP (map2
))
9737 from_string
= string
;
9740 goto replay_sequence
;
9745 else if (CONSP (XCDR (key
))
9746 && CONSP (EVENT_START (key
))
9747 && CONSP (XCDR (EVENT_START (key
))))
9751 posn
= POSN_POSN (EVENT_START (key
));
9752 /* Handle menu-bar events:
9753 insert the dummy prefix event `menu-bar'. */
9754 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9756 if (t
+ 1 >= bufsize
)
9757 error ("Key sequence too long");
9761 /* Zap the position in key, so we know that we've
9762 expanded it, and don't try to do so again. */
9763 POSN_SET_POSN (EVENT_START (key
),
9764 Fcons (posn
, Qnil
));
9767 goto replay_sequence
;
9769 else if (CONSP (posn
))
9771 /* We're looking at the second event of a
9772 sequence which we expanded before. Set
9773 last_real_key_start appropriately. */
9774 if (last_real_key_start
== t
&& t
> 0)
9775 last_real_key_start
= t
- 1;
9780 /* We have finally decided that KEY is something we might want
9782 first_binding
= (follow_key (key
,
9783 nmaps
- first_binding
,
9784 submaps
+ first_binding
,
9785 defs
+ first_binding
,
9786 submaps
+ first_binding
)
9789 /* If KEY wasn't bound, we'll try some fallbacks. */
9790 if (first_binding
< nmaps
)
9791 /* This is needed for the following scenario:
9792 event 0: a down-event that gets dropped by calling replay_key.
9793 event 1: some normal prefix like C-h.
9794 After event 0, first_unbound is 0, after event 1 indec.start,
9795 fkey.start, and keytran.start are all 1, so when we see that
9796 C-h is bound, we need to update first_unbound. */
9797 first_unbound
= max (t
+ 1, first_unbound
);
9802 /* Remember the position to put an upper bound on indec.start. */
9803 first_unbound
= min (t
, first_unbound
);
9805 head
= EVENT_HEAD (key
);
9806 if (help_char_p (head
) && t
> 0)
9808 read_key_sequence_cmd
= Vprefix_help_command
;
9810 last_nonmenu_event
= key
;
9811 /* The Microsoft C compiler can't handle the goto that
9819 Lisp_Object breakdown
;
9822 breakdown
= parse_modifiers (head
);
9823 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9824 /* Attempt to reduce an unbound mouse event to a simpler
9825 event that is bound:
9826 Drags reduce to clicks.
9827 Double-clicks reduce to clicks.
9828 Triple-clicks reduce to double-clicks, then to clicks.
9829 Down-clicks are eliminated.
9830 Double-downs reduce to downs, then are eliminated.
9831 Triple-downs reduce to double-downs, then to downs,
9832 then are eliminated. */
9833 if (modifiers
& (down_modifier
| drag_modifier
9834 | double_modifier
| triple_modifier
))
9836 while (modifiers
& (down_modifier
| drag_modifier
9837 | double_modifier
| triple_modifier
))
9839 Lisp_Object new_head
, new_click
;
9840 if (modifiers
& triple_modifier
)
9841 modifiers
^= (double_modifier
| triple_modifier
);
9842 else if (modifiers
& double_modifier
)
9843 modifiers
&= ~double_modifier
;
9844 else if (modifiers
& drag_modifier
)
9845 modifiers
&= ~drag_modifier
;
9848 /* Dispose of this `down' event by simply jumping
9849 back to replay_key, to get another event.
9851 Note that if this event came from mock input,
9852 then just jumping back to replay_key will just
9853 hand it to us again. So we have to wipe out any
9856 We could delete keybuf[t] and shift everything
9857 after that to the left by one spot, but we'd also
9858 have to fix up any variable that points into
9859 keybuf, and shifting isn't really necessary
9862 Adding prefixes for non-textual mouse clicks
9863 creates two characters of mock input, and both
9864 must be thrown away. If we're only looking at
9865 the prefix now, we can just jump back to
9866 replay_key. On the other hand, if we've already
9867 processed the prefix, and now the actual click
9868 itself is giving us trouble, then we've lost the
9869 state of the keymaps we want to backtrack to, and
9870 we need to replay the whole sequence to rebuild
9873 Beyond that, only function key expansion could
9874 create more than two keys, but that should never
9875 generate mouse events, so it's okay to zero
9876 mock_input in that case too.
9878 FIXME: The above paragraph seems just plain
9879 wrong, if you consider things like
9880 xterm-mouse-mode. -stef
9882 Isn't this just the most wonderful code ever? */
9884 /* If mock_input > t + 1, the above simplification
9885 will actually end up dropping keys on the floor.
9886 This is probably OK for now, but even
9887 if mock_input <= t + 1, we need to adjust indec,
9889 Typical case [header-line down-mouse-N]:
9890 mock_input = 2, t = 1, fkey.end = 1,
9891 last_real_key_start = 0. */
9892 if (indec
.end
> last_real_key_start
)
9894 indec
.end
= indec
.start
9895 = min (last_real_key_start
, indec
.start
);
9896 indec
.map
= indec
.parent
;
9897 if (fkey
.end
> last_real_key_start
)
9899 fkey
.end
= fkey
.start
9900 = min (last_real_key_start
, fkey
.start
);
9901 fkey
.map
= fkey
.parent
;
9902 if (keytran
.end
> last_real_key_start
)
9904 keytran
.end
= keytran
.start
9905 = min (last_real_key_start
, keytran
.start
);
9906 keytran
.map
= keytran
.parent
;
9910 if (t
== last_real_key_start
)
9917 mock_input
= last_real_key_start
;
9918 goto replay_sequence
;
9923 = apply_modifiers (modifiers
, XCAR (breakdown
));
9925 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9927 /* Look for a binding for this new key. follow_key
9928 promises that it didn't munge submaps the
9929 last time we called it, since key was unbound. */
9931 = (follow_key (new_click
,
9932 nmaps
- local_first_binding
,
9933 submaps
+ local_first_binding
,
9934 defs
+ local_first_binding
,
9935 submaps
+ local_first_binding
)
9936 + local_first_binding
);
9938 /* If that click is bound, go for it. */
9939 if (first_binding
< nmaps
)
9944 /* Otherwise, we'll leave key set to the drag event. */
9951 /* Normally, last_nonmenu_event gets the previous key we read.
9952 But when a mouse popup menu is being used,
9953 we don't update last_nonmenu_event; it continues to hold the mouse
9954 event that preceded the first level of menu. */
9955 if (!used_mouse_menu
)
9956 last_nonmenu_event
= key
;
9958 /* Record what part of this_command_keys is the current key sequence. */
9959 this_single_command_key_start
= this_command_key_count
- t
;
9961 /* Look for this sequence in input-decode-map.
9962 Scan from indec.end until we find a bound suffix. */
9963 while (indec
.end
< t
)
9965 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9968 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9969 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9974 mock_input
= diff
+ max (t
, mock_input
);
9975 goto replay_sequence
;
9979 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9980 && indec
.start
>= t
)
9981 /* There is a binding and it's not a prefix.
9982 (and it doesn't have any input-decode-map translation pending).
9983 There is thus no function-key in this sequence.
9984 Moving fkey.start is important in this case to allow keytran.start
9985 to go over the sequence before we return (since we keep the
9986 invariant that keytran.end <= fkey.start). */
9989 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9992 /* If the sequence is unbound, see if we can hang a function key
9993 off the end of it. */
9994 /* Continue scan from fkey.end until we find a bound suffix. */
9995 while (fkey
.end
< indec
.start
)
9997 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10000 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10001 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10002 max (t
, mock_input
),
10003 /* If there's a binding (i.e.
10004 first_binding >= nmaps) we don't want
10005 to apply this function-key-mapping. */
10006 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10011 mock_input
= diff
+ max (t
, mock_input
);
10012 /* Adjust the input-decode-map counters. */
10014 indec
.start
+= diff
;
10016 goto replay_sequence
;
10020 /* Look for this sequence in key-translation-map.
10021 Scan from keytran.end until we find a bound suffix. */
10022 while (keytran
.end
< fkey
.start
)
10024 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10027 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10028 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10033 mock_input
= diff
+ max (t
, mock_input
);
10034 /* Adjust the function-key-map and input-decode-map counters. */
10036 indec
.start
+= diff
;
10038 fkey
.start
+= diff
;
10040 goto replay_sequence
;
10044 /* If KEY is not defined in any of the keymaps,
10045 and cannot be part of a function key or translation,
10046 and is an upper case letter
10047 use the corresponding lower-case letter instead. */
10048 if (first_binding
>= nmaps
10049 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10051 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10052 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10053 || (XINT (key
) & shift_modifier
)))
10055 Lisp_Object new_key
;
10057 original_uppercase
= key
;
10058 original_uppercase_position
= t
- 1;
10060 if (XINT (key
) & shift_modifier
)
10061 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10063 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10064 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10066 /* We have to do this unconditionally, regardless of whether
10067 the lower-case char is defined in the keymaps, because they
10068 might get translated through function-key-map. */
10069 keybuf
[t
- 1] = new_key
;
10070 mock_input
= max (t
, mock_input
);
10071 shift_translated
= 1;
10073 goto replay_sequence
;
10075 /* If KEY is not defined in any of the keymaps,
10076 and cannot be part of a function key or translation,
10077 and is a shifted function key,
10078 use the corresponding unshifted function key instead. */
10079 if (first_binding
>= nmaps
10080 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10082 Lisp_Object breakdown
= parse_modifiers (key
);
10084 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10086 if (modifiers
& shift_modifier
10087 /* Treat uppercase keys as shifted. */
10089 && (KEY_TO_CHAR (key
)
10090 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10091 && UPPERCASEP (KEY_TO_CHAR (key
))))
10093 Lisp_Object new_key
10094 = (modifiers
& shift_modifier
10095 ? apply_modifiers (modifiers
& ~shift_modifier
,
10097 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10099 original_uppercase
= key
;
10100 original_uppercase_position
= t
- 1;
10102 /* We have to do this unconditionally, regardless of whether
10103 the lower-case char is defined in the keymaps, because they
10104 might get translated through function-key-map. */
10105 keybuf
[t
- 1] = new_key
;
10106 mock_input
= max (t
, mock_input
);
10107 /* Reset fkey (and consequently keytran) to apply
10108 function-key-map on the result, so that S-backspace is
10109 correctly mapped to DEL (via backspace). OTOH,
10110 input-decode-map doesn't need to go through it again. */
10111 fkey
.start
= fkey
.end
= 0;
10112 keytran
.start
= keytran
.end
= 0;
10113 shift_translated
= 1;
10115 goto replay_sequence
;
10120 read_key_sequence_cmd
= (first_binding
< nmaps
10121 ? defs
[first_binding
]
10124 unread_switch_frame
= delayed_switch_frame
;
10125 unbind_to (count
, Qnil
);
10127 /* Don't downcase the last character if the caller says don't.
10128 Don't downcase it if the result is undefined, either. */
10129 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10131 && t
- 1 == original_uppercase_position
)
10133 keybuf
[t
- 1] = original_uppercase
;
10134 shift_translated
= 0;
10137 if (shift_translated
)
10138 Vthis_command_keys_shift_translated
= Qt
;
10140 /* Occasionally we fabricate events, perhaps by expanding something
10141 according to function-key-map, or by adding a prefix symbol to a
10142 mouse click in the scroll bar or modeline. In this cases, return
10143 the entire generated key sequence, even if we hit an unbound
10144 prefix or a definition before the end. This means that you will
10145 be able to push back the event properly, and also means that
10146 read-key-sequence will always return a logical unit.
10149 for (; t
< mock_input
; t
++)
10151 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10152 && NILP (Fzerop (Vecho_keystrokes
)))
10153 echo_char (keybuf
[t
]);
10154 add_command_key (keybuf
[t
]);
10161 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10162 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10163 The sequence is sufficient to specify a non-prefix command in the
10164 current local and global maps.
10166 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10167 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10168 as a continuation of the previous key.
10170 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10171 convert the last event to lower case. (Normally any upper case event
10172 is converted to lower case if the original event is undefined and the lower
10173 case equivalent is defined.) A non-nil value is appropriate for reading
10174 a key sequence to be defined.
10176 A C-g typed while in this function is treated like any other character,
10177 and `quit-flag' is not set.
10179 If the key sequence starts with a mouse click, then the sequence is read
10180 using the keymaps of the buffer of the window clicked in, not the buffer
10181 of the selected window as normal.
10183 `read-key-sequence' drops unbound button-down events, since you normally
10184 only care about the click or drag events which follow them. If a drag
10185 or multi-click event is unbound, but the corresponding click event would
10186 be bound, `read-key-sequence' turns the event into a click event at the
10187 drag's starting position. This means that you don't have to distinguish
10188 between click and drag, double, or triple events unless you want to.
10190 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10191 lines separating windows, and scroll bars with imaginary keys
10192 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10194 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10195 function will process a switch-frame event if the user switches frames
10196 before typing anything. If the user switches frames in the middle of a
10197 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10198 is nil, then the event will be put off until after the current key sequence.
10200 `read-key-sequence' checks `function-key-map' for function key
10201 sequences, where they wouldn't conflict with ordinary bindings. See
10202 `function-key-map' for more details.
10204 The optional fifth argument COMMAND-LOOP, if non-nil, means
10205 that this key sequence is being read by something that will
10206 read commands one after another. It should be nil if the caller
10207 will read just one key sequence. */)
10208 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10210 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10211 Lisp_Object can_return_switch_frame
, command_loop
;
10213 Lisp_Object keybuf
[30];
10215 struct gcpro gcpro1
;
10216 int count
= SPECPDL_INDEX ();
10218 if (!NILP (prompt
))
10219 CHECK_STRING (prompt
);
10222 specbind (Qinput_method_exit_on_first_char
,
10223 (NILP (command_loop
) ? Qt
: Qnil
));
10224 specbind (Qinput_method_use_echo_area
,
10225 (NILP (command_loop
) ? Qt
: Qnil
));
10227 bzero (keybuf
, sizeof keybuf
);
10228 GCPRO1 (keybuf
[0]);
10229 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10231 if (NILP (continue_echo
))
10233 this_command_key_count
= 0;
10234 this_command_key_count_reset
= 0;
10235 this_single_command_key_start
= 0;
10238 #ifdef HAVE_WINDOW_SYSTEM
10239 if (display_hourglass_p
)
10240 cancel_hourglass ();
10243 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10244 prompt
, ! NILP (dont_downcase_last
),
10245 ! NILP (can_return_switch_frame
), 0);
10247 #if 0 /* The following is fine for code reading a key sequence and
10248 then proceeding with a lenghty computation, but it's not good
10249 for code reading keys in a loop, like an input method. */
10250 #ifdef HAVE_WINDOW_SYSTEM
10251 if (display_hourglass_p
)
10252 start_hourglass ();
10262 return unbind_to (count
, make_event_array (i
, keybuf
));
10265 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10266 Sread_key_sequence_vector
, 1, 5, 0,
10267 doc
: /* Like `read-key-sequence' but always return a vector. */)
10268 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10270 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10271 Lisp_Object can_return_switch_frame
, command_loop
;
10273 Lisp_Object keybuf
[30];
10275 struct gcpro gcpro1
;
10276 int count
= SPECPDL_INDEX ();
10278 if (!NILP (prompt
))
10279 CHECK_STRING (prompt
);
10282 specbind (Qinput_method_exit_on_first_char
,
10283 (NILP (command_loop
) ? Qt
: Qnil
));
10284 specbind (Qinput_method_use_echo_area
,
10285 (NILP (command_loop
) ? Qt
: Qnil
));
10287 bzero (keybuf
, sizeof keybuf
);
10288 GCPRO1 (keybuf
[0]);
10289 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10291 if (NILP (continue_echo
))
10293 this_command_key_count
= 0;
10294 this_command_key_count_reset
= 0;
10295 this_single_command_key_start
= 0;
10298 #ifdef HAVE_WINDOW_SYSTEM
10299 if (display_hourglass_p
)
10300 cancel_hourglass ();
10303 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10304 prompt
, ! NILP (dont_downcase_last
),
10305 ! NILP (can_return_switch_frame
), 0);
10307 #ifdef HAVE_WINDOW_SYSTEM
10308 if (display_hourglass_p
)
10309 start_hourglass ();
10318 return unbind_to (count
, Fvector (i
, keybuf
));
10321 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10322 doc
: /* Execute CMD as an editor command.
10323 CMD must be a symbol that satisfies the `commandp' predicate.
10324 Optional second arg RECORD-FLAG non-nil
10325 means unconditionally put this command in `command-history'.
10326 Otherwise, that is done only if an arg is read using the minibuffer.
10327 The argument KEYS specifies the value to use instead of (this-command-keys)
10328 when reading the arguments; if it is nil, (this-command-keys) is used.
10329 The argument SPECIAL, if non-nil, means that this command is executing
10330 a special event, so ignore the prefix argument and don't clear it. */)
10331 (cmd
, record_flag
, keys
, special
)
10332 Lisp_Object cmd
, record_flag
, keys
, special
;
10334 register Lisp_Object final
;
10335 register Lisp_Object tem
;
10336 Lisp_Object prefixarg
;
10337 extern int debug_on_next_call
;
10339 debug_on_next_call
= 0;
10341 if (NILP (special
))
10343 prefixarg
= current_kboard
->Vprefix_arg
;
10344 Vcurrent_prefix_arg
= prefixarg
;
10345 current_kboard
->Vprefix_arg
= Qnil
;
10352 tem
= Fget (cmd
, Qdisabled
);
10353 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10355 tem
= Fsymbol_value (Qdisabled_command_function
);
10357 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10363 final
= Findirect_function (cmd
, Qnil
);
10365 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10367 struct gcpro gcpro1
, gcpro2
;
10369 GCPRO2 (cmd
, prefixarg
);
10370 do_autoload (final
, cmd
);
10377 if (STRINGP (final
) || VECTORP (final
))
10379 /* If requested, place the macro in the command history. For
10380 other sorts of commands, call-interactively takes care of
10382 if (!NILP (record_flag
))
10385 = Fcons (Fcons (Qexecute_kbd_macro
,
10386 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10389 /* Don't keep command history around forever. */
10390 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10392 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10394 XSETCDR (tem
, Qnil
);
10398 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10401 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10402 /* Don't call Fcall_interactively directly because we want to make
10403 sure the backtrace has an entry for `call-interactively'.
10404 For the same reason, pass `cmd' rather than `final'. */
10405 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10412 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10414 doc
: /* Read function name, then read its arguments and call it.
10416 To pass a numeric argument to the command you are invoking with, specify
10417 the numeric argument to this command.
10419 Noninteractively, the argument PREFIXARG is the prefix argument to
10420 give to the command you invoke, if it asks for an argument. */)
10422 Lisp_Object prefixarg
;
10424 Lisp_Object function
;
10426 int saved_last_point_position
;
10427 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10428 Lisp_Object bindings
, value
;
10429 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10430 #ifdef HAVE_WINDOW_SYSTEM
10431 /* The call to Fcompleting_read wil start and cancel the hourglass,
10432 but if the hourglass was already scheduled, this means that no
10433 hourglass will be shown for the actual M-x command itself.
10434 So we restart it if it is already scheduled. Note that checking
10435 hourglass_shown_p is not enough, normally the hourglass is not shown,
10436 just scheduled to be shown. */
10437 int hstarted
= hourglass_started ();
10440 saved_keys
= Fvector (this_command_key_count
,
10441 XVECTOR (this_command_keys
)->contents
);
10442 saved_last_point_position_buffer
= last_point_position_buffer
;
10443 saved_last_point_position
= last_point_position
;
10445 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10447 if (EQ (prefixarg
, Qminus
))
10448 strcpy (buf
, "- ");
10449 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10450 strcpy (buf
, "C-u ");
10451 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10452 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10453 else if (INTEGERP (prefixarg
))
10454 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10456 /* This isn't strictly correct if execute-extended-command
10457 is bound to anything else. Perhaps it should use
10458 this_command_keys? */
10459 strcat (buf
, "M-x ");
10461 /* Prompt with buf, and then read a string, completing from and
10462 restricting to the set of all defined commands. Don't provide
10463 any initial input. Save the command read on the extended-command
10465 function
= Fcompleting_read (build_string (buf
),
10466 Vobarray
, Qcommandp
,
10467 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10470 #ifdef HAVE_WINDOW_SYSTEM
10471 if (hstarted
) start_hourglass ();
10474 if (STRINGP (function
) && SCHARS (function
) == 0)
10475 error ("No command name given");
10477 /* Set this_command_keys to the concatenation of saved_keys and
10478 function, followed by a RET. */
10483 this_command_key_count
= 0;
10484 this_command_key_count_reset
= 0;
10485 this_single_command_key_start
= 0;
10487 keys
= XVECTOR (saved_keys
)->contents
;
10488 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10489 add_command_key (keys
[i
]);
10491 for (i
= 0; i
< SCHARS (function
); i
++)
10492 add_command_key (Faref (function
, make_number (i
)));
10494 add_command_key (make_number ('\015'));
10497 last_point_position
= saved_last_point_position
;
10498 last_point_position_buffer
= saved_last_point_position_buffer
;
10502 function
= Fintern (function
, Qnil
);
10503 current_kboard
->Vprefix_arg
= prefixarg
;
10504 Vthis_command
= function
;
10505 real_this_command
= function
;
10507 /* If enabled, show which key runs this command. */
10508 if (!NILP (Vsuggest_key_bindings
)
10509 && NILP (Vexecuting_kbd_macro
)
10510 && SYMBOLP (function
))
10511 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10517 GCPRO3 (bindings
, value
, function
);
10518 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10520 /* If the command has a key binding, print it now. */
10521 if (!NILP (bindings
)
10522 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10525 /* But first wait, and skip the message if there is input. */
10526 Lisp_Object waited
;
10528 /* If this command displayed something in the echo area;
10529 wait a few seconds, then display our suggestion message. */
10530 if (NILP (echo_area_buffer
[0]))
10531 waited
= sit_for (make_number (0), 0, 2);
10532 else if (NUMBERP (Vsuggest_key_bindings
))
10533 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10535 waited
= sit_for (make_number (2), 0, 2);
10537 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10539 Lisp_Object binding
;
10541 int message_p
= push_message ();
10542 int count
= SPECPDL_INDEX ();
10544 record_unwind_protect (pop_message_unwind
, Qnil
);
10545 binding
= Fkey_description (bindings
, Qnil
);
10548 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10551 sprintf (newmessage
, "You can run the command `%s' with %s",
10552 SDATA (SYMBOL_NAME (function
)),
10554 message2_nolog (newmessage
,
10555 strlen (newmessage
),
10556 STRING_MULTIBYTE (binding
));
10557 if (NUMBERP (Vsuggest_key_bindings
))
10558 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10560 waited
= sit_for (make_number (2), 0, 2);
10562 if (!NILP (waited
) && message_p
)
10563 restore_message ();
10565 unbind_to (count
, Qnil
);
10569 RETURN_UNGCPRO (value
);
10573 /* Return nonzero if input events are pending. */
10576 detect_input_pending ()
10578 if (!input_pending
)
10579 get_input_pending (&input_pending
, 0);
10581 return input_pending
;
10584 /* Return nonzero if input events other than mouse movements are
10588 detect_input_pending_ignore_squeezables ()
10590 if (!input_pending
)
10591 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10593 return input_pending
;
10596 /* Return nonzero if input events are pending, and run any pending timers. */
10599 detect_input_pending_run_timers (do_display
)
10602 int old_timers_run
= timers_run
;
10604 if (!input_pending
)
10605 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10607 if (old_timers_run
!= timers_run
&& do_display
)
10609 redisplay_preserve_echo_area (8);
10610 /* The following fixes a bug when using lazy-lock with
10611 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10612 from an idle timer function. The symptom of the bug is that
10613 the cursor sometimes doesn't become visible until the next X
10614 event is processed. --gerd. */
10616 Lisp_Object tail
, frame
;
10617 FOR_EACH_FRAME (tail
, frame
)
10618 if (FRAME_RIF (XFRAME (frame
)))
10619 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10623 return input_pending
;
10626 /* This is called in some cases before a possible quit.
10627 It cases the next call to detect_input_pending to recompute input_pending.
10628 So calling this function unnecessarily can't do any harm. */
10631 clear_input_pending ()
10636 /* Return nonzero if there are pending requeued events.
10637 This isn't used yet. The hope is to make wait_reading_process_output
10638 call it, and return if it runs Lisp code that unreads something.
10639 The problem is, kbd_buffer_get_event needs to be fixed to know what
10640 to do in that case. It isn't trivial. */
10643 requeued_events_pending_p ()
10645 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10649 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10650 doc
: /* Return t if command input is currently available with no wait.
10651 Actually, the value is nil only if we can be sure that no input is available;
10652 if there is a doubt, the value is t. */)
10655 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10656 || !NILP (Vunread_post_input_method_events
)
10657 || !NILP (Vunread_input_method_events
))
10660 get_input_pending (&input_pending
,
10661 READABLE_EVENTS_DO_TIMERS_NOW
10662 | READABLE_EVENTS_FILTER_EVENTS
);
10663 return input_pending
> 0 ? Qt
: Qnil
;
10666 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10667 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10670 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10673 if (total_keys
< NUM_RECENT_KEYS
)
10674 return Fvector (total_keys
, keys
);
10677 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10678 bcopy (keys
+ recent_keys_index
,
10679 XVECTOR (val
)->contents
,
10680 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10682 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10683 recent_keys_index
* sizeof (Lisp_Object
));
10688 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10689 doc
: /* Return the key sequence that invoked this command.
10690 However, if the command has called `read-key-sequence', it returns
10691 the last key sequence that has been read.
10692 The value is a string or a vector.
10694 See also `this-command-keys-vector'. */)
10697 return make_event_array (this_command_key_count
,
10698 XVECTOR (this_command_keys
)->contents
);
10701 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10702 doc
: /* Return the key sequence that invoked this command, as a vector.
10703 However, if the command has called `read-key-sequence', it returns
10704 the last key sequence that has been read.
10706 See also `this-command-keys'. */)
10709 return Fvector (this_command_key_count
,
10710 XVECTOR (this_command_keys
)->contents
);
10713 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10714 Sthis_single_command_keys
, 0, 0, 0,
10715 doc
: /* Return the key sequence that invoked this command.
10716 More generally, it returns the last key sequence read, either by
10717 the command loop or by `read-key-sequence'.
10718 Unlike `this-command-keys', this function's value
10719 does not include prefix arguments.
10720 The value is always a vector. */)
10723 return Fvector (this_command_key_count
10724 - this_single_command_key_start
,
10725 (XVECTOR (this_command_keys
)->contents
10726 + this_single_command_key_start
));
10729 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10730 Sthis_single_command_raw_keys
, 0, 0, 0,
10731 doc
: /* Return the raw events that were read for this command.
10732 More generally, it returns the last key sequence read, either by
10733 the command loop or by `read-key-sequence'.
10734 Unlike `this-single-command-keys', this function's value
10735 shows the events before all translations (except for input methods).
10736 The value is always a vector. */)
10739 return Fvector (raw_keybuf_count
,
10740 (XVECTOR (raw_keybuf
)->contents
));
10743 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10744 Sreset_this_command_lengths
, 0, 0, 0,
10745 doc
: /* Make the unread events replace the last command and echo.
10746 Used in `universal-argument-other-key'.
10748 `universal-argument-other-key' rereads the event just typed.
10749 It then gets translated through `function-key-map'.
10750 The translated event has to replace the real events,
10751 both in the value of (this-command-keys) and in echoing.
10752 To achieve this, `universal-argument-other-key' calls
10753 `reset-this-command-lengths', which discards the record of reading
10754 these events the first time. */)
10757 this_command_key_count
= before_command_key_count
;
10758 if (this_command_key_count
< this_single_command_key_start
)
10759 this_single_command_key_start
= this_command_key_count
;
10761 echo_truncate (before_command_echo_length
);
10763 /* Cause whatever we put into unread-command-events
10764 to echo as if it were being freshly read from the keyboard. */
10765 this_command_key_count_reset
= 1;
10770 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10771 Sclear_this_command_keys
, 0, 1, 0,
10772 doc
: /* Clear out the vector that `this-command-keys' returns.
10773 Also clear the record of the last 100 events, unless optional arg
10774 KEEP-RECORD is non-nil. */)
10776 Lisp_Object keep_record
;
10780 this_command_key_count
= 0;
10781 this_command_key_count_reset
= 0;
10783 if (NILP (keep_record
))
10785 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10786 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10788 recent_keys_index
= 0;
10793 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10794 doc
: /* Return the current depth in recursive edits. */)
10798 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10802 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10803 "FOpen dribble file: ",
10804 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10805 If FILE is nil, close any open dribble file. */)
10818 file
= Fexpand_file_name (file
, Qnil
);
10819 dribble
= fopen (SDATA (file
), "w");
10821 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10826 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10827 doc
: /* Discard the contents of the terminal input buffer.
10828 Also end any kbd macro being defined. */)
10831 if (!NILP (current_kboard
->defining_kbd_macro
))
10833 /* Discard the last command from the macro. */
10834 Fcancel_kbd_macro_events ();
10838 update_mode_lines
++;
10840 Vunread_command_events
= Qnil
;
10841 unread_command_char
= -1;
10843 discard_tty_input ();
10845 kbd_fetch_ptr
= kbd_store_ptr
;
10851 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10852 doc
: /* Stop Emacs and return to superior process. You can resume later.
10853 If `cannot-suspend' is non-nil, or if the system doesn't support job
10854 control, run a subshell instead.
10856 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10857 to be read as terminal input by Emacs's parent, after suspension.
10859 Before suspending, run the normal hook `suspend-hook'.
10860 After resumption run the normal hook `suspend-resume-hook'.
10862 Some operating systems cannot stop the Emacs process and resume it later.
10863 On such systems, Emacs starts a subshell instead of suspending. */)
10865 Lisp_Object stuffstring
;
10867 int count
= SPECPDL_INDEX ();
10868 int old_height
, old_width
;
10870 struct gcpro gcpro1
;
10872 if (tty_list
&& tty_list
->next
)
10873 error ("There are other tty frames open; close them before suspending Emacs");
10875 if (!NILP (stuffstring
))
10876 CHECK_STRING (stuffstring
);
10878 /* Run the functions in suspend-hook. */
10879 if (!NILP (Vrun_hooks
))
10880 call1 (Vrun_hooks
, intern ("suspend-hook"));
10882 GCPRO1 (stuffstring
);
10883 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10884 reset_all_sys_modes ();
10885 /* sys_suspend can get an error if it tries to fork a subshell
10886 and the system resources aren't available for that. */
10887 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10889 stuff_buffered_input (stuffstring
);
10890 if (cannot_suspend
)
10894 unbind_to (count
, Qnil
);
10896 /* Check if terminal/window size has changed.
10897 Note that this is not useful when we are running directly
10898 with a window system; but suspend should be disabled in that case. */
10899 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10900 if (width
!= old_width
|| height
!= old_height
)
10901 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10903 /* Run suspend-resume-hook. */
10904 if (!NILP (Vrun_hooks
))
10905 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10911 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10912 Then in any case stuff anything Emacs has read ahead and not used. */
10915 stuff_buffered_input (stuffstring
)
10916 Lisp_Object stuffstring
;
10918 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10919 register unsigned char *p
;
10921 if (STRINGP (stuffstring
))
10923 register int count
;
10925 p
= SDATA (stuffstring
);
10926 count
= SBYTES (stuffstring
);
10927 while (count
-- > 0)
10932 /* Anything we have read ahead, put back for the shell to read. */
10933 /* ?? What should this do when we have multiple keyboards??
10934 Should we ignore anything that was typed in at the "wrong" kboard?
10936 rms: we should stuff everything back into the kboard
10938 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10941 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10942 kbd_fetch_ptr
= kbd_buffer
;
10943 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10944 stuff_char (kbd_fetch_ptr
->code
);
10946 clear_event (kbd_fetch_ptr
);
10950 #endif /* SIGTSTP */
10954 set_waiting_for_input (time_to_clear
)
10955 EMACS_TIME
*time_to_clear
;
10957 input_available_clear_time
= time_to_clear
;
10959 /* Tell handle_interrupt to throw back to read_char, */
10960 waiting_for_input
= 1;
10962 /* If handle_interrupt was called before and buffered a C-g,
10963 make it run again now, to avoid timing error. */
10964 if (!NILP (Vquit_flag
))
10965 quit_throw_to_read_char ();
10969 clear_waiting_for_input ()
10971 /* Tell handle_interrupt not to throw back to read_char, */
10972 waiting_for_input
= 0;
10973 input_available_clear_time
= 0;
10976 /* The SIGINT handler.
10978 If we have a frame on the controlling tty, we assume that the
10979 SIGINT was generated by C-g, so we call handle_interrupt.
10980 Otherwise, the handler kills Emacs. */
10983 interrupt_signal (signalnum
) /* If we don't have an argument, */
10984 int signalnum
; /* some compilers complain in signal calls. */
10986 /* Must preserve main program's value of errno. */
10987 int old_errno
= errno
;
10988 struct terminal
*terminal
;
10990 SIGNAL_THREAD_CHECK (signalnum
);
10992 /* See if we have an active terminal on our controlling tty. */
10993 terminal
= get_named_tty ("/dev/tty");
10996 /* If there are no frames there, let's pretend that we are a
10997 well-behaving UN*X program and quit. */
10998 Fkill_emacs (Qnil
);
11002 /* Otherwise, the SIGINT was probably generated by C-g. */
11004 /* Set internal_last_event_frame to the top frame of the
11005 controlling tty, if we have a frame there. We disable the
11006 interrupt key on secondary ttys, so the SIGINT must have come
11007 from the controlling tty. */
11008 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11010 handle_interrupt ();
11016 /* This routine is called at interrupt level in response to C-g.
11018 It is called from the SIGINT handler or kbd_buffer_store_event.
11020 If `waiting_for_input' is non zero, then unless `echoing' is
11021 nonzero, immediately throw back to read_char.
11023 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11024 eval to throw, when it gets a chance. If quit-flag is already
11025 non-nil, it stops the job right away. */
11028 handle_interrupt ()
11034 /* XXX This code needs to be revised for multi-tty support. */
11035 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
11037 /* If SIGINT isn't blocked, don't let us be interrupted by
11038 another SIGINT, it might be harmful due to non-reentrancy
11039 in I/O functions. */
11040 sigblock (sigmask (SIGINT
));
11043 reset_all_sys_modes ();
11045 #ifdef SIGTSTP /* Support possible in later USG versions */
11047 * On systems which can suspend the current process and return to the original
11048 * shell, this command causes the user to end up back at the shell.
11049 * The "Auto-save" and "Abort" questions are not asked until
11050 * the user elects to return to emacs, at which point he can save the current
11051 * job and either dump core or continue.
11055 /* Perhaps should really fork an inferior shell?
11056 But that would not provide any way to get back
11057 to the original shell, ever. */
11058 printf ("No support for stopping a process on this operating system;\n");
11059 printf ("you can continue or abort.\n");
11060 #endif /* not SIGTSTP */
11062 /* We must remain inside the screen area when the internal terminal
11063 is used. Note that [Enter] is not echoed by dos. */
11064 cursor_to (SELECTED_FRAME (), 0, 0);
11066 /* It doesn't work to autosave while GC is in progress;
11067 the code used for auto-saving doesn't cope with the mark bit. */
11068 if (!gc_in_progress
)
11070 printf ("Auto-save? (y or n) ");
11072 if (((c
= getchar ()) & ~040) == 'Y')
11074 Fdo_auto_save (Qt
, Qnil
);
11076 printf ("\r\nAuto-save done");
11077 #else /* not MSDOS */
11078 printf ("Auto-save done\n");
11079 #endif /* not MSDOS */
11081 while (c
!= '\n') c
= getchar ();
11085 /* During GC, it must be safe to reenable quitting again. */
11086 Vinhibit_quit
= Qnil
;
11089 #endif /* not MSDOS */
11090 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11091 printf ("but will instead do a real quit after garbage collection ends\r\n");
11096 printf ("\r\nAbort? (y or n) ");
11097 #else /* not MSDOS */
11098 printf ("Abort (and dump core)? (y or n) ");
11099 #endif /* not MSDOS */
11101 if (((c
= getchar ()) & ~040) == 'Y')
11103 while (c
!= '\n') c
= getchar ();
11105 printf ("\r\nContinuing...\r\n");
11106 #else /* not MSDOS */
11107 printf ("Continuing...\n");
11108 #endif /* not MSDOS */
11110 init_all_sys_modes ();
11115 /* If executing a function that wants to be interrupted out of
11116 and the user has not deferred quitting by binding `inhibit-quit'
11117 then quit right away. */
11118 if (immediate_quit
&& NILP (Vinhibit_quit
))
11120 struct gl_state_s saved
;
11121 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11123 immediate_quit
= 0;
11126 GCPRO4 (saved
.object
, saved
.global_code
,
11127 saved
.current_syntax_table
, saved
.old_prop
);
11128 Fsignal (Qquit
, Qnil
);
11129 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11134 /* Else request quit when it's safe */
11138 /* TODO: The longjmp in this call throws the NS event loop integration off,
11139 and it seems to do fine without this. Probably some attention
11140 needs to be paid to the setting of waiting_for_input in
11141 wait_reading_process_output() under HAVE_NS because of the call
11142 to ns_select there (needed because otherwise events aren't picked up
11143 outside of polling since we don't get SIGIO like X and we don't have a
11144 separate event loop thread like W32. */
11146 if (waiting_for_input
&& !echoing
)
11147 quit_throw_to_read_char ();
11151 /* Handle a C-g by making read_char return C-g. */
11154 quit_throw_to_read_char ()
11157 /* Prevent another signal from doing this before we finish. */
11158 clear_waiting_for_input ();
11161 Vunread_command_events
= Qnil
;
11162 unread_command_char
= -1;
11164 #if 0 /* Currently, sit_for is called from read_char without turning
11165 off polling. And that can call set_waiting_for_input.
11166 It seems to be harmless. */
11167 #ifdef POLL_FOR_INPUT
11168 /* May be > 1 if in recursive minibuffer. */
11169 if (poll_suppress_count
== 0)
11173 if (FRAMEP (internal_last_event_frame
)
11174 && !EQ (internal_last_event_frame
, selected_frame
))
11175 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11178 _longjmp (getcjmp
, 1);
11181 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11182 doc
: /* Set interrupt mode of reading keyboard input.
11183 If INTERRUPT is non-nil, Emacs will use input interrupts;
11184 otherwise Emacs uses CBREAK mode.
11186 See also `current-input-mode'. */)
11188 Lisp_Object interrupt
;
11190 int new_interrupt_input
;
11192 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11193 #ifdef HAVE_X_WINDOWS
11194 if (x_display_list
!= NULL
)
11196 /* When using X, don't give the user a real choice,
11197 because we haven't implemented the mechanisms to support it. */
11198 new_interrupt_input
= 1;
11201 #endif /* HAVE_X_WINDOWS */
11202 new_interrupt_input
= !NILP (interrupt
);
11203 #else /* not SIGIO */
11204 new_interrupt_input
= 0;
11205 #endif /* not SIGIO */
11207 if (new_interrupt_input
!= interrupt_input
)
11209 #ifdef POLL_FOR_INPUT
11213 /* this causes startup screen to be restored and messes with the mouse */
11214 reset_all_sys_modes ();
11216 interrupt_input
= new_interrupt_input
;
11218 init_all_sys_modes ();
11221 #ifdef POLL_FOR_INPUT
11222 poll_suppress_count
= 1;
11229 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11230 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11231 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11232 C-q in key sequences.
11234 This setting only has an effect on tty terminals and only when
11235 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11237 See also `current-input-mode'. */)
11239 Lisp_Object flow
, terminal
;
11241 struct terminal
*t
= get_terminal (terminal
, 1);
11242 struct tty_display_info
*tty
;
11243 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11245 tty
= t
->display_info
.tty
;
11247 if (tty
->flow_control
!= !NILP (flow
))
11250 /* this causes startup screen to be restored and messes with the mouse */
11251 reset_sys_modes (tty
);
11254 tty
->flow_control
= !NILP (flow
);
11257 init_sys_modes (tty
);
11263 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11264 doc
: /* Enable or disable 8-bit input on TERMINAL.
11265 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11266 bit as the Meta modifier.
11268 If META is nil, Emacs will ignore the top bit, on the assumption it is
11271 Otherwise, Emacs will accept and pass through 8-bit input without
11272 specially interpreting the top bit.
11274 This setting only has an effect on tty terminal devices.
11276 Optional parameter TERMINAL specifies the tty terminal device to use.
11277 It may be a terminal object, a frame, or nil for the terminal used by
11278 the currently selected frame.
11280 See also `current-input-mode'. */)
11282 Lisp_Object meta
, terminal
;
11284 struct terminal
*t
= get_terminal (terminal
, 1);
11285 struct tty_display_info
*tty
;
11288 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11290 tty
= t
->display_info
.tty
;
11294 else if (EQ (meta
, Qt
))
11299 if (tty
->meta_key
!= new_meta
)
11302 /* this causes startup screen to be restored and messes with the mouse */
11303 reset_sys_modes (tty
);
11306 tty
->meta_key
= new_meta
;
11309 init_sys_modes (tty
);
11315 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11316 doc
: /* Specify character used for quitting.
11317 QUIT must be an ASCII character.
11319 This function only has an effect on the controlling tty of the Emacs
11322 See also `current-input-mode'. */)
11326 struct terminal
*t
= get_named_tty ("/dev/tty");
11327 struct tty_display_info
*tty
;
11328 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11330 tty
= t
->display_info
.tty
;
11332 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11333 error ("QUIT must be an ASCII character");
11336 /* this causes startup screen to be restored and messes with the mouse */
11337 reset_sys_modes (tty
);
11340 /* Don't let this value be out of range. */
11341 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11344 init_sys_modes (tty
);
11350 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11351 doc
: /* Set mode of reading keyboard input.
11352 First arg INTERRUPT non-nil means use input interrupts;
11353 nil means use CBREAK mode.
11354 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11355 (no effect except in CBREAK mode).
11356 Third arg META t means accept 8-bit input (for a Meta key).
11357 META nil means ignore the top bit, on the assumption it is parity.
11358 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11359 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11360 See also `current-input-mode'. */)
11361 (interrupt
, flow
, meta
, quit
)
11362 Lisp_Object interrupt
, flow
, meta
, quit
;
11364 Fset_input_interrupt_mode (interrupt
);
11365 Fset_output_flow_control (flow
, Qnil
);
11366 Fset_input_meta_mode (meta
, Qnil
);
11368 Fset_quit_char (quit
);
11372 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11373 doc
: /* Return information about the way Emacs currently reads keyboard input.
11374 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11375 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11376 nil, Emacs is using CBREAK mode.
11377 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11378 terminal; this does not apply if Emacs uses interrupt-driven input.
11379 META is t if accepting 8-bit input with 8th bit as Meta flag.
11380 META nil means ignoring the top bit, on the assumption it is parity.
11381 META is neither t nor nil if accepting 8-bit input and using
11382 all 8 bits as the character code.
11383 QUIT is the character Emacs currently uses to quit.
11384 The elements of this list correspond to the arguments of
11385 `set-input-mode'. */)
11388 Lisp_Object val
[4];
11389 struct frame
*sf
= XFRAME (selected_frame
);
11391 val
[0] = interrupt_input
? Qt
: Qnil
;
11392 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11394 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11395 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11397 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11404 XSETFASTINT (val
[3], quit_char
);
11406 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11409 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11410 doc
: /* Return position information for pixel coordinates X and Y.
11411 By default, X and Y are relative to text area of the selected window.
11412 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11413 If optional fourth arg WHOLE is non-nil, X is relative to the left
11414 edge of the window.
11416 The return value is similar to a mouse click position:
11417 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11418 IMAGE (DX . DY) (WIDTH . HEIGHT))
11419 The `posn-' functions access elements of such lists. */)
11420 (x
, y
, frame_or_window
, whole
)
11421 Lisp_Object x
, y
, frame_or_window
, whole
;
11426 if (NILP (frame_or_window
))
11427 frame_or_window
= selected_window
;
11429 if (WINDOWP (frame_or_window
))
11433 CHECK_LIVE_WINDOW (frame_or_window
);
11435 w
= XWINDOW (frame_or_window
);
11436 XSETINT (x
, (XINT (x
)
11437 + WINDOW_LEFT_EDGE_X (w
)
11439 ? window_box_left_offset (w
, TEXT_AREA
)
11441 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11442 frame_or_window
= w
->frame
;
11445 CHECK_LIVE_FRAME (frame_or_window
);
11447 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11450 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11451 doc
: /* Return position information for buffer POS in WINDOW.
11452 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11454 Return nil if position is not visible in window. Otherwise,
11455 the return value is similar to that returned by `event-start' for
11456 a mouse click at the upper left corner of the glyph corresponding
11457 to the given buffer position:
11458 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11459 IMAGE (DX . DY) (WIDTH . HEIGHT))
11460 The `posn-' functions access elements of such lists. */)
11462 Lisp_Object pos
, window
;
11467 window
= selected_window
;
11469 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11472 Lisp_Object x
= XCAR (tem
);
11473 Lisp_Object y
= XCAR (XCDR (tem
));
11475 /* Point invisible due to hscrolling? */
11478 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11486 * Set up a new kboard object with reasonable initial values.
11492 kb
->Voverriding_terminal_local_map
= Qnil
;
11493 kb
->Vlast_command
= Qnil
;
11494 kb
->Vreal_last_command
= Qnil
;
11495 kb
->Vkeyboard_translate_table
= Qnil
;
11496 kb
->Vlast_repeatable_command
= Qnil
;
11497 kb
->Vprefix_arg
= Qnil
;
11498 kb
->Vlast_prefix_arg
= Qnil
;
11499 kb
->kbd_queue
= Qnil
;
11500 kb
->kbd_queue_has_data
= 0;
11501 kb
->immediate_echo
= 0;
11502 kb
->echo_string
= Qnil
;
11503 kb
->echo_after_prompt
= -1;
11504 kb
->kbd_macro_buffer
= 0;
11505 kb
->kbd_macro_bufsize
= 0;
11506 kb
->defining_kbd_macro
= Qnil
;
11507 kb
->Vlast_kbd_macro
= Qnil
;
11508 kb
->reference_count
= 0;
11509 kb
->Vsystem_key_alist
= Qnil
;
11510 kb
->system_key_syms
= Qnil
;
11511 kb
->Vwindow_system
= Qt
; /* Unset. */
11512 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11513 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11514 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11515 kb
->Vdefault_minibuffer_frame
= Qnil
;
11519 * Destroy the contents of a kboard object, but not the object itself.
11520 * We use this just before deleting it, or if we're going to initialize
11521 * it a second time.
11527 xfree (kb
->kbd_macro_buffer
);
11530 /* Free KB and memory referenced from it. */
11538 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11541 *kbp
= kb
->next_kboard
;
11543 /* Prevent a dangling reference to KB. */
11544 if (kb
== current_kboard
11545 && FRAMEP (selected_frame
)
11546 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11548 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11550 if (current_kboard
== kb
)
11561 /* This is correct before outermost invocation of the editor loop */
11562 command_loop_level
= -1;
11563 immediate_quit
= 0;
11564 quit_char
= Ctl ('g');
11565 Vunread_command_events
= Qnil
;
11566 unread_command_char
= -1;
11567 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11569 recent_keys_index
= 0;
11570 kbd_fetch_ptr
= kbd_buffer
;
11571 kbd_store_ptr
= kbd_buffer
;
11572 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11573 do_mouse_tracking
= Qnil
;
11576 interrupt_input_blocked
= 0;
11577 interrupt_input_pending
= 0;
11579 pending_signals
= 0;
11582 /* This means that command_loop_1 won't try to select anything the first
11584 internal_last_event_frame
= Qnil
;
11585 Vlast_event_frame
= internal_last_event_frame
;
11587 current_kboard
= initial_kboard
;
11588 /* Re-initialize the keyboard again. */
11589 wipe_kboard (current_kboard
);
11590 init_kboard (current_kboard
);
11591 /* A value of nil for Vwindow_system normally means a tty, but we also use
11592 it for the initial terminal since there is no window system there. */
11593 current_kboard
->Vwindow_system
= Qnil
;
11595 if (!noninteractive
)
11597 /* Before multi-tty support, these handlers used to be installed
11598 only if the current session was a tty session. Now an Emacs
11599 session may have multiple display types, so we always handle
11600 SIGINT. There is special code in interrupt_signal to exit
11601 Emacs on SIGINT when there are no termcap frames on the
11602 controlling terminal. */
11603 signal (SIGINT
, interrupt_signal
);
11604 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11605 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11606 SIGQUIT and we can't tell which one it will give us. */
11607 signal (SIGQUIT
, interrupt_signal
);
11608 #endif /* HAVE_TERMIO */
11610 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11612 if (!noninteractive
)
11613 signal (SIGIO
, input_available_signal
);
11616 /* Use interrupt input by default, if it works and noninterrupt input
11617 has deficiencies. */
11619 #ifdef INTERRUPT_INPUT
11620 interrupt_input
= 1;
11622 interrupt_input
= 0;
11628 if (keyboard_init_hook
)
11629 (*keyboard_init_hook
) ();
11631 #ifdef POLL_FOR_INPUT
11633 poll_suppress_count
= 1;
11638 /* This type's only use is in syms_of_keyboard, to initialize the
11639 event header symbols and put properties on them. */
11640 struct event_head
{
11646 struct event_head head_table
[] = {
11647 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11648 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11649 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11650 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11651 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11652 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11653 /* `select-window' should be handled just like `switch-frame'
11654 in read_key_sequence. */
11655 {&Qselect_window
, "select-window", &Qswitch_frame
}
11659 syms_of_keyboard ()
11661 pending_funcalls
= Qnil
;
11662 staticpro (&pending_funcalls
);
11664 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11665 staticpro (&Vlispy_mouse_stem
);
11668 QCimage
= intern_c_string (":image");
11669 staticpro (&QCimage
);
11671 staticpro (&Qhelp_echo
);
11672 Qhelp_echo
= intern_c_string ("help-echo");
11675 Qrtl
= intern_c_string (":rtl");
11677 staticpro (&item_properties
);
11678 item_properties
= Qnil
;
11680 staticpro (&tool_bar_item_properties
);
11681 tool_bar_item_properties
= Qnil
;
11682 staticpro (&tool_bar_items_vector
);
11683 tool_bar_items_vector
= Qnil
;
11685 staticpro (&real_this_command
);
11686 real_this_command
= Qnil
;
11688 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11689 staticpro (&Qtimer_event_handler
);
11691 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11692 staticpro (&Qdisabled_command_function
);
11694 Qself_insert_command
= intern_c_string ("self-insert-command");
11695 staticpro (&Qself_insert_command
);
11697 Qforward_char
= intern_c_string ("forward-char");
11698 staticpro (&Qforward_char
);
11700 Qbackward_char
= intern_c_string ("backward-char");
11701 staticpro (&Qbackward_char
);
11703 Qdisabled
= intern_c_string ("disabled");
11704 staticpro (&Qdisabled
);
11706 Qundefined
= intern_c_string ("undefined");
11707 staticpro (&Qundefined
);
11709 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11710 staticpro (&Qpre_command_hook
);
11712 Qpost_command_hook
= intern_c_string ("post-command-hook");
11713 staticpro (&Qpost_command_hook
);
11715 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11716 staticpro (&Qdeferred_action_function
);
11718 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11719 staticpro (&Qcommand_hook_internal
);
11721 Qfunction_key
= intern_c_string ("function-key");
11722 staticpro (&Qfunction_key
);
11723 Qmouse_click
= intern_c_string ("mouse-click");
11724 staticpro (&Qmouse_click
);
11725 #if defined (WINDOWSNT)
11726 Qlanguage_change
= intern_c_string ("language-change");
11727 staticpro (&Qlanguage_change
);
11729 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11730 staticpro (&Qdrag_n_drop
);
11732 Qsave_session
= intern_c_string ("save-session");
11733 staticpro (&Qsave_session
);
11736 Qdbus_event
= intern_c_string ("dbus-event");
11737 staticpro (&Qdbus_event
);
11740 Qxwidget_event
= intern ("xwidget-event");
11741 staticpro (&Qxwidget_event
);
11744 Qmenu_enable
= intern ("menu-enable");
11745 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11746 staticpro (&Qconfig_changed_event
);
11748 Qmenu_enable
= intern_c_string ("menu-enable");
11749 staticpro (&Qmenu_enable
);
11750 QCenable
= intern_c_string (":enable");
11751 staticpro (&QCenable
);
11752 QCvisible
= intern_c_string (":visible");
11753 staticpro (&QCvisible
);
11754 QChelp
= intern_c_string (":help");
11755 staticpro (&QChelp
);
11756 QCfilter
= intern_c_string (":filter");
11757 staticpro (&QCfilter
);
11758 QCbutton
= intern_c_string (":button");
11759 staticpro (&QCbutton
);
11760 QCkeys
= intern_c_string (":keys");
11761 staticpro (&QCkeys
);
11762 QCkey_sequence
= intern_c_string (":key-sequence");
11763 staticpro (&QCkey_sequence
);
11764 QCtoggle
= intern_c_string (":toggle");
11765 staticpro (&QCtoggle
);
11766 QCradio
= intern_c_string (":radio");
11767 staticpro (&QCradio
);
11768 QClabel
= intern_c_string (":label");
11769 staticpro (&QClabel
);
11771 Qmode_line
= intern_c_string ("mode-line");
11772 staticpro (&Qmode_line
);
11773 Qvertical_line
= intern_c_string ("vertical-line");
11774 staticpro (&Qvertical_line
);
11775 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11776 staticpro (&Qvertical_scroll_bar
);
11777 Qmenu_bar
= intern_c_string ("menu-bar");
11778 staticpro (&Qmenu_bar
);
11780 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11781 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11782 staticpro (&Qmouse_fixup_help_message
);
11785 Qabove_handle
= intern_c_string ("above-handle");
11786 staticpro (&Qabove_handle
);
11787 Qhandle
= intern_c_string ("handle");
11788 staticpro (&Qhandle
);
11789 Qbelow_handle
= intern_c_string ("below-handle");
11790 staticpro (&Qbelow_handle
);
11791 Qup
= intern_c_string ("up");
11793 Qdown
= intern_c_string ("down");
11794 staticpro (&Qdown
);
11795 Qtop
= intern_c_string ("top");
11797 Qbottom
= intern_c_string ("bottom");
11798 staticpro (&Qbottom
);
11799 Qend_scroll
= intern_c_string ("end-scroll");
11800 staticpro (&Qend_scroll
);
11801 Qratio
= intern_c_string ("ratio");
11802 staticpro (&Qratio
);
11804 Qevent_kind
= intern_c_string ("event-kind");
11805 staticpro (&Qevent_kind
);
11806 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11807 staticpro (&Qevent_symbol_elements
);
11808 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11809 staticpro (&Qevent_symbol_element_mask
);
11810 Qmodifier_cache
= intern_c_string ("modifier-cache");
11811 staticpro (&Qmodifier_cache
);
11813 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11814 staticpro (&Qrecompute_lucid_menubar
);
11815 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11816 staticpro (&Qactivate_menubar_hook
);
11818 Qpolling_period
= intern_c_string ("polling-period");
11819 staticpro (&Qpolling_period
);
11821 Qinput_method_function
= intern_c_string ("input-method-function");
11822 staticpro (&Qinput_method_function
);
11824 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11825 staticpro (&Qinput_method_exit_on_first_char
);
11826 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11827 staticpro (&Qinput_method_use_echo_area
);
11829 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11830 Fset (Qinput_method_use_echo_area
, Qnil
);
11832 last_point_position_buffer
= Qnil
;
11833 last_point_position_window
= Qnil
;
11836 struct event_head
*p
;
11838 for (p
= head_table
;
11839 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11842 *p
->var
= intern_c_string (p
->name
);
11843 staticpro (p
->var
);
11844 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11845 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11849 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11850 staticpro (&button_down_location
);
11851 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11852 staticpro (&mouse_syms
);
11853 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11854 / sizeof (lispy_wheel_names
[0])),
11856 staticpro (&wheel_syms
);
11860 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11862 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11863 for (i
= 0; i
< len
; i
++)
11864 if (modifier_names
[i
])
11865 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11866 staticpro (&modifier_symbols
);
11869 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11870 staticpro (&recent_keys
);
11872 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11873 staticpro (&this_command_keys
);
11875 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11876 staticpro (&raw_keybuf
);
11878 Qextended_command_history
= intern_c_string ("extended-command-history");
11879 Fset (Qextended_command_history
, Qnil
);
11880 staticpro (&Qextended_command_history
);
11882 accent_key_syms
= Qnil
;
11883 staticpro (&accent_key_syms
);
11885 func_key_syms
= Qnil
;
11886 staticpro (&func_key_syms
);
11888 drag_n_drop_syms
= Qnil
;
11889 staticpro (&drag_n_drop_syms
);
11891 unread_switch_frame
= Qnil
;
11892 staticpro (&unread_switch_frame
);
11894 internal_last_event_frame
= Qnil
;
11895 staticpro (&internal_last_event_frame
);
11897 read_key_sequence_cmd
= Qnil
;
11898 staticpro (&read_key_sequence_cmd
);
11900 menu_bar_one_keymap_changed_items
= Qnil
;
11901 staticpro (&menu_bar_one_keymap_changed_items
);
11903 menu_bar_items_vector
= Qnil
;
11904 staticpro (&menu_bar_items_vector
);
11906 help_form_saved_window_configs
= Qnil
;
11907 staticpro (&help_form_saved_window_configs
);
11909 defsubr (&Scurrent_idle_time
);
11910 defsubr (&Sevent_symbol_parse_modifiers
);
11911 defsubr (&Sevent_convert_list
);
11912 defsubr (&Sread_key_sequence
);
11913 defsubr (&Sread_key_sequence_vector
);
11914 defsubr (&Srecursive_edit
);
11915 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11916 defsubr (&Strack_mouse
);
11918 defsubr (&Sinput_pending_p
);
11919 defsubr (&Scommand_execute
);
11920 defsubr (&Srecent_keys
);
11921 defsubr (&Sthis_command_keys
);
11922 defsubr (&Sthis_command_keys_vector
);
11923 defsubr (&Sthis_single_command_keys
);
11924 defsubr (&Sthis_single_command_raw_keys
);
11925 defsubr (&Sreset_this_command_lengths
);
11926 defsubr (&Sclear_this_command_keys
);
11927 defsubr (&Ssuspend_emacs
);
11928 defsubr (&Sabort_recursive_edit
);
11929 defsubr (&Sexit_recursive_edit
);
11930 defsubr (&Srecursion_depth
);
11931 defsubr (&Stop_level
);
11932 defsubr (&Sdiscard_input
);
11933 defsubr (&Sopen_dribble_file
);
11934 defsubr (&Sset_input_interrupt_mode
);
11935 defsubr (&Sset_output_flow_control
);
11936 defsubr (&Sset_input_meta_mode
);
11937 defsubr (&Sset_quit_char
);
11938 defsubr (&Sset_input_mode
);
11939 defsubr (&Scurrent_input_mode
);
11940 defsubr (&Sexecute_extended_command
);
11941 defsubr (&Sposn_at_point
);
11942 defsubr (&Sposn_at_x_y
);
11944 DEFVAR_LISP ("last-command-event", &last_command_event
,
11945 doc
: /* Last input event that was part of a command. */);
11947 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11948 doc
: /* Last input event in a command, except for mouse menu events.
11949 Mouse menus give back keys that don't look like mouse events;
11950 this variable holds the actual mouse event that led to the menu,
11951 so that you can determine whether the command was run by mouse or not. */);
11953 DEFVAR_LISP ("last-input-event", &last_input_event
,
11954 doc
: /* Last input event. */);
11956 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11957 doc
: /* List of events to be read as the command input.
11958 These events are processed first, before actual keyboard input.
11959 Events read from this list are not normally added to `this-command-keys',
11960 as they will already have been added once as they were read for the first time.
11961 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11962 Vunread_command_events
= Qnil
;
11964 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11965 doc
: /* If not -1, an object to be read as next command input event. */);
11967 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11968 doc
: /* List of events to be processed as input by input methods.
11969 These events are processed before `unread-command-events'
11970 and actual keyboard input, but are not given to `input-method-function'. */);
11971 Vunread_post_input_method_events
= Qnil
;
11973 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11974 doc
: /* List of events to be processed as input by input methods.
11975 These events are processed after `unread-command-events', but
11976 before actual keyboard input.
11977 If there's an active input method, the events are given to
11978 `input-method-function'. */);
11979 Vunread_input_method_events
= Qnil
;
11981 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11982 doc
: /* Meta-prefix character code.
11983 Meta-foo as command input turns into this character followed by foo. */);
11984 XSETINT (meta_prefix_char
, 033);
11986 DEFVAR_KBOARD ("last-command", Vlast_command
,
11987 doc
: /* The last command executed.
11988 Normally a symbol with a function definition, but can be whatever was found
11989 in the keymap, or whatever the variable `this-command' was set to by that
11992 The value `mode-exit' is special; it means that the previous command
11993 read an event that told it to exit, and it did so and unread that event.
11994 In other words, the present command is the event that made the previous
11997 The value `kill-region' is special; it means that the previous command
11998 was a kill command.
12000 `last-command' has a separate binding for each terminal device.
12001 See Info node `(elisp)Multiple Terminals'. */);
12003 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12004 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12006 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12007 doc
: /* Last command that may be repeated.
12008 The last command executed that was not bound to an input event.
12009 This is the command `repeat' will try to repeat. */);
12011 DEFVAR_LISP ("this-command", &Vthis_command
,
12012 doc
: /* The command now being executed.
12013 The command can set this variable; whatever is put here
12014 will be in `last-command' during the following command. */);
12015 Vthis_command
= Qnil
;
12017 DEFVAR_LISP ("this-command-keys-shift-translated",
12018 &Vthis_command_keys_shift_translated
,
12019 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12020 Shift-translation occurs when there is no binding for the key sequence
12021 as entered, but a binding was found by changing an upper-case letter
12022 to lower-case, or a shifted function key to an unshifted one. */);
12023 Vthis_command_keys_shift_translated
= Qnil
;
12025 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12026 doc
: /* The command bound to the current key sequence before remapping.
12027 It equals `this-command' if the original command was not remapped through
12028 any of the active keymaps. Otherwise, the value of `this-command' is the
12029 result of looking up the original command in the active keymaps. */);
12030 Vthis_original_command
= Qnil
;
12032 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12033 doc
: /* *Number of input events between auto-saves.
12034 Zero means disable autosaving due to number of characters typed. */);
12035 auto_save_interval
= 300;
12037 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12038 doc
: /* *Number of seconds idle time before auto-save.
12039 Zero or nil means disable auto-saving due to idleness.
12040 After auto-saving due to this many seconds of idle time,
12041 Emacs also does a garbage collection if that seems to be warranted. */);
12042 XSETFASTINT (Vauto_save_timeout
, 30);
12044 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12045 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12046 The value may be integer or floating point. */);
12047 Vecho_keystrokes
= make_number (1);
12049 DEFVAR_INT ("polling-period", &polling_period
,
12050 doc
: /* *Interval between polling for input during Lisp execution.
12051 The reason for polling is to make C-g work to stop a running program.
12052 Polling is needed only when using X windows and SIGIO does not work.
12053 Polling is automatically disabled in all other cases. */);
12054 polling_period
= 2;
12056 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12057 doc
: /* *Maximum time between mouse clicks to make a double-click.
12058 Measured in milliseconds. The value nil means disable double-click
12059 recognition; t means double-clicks have no time limit and are detected
12060 by position only. */);
12061 Vdouble_click_time
= make_number (500);
12063 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12064 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12065 On window-system frames, value is the number of pixels the mouse may have
12066 moved horizontally or vertically between two clicks to make a double-click.
12067 On non window-system frames, value is interpreted in units of 1/8 characters
12070 This variable is also the threshold for motion of the mouse
12071 to count as a drag. */);
12072 double_click_fuzz
= 3;
12074 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12075 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12076 inhibit_local_menu_bar_menus
= 0;
12078 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12079 doc
: /* Number of complete key sequences read as input so far.
12080 This includes key sequences read from keyboard macros.
12081 The number is effectively the number of interactive command invocations. */);
12082 num_input_keys
= 0;
12084 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12085 doc
: /* Number of input events read from the keyboard so far.
12086 This does not include events generated by keyboard macros. */);
12087 num_nonmacro_input_events
= 0;
12089 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12090 doc
: /* The frame in which the most recently read event occurred.
12091 If the last event came from a keyboard macro, this is set to `macro'. */);
12092 Vlast_event_frame
= Qnil
;
12094 /* This variable is set up in sysdep.c. */
12095 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12096 doc
: /* The ERASE character as set by the user with stty. */);
12098 DEFVAR_LISP ("help-char", &Vhelp_char
,
12099 doc
: /* Character to recognize as meaning Help.
12100 When it is read, do `(eval help-form)', and display result if it's a string.
12101 If the value of `help-form' is nil, this char can be read normally. */);
12102 XSETINT (Vhelp_char
, Ctl ('H'));
12104 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12105 doc
: /* List of input events to recognize as meaning Help.
12106 These work just like the value of `help-char' (see that). */);
12107 Vhelp_event_list
= Qnil
;
12109 DEFVAR_LISP ("help-form", &Vhelp_form
,
12110 doc
: /* Form to execute when character `help-char' is read.
12111 If the form returns a string, that string is displayed.
12112 If `help-form' is nil, the help char is not recognized. */);
12115 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12116 doc
: /* Command to run when `help-char' character follows a prefix key.
12117 This command is used only when there is no actual binding
12118 for that character after that prefix key. */);
12119 Vprefix_help_command
= Qnil
;
12121 DEFVAR_LISP ("top-level", &Vtop_level
,
12122 doc
: /* Form to evaluate when Emacs starts up.
12123 Useful to set before you dump a modified Emacs. */);
12126 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12127 doc
: /* Translate table for local keyboard input, or nil.
12128 If non-nil, the value should be a char-table. Each character read
12129 from the keyboard is looked up in this char-table. If the value found
12130 there is non-nil, then it is used instead of the actual input character.
12132 The value can also be a string or vector, but this is considered obsolete.
12133 If it is a string or vector of length N, character codes N and up are left
12134 untranslated. In a vector, an element which is nil means "no translation".
12136 This is applied to the characters supplied to input methods, not their
12137 output. See also `translation-table-for-input'.
12139 This variable has a separate binding for each terminal.
12140 See Info node `(elisp)Multiple Terminals'. */);
12142 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12143 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12144 \(Even if the operating system has support for stopping a process.\) */);
12145 cannot_suspend
= 0;
12147 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12148 doc
: /* Non-nil means prompt with menus when appropriate.
12149 This is done when reading from a keymap that has a prompt string,
12150 for elements that have prompt strings.
12151 The menu is displayed on the screen
12152 if X menus were enabled at configuration
12153 time and the previous event was a mouse click prefix key.
12154 Otherwise, menu prompting uses the echo area. */);
12155 menu_prompting
= 1;
12157 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12158 doc
: /* Character to see next line of menu prompt.
12159 Type this character while in a menu prompt to rotate around the lines of it. */);
12160 XSETINT (menu_prompt_more_char
, ' ');
12162 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12163 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12164 Emacs applies the modifiers of the character stored here to each keyboard
12165 character it reads. For example, after evaluating the expression
12166 (setq extra-keyboard-modifiers ?\\C-x)
12167 all input characters will have the control modifier applied to them.
12169 Note that the character ?\\C-@, equivalent to the integer zero, does
12170 not count as a control character; rather, it counts as a character
12171 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12172 cancels any modification. */);
12173 extra_keyboard_modifiers
= 0;
12175 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12176 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12177 The command loop sets this to nil before each command,
12178 and tests the value when the command returns.
12179 Buffer modification stores t in this variable. */);
12180 Vdeactivate_mark
= Qnil
;
12181 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12182 staticpro (&Qdeactivate_mark
);
12184 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12185 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12186 Vcommand_hook_internal
= Qnil
;
12188 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12189 doc
: /* Normal hook run before each command is executed.
12190 If an unhandled error happens in running this hook,
12191 the hook value is set to nil, since otherwise the error
12192 might happen repeatedly and make Emacs nonfunctional. */);
12193 Vpre_command_hook
= Qnil
;
12195 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12196 doc
: /* Normal hook run after each command is executed.
12197 If an unhandled error happens in running this hook,
12198 the hook value is set to nil, since otherwise the error
12199 might happen repeatedly and make Emacs nonfunctional. */);
12200 Vpost_command_hook
= Qnil
;
12203 DEFVAR_LISP ("echo-area-clear-hook", ...,
12204 doc
: /* Normal hook run when clearing the echo area. */);
12206 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12207 staticpro (&Qecho_area_clear_hook
);
12208 Fset (Qecho_area_clear_hook
, Qnil
);
12210 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12211 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12212 Vlucid_menu_bar_dirty_flag
= Qnil
;
12214 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12215 doc
: /* List of menu bar items to move to the end of the menu bar.
12216 The elements of the list are event types that may have menu bar bindings. */);
12217 Vmenu_bar_final_items
= Qnil
;
12219 DEFVAR_KBOARD ("overriding-terminal-local-map",
12220 Voverriding_terminal_local_map
,
12221 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12222 If this variable is non-nil, it is used as a keymap instead of the
12223 buffer's local map, and the minor mode keymaps and text property keymaps.
12224 It also replaces `overriding-local-map'.
12226 This variable is intended to let commands such as `universal-argument'
12227 set up a different keymap for reading the next command.
12229 `overriding-terminal-local-map' has a separate binding for each
12231 See Info node `(elisp)Multiple Terminals'. */);
12233 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12234 doc
: /* Keymap that overrides all other local keymaps.
12235 If this variable is non-nil, it is used as a keymap--replacing the
12236 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12237 Voverriding_local_map
= Qnil
;
12239 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12240 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12241 Otherwise, the menu bar continues to reflect the buffer's local map
12242 and the minor mode maps regardless of `overriding-local-map'. */);
12243 Voverriding_local_map_menu_flag
= Qnil
;
12245 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12246 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12247 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12249 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12250 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12252 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12253 doc
: /* Alist of system-specific X windows key symbols.
12254 Each element should have the form (N . SYMBOL) where N is the
12255 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12256 and SYMBOL is its name.
12258 `system-key-alist' has a separate binding for each terminal device.
12259 See Info node `(elisp)Multiple Terminals'. */);
12261 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12262 doc
: /* Keymap that translates key sequences to key sequences during input.
12263 This is used mainly for mapping key sequences into some preferred
12264 key events (symbols).
12266 The `read-key-sequence' function replaces any subsequence bound by
12267 `local-function-key-map' with its binding. More precisely, when the
12268 active keymaps have no binding for the current key sequence but
12269 `local-function-key-map' binds a suffix of the sequence to a vector or
12270 string, `read-key-sequence' replaces the matching suffix with its
12271 binding, and continues with the new sequence.
12273 If the binding is a function, it is called with one argument (the prompt)
12274 and its return value (a key sequence) is used.
12276 The events that come from bindings in `local-function-key-map' are not
12277 themselves looked up in `local-function-key-map'.
12279 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12280 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12281 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12282 typing `ESC O P x' would return [f1 x].
12284 `local-function-key-map' has a separate binding for each terminal
12285 device. See Info node `(elisp)Multiple Terminals'. If you need to
12286 define a binding on all terminals, change `function-key-map'
12287 instead. Initially, `local-function-key-map' is an empty keymap that
12288 has `function-key-map' as its parent on all terminal devices. */);
12290 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12291 doc
: /* Keymap that decodes input escape sequences.
12292 This is used mainly for mapping ASCII function key sequences into
12293 real Emacs function key events (symbols).
12295 The `read-key-sequence' function replaces any subsequence bound by
12296 `input-decode-map' with its binding. Contrary to `function-key-map',
12297 this map applies its rebinding regardless of the presence of an ordinary
12298 binding. So it is more like `key-translation-map' except that it applies
12299 before `function-key-map' rather than after.
12301 If the binding is a function, it is called with one argument (the prompt)
12302 and its return value (a key sequence) is used.
12304 The events that come from bindings in `input-decode-map' are not
12305 themselves looked up in `input-decode-map'.
12307 This variable is keyboard-local. */);
12309 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12310 doc
: /* The parent keymap of all `local-function-key-map' instances.
12311 Function key definitions that apply to all terminal devices should go
12312 here. If a mapping is defined in both the current
12313 `local-function-key-map' binding and this variable, then the local
12314 definition will take precendence. */);
12315 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12317 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12318 doc
: /* Keymap of key translations that can override keymaps.
12319 This keymap works like `function-key-map', but comes after that,
12320 and its non-prefix bindings override ordinary bindings.
12321 Another difference is that it is global rather than keyboard-local. */);
12322 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12324 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12325 doc
: /* List of deferred actions to be performed at a later time.
12326 The precise format isn't relevant here; we just check whether it is nil. */);
12327 Vdeferred_action_list
= Qnil
;
12329 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12330 doc
: /* Function to call to handle deferred actions, after each command.
12331 This function is called with no arguments after each command
12332 whenever `deferred-action-list' is non-nil. */);
12333 Vdeferred_action_function
= Qnil
;
12335 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12336 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12337 The value can be a length of time to show the message for.
12338 If the value is non-nil and not a number, we wait 2 seconds. */);
12339 Vsuggest_key_bindings
= Qt
;
12341 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12342 doc
: /* List of active absolute time timers in order of increasing time. */);
12343 Vtimer_list
= Qnil
;
12345 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12346 doc
: /* List of active idle-time timers in order of increasing time. */);
12347 Vtimer_idle_list
= Qnil
;
12349 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12350 doc
: /* If non-nil, the function that implements the current input method.
12351 It's called with one argument, a printing character that was just read.
12352 \(That means a character with code 040...0176.)
12353 Typically this function uses `read-event' to read additional events.
12354 When it does so, it should first bind `input-method-function' to nil
12355 so it will not be called recursively.
12357 The function should return a list of zero or more events
12358 to be used as input. If it wants to put back some events
12359 to be reconsidered, separately, by the input method,
12360 it can add them to the beginning of `unread-command-events'.
12362 The input method function can find in `input-method-previous-message'
12363 the previous echo area message.
12365 The input method function should refer to the variables
12366 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12367 for guidance on what to do. */);
12368 Vinput_method_function
= Qnil
;
12370 DEFVAR_LISP ("input-method-previous-message",
12371 &Vinput_method_previous_message
,
12372 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12373 This variable exists because `read-event' clears the echo area
12374 before running the input method. It is nil if there was no message. */);
12375 Vinput_method_previous_message
= Qnil
;
12377 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12378 doc
: /* If non-nil, the function that implements the display of help.
12379 It's called with one argument, the help string to display. */);
12380 Vshow_help_function
= Qnil
;
12382 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12383 doc
: /* If non-nil, suppress point adjustment after executing a command.
12385 After a command is executed, if point is moved into a region that has
12386 special properties (e.g. composition, display), we adjust point to
12387 the boundary of the region. But, when a command sets this variable to
12388 non-nil, we suppress the point adjustment.
12390 This variable is set to nil before reading a command, and is checked
12391 just after executing the command. */);
12392 Vdisable_point_adjustment
= Qnil
;
12394 DEFVAR_LISP ("global-disable-point-adjustment",
12395 &Vglobal_disable_point_adjustment
,
12396 doc
: /* *If non-nil, always suppress point adjustment.
12398 The default value is nil, in which case, point adjustment are
12399 suppressed only after special commands that set
12400 `disable-point-adjustment' (which see) to non-nil. */);
12401 Vglobal_disable_point_adjustment
= Qnil
;
12403 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12404 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12405 If the value is not a number, such messages don't time out. */);
12406 Vminibuffer_message_timeout
= make_number (2);
12408 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12409 doc
: /* If non-nil, any keyboard input throws to this symbol.
12410 The value of that variable is passed to `quit-flag' and later causes a
12411 peculiar kind of quitting. */);
12412 Vthrow_on_input
= Qnil
;
12414 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12415 doc
: /* If non-nil, function to output error messages.
12416 The arguments are the error data, a list of the form
12417 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12418 such as just as `condition-case' would bind its variable to,
12419 the context (a string which normally goes at the start of the message),
12420 and the Lisp function within which the error was signaled. */);
12421 Vcommand_error_function
= Qnil
;
12423 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12424 &Venable_disabled_menus_and_buttons
,
12425 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12427 Help functions bind this to allow help on disabled menu items
12428 and tool-bar buttons. */);
12429 Venable_disabled_menus_and_buttons
= Qnil
;
12431 /* Create the initial keyboard. */
12432 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12433 init_kboard (initial_kboard
);
12434 /* Vwindow_system is left at t for now. */
12435 initial_kboard
->next_kboard
= all_kboards
;
12436 all_kboards
= initial_kboard
;
12440 keys_of_keyboard ()
12442 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12443 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12444 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12445 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12446 initial_define_key (meta_map
, 'x', "execute-extended-command");
12448 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12449 "handle-delete-frame");
12450 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12451 "ns-put-working-text");
12452 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12453 "ns-unput-working-text");
12454 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12455 current-prefix-arg, as is done in `handle-switch-frame'.
12456 But `handle-switch-frame is not run from the special-map.
12457 Commands from that map are run in a special way that automatically
12458 preserves the prefix-arg. Restoring the prefix arg here is not just
12459 redundant but harmful:
12461 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12462 - after the first prompt, the exit-minibuffer-hook is run which may
12463 iconify a frame and thus push a `iconify-frame' event.
12464 - after running exit-minibuffer-hook, current-prefix-arg is
12465 restored to the non-nil value it had before the prompt.
12466 - we enter the second prompt.
12467 current-prefix-arg is non-nil, prefix-arg is nil.
12468 - before running the first real event, we run the special iconify-frame
12469 event, but we pass the `special' arg to execute-command so
12470 current-prefix-arg and prefix-arg are left untouched.
12471 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12472 - the next key event will have a spuriously non-nil current-prefix-arg. */
12473 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12475 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12477 /* Handling it at such a low-level causes read_key_sequence to get
12478 * confused because it doesn't realize that the current_buffer was
12479 * changed by read_char.
12481 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12482 * "handle-select-window"); */
12483 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12484 "handle-save-session");
12487 /* Define a special event which is raised for dbus callback
12489 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12490 "dbus-handle-event");
12493 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12497 /* Mark the pointers in the kboard objects.
12498 Called by the Fgarbage_collector. */
12504 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12506 if (kb
->kbd_macro_buffer
)
12507 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12509 mark_object (kb
->Voverriding_terminal_local_map
);
12510 mark_object (kb
->Vlast_command
);
12511 mark_object (kb
->Vreal_last_command
);
12512 mark_object (kb
->Vkeyboard_translate_table
);
12513 mark_object (kb
->Vlast_repeatable_command
);
12514 mark_object (kb
->Vprefix_arg
);
12515 mark_object (kb
->Vlast_prefix_arg
);
12516 mark_object (kb
->kbd_queue
);
12517 mark_object (kb
->defining_kbd_macro
);
12518 mark_object (kb
->Vlast_kbd_macro
);
12519 mark_object (kb
->Vsystem_key_alist
);
12520 mark_object (kb
->system_key_syms
);
12521 mark_object (kb
->Vwindow_system
);
12522 mark_object (kb
->Vinput_decode_map
);
12523 mark_object (kb
->Vlocal_function_key_map
);
12524 mark_object (kb
->Vdefault_minibuffer_frame
);
12525 mark_object (kb
->echo_string
);
12528 struct input_event
*event
;
12529 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12531 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12532 event
= kbd_buffer
;
12533 if (event
->kind
!= SELECTION_REQUEST_EVENT
12534 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12536 mark_object (event
->x
);
12537 mark_object (event
->y
);
12539 mark_object (event
->frame_or_window
);
12540 mark_object (event
->arg
);
12545 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12546 (do not change this comment) */