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 Qconfig_changed_event
;
490 /* Lisp_Object Qmouse_movement; - also an event header */
492 /* Properties of event headers. */
493 Lisp_Object Qevent_kind
;
494 Lisp_Object Qevent_symbol_elements
;
496 /* menu item parts */
497 Lisp_Object Qmenu_enable
;
498 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
499 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
;
500 extern Lisp_Object Qmenu_item
;
502 /* An event header symbol HEAD may have a property named
503 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
504 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
505 mask of modifiers applied to it. If present, this is used to help
506 speed up parse_modifiers. */
507 Lisp_Object Qevent_symbol_element_mask
;
509 /* An unmodified event header BASE may have a property named
510 Qmodifier_cache, which is an alist mapping modifier masks onto
511 modified versions of BASE. If present, this helps speed up
513 Lisp_Object Qmodifier_cache
;
515 /* Symbols to use for parts of windows. */
516 Lisp_Object Qmode_line
;
517 Lisp_Object Qvertical_line
;
518 Lisp_Object Qvertical_scroll_bar
;
519 Lisp_Object Qmenu_bar
;
520 extern Lisp_Object Qleft_margin
, Qright_margin
;
521 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
522 extern Lisp_Object QCmap
;
524 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
525 Lisp_Object
Fthis_command_keys (void);
526 Lisp_Object Qextended_command_history
;
527 EMACS_TIME
timer_check (int do_it_now
);
529 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
531 extern char *x_get_keysym_name ();
533 static void record_menu_key (Lisp_Object c
);
534 static int echo_length (void);
536 Lisp_Object Qpolling_period
;
538 /* List of absolute timers. Appears in order of next scheduled event. */
539 Lisp_Object Vtimer_list
;
541 /* List of idle time timers. Appears in order of next scheduled event. */
542 Lisp_Object Vtimer_idle_list
;
544 /* Incremented whenever a timer is run. */
547 extern Lisp_Object Vprint_level
, Vprint_length
;
549 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
551 EMACS_TIME
*input_available_clear_time
;
553 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
554 Default is 1 if INTERRUPT_INPUT is defined. */
557 /* Nonzero while interrupts are temporarily deferred during redisplay. */
558 int interrupts_deferred
;
560 /* Allow m- file to inhibit use of FIONREAD. */
561 #ifdef BROKEN_FIONREAD
565 /* We are unable to use interrupts if FIONREAD is not available,
566 so flush SIGIO so we won't try. */
567 #if !defined (FIONREAD)
573 /* If we support a window system, turn on the code to poll periodically
574 to detect C-g. It isn't actually used when doing interrupt input. */
575 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
576 #define POLL_FOR_INPUT
579 /* After a command is executed, if point is moved into a region that
580 has specific properties (e.g. composition, display), we adjust
581 point to the boundary of the region. But, if a command sets this
582 variable to non-nil, we suppress this point adjustment. This
583 variable is set to nil before reading a command. */
585 Lisp_Object Vdisable_point_adjustment
;
587 /* If non-nil, always disable point adjustment. */
589 Lisp_Object Vglobal_disable_point_adjustment
;
591 /* The time when Emacs started being idle. */
593 static EMACS_TIME timer_idleness_start_time
;
595 /* After Emacs stops being idle, this saves the last value
596 of timer_idleness_start_time from when it was idle. */
598 static EMACS_TIME timer_last_idleness_start_time
;
600 /* If non-nil, events produced by disabled menu items and tool-bar
601 buttons are not ignored. Help functions bind this to allow help on
602 those items and buttons. */
603 Lisp_Object Venable_disabled_menus_and_buttons
;
606 /* Global variable declarations. */
608 /* Flags for readable_events. */
609 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
610 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
611 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
613 /* Function for init_keyboard to call with no args (if nonzero). */
614 void (*keyboard_init_hook
) ();
616 static int read_avail_input (int);
617 static void get_input_pending (int *, int);
618 static int readable_events (int);
619 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
621 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
623 static Lisp_Object
make_lispy_event (struct input_event
*);
624 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
625 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
626 enum scroll_bar_part
,
627 Lisp_Object
, Lisp_Object
,
630 static Lisp_Object
modify_event_symbol (int, unsigned, Lisp_Object
,
631 Lisp_Object
, char **,
632 Lisp_Object
*, unsigned);
633 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
634 static void save_getcjmp (jmp_buf);
635 static void restore_getcjmp (jmp_buf);
636 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
637 static void clear_event (struct input_event
*);
638 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
639 static SIGTYPE
interrupt_signal (int signalnum
);
640 static void handle_interrupt (void);
641 static void timer_start_idle (void);
642 static void timer_stop_idle (void);
643 static void timer_resume_idle (void);
644 static SIGTYPE
handle_user_signal (int);
645 static char *find_user_signal_name (int);
646 static int store_user_signal_events (void);
648 /* Nonzero means don't try to suspend even if the operating system seems
650 static int cannot_suspend
;
652 extern Lisp_Object Qidentity
, Qonly
;
654 /* Install the string STR as the beginning of the string of echoing,
655 so that it serves as a prompt for the next character.
656 Also start echoing. */
659 echo_prompt (Lisp_Object str
)
661 current_kboard
->echo_string
= str
;
662 current_kboard
->echo_after_prompt
= SCHARS (str
);
666 /* Add C to the echo string, if echoing is going on.
667 C can be a character, which is printed prettily ("M-C-x" and all that
668 jazz), or a symbol, whose name is printed. */
671 echo_char (Lisp_Object c
)
673 if (current_kboard
->immediate_echo
)
675 int size
= KEY_DESCRIPTION_SIZE
+ 100;
676 char *buffer
= (char *) alloca (size
);
678 Lisp_Object echo_string
;
680 echo_string
= current_kboard
->echo_string
;
682 /* If someone has passed us a composite event, use its head symbol. */
687 ptr
= push_key_description (XINT (c
), ptr
, 1);
689 else if (SYMBOLP (c
))
691 Lisp_Object name
= SYMBOL_NAME (c
);
692 int nbytes
= SBYTES (name
);
694 if (size
- (ptr
- buffer
) < nbytes
)
696 int offset
= ptr
- buffer
;
697 size
= max (2 * size
, size
+ nbytes
);
698 buffer
= (char *) alloca (size
);
699 ptr
= buffer
+ offset
;
702 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
703 STRING_MULTIBYTE (name
), 1);
706 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
709 const char *text
= " (Type ? for further options)";
710 int len
= strlen (text
);
712 if (size
- (ptr
- buffer
) < len
)
714 int offset
= ptr
- buffer
;
716 buffer
= (char *) alloca (size
);
717 ptr
= buffer
+ offset
;
720 bcopy (text
, ptr
, len
);
724 /* Replace a dash from echo_dash with a space, otherwise
725 add a space at the end as a separator between keys. */
726 if (STRINGP (echo_string
)
727 && SCHARS (echo_string
) > 1)
729 Lisp_Object last_char
, prev_char
, idx
;
731 idx
= make_number (SCHARS (echo_string
) - 2);
732 prev_char
= Faref (echo_string
, idx
);
734 idx
= make_number (SCHARS (echo_string
) - 1);
735 last_char
= Faref (echo_string
, idx
);
737 /* We test PREV_CHAR to make sure this isn't the echoing
739 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
740 Faset (echo_string
, idx
, make_number (' '));
742 echo_string
= concat2 (echo_string
, build_string (" "));
744 else if (STRINGP (echo_string
))
745 echo_string
= concat2 (echo_string
, build_string (" "));
747 current_kboard
->echo_string
748 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
754 /* Temporarily add a dash to the end of the echo string if it's not
755 empty, so that it serves as a mini-prompt for the very next character. */
760 /* Do nothing if not echoing at all. */
761 if (NILP (current_kboard
->echo_string
))
764 if (!current_kboard
->immediate_echo
765 && SCHARS (current_kboard
->echo_string
) == 0)
768 /* Do nothing if we just printed a prompt. */
769 if (current_kboard
->echo_after_prompt
770 == SCHARS (current_kboard
->echo_string
))
773 /* Do nothing if we have already put a dash at the end. */
774 if (SCHARS (current_kboard
->echo_string
) > 1)
776 Lisp_Object last_char
, prev_char
, idx
;
778 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
779 prev_char
= Faref (current_kboard
->echo_string
, idx
);
781 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
782 last_char
= Faref (current_kboard
->echo_string
, idx
);
784 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
788 /* Put a dash at the end of the buffer temporarily,
789 but make it go away when the next character is added. */
790 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
795 /* Display the current echo string, and begin echoing if not already
801 if (!current_kboard
->immediate_echo
)
804 current_kboard
->immediate_echo
= 1;
806 for (i
= 0; i
< this_command_key_count
; i
++)
810 /* Set before_command_echo_length to the value that would
811 have been saved before the start of this subcommand in
812 command_loop_1, if we had already been echoing then. */
813 if (i
== this_single_command_key_start
)
814 before_command_echo_length
= echo_length ();
816 c
= XVECTOR (this_command_keys
)->contents
[i
];
817 if (! (EVENT_HAS_PARAMETERS (c
)
818 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
822 /* Set before_command_echo_length to the value that would
823 have been saved before the start of this subcommand in
824 command_loop_1, if we had already been echoing then. */
825 if (this_command_key_count
== this_single_command_key_start
)
826 before_command_echo_length
= echo_length ();
828 /* Put a dash at the end to invite the user to type more. */
833 message3_nolog (current_kboard
->echo_string
,
834 SBYTES (current_kboard
->echo_string
),
835 STRING_MULTIBYTE (current_kboard
->echo_string
));
838 /* Record in what buffer we echoed, and from which kboard. */
839 echo_message_buffer
= echo_area_buffer
[0];
840 echo_kboard
= current_kboard
;
842 if (waiting_for_input
&& !NILP (Vquit_flag
))
843 quit_throw_to_read_char ();
846 /* Turn off echoing, for the start of a new command. */
849 cancel_echoing (void)
851 current_kboard
->immediate_echo
= 0;
852 current_kboard
->echo_after_prompt
= -1;
853 current_kboard
->echo_string
= Qnil
;
854 ok_to_echo_at_next_pause
= NULL
;
856 echo_message_buffer
= Qnil
;
859 /* Return the length of the current echo string. */
864 return (STRINGP (current_kboard
->echo_string
)
865 ? SCHARS (current_kboard
->echo_string
)
869 /* Truncate the current echo message to its first LEN chars.
870 This and echo_char get used by read_key_sequence when the user
871 switches frames while entering a key sequence. */
874 echo_truncate (int nchars
)
876 if (STRINGP (current_kboard
->echo_string
))
877 current_kboard
->echo_string
878 = Fsubstring (current_kboard
->echo_string
,
879 make_number (0), make_number (nchars
));
880 truncate_echo_area (nchars
);
884 /* Functions for manipulating this_command_keys. */
886 add_command_key (Lisp_Object key
)
888 #if 0 /* Not needed after we made Freset_this_command_lengths
889 do the job immediately. */
890 /* If reset-this-command-length was called recently, obey it now.
891 See the doc string of that function for an explanation of why. */
892 if (before_command_restore_flag
)
894 this_command_key_count
= before_command_key_count_1
;
895 if (this_command_key_count
< this_single_command_key_start
)
896 this_single_command_key_start
= this_command_key_count
;
897 echo_truncate (before_command_echo_length_1
);
898 before_command_restore_flag
= 0;
902 if (this_command_key_count
>= ASIZE (this_command_keys
))
903 this_command_keys
= larger_vector (this_command_keys
,
904 2 * ASIZE (this_command_keys
),
907 ASET (this_command_keys
, this_command_key_count
, key
);
908 ++this_command_key_count
;
913 recursive_edit_1 (void)
915 int count
= SPECPDL_INDEX ();
918 if (command_loop_level
> 0)
920 specbind (Qstandard_output
, Qt
);
921 specbind (Qstandard_input
, Qt
);
924 #ifdef HAVE_WINDOW_SYSTEM
925 /* The command loop has started an hourglass timer, so we have to
926 cancel it here, otherwise it will fire because the recursive edit
927 can take some time. Do not check for display_hourglass_p here,
928 because it could already be nil. */
932 /* This function may have been called from a debugger called from
933 within redisplay, for instance by Edebugging a function called
934 from fontification-functions. We want to allow redisplay in
935 the debugging session.
937 The recursive edit is left with a `(throw exit ...)'. The `exit'
938 tag is not caught anywhere in redisplay, i.e. when we leave the
939 recursive edit, the original redisplay leading to the recursive
940 edit will be unwound. The outcome should therefore be safe. */
941 specbind (Qinhibit_redisplay
, Qnil
);
944 val
= command_loop ();
946 Fsignal (Qquit
, Qnil
);
947 /* Handle throw from read_minibuf when using minibuffer
948 while it's active but we're in another window. */
950 xsignal1 (Qerror
, val
);
952 return unbind_to (count
, Qnil
);
955 /* When an auto-save happens, record the "time", and don't do again soon. */
958 record_auto_save (void)
960 last_auto_save
= num_nonmacro_input_events
;
963 /* Make an auto save happen as soon as possible at command level. */
966 force_auto_save_soon (void)
968 last_auto_save
= - auto_save_interval
- 1;
970 record_asynch_buffer_change ();
973 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
974 doc
: /* Invoke the editor command loop recursively.
975 To get out of the recursive edit, a command can do `(throw 'exit nil)';
976 that tells this function to return.
977 Alternatively, `(throw 'exit t)' makes this function signal an error.
978 This function is called by the editor initialization to begin editing. */)
981 int count
= SPECPDL_INDEX ();
984 /* If we enter while input is blocked, don't lock up here.
985 This may happen through the debugger during redisplay. */
989 command_loop_level
++;
990 update_mode_lines
= 1;
992 if (command_loop_level
993 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
994 buffer
= Fcurrent_buffer ();
998 /* If we leave recursive_edit_1 below with a `throw' for instance,
999 like it is done in the splash screen display, we have to
1000 make sure that we restore single_kboard as command_loop_1
1001 would have done if it were left normally. */
1002 if (command_loop_level
> 0)
1003 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1004 record_unwind_protect (recursive_edit_unwind
, buffer
);
1006 recursive_edit_1 ();
1007 return unbind_to (count
, Qnil
);
1011 recursive_edit_unwind (Lisp_Object buffer
)
1013 if (BUFFERP (buffer
))
1014 Fset_buffer (buffer
);
1016 command_loop_level
--;
1017 update_mode_lines
= 1;
1022 #if 0 /* These two functions are now replaced with
1023 temporarily_switch_to_single_kboard. */
1027 #if 0 /* Theory: if there's anything in Vunread_command_events,
1028 it will right away be read by read_key_sequence,
1029 and then if we do switch KBOARDS, it will go into the side
1030 queue then. So we don't need to do anything special here -- rms. */
1031 if (CONSP (Vunread_command_events
))
1033 current_kboard
->kbd_queue
1034 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1035 current_kboard
->kbd_queue_has_data
= 1;
1037 Vunread_command_events
= Qnil
;
1042 /* Switch to the single-kboard state, making current_kboard
1043 the only KBOARD from which further input is accepted. */
1046 single_kboard_state ()
1052 /* If we're in single_kboard state for kboard KBOARD,
1056 not_single_kboard_state (KBOARD
*kboard
)
1058 if (kboard
== current_kboard
)
1062 /* Maintain a stack of kboards, so other parts of Emacs
1063 can switch temporarily to the kboard of a given frame
1064 and then revert to the previous status. */
1069 struct kboard_stack
*next
;
1072 static struct kboard_stack
*kboard_stack
;
1075 push_kboard (struct kboard
*k
)
1077 struct kboard_stack
*p
1078 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1080 p
->next
= kboard_stack
;
1081 p
->kboard
= current_kboard
;
1091 struct kboard_stack
*p
= kboard_stack
;
1093 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1095 if (t
->kboard
== p
->kboard
)
1097 current_kboard
= p
->kboard
;
1104 /* The terminal we remembered has been deleted. */
1105 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1108 kboard_stack
= p
->next
;
1112 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1113 from which further input is accepted. If F is non-nil, set its
1114 KBOARD as the current keyboard.
1116 This function uses record_unwind_protect to return to the previous
1119 If Emacs is already in single_kboard mode, and F's keyboard is
1120 locked, then this function will throw an errow. */
1123 temporarily_switch_to_single_kboard (struct frame
*f
)
1125 int was_locked
= single_kboard
;
1128 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1129 /* We can not switch keyboards while in single_kboard mode.
1130 In rare cases, Lisp code may call `recursive-edit' (or
1131 `read-minibuffer' or `y-or-n-p') after it switched to a
1132 locked frame. For example, this is likely to happen
1133 when server.el connects to a new terminal while Emacs is in
1134 single_kboard mode. It is best to throw an error instead
1135 of presenting the user with a frozen screen. */
1136 error ("Terminal %d is locked, cannot read from it",
1137 FRAME_TERMINAL (f
)->id
);
1139 /* This call is unnecessary, but helps
1140 `restore_kboard_configuration' discover if somebody changed
1141 `current_kboard' behind our back. */
1142 push_kboard (current_kboard
);
1145 current_kboard
= FRAME_KBOARD (f
);
1147 record_unwind_protect (restore_kboard_configuration
,
1148 (was_locked
? Qt
: Qnil
));
1151 #if 0 /* This function is not needed anymore. */
1153 record_single_kboard_state ()
1156 push_kboard (current_kboard
);
1157 record_unwind_protect (restore_kboard_configuration
,
1158 (single_kboard
? Qt
: Qnil
));
1163 restore_kboard_configuration (Lisp_Object was_locked
)
1165 if (NILP (was_locked
))
1169 struct kboard
*prev
= current_kboard
;
1172 /* The pop should not change the kboard. */
1173 if (single_kboard
&& current_kboard
!= prev
)
1180 /* Handle errors that are not handled at inner levels
1181 by printing an error message and returning to the editor command loop. */
1184 cmd_error (Lisp_Object data
)
1186 Lisp_Object old_level
, old_length
;
1187 char macroerror
[50];
1189 #ifdef HAVE_WINDOW_SYSTEM
1190 if (display_hourglass_p
)
1191 cancel_hourglass ();
1194 if (!NILP (executing_kbd_macro
))
1196 if (executing_kbd_macro_iterations
== 1)
1197 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1199 sprintf (macroerror
, "After %d kbd macro iterations: ",
1200 executing_kbd_macro_iterations
);
1205 Vstandard_output
= Qt
;
1206 Vstandard_input
= Qt
;
1207 Vexecuting_kbd_macro
= Qnil
;
1208 executing_kbd_macro
= Qnil
;
1209 current_kboard
->Vprefix_arg
= Qnil
;
1210 current_kboard
->Vlast_prefix_arg
= Qnil
;
1213 /* Avoid unquittable loop if data contains a circular list. */
1214 old_level
= Vprint_level
;
1215 old_length
= Vprint_length
;
1216 XSETFASTINT (Vprint_level
, 10);
1217 XSETFASTINT (Vprint_length
, 10);
1218 cmd_error_internal (data
, macroerror
);
1219 Vprint_level
= old_level
;
1220 Vprint_length
= old_length
;
1224 Vinhibit_quit
= Qnil
;
1225 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1226 if (command_loop_level
== 0 && minibuf_level
== 0)
1227 any_kboard_state ();
1230 return make_number (0);
1233 /* Take actions on handling an error. DATA is the data that describes
1236 CONTEXT is a C-string containing ASCII characters only which
1237 describes the context in which the error happened. If we need to
1238 generalize CONTEXT to allow multibyte characters, make it a Lisp
1242 cmd_error_internal (Lisp_Object data
, char *context
)
1244 struct frame
*sf
= SELECTED_FRAME ();
1246 /* The immediate context is not interesting for Quits,
1247 since they are asyncronous. */
1248 if (EQ (XCAR (data
), Qquit
))
1249 Vsignaling_function
= Qnil
;
1254 /* Use user's specified output function if any. */
1255 if (!NILP (Vcommand_error_function
))
1256 call3 (Vcommand_error_function
, data
,
1257 context
? build_string (context
) : empty_unibyte_string
,
1258 Vsignaling_function
);
1259 /* If the window system or terminal frame hasn't been initialized
1260 yet, or we're not interactive, write the message to stderr and exit. */
1261 else if (!sf
->glyphs_initialized_p
1262 /* The initial frame is a special non-displaying frame. It
1263 will be current in daemon mode when there are no frames
1264 to display, and in non-daemon mode before the real frame
1265 has finished initializing. If an error is thrown in the
1266 latter case while creating the frame, then the frame
1267 will never be displayed, so the safest thing to do is
1268 write to stderr and quit. In daemon mode, there are
1269 many other potential errors that do not prevent frames
1270 from being created, so continuing as normal is better in
1272 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1275 print_error_message (data
, Qexternal_debugging_output
,
1276 context
, Vsignaling_function
);
1277 Fterpri (Qexternal_debugging_output
);
1278 Fkill_emacs (make_number (-1));
1282 clear_message (1, 0);
1284 message_log_maybe_newline ();
1287 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1290 Vsignaling_function
= Qnil
;
1293 Lisp_Object
command_loop_1 (void);
1294 Lisp_Object
command_loop_2 (Lisp_Object
);
1295 Lisp_Object
top_level_1 (Lisp_Object
);
1297 /* Entry to editor-command-loop.
1298 This level has the catches for exiting/returning to editor command loop.
1299 It returns nil to exit recursive edit, t to abort it. */
1304 if (command_loop_level
> 0 || minibuf_level
> 0)
1307 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1308 executing_kbd_macro
= Qnil
;
1314 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1315 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1316 /* Reset single_kboard in case top-level set it while
1317 evaluating an -f option, or we are stuck there for some
1319 any_kboard_state ();
1321 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1322 executing_kbd_macro
= Qnil
;
1324 /* End of file in -batch run causes exit here. */
1330 /* Here we catch errors in execution of commands within the
1331 editing loop, and reenter the editing loop.
1332 When there is an error, cmd_error runs and returns a non-nil
1333 value to us. A value of nil means that command_loop_1 itself
1334 returned due to end of file (or end of kbd macro). */
1337 command_loop_2 (Lisp_Object ignore
)
1339 register Lisp_Object val
;
1342 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1343 while (!NILP (val
));
1351 return Feval (Vtop_level
);
1355 top_level_1 (Lisp_Object ignore
)
1357 /* On entry to the outer level, run the startup file */
1358 if (!NILP (Vtop_level
))
1359 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1360 else if (!NILP (Vpurify_flag
))
1361 message ("Bare impure Emacs (standard Lisp code not loaded)");
1363 message ("Bare Emacs (standard Lisp code not loaded)");
1367 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1368 doc
: /* Exit all recursive editing levels.
1369 This also exits all active minibuffers. */)
1372 #ifdef HAVE_WINDOW_SYSTEM
1373 if (display_hourglass_p
)
1374 cancel_hourglass ();
1377 /* Unblock input if we enter with input blocked. This may happen if
1378 redisplay traps e.g. during tool-bar update with input blocked. */
1379 while (INPUT_BLOCKED_P
)
1382 return Fthrow (Qtop_level
, Qnil
);
1385 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1386 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1389 if (command_loop_level
> 0 || minibuf_level
> 0)
1390 Fthrow (Qexit
, Qnil
);
1392 error ("No recursive edit is in progress");
1396 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1397 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1400 if (command_loop_level
> 0 || minibuf_level
> 0)
1403 error ("No recursive edit is in progress");
1407 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1409 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1410 of this function. */
1413 tracking_off (Lisp_Object old_value
)
1415 do_mouse_tracking
= old_value
;
1416 if (NILP (old_value
))
1418 /* Redisplay may have been preempted because there was input
1419 available, and it assumes it will be called again after the
1420 input has been processed. If the only input available was
1421 the sort that we have just disabled, then we need to call
1423 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1425 redisplay_preserve_echo_area (6);
1426 get_input_pending (&input_pending
,
1427 READABLE_EVENTS_DO_TIMERS_NOW
);
1433 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1434 doc
: /* Evaluate BODY with mouse movement events enabled.
1435 Within a `track-mouse' form, mouse motion generates input events that
1436 you can read with `read-event'.
1437 Normally, mouse motion is ignored.
1438 usage: (track-mouse BODY...) */)
1442 int count
= SPECPDL_INDEX ();
1445 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1447 do_mouse_tracking
= Qt
;
1449 val
= Fprogn (args
);
1450 return unbind_to (count
, val
);
1453 /* If mouse has moved on some frame, return one of those frames.
1457 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1458 after resizing the tool-bar window. */
1460 int ignore_mouse_drag_p
;
1463 some_mouse_moved (void)
1465 Lisp_Object tail
, frame
;
1467 if (ignore_mouse_drag_p
)
1469 /* ignore_mouse_drag_p = 0; */
1473 FOR_EACH_FRAME (tail
, frame
)
1475 if (XFRAME (frame
)->mouse_moved
)
1476 return XFRAME (frame
);
1482 #endif /* HAVE_MOUSE || HAVE_GPM */
1484 /* This is the actual command reading loop,
1485 sans error-handling encapsulation. */
1487 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1489 void safe_run_hooks (Lisp_Object
);
1490 static void adjust_point_for_property (int, int);
1492 /* Cancel hourglass from protect_unwind.
1494 #ifdef HAVE_WINDOW_SYSTEM
1496 cancel_hourglass_unwind (Lisp_Object arg
)
1498 cancel_hourglass ();
1504 command_loop_1 (void)
1507 Lisp_Object keybuf
[30];
1509 int prev_modiff
= 0;
1510 struct buffer
*prev_buffer
= NULL
;
1511 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1512 int was_locked
= single_kboard
;
1514 int already_adjusted
= 0;
1516 current_kboard
->Vprefix_arg
= Qnil
;
1517 current_kboard
->Vlast_prefix_arg
= Qnil
;
1518 Vdeactivate_mark
= Qnil
;
1519 waiting_for_input
= 0;
1522 this_command_key_count
= 0;
1523 this_command_key_count_reset
= 0;
1524 this_single_command_key_start
= 0;
1526 if (NILP (Vmemory_full
))
1528 /* Make sure this hook runs after commands that get errors and
1529 throw to top level. */
1530 /* Note that the value cell will never directly contain nil
1531 if the symbol is a local variable. */
1532 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1533 safe_run_hooks (Qpost_command_hook
);
1535 /* If displaying a message, resize the echo area window to fit
1536 that message's size exactly. */
1537 if (!NILP (echo_area_buffer
[0]))
1538 resize_echo_area_exactly ();
1540 if (!NILP (Vdeferred_action_list
))
1541 safe_run_hooks (Qdeferred_action_function
);
1544 /* Do this after running Vpost_command_hook, for consistency. */
1545 current_kboard
->Vlast_command
= Vthis_command
;
1546 current_kboard
->Vreal_last_command
= real_this_command
;
1547 if (!CONSP (last_command_event
))
1548 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1552 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1555 /* Make sure the current window's buffer is selected. */
1556 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1557 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1559 /* Display any malloc warning that just came out. Use while because
1560 displaying one warning can cause another. */
1562 while (pending_malloc_warning
)
1563 display_malloc_warning ();
1565 Vdeactivate_mark
= Qnil
;
1567 /* If minibuffer on and echo area in use,
1568 wait a short time and redraw minibuffer. */
1571 && !NILP (echo_area_buffer
[0])
1572 && EQ (minibuf_window
, echo_area_window
)
1573 && NUMBERP (Vminibuffer_message_timeout
))
1575 /* Bind inhibit-quit to t so that C-g gets read in
1576 rather than quitting back to the minibuffer. */
1577 int count
= SPECPDL_INDEX ();
1578 specbind (Qinhibit_quit
, Qt
);
1580 sit_for (Vminibuffer_message_timeout
, 0, 2);
1582 /* Clear the echo area. */
1584 safe_run_hooks (Qecho_area_clear_hook
);
1586 unbind_to (count
, Qnil
);
1588 /* If a C-g came in before, treat it as input now. */
1589 if (!NILP (Vquit_flag
))
1592 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1597 /* Select the frame that the last event came from. Usually,
1598 switch-frame events will take care of this, but if some lisp
1599 code swallows a switch-frame event, we'll fix things up here.
1600 Is this a good idea? */
1601 if (FRAMEP (internal_last_event_frame
)
1602 && !EQ (internal_last_event_frame
, selected_frame
))
1603 Fselect_frame (internal_last_event_frame
, Qnil
);
1605 /* If it has changed current-menubar from previous value,
1606 really recompute the menubar from the value. */
1607 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1608 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1609 call0 (Qrecompute_lucid_menubar
);
1611 before_command_key_count
= this_command_key_count
;
1612 before_command_echo_length
= echo_length ();
1614 Vthis_command
= Qnil
;
1615 real_this_command
= Qnil
;
1616 Vthis_original_command
= Qnil
;
1617 Vthis_command_keys_shift_translated
= Qnil
;
1619 /* Read next key sequence; i gets its length. */
1620 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1623 /* A filter may have run while we were reading the input. */
1624 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1626 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1627 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1631 /* Now we have read a key sequence of length I,
1632 or else I is 0 and we found end of file. */
1634 if (i
== 0) /* End of file -- happens only in */
1635 return Qnil
; /* a kbd macro, at the end. */
1636 /* -1 means read_key_sequence got a menu that was rejected.
1637 Just loop around and read another command. */
1641 this_command_key_count
= 0;
1642 this_command_key_count_reset
= 0;
1643 this_single_command_key_start
= 0;
1647 last_command_event
= keybuf
[i
- 1];
1649 /* If the previous command tried to force a specific window-start,
1650 forget about that, in case this command moves point far away
1651 from that position. But also throw away beg_unchanged and
1652 end_unchanged information in that case, so that redisplay will
1653 update the whole window properly. */
1654 if (!NILP (XWINDOW (selected_window
)->force_start
))
1657 XWINDOW (selected_window
)->force_start
= Qnil
;
1658 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1659 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1662 cmd
= read_key_sequence_cmd
;
1663 if (!NILP (Vexecuting_kbd_macro
))
1665 if (!NILP (Vquit_flag
))
1667 Vexecuting_kbd_macro
= Qt
;
1668 QUIT
; /* Make some noise. */
1669 /* Will return since macro now empty. */
1673 /* Do redisplay processing after this command except in special
1674 cases identified below. */
1675 prev_buffer
= current_buffer
;
1676 prev_modiff
= MODIFF
;
1677 last_point_position
= PT
;
1678 last_point_position_window
= selected_window
;
1679 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1681 /* By default, we adjust point to a boundary of a region that
1682 has such a property that should be treated intangible
1683 (e.g. composition, display). But, some commands will set
1684 this variable differently. */
1685 Vdisable_point_adjustment
= Qnil
;
1687 /* Process filters and timers may have messed with deactivate-mark.
1688 reset it before we execute the command. */
1689 Vdeactivate_mark
= Qnil
;
1691 /* Remap command through active keymaps */
1692 Vthis_original_command
= cmd
;
1696 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1700 /* Execute the command. */
1702 Vthis_command
= cmd
;
1703 real_this_command
= cmd
;
1704 /* Note that the value cell will never directly contain nil
1705 if the symbol is a local variable. */
1706 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1707 safe_run_hooks (Qpre_command_hook
);
1709 already_adjusted
= 0;
1711 if (NILP (Vthis_command
))
1713 /* nil means key is undefined. */
1714 Lisp_Object keys
= Fvector (i
, keybuf
);
1715 keys
= Fkey_description (keys
, Qnil
);
1717 message_with_string ("%s is undefined", keys
, 0);
1718 current_kboard
->defining_kbd_macro
= Qnil
;
1719 update_mode_lines
= 1;
1720 current_kboard
->Vprefix_arg
= Qnil
;
1724 /* Here for a command that isn't executed directly */
1726 #ifdef HAVE_WINDOW_SYSTEM
1727 int scount
= SPECPDL_INDEX ();
1729 if (display_hourglass_p
1730 && NILP (Vexecuting_kbd_macro
))
1732 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1737 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1739 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1741 #ifdef HAVE_WINDOW_SYSTEM
1742 /* Do not check display_hourglass_p here, because
1743 Fcommand_execute could change it, but we should cancel
1744 hourglass cursor anyway.
1745 But don't cancel the hourglass within a macro
1746 just because a command in the macro finishes. */
1747 if (NILP (Vexecuting_kbd_macro
))
1748 unbind_to (scount
, Qnil
);
1751 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1753 /* Note that the value cell will never directly contain nil
1754 if the symbol is a local variable. */
1755 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1756 safe_run_hooks (Qpost_command_hook
);
1758 /* If displaying a message, resize the echo area window to fit
1759 that message's size exactly. */
1760 if (!NILP (echo_area_buffer
[0]))
1761 resize_echo_area_exactly ();
1763 if (!NILP (Vdeferred_action_list
))
1764 safe_run_hooks (Qdeferred_action_function
);
1766 /* If there is a prefix argument,
1767 1) We don't want Vlast_command to be ``universal-argument''
1768 (that would be dumb), so don't set Vlast_command,
1769 2) we want to leave echoing on so that the prefix will be
1770 echoed as part of this key sequence, so don't call
1772 3) we want to leave this_command_key_count non-zero, so that
1773 read_char will realize that it is re-reading a character, and
1774 not echo it a second time.
1776 If the command didn't actually create a prefix arg,
1777 but is merely a frame event that is transparent to prefix args,
1778 then the above doesn't apply. */
1779 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1781 current_kboard
->Vlast_command
= Vthis_command
;
1782 current_kboard
->Vreal_last_command
= real_this_command
;
1783 if (!CONSP (last_command_event
))
1784 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1786 this_command_key_count
= 0;
1787 this_command_key_count_reset
= 0;
1788 this_single_command_key_start
= 0;
1791 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1793 /* In Emacs 22, setting transient-mark-mode to `only' was a
1794 way of turning it on for just one command. This usage is
1795 obsolete, but support it anyway. */
1796 if (EQ (Vtransient_mark_mode
, Qidentity
))
1797 Vtransient_mark_mode
= Qnil
;
1798 else if (EQ (Vtransient_mark_mode
, Qonly
))
1799 Vtransient_mark_mode
= Qidentity
;
1801 if (!NILP (Vdeactivate_mark
))
1802 call0 (Qdeactivate_mark
);
1803 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1804 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1809 if (current_buffer
== prev_buffer
1810 && last_point_position
!= PT
1811 && NILP (Vdisable_point_adjustment
)
1812 && NILP (Vglobal_disable_point_adjustment
))
1814 if (last_point_position
> BEGV
1815 && last_point_position
< ZV
1816 && (composition_adjust_point (last_point_position
,
1817 last_point_position
)
1818 != last_point_position
))
1819 /* The last point was temporarily set within a grapheme
1820 cluster to prevent automatic composition. To recover
1821 the automatic composition, we must update the
1823 windows_or_buffers_changed
++;
1824 if (!already_adjusted
)
1825 adjust_point_for_property (last_point_position
,
1826 MODIFF
!= prev_modiff
);
1829 /* Install chars successfully executed in kbd macro. */
1831 if (!NILP (current_kboard
->defining_kbd_macro
)
1832 && NILP (current_kboard
->Vprefix_arg
))
1833 finalize_kbd_macro_chars ();
1834 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1836 any_kboard_state ();
1841 extern Lisp_Object Qcomposition
, Qdisplay
;
1843 /* Adjust point to a boundary of a region that has such a property
1844 that should be treated intangible. For the moment, we check
1845 `composition', `display' and `invisible' properties.
1846 LAST_PT is the last position of point. */
1848 extern Lisp_Object Qafter_string
, Qbefore_string
;
1849 extern Lisp_Object
get_pos_property (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1852 adjust_point_for_property (int last_pt
, int modified
)
1855 Lisp_Object val
, overlay
, tmp
;
1856 /* When called after buffer modification, we should temporarily
1857 suppress the point adjustment for automatic composition so that a
1858 user can keep inserting another character at point or keep
1859 deleting characters around point. */
1860 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1863 /* FIXME: cycling is probably not necessary because these properties
1864 can't be usefully combined anyway. */
1865 while (check_composition
|| check_display
|| check_invisible
)
1867 /* FIXME: check `intangible'. */
1868 if (check_composition
1869 && PT
> BEGV
&& PT
< ZV
1870 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1873 check_display
= check_invisible
= 1;
1875 check_composition
= 0;
1877 && PT
> BEGV
&& PT
< ZV
1878 && !NILP (val
= get_char_property_and_overlay
1879 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1880 && display_prop_intangible_p (val
)
1881 && (!OVERLAYP (overlay
)
1882 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1883 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1884 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1885 && (beg
< PT
/* && end > PT <- It's always the case. */
1886 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1889 SET_PT (PT
< last_pt
1890 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1892 check_composition
= check_invisible
= 1;
1895 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1897 int inv
, ellipsis
= 0;
1900 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1903 /* FIXME: We should stop if we find a spot between
1904 two runs of `invisible' where inserted text would
1905 be visible. This is important when we have two
1906 invisible boundaries that enclose an area: if the
1907 area is empty, we need this test in order to make
1908 it possible to place point in the middle rather
1909 than skip both boundaries. However, this code
1910 also stops anywhere in a non-sticky text-property,
1911 which breaks (e.g.) Org mode. */
1912 && (val
= get_pos_property (make_number (end
),
1914 TEXT_PROP_MEANS_INVISIBLE (val
))
1916 && !NILP (val
= get_char_property_and_overlay
1917 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1918 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1920 ellipsis
= ellipsis
|| inv
> 1
1921 || (OVERLAYP (overlay
)
1922 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1923 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1924 tmp
= Fnext_single_char_property_change
1925 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1926 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1930 && (val
= get_pos_property (make_number (beg
),
1932 TEXT_PROP_MEANS_INVISIBLE (val
))
1934 && !NILP (val
= get_char_property_and_overlay
1935 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1936 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1938 ellipsis
= ellipsis
|| inv
> 1
1939 || (OVERLAYP (overlay
)
1940 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1941 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1942 tmp
= Fprevious_single_char_property_change
1943 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1944 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1947 /* Move away from the inside area. */
1948 if (beg
< PT
&& end
> PT
)
1950 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1951 /* We haven't moved yet (so we don't need to fear
1952 infinite-looping) and we were outside the range
1953 before (so either end of the range still corresponds
1954 to a move in the right direction): pretend we moved
1955 less than we actually did, so that we still have
1956 more freedom below in choosing which end of the range
1958 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1959 /* We either have moved already or the last point
1960 was already in the range: we don't get to choose
1961 which end of the range we have to go to. */
1962 : (PT
< last_pt
? beg
: end
));
1963 check_composition
= check_display
= 1;
1965 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1966 the point to something other than its argument, due to
1967 point-motion hooks, intangibility, etc. */
1968 xassert (PT
== beg
|| PT
== end
);
1971 /* Pretend the area doesn't exist if the buffer is not
1973 if (!modified
&& !ellipsis
&& beg
< end
)
1975 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1976 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1977 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1978 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1979 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1980 /* We've already moved as far as we can. Trying to go
1981 to the other end would mean moving backwards and thus
1982 could lead to an infinite loop. */
1984 else if (val
= get_pos_property (make_number (PT
),
1986 TEXT_PROP_MEANS_INVISIBLE (val
)
1987 && (val
= get_pos_property
1988 (make_number (PT
== beg
? end
: beg
),
1990 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1991 (check_composition
= check_display
= 1,
1992 SET_PT (PT
== beg
? end
: beg
));
1995 check_invisible
= 0;
1999 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2002 safe_run_hooks_1 (void)
2004 if (NILP (Vrun_hooks
))
2006 return call1 (Vrun_hooks
, Vinhibit_quit
);
2009 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2012 safe_run_hooks_error (Lisp_Object data
)
2014 Lisp_Object args
[3];
2015 args
[0] = build_string ("Error in %s: %s");
2016 args
[1] = Vinhibit_quit
;
2019 return Fset (Vinhibit_quit
, Qnil
);
2022 /* If we get an error while running the hook, cause the hook variable
2023 to be nil. Also inhibit quits, so that C-g won't cause the hook
2024 to mysteriously evaporate. */
2027 safe_run_hooks (Lisp_Object hook
)
2029 int count
= SPECPDL_INDEX ();
2030 specbind (Qinhibit_quit
, hook
);
2032 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2034 unbind_to (count
, Qnil
);
2038 /* Number of seconds between polling for input. This is a Lisp
2039 variable that can be bound. */
2041 EMACS_INT polling_period
;
2043 /* Nonzero means polling for input is temporarily suppressed. */
2045 int poll_suppress_count
;
2047 /* Asynchronous timer for polling. */
2049 struct atimer
*poll_timer
;
2052 #ifdef POLL_FOR_INPUT
2054 /* Poll for input, so that we catch a C-g if it comes in. This
2055 function is called from x_make_frame_visible, see comment
2059 poll_for_input_1 (void)
2061 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2062 doing anything dangerous. */
2066 if (interrupt_input_blocked
== 0
2067 && !waiting_for_input
)
2068 read_avail_input (0);
2074 /* Timer callback function for poll_timer. TIMER is equal to
2078 poll_for_input (struct atimer
*timer
)
2080 if (poll_suppress_count
== 0)
2083 interrupt_input_pending
= 1;
2084 pending_signals
= 1;
2086 poll_for_input_1 ();
2091 #endif /* POLL_FOR_INPUT */
2093 /* Begin signals to poll for input, if they are appropriate.
2094 This function is called unconditionally from various places. */
2097 start_polling (void)
2099 #ifdef POLL_FOR_INPUT
2100 /* XXX This condition was (read_socket_hook && !interrupt_input),
2101 but read_socket_hook is not global anymore. Let's pretend that
2103 if (!interrupt_input
)
2105 /* Turn alarm handling on unconditionally. It might have
2106 been turned off in process.c. */
2107 turn_on_atimers (1);
2109 /* If poll timer doesn't exist, are we need one with
2110 a different interval, start a new one. */
2111 if (poll_timer
== NULL
2112 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2114 EMACS_TIME interval
;
2117 cancel_atimer (poll_timer
);
2119 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2120 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2121 poll_for_input
, NULL
);
2124 /* Let the timer's callback function poll for input
2125 if this becomes zero. */
2126 --poll_suppress_count
;
2131 /* Nonzero if we are using polling to handle input asynchronously. */
2134 input_polling_used (void)
2136 #ifdef POLL_FOR_INPUT
2137 /* XXX This condition was (read_socket_hook && !interrupt_input),
2138 but read_socket_hook is not global anymore. Let's pretend that
2140 return !interrupt_input
;
2146 /* Turn off polling. */
2151 #ifdef POLL_FOR_INPUT
2152 /* XXX This condition was (read_socket_hook && !interrupt_input),
2153 but read_socket_hook is not global anymore. Let's pretend that
2155 if (!interrupt_input
)
2156 ++poll_suppress_count
;
2160 /* Set the value of poll_suppress_count to COUNT
2161 and start or stop polling accordingly. */
2164 set_poll_suppress_count (int count
)
2166 #ifdef POLL_FOR_INPUT
2167 if (count
== 0 && poll_suppress_count
!= 0)
2169 poll_suppress_count
= 1;
2172 else if (count
!= 0 && poll_suppress_count
== 0)
2176 poll_suppress_count
= count
;
2180 /* Bind polling_period to a value at least N.
2181 But don't decrease it. */
2184 bind_polling_period (int n
)
2186 #ifdef POLL_FOR_INPUT
2187 int new = polling_period
;
2192 stop_other_atimers (poll_timer
);
2194 specbind (Qpolling_period
, make_number (new));
2195 /* Start a new alarm with the new period. */
2200 /* Apply the control modifier to CHARACTER. */
2203 make_ctrl_char (int c
)
2205 /* Save the upper bits here. */
2206 int upper
= c
& ~0177;
2208 if (! ASCII_BYTE_P (c
))
2209 return c
|= ctrl_modifier
;
2213 /* Everything in the columns containing the upper-case letters
2214 denotes a control character. */
2215 if (c
>= 0100 && c
< 0140)
2219 /* Set the shift modifier for a control char
2220 made from a shifted letter. But only for letters! */
2221 if (oc
>= 'A' && oc
<= 'Z')
2222 c
|= shift_modifier
;
2225 /* The lower-case letters denote control characters too. */
2226 else if (c
>= 'a' && c
<= 'z')
2229 /* Include the bits for control and shift
2230 only if the basic ASCII code can't indicate them. */
2234 /* Replace the high bits. */
2235 c
|= (upper
& ~ctrl_modifier
);
2240 /* Display the help-echo property of the character after the mouse pointer.
2241 Either show it in the echo area, or call show-help-function to display
2242 it by other means (maybe in a tooltip).
2244 If HELP is nil, that means clear the previous help echo.
2246 If HELP is a string, display that string. If HELP is a function,
2247 call it with OBJECT and POS as arguments; the function should
2248 return a help string or nil for none. For all other types of HELP,
2249 evaluate it to obtain a string.
2251 WINDOW is the window in which the help was generated, if any.
2252 It is nil if not in a window.
2254 If OBJECT is a buffer, POS is the position in the buffer where the
2255 `help-echo' text property was found.
2257 If OBJECT is an overlay, that overlay has a `help-echo' property,
2258 and POS is the position in the overlay's buffer under the mouse.
2260 If OBJECT is a string (an overlay string or a string displayed with
2261 the `display' property). POS is the position in that string under
2264 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2265 echo overwrites a keystroke echo currently displayed in the echo
2268 Note: this function may only be called with HELP nil or a string
2269 from X code running asynchronously. */
2272 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2273 Lisp_Object pos
, int ok_to_overwrite_keystroke_echo
)
2275 if (!NILP (help
) && !STRINGP (help
))
2277 if (FUNCTIONP (help
))
2279 Lisp_Object args
[4];
2284 help
= safe_call (4, args
);
2287 help
= safe_eval (help
);
2289 if (!STRINGP (help
))
2293 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2294 if (!noninteractive
&& STRINGP (help
))
2296 /* The mouse-fixup-help-message Lisp function can call
2297 mouse_position_hook, which resets the mouse_moved flags.
2298 This causes trouble if we are trying to read a mouse motion
2299 event (i.e., if we are inside a `track-mouse' form), so we
2300 restore the mouse_moved flag. */
2301 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2302 help
= call1 (Qmouse_fixup_help_message
, help
);
2308 if (STRINGP (help
) || NILP (help
))
2310 if (!NILP (Vshow_help_function
))
2311 call1 (Vshow_help_function
, help
);
2312 help_echo_showing_p
= STRINGP (help
);
2318 /* Input of single characters from keyboard */
2320 Lisp_Object
print_help (Lisp_Object object
);
2321 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2322 struct timeval
*end_time
);
2323 static void record_char (Lisp_Object c
);
2325 static Lisp_Object help_form_saved_window_configs
;
2327 read_char_help_form_unwind (Lisp_Object arg
)
2329 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2330 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2331 if (!NILP (window_config
))
2332 Fset_window_configuration (window_config
);
2336 #define STOP_POLLING \
2337 do { if (! polling_stopped_here) stop_polling (); \
2338 polling_stopped_here = 1; } while (0)
2340 #define RESUME_POLLING \
2341 do { if (polling_stopped_here) start_polling (); \
2342 polling_stopped_here = 0; } while (0)
2344 /* read a character from the keyboard; call the redisplay if needed */
2345 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2346 -1 means do not do redisplay, but do do autosaving.
2349 /* The arguments MAPS and NMAPS are for menu prompting.
2350 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2352 PREV_EVENT is the previous input event, or nil if we are reading
2353 the first event of a key sequence (or not reading a key sequence).
2354 If PREV_EVENT is t, that is a "magic" value that says
2355 not to run input methods, but in other respects to act as if
2356 not reading a key sequence.
2358 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2359 if we used a mouse menu to read the input, or zero otherwise. If
2360 USED_MOUSE_MENU is null, we don't dereference it.
2362 Value is -2 when we find input on another keyboard. A second call
2363 to read_char will read it.
2365 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2366 specifying the maximum time to wait until. If no input arrives by
2367 that time, stop waiting and return nil.
2369 Value is t if we showed a menu and the user rejected it. */
2372 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2373 int *used_mouse_menu
, struct timeval
*end_time
)
2375 volatile Lisp_Object c
;
2376 int count
, jmpcount
;
2377 jmp_buf local_getcjmp
;
2379 volatile int key_already_recorded
= 0;
2380 Lisp_Object tem
, save
;
2381 volatile Lisp_Object previous_echo_area_message
;
2382 volatile Lisp_Object also_record
;
2383 volatile int reread
;
2384 struct gcpro gcpro1
, gcpro2
;
2385 int polling_stopped_here
= 0;
2386 struct kboard
*orig_kboard
= current_kboard
;
2390 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2391 before_command_key_count
= this_command_key_count
;
2392 before_command_echo_length
= echo_length ();
2395 previous_echo_area_message
= Qnil
;
2397 GCPRO2 (c
, previous_echo_area_message
);
2402 if (CONSP (Vunread_post_input_method_events
))
2404 c
= XCAR (Vunread_post_input_method_events
);
2405 Vunread_post_input_method_events
2406 = XCDR (Vunread_post_input_method_events
);
2408 /* Undo what read_char_x_menu_prompt did when it unread
2409 additional keys returned by Fx_popup_menu. */
2411 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2419 if (unread_command_char
!= -1)
2421 XSETINT (c
, unread_command_char
);
2422 unread_command_char
= -1;
2428 if (CONSP (Vunread_command_events
))
2430 int was_disabled
= 0;
2432 c
= XCAR (Vunread_command_events
);
2433 Vunread_command_events
= XCDR (Vunread_command_events
);
2437 /* Undo what sit-for did when it unread additional keys
2438 inside universal-argument. */
2441 && EQ (XCAR (c
), Qt
))
2447 /* Undo what read_char_x_menu_prompt did when it unread
2448 additional keys returned by Fx_popup_menu. */
2450 && EQ (XCDR (c
), Qdisabled
)
2451 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2457 /* If the queued event is something that used the mouse,
2458 set used_mouse_menu accordingly. */
2460 /* Also check was_disabled so last-nonmenu-event won't return
2461 a bad value when submenus are involved. (Bug#447) */
2462 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2463 *used_mouse_menu
= 1;
2465 goto reread_for_input_method
;
2468 if (CONSP (Vunread_input_method_events
))
2470 c
= XCAR (Vunread_input_method_events
);
2471 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2473 /* Undo what read_char_x_menu_prompt did when it unread
2474 additional keys returned by Fx_popup_menu. */
2476 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2480 goto reread_for_input_method
;
2483 this_command_key_count_reset
= 0;
2485 if (!NILP (Vexecuting_kbd_macro
))
2487 /* We set this to Qmacro; since that's not a frame, nobody will
2488 try to switch frames on us, and the selected window will
2491 Since this event came from a macro, it would be misleading to
2492 leave internal_last_event_frame set to wherever the last
2493 real event came from. Normally, a switch-frame event selects
2494 internal_last_event_frame after each command is read, but
2495 events read from a macro should never cause a new frame to be
2497 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2499 /* Exit the macro if we are at the end.
2500 Also, some things replace the macro with t
2501 to force an early exit. */
2502 if (EQ (Vexecuting_kbd_macro
, Qt
)
2503 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2509 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2510 if (STRINGP (Vexecuting_kbd_macro
)
2511 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2512 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2514 executing_kbd_macro_index
++;
2519 if (!NILP (unread_switch_frame
))
2521 c
= unread_switch_frame
;
2522 unread_switch_frame
= Qnil
;
2524 /* This event should make it into this_command_keys, and get echoed
2525 again, so we do not set `reread'. */
2529 /* if redisplay was requested */
2530 if (commandflag
>= 0)
2532 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2534 /* If there is pending input, process any events which are not
2535 user-visible, such as X selection_request events. */
2537 || detect_input_pending_run_timers (0))
2538 swallow_events (0); /* may clear input_pending */
2540 /* Redisplay if no pending input. */
2541 while (!input_pending
)
2543 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2544 redisplay_preserve_echo_area (5);
2549 /* Normal case: no input arrived during redisplay. */
2552 /* Input arrived and pre-empted redisplay.
2553 Process any events which are not user-visible. */
2555 /* If that cleared input_pending, try again to redisplay. */
2558 /* Prevent the redisplay we just did
2559 from messing up echoing of the input after the prompt. */
2560 if (commandflag
== 0 && echo_current
)
2561 echo_message_buffer
= echo_area_buffer
[0];
2565 /* Message turns off echoing unless more keystrokes turn it on again.
2567 The code in 20.x for the condition was
2569 1. echo_area_glyphs && *echo_area_glyphs
2570 2. && echo_area_glyphs != current_kboard->echobuf
2571 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2573 (1) means there's a current message displayed
2575 (2) means it's not the message from echoing from the current
2578 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2579 is set to a non-null value. This is done in read_char and it is
2580 set to echo_area_glyphs after a call to echo_char. That means
2581 ok_to_echo_at_next_pause is either null or
2582 current_kboard->echobuf with the appropriate current_kboard at
2585 So, condition (3) means in clear text ok_to_echo_at_next_pause
2586 must be either null, or the current message isn't from echoing at
2587 all, or it's from echoing from a different kboard than the
2590 if (/* There currently is something in the echo area. */
2591 !NILP (echo_area_buffer
[0])
2592 && (/* And it's either not from echoing. */
2593 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2594 /* Or it's an echo from a different kboard. */
2595 || echo_kboard
!= current_kboard
2596 /* Or we explicitly allow overwriting whatever there is. */
2597 || ok_to_echo_at_next_pause
== NULL
))
2602 /* Try reading a character via menu prompting in the minibuf.
2603 Try this before the sit-for, because the sit-for
2604 would do the wrong thing if we are supposed to do
2605 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2606 after a mouse event so don't try a minibuf menu. */
2608 if (nmaps
> 0 && INTERACTIVE
2609 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2610 /* Don't bring up a menu if we already have another event. */
2611 && NILP (Vunread_command_events
)
2612 && unread_command_char
< 0
2613 && !detect_input_pending_run_timers (0))
2615 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2617 if (INTEGERP (c
) && XINT (c
) == -2)
2618 return c
; /* wrong_kboard_jmpbuf */
2622 key_already_recorded
= 1;
2627 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2628 We will do that below, temporarily for short sections of code,
2629 when appropriate. local_getcjmp must be in effect
2630 around any call to sit_for or kbd_buffer_get_event;
2631 it *must not* be in effect when we call redisplay. */
2633 jmpcount
= SPECPDL_INDEX ();
2634 if (_setjmp (local_getcjmp
))
2636 /* Handle quits while reading the keyboard. */
2637 /* We must have saved the outer value of getcjmp here,
2638 so restore it now. */
2639 restore_getcjmp (save_jump
);
2640 unbind_to (jmpcount
, Qnil
);
2641 XSETINT (c
, quit_char
);
2642 internal_last_event_frame
= selected_frame
;
2643 Vlast_event_frame
= internal_last_event_frame
;
2644 /* If we report the quit char as an event,
2645 don't do so more than once. */
2646 if (!NILP (Vinhibit_quit
))
2650 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2651 if (kb
!= current_kboard
)
2653 Lisp_Object link
= kb
->kbd_queue
;
2654 /* We shouldn't get here if we were in single-kboard mode! */
2659 while (CONSP (XCDR (link
)))
2661 if (!NILP (XCDR (link
)))
2665 kb
->kbd_queue
= Fcons (c
, Qnil
);
2667 XSETCDR (link
, Fcons (c
, Qnil
));
2668 kb
->kbd_queue_has_data
= 1;
2669 current_kboard
= kb
;
2670 /* This is going to exit from read_char
2671 so we had better get rid of this frame's stuff. */
2673 return make_number (-2); /* wrong_kboard_jmpbuf */
2679 /* Start idle timers if no time limit is supplied. We don't do it
2680 if a time limit is supplied to avoid an infinite recursion in the
2681 situation where an idle timer calls `sit-for'. */
2684 timer_start_idle ();
2686 /* If in middle of key sequence and minibuffer not active,
2687 start echoing if enough time elapses. */
2689 if (minibuf_level
== 0
2691 && !current_kboard
->immediate_echo
2692 && this_command_key_count
> 0
2694 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2695 && NILP (Fzerop (Vecho_keystrokes
))
2696 && (/* No message. */
2697 NILP (echo_area_buffer
[0])
2698 /* Or empty message. */
2699 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2700 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2701 /* Or already echoing from same kboard. */
2702 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2703 /* Or not echoing before and echoing allowed. */
2704 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2706 /* After a mouse event, start echoing right away.
2707 This is because we are probably about to display a menu,
2708 and we don't want to delay before doing so. */
2709 if (EVENT_HAS_PARAMETERS (prev_event
))
2715 save_getcjmp (save_jump
);
2716 restore_getcjmp (local_getcjmp
);
2717 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2718 restore_getcjmp (save_jump
);
2720 && ! CONSP (Vunread_command_events
))
2725 /* Maybe auto save due to number of keystrokes. */
2727 if (commandflag
!= 0
2728 && auto_save_interval
> 0
2729 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2730 && !detect_input_pending_run_timers (0))
2732 Fdo_auto_save (Qnil
, Qnil
);
2733 /* Hooks can actually change some buffers in auto save. */
2737 /* Try reading using an X menu.
2738 This is never confused with reading using the minibuf
2739 because the recursive call of read_char in read_char_minibuf_menu_prompt
2740 does not pass on any keymaps. */
2742 if (nmaps
> 0 && INTERACTIVE
2743 && !NILP (prev_event
)
2744 && EVENT_HAS_PARAMETERS (prev_event
)
2745 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2746 && !EQ (XCAR (prev_event
), Qtool_bar
)
2747 /* Don't bring up a menu if we already have another event. */
2748 && NILP (Vunread_command_events
)
2749 && unread_command_char
< 0)
2751 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2753 /* Now that we have read an event, Emacs is not idle. */
2760 /* Maybe autosave and/or garbage collect due to idleness. */
2762 if (INTERACTIVE
&& NILP (c
))
2764 int delay_level
, buffer_size
;
2766 /* Slow down auto saves logarithmically in size of current buffer,
2767 and garbage collect while we're at it. */
2768 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2769 last_non_minibuf_size
= Z
- BEG
;
2770 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2772 while (buffer_size
> 64)
2773 delay_level
++, buffer_size
-= buffer_size
>> 2;
2774 if (delay_level
< 4) delay_level
= 4;
2775 /* delay_level is 4 for files under around 50k, 7 at 100k,
2776 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2778 /* Auto save if enough time goes by without input. */
2779 if (commandflag
!= 0
2780 && num_nonmacro_input_events
> last_auto_save
2781 && INTEGERP (Vauto_save_timeout
)
2782 && XINT (Vauto_save_timeout
) > 0)
2785 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2787 save_getcjmp (save_jump
);
2788 restore_getcjmp (local_getcjmp
);
2789 tem0
= sit_for (make_number (timeout
), 1, 1);
2790 restore_getcjmp (save_jump
);
2793 && ! CONSP (Vunread_command_events
))
2795 Fdo_auto_save (Qnil
, Qnil
);
2797 /* If we have auto-saved and there is still no input
2798 available, garbage collect if there has been enough
2799 consing going on to make it worthwhile. */
2800 if (!detect_input_pending_run_timers (0)
2801 && consing_since_gc
> gc_cons_threshold
/ 2)
2802 Fgarbage_collect ();
2809 /* Notify the caller if an autosave hook, or a timer, sentinel or
2810 filter in the sit_for calls above have changed the current
2811 kboard. This could happen if they use the minibuffer or start a
2812 recursive edit, like the fancy splash screen in server.el's
2813 filter. If this longjmp wasn't here, read_key_sequence would
2814 interpret the next key sequence using the wrong translation
2815 tables and function keymaps. */
2816 if (NILP (c
) && current_kboard
!= orig_kboard
)
2819 return make_number (-2); /* wrong_kboard_jmpbuf */
2822 /* If this has become non-nil here, it has been set by a timer
2823 or sentinel or filter. */
2824 if (CONSP (Vunread_command_events
))
2826 c
= XCAR (Vunread_command_events
);
2827 Vunread_command_events
= XCDR (Vunread_command_events
);
2830 /* Read something from current KBOARD's side queue, if possible. */
2834 if (current_kboard
->kbd_queue_has_data
)
2836 if (!CONSP (current_kboard
->kbd_queue
))
2838 c
= XCAR (current_kboard
->kbd_queue
);
2839 current_kboard
->kbd_queue
2840 = XCDR (current_kboard
->kbd_queue
);
2841 if (NILP (current_kboard
->kbd_queue
))
2842 current_kboard
->kbd_queue_has_data
= 0;
2843 input_pending
= readable_events (0);
2844 if (EVENT_HAS_PARAMETERS (c
)
2845 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2846 internal_last_event_frame
= XCAR (XCDR (c
));
2847 Vlast_event_frame
= internal_last_event_frame
;
2851 /* If current_kboard's side queue is empty check the other kboards.
2852 If one of them has data that we have not yet seen here,
2853 switch to it and process the data waiting for it.
2855 Note: if the events queued up for another kboard
2856 have already been seen here, and therefore are not a complete command,
2857 the kbd_queue_has_data field is 0, so we skip that kboard here.
2858 That's to avoid an infinite loop switching between kboards here. */
2859 if (NILP (c
) && !single_kboard
)
2862 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2863 if (kb
->kbd_queue_has_data
)
2865 current_kboard
= kb
;
2866 /* This is going to exit from read_char
2867 so we had better get rid of this frame's stuff. */
2869 return make_number (-2); /* wrong_kboard_jmpbuf */
2877 /* Finally, we read from the main queue,
2878 and if that gives us something we can't use yet, we put it on the
2879 appropriate side queue and try again. */
2888 EMACS_GET_TIME (now
);
2889 if (EMACS_TIME_GE (now
, *end_time
))
2893 /* Actually read a character, waiting if necessary. */
2894 save_getcjmp (save_jump
);
2895 restore_getcjmp (local_getcjmp
);
2897 timer_start_idle ();
2898 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2899 restore_getcjmp (save_jump
);
2901 if (! NILP (c
) && (kb
!= current_kboard
))
2903 Lisp_Object link
= kb
->kbd_queue
;
2906 while (CONSP (XCDR (link
)))
2908 if (!NILP (XCDR (link
)))
2912 kb
->kbd_queue
= Fcons (c
, Qnil
);
2914 XSETCDR (link
, Fcons (c
, Qnil
));
2915 kb
->kbd_queue_has_data
= 1;
2919 current_kboard
= kb
;
2920 /* This is going to exit from read_char
2921 so we had better get rid of this frame's stuff. */
2923 return make_number (-2);
2927 /* Terminate Emacs in batch mode if at eof. */
2928 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2929 Fkill_emacs (make_number (1));
2933 /* Add in any extra modifiers, where appropriate. */
2934 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2935 || ((extra_keyboard_modifiers
& 0177) < ' '
2936 && (extra_keyboard_modifiers
& 0177) != 0))
2937 XSETINT (c
, make_ctrl_char (XINT (c
)));
2939 /* Transfer any other modifier bits directly from
2940 extra_keyboard_modifiers to c. Ignore the actual character code
2941 in the low 16 bits of extra_keyboard_modifiers. */
2942 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2953 if (commandflag
>= 0
2954 && !input_pending
&& !detect_input_pending_run_timers (0))
2962 /* Buffer switch events are only for internal wakeups
2963 so don't show them to the user.
2964 Also, don't record a key if we already did. */
2965 if (BUFFERP (c
) || key_already_recorded
)
2968 /* Process special events within read_char
2969 and loop around to read another event. */
2972 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2977 struct buffer
*prev_buffer
= current_buffer
;
2978 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2979 int was_locked
= single_kboard
;
2980 int count
= SPECPDL_INDEX ();
2981 record_single_kboard_state ();
2984 last_input_event
= c
;
2985 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2987 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2988 /* We stopped being idle for this event; undo that. This
2989 prevents automatic window selection (under
2990 mouse_autoselect_window from acting as a real input event, for
2991 example banishing the mouse under mouse-avoidance-mode. */
2992 timer_resume_idle ();
2994 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2995 /* Resume allowing input from any kboard, if that was true before. */
2997 any_kboard_state ();
2998 unbind_to (count
, Qnil
);
3001 if (current_buffer
!= prev_buffer
)
3003 /* The command may have changed the keymaps. Pretend there
3004 is input in another keyboard and return. This will
3005 recalculate keymaps. */
3006 c
= make_number (-2);
3013 /* Handle things that only apply to characters. */
3016 /* If kbd_buffer_get_event gave us an EOF, return that. */
3020 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3021 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3022 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3023 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3024 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3028 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3029 /* nil in keyboard-translate-table means no translation. */
3035 /* If this event is a mouse click in the menu bar,
3036 return just menu-bar for now. Modify the mouse click event
3037 so we won't do this twice, then queue it up. */
3038 if (EVENT_HAS_PARAMETERS (c
)
3040 && CONSP (EVENT_START (c
))
3041 && CONSP (XCDR (EVENT_START (c
))))
3045 posn
= POSN_POSN (EVENT_START (c
));
3046 /* Handle menu-bar events:
3047 insert the dummy prefix event `menu-bar'. */
3048 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3050 /* Change menu-bar to (menu-bar) as the event "position". */
3051 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3054 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3059 /* Store these characters into recent_keys, the dribble file if any,
3060 and the keyboard macro being defined, if any. */
3062 if (! NILP (also_record
))
3063 record_char (also_record
);
3065 /* Wipe the echo area.
3066 But first, if we are about to use an input method,
3067 save the echo area contents for it to refer to. */
3069 && ! NILP (Vinput_method_function
)
3070 && (unsigned) XINT (c
) >= ' '
3071 && (unsigned) XINT (c
) != 127
3072 && (unsigned) XINT (c
) < 256)
3074 previous_echo_area_message
= Fcurrent_message ();
3075 Vinput_method_previous_message
= previous_echo_area_message
;
3078 /* Now wipe the echo area, except for help events which do their
3079 own stuff with the echo area. */
3081 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3082 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3084 if (!NILP (echo_area_buffer
[0]))
3085 safe_run_hooks (Qecho_area_clear_hook
);
3086 clear_message (1, 0);
3089 reread_for_input_method
:
3091 /* Pass this to the input method, if appropriate. */
3093 && ! NILP (Vinput_method_function
)
3094 /* Don't run the input method within a key sequence,
3095 after the first event of the key sequence. */
3096 && NILP (prev_event
)
3097 && (unsigned) XINT (c
) >= ' '
3098 && (unsigned) XINT (c
) != 127
3099 && (unsigned) XINT (c
) < 256)
3102 int key_count
, key_count_reset
;
3103 struct gcpro gcpro1
;
3104 int count
= SPECPDL_INDEX ();
3106 /* Save the echo status. */
3107 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3108 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3109 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3110 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3113 if (before_command_restore_flag
)
3115 this_command_key_count
= before_command_key_count_1
;
3116 if (this_command_key_count
< this_single_command_key_start
)
3117 this_single_command_key_start
= this_command_key_count
;
3118 echo_truncate (before_command_echo_length_1
);
3119 before_command_restore_flag
= 0;
3123 /* Save the this_command_keys status. */
3124 key_count
= this_command_key_count
;
3125 key_count_reset
= this_command_key_count_reset
;
3128 keys
= Fcopy_sequence (this_command_keys
);
3133 /* Clear out this_command_keys. */
3134 this_command_key_count
= 0;
3135 this_command_key_count_reset
= 0;
3137 /* Now wipe the echo area. */
3138 if (!NILP (echo_area_buffer
[0]))
3139 safe_run_hooks (Qecho_area_clear_hook
);
3140 clear_message (1, 0);
3143 /* If we are not reading a key sequence,
3144 never use the echo area. */
3147 specbind (Qinput_method_use_echo_area
, Qt
);
3150 /* Call the input method. */
3151 tem
= call1 (Vinput_method_function
, c
);
3153 tem
= unbind_to (count
, tem
);
3155 /* Restore the saved echoing state
3156 and this_command_keys state. */
3157 this_command_key_count
= key_count
;
3158 this_command_key_count_reset
= key_count_reset
;
3160 this_command_keys
= keys
;
3163 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3164 current_kboard
->echo_string
= saved_echo_string
;
3165 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3166 if (saved_immediate_echo
)
3171 /* The input method can return no events. */
3174 /* Bring back the previous message, if any. */
3175 if (! NILP (previous_echo_area_message
))
3176 message_with_string ("%s", previous_echo_area_message
, 0);
3179 /* It returned one event or more. */
3181 Vunread_post_input_method_events
3182 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3187 /* Display help if not echoing. */
3188 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3190 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3191 Lisp_Object help
, object
, position
, window
, tem
;
3193 tem
= Fcdr (XCDR (c
));
3196 window
= Fcar (tem
);
3198 object
= Fcar (tem
);
3200 position
= Fcar (tem
);
3202 show_help_echo (help
, window
, object
, position
, 0);
3204 /* We stopped being idle for this event; undo that. */
3206 timer_resume_idle ();
3210 if ((! reread
|| this_command_key_count
== 0
3211 || this_command_key_count_reset
)
3215 /* Don't echo mouse motion events. */
3216 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3217 && NILP (Fzerop (Vecho_keystrokes
))
3218 && ! (EVENT_HAS_PARAMETERS (c
)
3219 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3222 if (! NILP (also_record
))
3223 echo_char (also_record
);
3224 /* Once we reread a character, echoing can happen
3225 the next time we pause to read a new one. */
3226 ok_to_echo_at_next_pause
= current_kboard
;
3229 /* Record this character as part of the current key. */
3230 add_command_key (c
);
3231 if (! NILP (also_record
))
3232 add_command_key (also_record
);
3235 last_input_event
= c
;
3238 /* Process the help character specially if enabled */
3239 if (!NILP (Vhelp_form
) && help_char_p (c
))
3242 count
= SPECPDL_INDEX ();
3244 help_form_saved_window_configs
3245 = Fcons (Fcurrent_window_configuration (Qnil
),
3246 help_form_saved_window_configs
);
3247 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3249 tem0
= Feval (Vhelp_form
);
3251 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3256 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3257 if (EVENT_HAS_PARAMETERS (c
)
3258 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3259 XSETCAR (help_form_saved_window_configs
, Qnil
);
3261 while (BUFFERP (c
));
3262 /* Remove the help from the frame */
3263 unbind_to (count
, Qnil
);
3266 if (EQ (c
, make_number (040)))
3270 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3271 while (BUFFERP (c
));
3280 /* Record a key that came from a mouse menu.
3281 Record it for echoing, for this-command-keys, and so on. */
3284 record_menu_key (Lisp_Object c
)
3286 /* Wipe the echo area. */
3287 clear_message (1, 0);
3292 before_command_key_count
= this_command_key_count
;
3293 before_command_echo_length
= echo_length ();
3296 /* Don't echo mouse motion events. */
3297 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3298 && NILP (Fzerop (Vecho_keystrokes
)))
3302 /* Once we reread a character, echoing can happen
3303 the next time we pause to read a new one. */
3304 ok_to_echo_at_next_pause
= 0;
3307 /* Record this character as part of the current key. */
3308 add_command_key (c
);
3310 /* Re-reading in the middle of a command */
3311 last_input_event
= c
;
3315 /* Return 1 if should recognize C as "the help character". */
3318 help_char_p (Lisp_Object c
)
3322 if (EQ (c
, Vhelp_char
))
3324 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3325 if (EQ (c
, XCAR (tail
)))
3330 /* Record the input event C in various ways. */
3333 record_char (Lisp_Object c
)
3337 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3339 /* To avoid filling recent_keys with help-echo and mouse-movement
3340 events, we filter out repeated help-echo events, only store the
3341 first and last in a series of mouse-movement events, and don't
3342 store repeated help-echo events which are only separated by
3343 mouse-movement events. */
3345 Lisp_Object ev1
, ev2
, ev3
;
3348 if ((ix1
= recent_keys_index
- 1) < 0)
3349 ix1
= NUM_RECENT_KEYS
- 1;
3350 ev1
= AREF (recent_keys
, ix1
);
3352 if ((ix2
= ix1
- 1) < 0)
3353 ix2
= NUM_RECENT_KEYS
- 1;
3354 ev2
= AREF (recent_keys
, ix2
);
3356 if ((ix3
= ix2
- 1) < 0)
3357 ix3
= NUM_RECENT_KEYS
- 1;
3358 ev3
= AREF (recent_keys
, ix3
);
3360 if (EQ (XCAR (c
), Qhelp_echo
))
3362 /* Don't record `help-echo' in recent_keys unless it shows some help
3363 message, and a different help than the previously recorded
3365 Lisp_Object help
, last_help
;
3367 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3368 if (!STRINGP (help
))
3370 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3371 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3373 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3374 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3375 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3377 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3378 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3379 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3380 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3383 else if (EQ (XCAR (c
), Qmouse_movement
))
3385 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3386 So additional mouse movement events replace the last element. */
3387 Lisp_Object last_window
, window
;
3389 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3390 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3391 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3392 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3393 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3395 ASET (recent_keys
, ix1
, c
);
3401 store_kbd_macro_char (c
);
3406 ASET (recent_keys
, recent_keys_index
, c
);
3407 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3408 recent_keys_index
= 0;
3410 else if (recorded
< 0)
3412 /* We need to remove one or two events from recent_keys.
3413 To do this, we simply put nil at those events and move the
3414 recent_keys_index backwards over those events. Usually,
3415 users will never see those nil events, as they will be
3416 overwritten by the command keys entered to see recent_keys
3419 while (recorded
++ < 0 && total_keys
> 0)
3421 if (total_keys
< NUM_RECENT_KEYS
)
3423 if (--recent_keys_index
< 0)
3424 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3425 ASET (recent_keys
, recent_keys_index
, Qnil
);
3429 num_nonmacro_input_events
++;
3431 /* Write c to the dribble file. If c is a lispy event, write
3432 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3433 If you, dear reader, have a better idea, you've got the source. :-) */
3439 if (XUINT (c
) < 0x100)
3440 putc (XINT (c
), dribble
);
3442 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3446 Lisp_Object dribblee
;
3448 /* If it's a structured event, take the event header. */
3449 dribblee
= EVENT_HEAD (c
);
3451 if (SYMBOLP (dribblee
))
3453 putc ('<', dribble
);
3454 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3455 SBYTES (SYMBOL_NAME (dribblee
)),
3457 putc ('>', dribble
);
3467 print_help (Lisp_Object object
)
3469 struct buffer
*old
= current_buffer
;
3470 Fprinc (object
, Qnil
);
3471 set_buffer_internal (XBUFFER (Vstandard_output
));
3472 call0 (intern ("help-mode"));
3473 set_buffer_internal (old
);
3477 /* Copy out or in the info on where C-g should throw to.
3478 This is used when running Lisp code from within get_char,
3479 in case get_char is called recursively.
3480 See read_process_output. */
3483 save_getcjmp (jmp_buf temp
)
3485 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3489 restore_getcjmp (jmp_buf temp
)
3491 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3494 /* Low level keyboard/mouse input.
3495 kbd_buffer_store_event places events in kbd_buffer, and
3496 kbd_buffer_get_event retrieves them. */
3498 /* Return true if there are any events in the queue that read-char
3499 would return. If this returns false, a read-char would block. */
3501 readable_events (int flags
)
3504 /* Check whether a D-Bus message has arrived. */
3505 if (xd_pending_messages () > 0)
3507 #endif /* HAVE_DBUS */
3509 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3512 /* If the buffer contains only FOCUS_IN_EVENT events, and
3513 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3514 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3516 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3517 #ifdef USE_TOOLKIT_SCROLL_BARS
3518 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3522 struct input_event
*event
;
3524 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3531 #ifdef USE_TOOLKIT_SCROLL_BARS
3532 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3534 event
->kind
== FOCUS_IN_EVENT
)
3535 #ifdef USE_TOOLKIT_SCROLL_BARS
3536 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3537 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3538 && event
->part
== scroll_bar_handle
3539 && event
->modifiers
== 0)
3544 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3547 while (event
!= kbd_store_ptr
);
3553 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3554 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3555 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3560 if (current_kboard
->kbd_queue_has_data
)
3566 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3567 if (kb
->kbd_queue_has_data
)
3573 /* Set this for debugging, to have a way to get out */
3577 event_to_kboard (struct input_event
*event
)
3580 frame
= event
->frame_or_window
;
3582 frame
= XCAR (frame
);
3583 else if (WINDOWP (frame
))
3584 frame
= WINDOW_FRAME (XWINDOW (frame
));
3586 /* There are still some events that don't set this field.
3587 For now, just ignore the problem.
3588 Also ignore dead frames here. */
3589 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3592 return FRAME_KBOARD (XFRAME (frame
));
3596 Lisp_Object Vthrow_on_input
;
3598 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3601 kbd_buffer_store_event (register struct input_event
*event
)
3603 kbd_buffer_store_event_hold (event
, 0);
3606 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3608 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3609 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3610 Else, if EVENT is a quit event, store the quit event
3611 in HOLD_QUIT, and return (thus ignoring further events).
3613 This is used in read_avail_input to postpone the processing
3614 of the quit event until all subsequent input events have been
3615 parsed (and discarded).
3619 kbd_buffer_store_event_hold (register struct input_event
*event
,
3620 struct input_event
*hold_quit
)
3622 if (event
->kind
== NO_EVENT
)
3625 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3628 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3630 register int c
= event
->code
& 0377;
3632 if (event
->modifiers
& ctrl_modifier
)
3633 c
= make_ctrl_char (c
);
3635 c
|= (event
->modifiers
3636 & (meta_modifier
| alt_modifier
3637 | hyper_modifier
| super_modifier
));
3641 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3642 struct input_event
*sp
;
3644 if (single_kboard
&& kb
!= current_kboard
)
3647 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3648 Fcons (make_number (c
), Qnil
));
3649 kb
->kbd_queue_has_data
= 1;
3650 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3652 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3655 if (event_to_kboard (sp
) == kb
)
3657 sp
->kind
= NO_EVENT
;
3658 sp
->frame_or_window
= Qnil
;
3667 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3671 /* If this results in a quit_char being returned to Emacs as
3672 input, set Vlast_event_frame properly. If this doesn't
3673 get returned to Emacs as an event, the next event read
3674 will set Vlast_event_frame again, so this is safe to do. */
3678 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3680 focus
= event
->frame_or_window
;
3681 internal_last_event_frame
= focus
;
3682 Vlast_event_frame
= focus
;
3685 last_event_timestamp
= event
->timestamp
;
3686 handle_interrupt ();
3690 if (c
&& c
== stop_character
)
3696 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3697 Just ignore the second one. */
3698 else if (event
->kind
== BUFFER_SWITCH_EVENT
3699 && kbd_fetch_ptr
!= kbd_store_ptr
3700 && ((kbd_store_ptr
== kbd_buffer
3701 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3702 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3705 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3706 kbd_store_ptr
= kbd_buffer
;
3708 /* Don't let the very last slot in the buffer become full,
3709 since that would make the two pointers equal,
3710 and that is indistinguishable from an empty buffer.
3711 Discard the event if it would fill the last slot. */
3712 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3714 *kbd_store_ptr
= *event
;
3718 /* If we're inside while-no-input, and this event qualifies
3719 as input, set quit-flag to cause an interrupt. */
3720 if (!NILP (Vthrow_on_input
)
3721 && event
->kind
!= FOCUS_IN_EVENT
3722 && event
->kind
!= HELP_EVENT
3723 && event
->kind
!= DEICONIFY_EVENT
)
3725 Vquit_flag
= Vthrow_on_input
;
3726 /* If we're inside a function that wants immediate quits,
3728 if (immediate_quit
&& NILP (Vinhibit_quit
))
3738 /* Put an input event back in the head of the event queue. */
3741 kbd_buffer_unget_event (register struct input_event
*event
)
3743 if (kbd_fetch_ptr
== kbd_buffer
)
3744 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3746 /* Don't let the very last slot in the buffer become full, */
3747 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3750 *kbd_fetch_ptr
= *event
;
3755 /* Generate HELP_EVENT input_events in BUFP which has room for
3756 SIZE events. If there's not enough room in BUFP, ignore this
3759 HELP is the help form.
3761 FRAME is the frame on which the help is generated. OBJECT is the
3762 Lisp object where the help was found (a buffer, a string, an
3763 overlay, or nil if neither from a string nor from a buffer. POS is
3764 the position within OBJECT where the help was found.
3766 Value is the number of input_events generated. */
3769 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3770 Lisp_Object object
, int pos
)
3772 struct input_event event
;
3776 event
.kind
= HELP_EVENT
;
3777 event
.frame_or_window
= frame
;
3779 event
.x
= WINDOWP (window
) ? window
: frame
;
3782 kbd_buffer_store_event (&event
);
3786 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3789 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3791 struct input_event event
;
3793 event
.kind
= HELP_EVENT
;
3794 event
.frame_or_window
= frame
;
3799 kbd_buffer_store_event (&event
);
3803 /* Discard any mouse events in the event buffer by setting them to
3806 discard_mouse_events (void)
3808 struct input_event
*sp
;
3809 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3811 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3814 if (sp
->kind
== MOUSE_CLICK_EVENT
3815 || sp
->kind
== WHEEL_EVENT
3816 || sp
->kind
== HORIZ_WHEEL_EVENT
3818 || sp
->kind
== GPM_CLICK_EVENT
3820 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3822 sp
->kind
= NO_EVENT
;
3828 /* Return non-zero if there are any real events waiting in the event
3829 buffer, not counting `NO_EVENT's.
3831 If DISCARD is non-zero, discard NO_EVENT events at the front of
3832 the input queue, possibly leaving the input queue empty if there
3833 are no real input events. */
3836 kbd_buffer_events_waiting (int discard
)
3838 struct input_event
*sp
;
3840 for (sp
= kbd_fetch_ptr
;
3841 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3844 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3851 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3855 /* Clear input event EVENT. */
3858 clear_event (struct input_event
*event
)
3860 event
->kind
= NO_EVENT
;
3864 /* Read one event from the event buffer, waiting if necessary.
3865 The value is a Lisp object representing the event.
3866 The value is nil for an event that should be ignored,
3867 or that was handled here.
3868 We always read and discard one event. */
3871 kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
, struct timeval
*end_time
)
3877 /* In case we are running as a daemon, only do this before
3878 detaching from the terminal. */
3879 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3883 *kbp
= current_kboard
;
3887 /* Wait until there is input available. */
3890 /* Break loop if there's an unread command event. Needed in
3891 moused window autoselection which uses a timer to insert such
3893 if (CONSP (Vunread_command_events
))
3896 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3898 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3899 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3903 /* If the quit flag is set, then read_char will return
3904 quit_char, so that counts as "available input." */
3905 if (!NILP (Vquit_flag
))
3906 quit_throw_to_read_char ();
3908 /* One way or another, wait until input is available; then, if
3909 interrupt handlers have not read it, read it now. */
3911 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3915 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3917 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3918 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3923 EMACS_TIME duration
;
3924 EMACS_GET_TIME (duration
);
3925 if (EMACS_TIME_GE (duration
, *end_time
))
3926 return Qnil
; /* finished waiting */
3929 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3930 wait_reading_process_output (EMACS_SECS (duration
),
3931 EMACS_USECS (duration
),
3932 -1, 1, Qnil
, NULL
, 0);
3936 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3938 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3939 /* Pass 1 for EXPECT since we just waited to have input. */
3940 read_avail_input (1);
3943 if (CONSP (Vunread_command_events
))
3946 first
= XCAR (Vunread_command_events
);
3947 Vunread_command_events
= XCDR (Vunread_command_events
);
3948 *kbp
= current_kboard
;
3952 /* At this point, we know that there is a readable event available
3953 somewhere. If the event queue is empty, then there must be a
3954 mouse movement enabled and available. */
3955 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3957 struct input_event
*event
;
3959 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3963 last_event_timestamp
= event
->timestamp
;
3965 *kbp
= event_to_kboard (event
);
3967 *kbp
= current_kboard
; /* Better than returning null ptr? */
3971 /* These two kinds of events get special handling
3972 and don't actually appear to the command loop.
3973 We return nil for them. */
3974 if (event
->kind
== SELECTION_REQUEST_EVENT
3975 || event
->kind
== SELECTION_CLEAR_EVENT
)
3978 struct input_event copy
;
3980 /* Remove it from the buffer before processing it,
3981 since otherwise swallow_events will see it
3982 and process it again. */
3984 kbd_fetch_ptr
= event
+ 1;
3985 input_pending
= readable_events (0);
3986 x_handle_selection_event (©
);
3988 /* We're getting selection request events, but we don't have
3994 #if defined (HAVE_NS)
3995 else if (event
->kind
== NS_TEXT_EVENT
)
3997 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3998 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4000 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4001 kbd_fetch_ptr
= event
+ 1;
4002 if (used_mouse_menu
)
4003 *used_mouse_menu
= 1;
4007 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4008 || defined (HAVE_NS)
4009 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4011 /* Make an event (delete-frame (FRAME)). */
4012 obj
= Fcons (event
->frame_or_window
, Qnil
);
4013 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4014 kbd_fetch_ptr
= event
+ 1;
4017 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4018 || defined (HAVE_NS)
4019 else if (event
->kind
== ICONIFY_EVENT
)
4021 /* Make an event (iconify-frame (FRAME)). */
4022 obj
= Fcons (event
->frame_or_window
, Qnil
);
4023 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4024 kbd_fetch_ptr
= event
+ 1;
4026 else if (event
->kind
== DEICONIFY_EVENT
)
4028 /* Make an event (make-frame-visible (FRAME)). */
4029 obj
= Fcons (event
->frame_or_window
, Qnil
);
4030 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4031 kbd_fetch_ptr
= event
+ 1;
4034 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4036 /* The value doesn't matter here; only the type is tested. */
4037 XSETBUFFER (obj
, current_buffer
);
4038 kbd_fetch_ptr
= event
+ 1;
4040 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4041 || defined(HAVE_NS) || defined (USE_GTK)
4042 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4044 kbd_fetch_ptr
= event
+ 1;
4045 input_pending
= readable_events (0);
4046 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4047 x_activate_menubar (XFRAME (event
->frame_or_window
));
4050 #if defined (WINDOWSNT)
4051 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4053 /* Make an event (language-change (FRAME CHARSET LCID)). */
4054 obj
= Fcons (event
->frame_or_window
, Qnil
);
4055 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4056 kbd_fetch_ptr
= event
+ 1;
4059 else if (event
->kind
== SAVE_SESSION_EVENT
)
4061 obj
= Fcons (Qsave_session
, Qnil
);
4062 kbd_fetch_ptr
= event
+ 1;
4064 /* Just discard these, by returning nil.
4065 With MULTI_KBOARD, these events are used as placeholders
4066 when we need to randomly delete events from the queue.
4067 (They shouldn't otherwise be found in the buffer,
4068 but on some machines it appears they do show up
4069 even without MULTI_KBOARD.) */
4070 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4071 mouse events during a popup-menu call. */
4072 else if (event
->kind
== NO_EVENT
)
4073 kbd_fetch_ptr
= event
+ 1;
4074 else if (event
->kind
== HELP_EVENT
)
4076 Lisp_Object object
, position
, help
, frame
, window
;
4078 frame
= event
->frame_or_window
;
4079 object
= event
->arg
;
4080 position
= make_number (event
->code
);
4083 clear_event (event
);
4085 kbd_fetch_ptr
= event
+ 1;
4086 if (!WINDOWP (window
))
4088 obj
= Fcons (Qhelp_echo
,
4089 list5 (frame
, help
, window
, object
, position
));
4091 else if (event
->kind
== FOCUS_IN_EVENT
)
4093 /* Notification of a FocusIn event. The frame receiving the
4094 focus is in event->frame_or_window. Generate a
4095 switch-frame event if necessary. */
4096 Lisp_Object frame
, focus
;
4098 frame
= event
->frame_or_window
;
4099 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4103 if (!EQ (frame
, internal_last_event_frame
)
4104 && !EQ (frame
, selected_frame
))
4105 obj
= make_lispy_switch_frame (frame
);
4106 internal_last_event_frame
= frame
;
4107 kbd_fetch_ptr
= event
+ 1;
4110 else if (event
->kind
== DBUS_EVENT
)
4112 obj
= make_lispy_event (event
);
4113 kbd_fetch_ptr
= event
+ 1;
4116 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4118 obj
= make_lispy_event (event
);
4119 kbd_fetch_ptr
= event
+ 1;
4123 /* If this event is on a different frame, return a switch-frame this
4124 time, and leave the event in the queue for next time. */
4128 frame
= event
->frame_or_window
;
4130 frame
= XCAR (frame
);
4131 else if (WINDOWP (frame
))
4132 frame
= WINDOW_FRAME (XWINDOW (frame
));
4134 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4138 if (! EQ (frame
, internal_last_event_frame
)
4139 && !EQ (frame
, selected_frame
))
4140 obj
= make_lispy_switch_frame (frame
);
4141 internal_last_event_frame
= frame
;
4143 /* If we didn't decide to make a switch-frame event, go ahead
4144 and build a real event from the queue entry. */
4148 obj
= make_lispy_event (event
);
4150 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4151 || defined(HAVE_NS) || defined (USE_GTK)
4152 /* If this was a menu selection, then set the flag to inhibit
4153 writing to last_nonmenu_event. Don't do this if the event
4154 we're returning is (menu-bar), though; that indicates the
4155 beginning of the menu sequence, and we might as well leave
4156 that as the `event with parameters' for this selection. */
4158 && !EQ (event
->frame_or_window
, event
->arg
)
4159 && (event
->kind
== MENU_BAR_EVENT
4160 || event
->kind
== TOOL_BAR_EVENT
))
4161 *used_mouse_menu
= 1;
4164 /* certain system events are non-key events */
4166 && event
->kind
== NS_NONKEY_EVENT
)
4167 *used_mouse_menu
= 1;
4170 /* Wipe out this event, to catch bugs. */
4171 clear_event (event
);
4172 kbd_fetch_ptr
= event
+ 1;
4176 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4177 /* Try generating a mouse motion event. */
4178 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4180 FRAME_PTR f
= some_mouse_moved ();
4181 Lisp_Object bar_window
;
4182 enum scroll_bar_part part
;
4186 *kbp
= current_kboard
;
4187 /* Note that this uses F to determine which terminal to look at.
4188 If there is no valid info, it does not store anything
4189 so x remains nil. */
4192 /* XXX Can f or mouse_position_hook be NULL here? */
4193 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4194 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4195 &part
, &x
, &y
, &time
);
4199 /* Decide if we should generate a switch-frame event. Don't
4200 generate switch-frame events for motion outside of all Emacs
4206 frame
= FRAME_FOCUS_FRAME (f
);
4208 XSETFRAME (frame
, f
);
4210 if (! EQ (frame
, internal_last_event_frame
)
4211 && !EQ (frame
, selected_frame
))
4212 obj
= make_lispy_switch_frame (frame
);
4213 internal_last_event_frame
= frame
;
4216 /* If we didn't decide to make a switch-frame event, go ahead and
4217 return a mouse-motion event. */
4218 if (!NILP (x
) && NILP (obj
))
4219 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4221 #endif /* HAVE_MOUSE || HAVE GPM */
4223 /* We were promised by the above while loop that there was
4224 something for us to read! */
4227 input_pending
= readable_events (0);
4229 Vlast_event_frame
= internal_last_event_frame
;
4234 /* Process any events that are not user-visible,
4235 then return, without reading any user-visible events. */
4238 swallow_events (int do_display
)
4242 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4244 struct input_event
*event
;
4246 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4250 last_event_timestamp
= event
->timestamp
;
4252 /* These two kinds of events get special handling
4253 and don't actually appear to the command loop. */
4254 if (event
->kind
== SELECTION_REQUEST_EVENT
4255 || event
->kind
== SELECTION_CLEAR_EVENT
)
4258 struct input_event copy
;
4260 /* Remove it from the buffer before processing it,
4261 since otherwise swallow_events called recursively could see it
4262 and process it again. */
4264 kbd_fetch_ptr
= event
+ 1;
4265 input_pending
= readable_events (0);
4266 x_handle_selection_event (©
);
4268 /* We're getting selection request events, but we don't have
4277 old_timers_run
= timers_run
;
4278 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4280 if (timers_run
!= old_timers_run
&& do_display
)
4281 redisplay_preserve_echo_area (7);
4284 /* Record the start of when Emacs is idle,
4285 for the sake of running idle-time timers. */
4288 timer_start_idle (void)
4292 /* If we are already in the idle state, do nothing. */
4293 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4296 EMACS_GET_TIME (timer_idleness_start_time
);
4298 timer_last_idleness_start_time
= timer_idleness_start_time
;
4300 /* Mark all idle-time timers as once again candidates for running. */
4301 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4305 timer
= XCAR (timers
);
4307 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4309 XVECTOR (timer
)->contents
[0] = Qnil
;
4313 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4316 timer_stop_idle (void)
4318 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4321 /* Resume idle timer from last idle start time. */
4324 timer_resume_idle (void)
4326 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4329 timer_idleness_start_time
= timer_last_idleness_start_time
;
4332 /* This is only for debugging. */
4333 struct input_event last_timer_event
;
4335 /* List of elisp functions to call, delayed because they were generated in
4336 a context where Elisp could not be safely run (e.g. redisplay, signal,
4337 ...). Each element has the form (FUN . ARGS). */
4338 Lisp_Object pending_funcalls
;
4340 extern Lisp_Object Qapply
;
4342 /* Check whether a timer has fired. To prevent larger problems we simply
4343 disregard elements that are not proper timers. Do not make a circular
4344 timer list for the time being.
4346 Returns the time to wait until the next timer fires. If a
4347 timer is triggering now, return zero.
4348 If no timer is active, return -1.
4350 If a timer is ripe, we run it, with quitting turned off.
4351 In that case we return 0 to indicate that a new timer_check_2 call
4355 timer_check_2 (void)
4357 EMACS_TIME nexttime
;
4358 EMACS_TIME now
, idleness_now
;
4359 Lisp_Object timers
, idle_timers
, chosen_timer
;
4360 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4362 EMACS_SET_SECS (nexttime
, -1);
4363 EMACS_SET_USECS (nexttime
, -1);
4365 /* Always consider the ordinary timers. */
4366 timers
= Vtimer_list
;
4367 /* Consider the idle timers only if Emacs is idle. */
4368 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4369 idle_timers
= Vtimer_idle_list
;
4372 chosen_timer
= Qnil
;
4373 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4375 /* First run the code that was delayed. */
4376 while (CONSP (pending_funcalls
))
4378 Lisp_Object funcall
= XCAR (pending_funcalls
);
4379 pending_funcalls
= XCDR (pending_funcalls
);
4380 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4383 if (CONSP (timers
) || CONSP (idle_timers
))
4385 EMACS_GET_TIME (now
);
4386 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4387 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4390 while (CONSP (timers
) || CONSP (idle_timers
))
4392 Lisp_Object
*vector
;
4393 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4394 EMACS_TIME timer_time
, idle_timer_time
;
4395 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4397 /* Skip past invalid timers and timers already handled. */
4400 timer
= XCAR (timers
);
4401 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4403 timers
= XCDR (timers
);
4406 vector
= XVECTOR (timer
)->contents
;
4408 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4409 || !INTEGERP (vector
[3])
4410 || ! NILP (vector
[0]))
4412 timers
= XCDR (timers
);
4416 if (!NILP (idle_timers
))
4418 timer
= XCAR (idle_timers
);
4419 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4421 idle_timers
= XCDR (idle_timers
);
4424 vector
= XVECTOR (timer
)->contents
;
4426 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4427 || !INTEGERP (vector
[3])
4428 || ! NILP (vector
[0]))
4430 idle_timers
= XCDR (idle_timers
);
4435 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4436 based on the next ordinary timer.
4437 TIMER_DIFFERENCE is the distance in time from NOW to when
4438 this timer becomes ripe (negative if it's already ripe). */
4441 timer
= XCAR (timers
);
4442 vector
= XVECTOR (timer
)->contents
;
4443 EMACS_SET_SECS (timer_time
,
4444 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4445 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4446 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4449 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4450 based on the next idle timer. */
4451 if (!NILP (idle_timers
))
4453 idle_timer
= XCAR (idle_timers
);
4454 vector
= XVECTOR (idle_timer
)->contents
;
4455 EMACS_SET_SECS (idle_timer_time
,
4456 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4457 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4458 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4461 /* Decide which timer is the next timer,
4462 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4463 Also step down the list where we found that timer. */
4465 if (! NILP (timers
) && ! NILP (idle_timers
))
4468 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4469 if (EMACS_TIME_NEG_P (temp
))
4471 chosen_timer
= timer
;
4472 timers
= XCDR (timers
);
4473 difference
= timer_difference
;
4477 chosen_timer
= idle_timer
;
4478 idle_timers
= XCDR (idle_timers
);
4479 difference
= idle_timer_difference
;
4482 else if (! NILP (timers
))
4484 chosen_timer
= timer
;
4485 timers
= XCDR (timers
);
4486 difference
= timer_difference
;
4490 chosen_timer
= idle_timer
;
4491 idle_timers
= XCDR (idle_timers
);
4492 difference
= idle_timer_difference
;
4494 vector
= XVECTOR (chosen_timer
)->contents
;
4496 /* If timer is ripe, run it if it hasn't been run. */
4497 if (EMACS_TIME_NEG_P (difference
)
4498 || (EMACS_SECS (difference
) == 0
4499 && EMACS_USECS (difference
) == 0))
4501 if (NILP (vector
[0]))
4503 int count
= SPECPDL_INDEX ();
4504 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4506 /* Mark the timer as triggered to prevent problems if the lisp
4507 code fails to reschedule it right. */
4510 specbind (Qinhibit_quit
, Qt
);
4512 call1 (Qtimer_event_handler
, chosen_timer
);
4513 Vdeactivate_mark
= old_deactivate_mark
;
4515 unbind_to (count
, Qnil
);
4517 /* Since we have handled the event,
4518 we don't need to tell the caller to wake up and do it. */
4519 /* But the caller must still wait for the next timer, so
4520 return 0 to indicate that. */
4523 EMACS_SET_SECS (nexttime
, 0);
4524 EMACS_SET_USECS (nexttime
, 0);
4527 /* When we encounter a timer that is still waiting,
4528 return the amount of time to wait before it is ripe. */
4535 /* No timers are pending in the future. */
4536 /* Return 0 if we generated an event, and -1 if not. */
4542 /* Check whether a timer has fired. To prevent larger problems we simply
4543 disregard elements that are not proper timers. Do not make a circular
4544 timer list for the time being.
4546 Returns the time to wait until the next timer fires.
4547 If no timer is active, return -1.
4549 As long as any timer is ripe, we run it.
4551 DO_IT_NOW is now ignored. It used to mean that we should
4552 run the timer directly instead of queueing a timer-event.
4553 Now we always run timers directly. */
4556 timer_check (int do_it_now
)
4558 EMACS_TIME nexttime
;
4562 nexttime
= timer_check_2 ();
4564 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4569 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4570 doc
: /* Return the current length of Emacs idleness, or nil.
4571 The value when Emacs is idle is a list of three integers. The first has
4572 the most significant 16 bits of the seconds, while the second has the least
4573 significant 16 bits. The third integer gives the microsecond count.
4575 The value when Emacs is not idle is nil.
4577 The microsecond count is zero on systems that do not provide
4578 resolution finer than a second. */)
4581 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4583 EMACS_TIME now
, idleness_now
;
4585 EMACS_GET_TIME (now
);
4586 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4588 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4589 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4590 make_number (EMACS_USECS (idleness_now
)));
4596 /* Caches for modify_event_symbol. */
4597 static Lisp_Object accent_key_syms
;
4598 static Lisp_Object func_key_syms
;
4599 static Lisp_Object mouse_syms
;
4600 static Lisp_Object wheel_syms
;
4601 static Lisp_Object drag_n_drop_syms
;
4603 /* This is a list of keysym codes for special "accent" characters.
4604 It parallels lispy_accent_keys. */
4606 static const int lispy_accent_codes
[] =
4608 #ifdef XK_dead_circumflex
4613 #ifdef XK_dead_grave
4618 #ifdef XK_dead_tilde
4623 #ifdef XK_dead_diaeresis
4628 #ifdef XK_dead_macron
4633 #ifdef XK_dead_degree
4638 #ifdef XK_dead_acute
4643 #ifdef XK_dead_cedilla
4648 #ifdef XK_dead_breve
4653 #ifdef XK_dead_ogonek
4658 #ifdef XK_dead_caron
4663 #ifdef XK_dead_doubleacute
4664 XK_dead_doubleacute
,
4668 #ifdef XK_dead_abovedot
4673 #ifdef XK_dead_abovering
4683 #ifdef XK_dead_belowdot
4688 #ifdef XK_dead_voiced_sound
4689 XK_dead_voiced_sound
,
4693 #ifdef XK_dead_semivoiced_sound
4694 XK_dead_semivoiced_sound
,
4710 /* This is a list of Lisp names for special "accent" characters.
4711 It parallels lispy_accent_codes. */
4713 static char *lispy_accent_keys
[] =
4731 "dead-voiced-sound",
4732 "dead-semivoiced-sound",
4738 #define FUNCTION_KEY_OFFSET 0x0
4740 char *lispy_function_keys
[] =
4744 0, /* VK_LBUTTON 0x01 */
4745 0, /* VK_RBUTTON 0x02 */
4746 "cancel", /* VK_CANCEL 0x03 */
4747 0, /* VK_MBUTTON 0x04 */
4749 0, 0, 0, /* 0x05 .. 0x07 */
4751 "backspace", /* VK_BACK 0x08 */
4752 "tab", /* VK_TAB 0x09 */
4754 0, 0, /* 0x0A .. 0x0B */
4756 "clear", /* VK_CLEAR 0x0C */
4757 "return", /* VK_RETURN 0x0D */
4759 0, 0, /* 0x0E .. 0x0F */
4761 0, /* VK_SHIFT 0x10 */
4762 0, /* VK_CONTROL 0x11 */
4763 0, /* VK_MENU 0x12 */
4764 "pause", /* VK_PAUSE 0x13 */
4765 "capslock", /* VK_CAPITAL 0x14 */
4766 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4768 "junja", /* VK_JUNJA 0x17 */
4769 "final", /* VK_FINAL 0x18 */
4770 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4772 "escape", /* VK_ESCAPE 0x1B */
4773 "convert", /* VK_CONVERT 0x1C */
4774 "non-convert", /* VK_NONCONVERT 0x1D */
4775 "accept", /* VK_ACCEPT 0x1E */
4776 "mode-change", /* VK_MODECHANGE 0x1F */
4777 0, /* VK_SPACE 0x20 */
4778 "prior", /* VK_PRIOR 0x21 */
4779 "next", /* VK_NEXT 0x22 */
4780 "end", /* VK_END 0x23 */
4781 "home", /* VK_HOME 0x24 */
4782 "left", /* VK_LEFT 0x25 */
4783 "up", /* VK_UP 0x26 */
4784 "right", /* VK_RIGHT 0x27 */
4785 "down", /* VK_DOWN 0x28 */
4786 "select", /* VK_SELECT 0x29 */
4787 "print", /* VK_PRINT 0x2A */
4788 "execute", /* VK_EXECUTE 0x2B */
4789 "snapshot", /* VK_SNAPSHOT 0x2C */
4790 "insert", /* VK_INSERT 0x2D */
4791 "delete", /* VK_DELETE 0x2E */
4792 "help", /* VK_HELP 0x2F */
4794 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4796 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4798 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4800 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4802 0, 0, 0, 0, 0, 0, 0, 0, 0,
4803 0, 0, 0, 0, 0, 0, 0, 0, 0,
4804 0, 0, 0, 0, 0, 0, 0, 0,
4806 "lwindow", /* VK_LWIN 0x5B */
4807 "rwindow", /* VK_RWIN 0x5C */
4808 "apps", /* VK_APPS 0x5D */
4811 "kp-0", /* VK_NUMPAD0 0x60 */
4812 "kp-1", /* VK_NUMPAD1 0x61 */
4813 "kp-2", /* VK_NUMPAD2 0x62 */
4814 "kp-3", /* VK_NUMPAD3 0x63 */
4815 "kp-4", /* VK_NUMPAD4 0x64 */
4816 "kp-5", /* VK_NUMPAD5 0x65 */
4817 "kp-6", /* VK_NUMPAD6 0x66 */
4818 "kp-7", /* VK_NUMPAD7 0x67 */
4819 "kp-8", /* VK_NUMPAD8 0x68 */
4820 "kp-9", /* VK_NUMPAD9 0x69 */
4821 "kp-multiply", /* VK_MULTIPLY 0x6A */
4822 "kp-add", /* VK_ADD 0x6B */
4823 "kp-separator", /* VK_SEPARATOR 0x6C */
4824 "kp-subtract", /* VK_SUBTRACT 0x6D */
4825 "kp-decimal", /* VK_DECIMAL 0x6E */
4826 "kp-divide", /* VK_DIVIDE 0x6F */
4827 "f1", /* VK_F1 0x70 */
4828 "f2", /* VK_F2 0x71 */
4829 "f3", /* VK_F3 0x72 */
4830 "f4", /* VK_F4 0x73 */
4831 "f5", /* VK_F5 0x74 */
4832 "f6", /* VK_F6 0x75 */
4833 "f7", /* VK_F7 0x76 */
4834 "f8", /* VK_F8 0x77 */
4835 "f9", /* VK_F9 0x78 */
4836 "f10", /* VK_F10 0x79 */
4837 "f11", /* VK_F11 0x7A */
4838 "f12", /* VK_F12 0x7B */
4839 "f13", /* VK_F13 0x7C */
4840 "f14", /* VK_F14 0x7D */
4841 "f15", /* VK_F15 0x7E */
4842 "f16", /* VK_F16 0x7F */
4843 "f17", /* VK_F17 0x80 */
4844 "f18", /* VK_F18 0x81 */
4845 "f19", /* VK_F19 0x82 */
4846 "f20", /* VK_F20 0x83 */
4847 "f21", /* VK_F21 0x84 */
4848 "f22", /* VK_F22 0x85 */
4849 "f23", /* VK_F23 0x86 */
4850 "f24", /* VK_F24 0x87 */
4852 0, 0, 0, 0, /* 0x88 .. 0x8B */
4853 0, 0, 0, 0, /* 0x8C .. 0x8F */
4855 "kp-numlock", /* VK_NUMLOCK 0x90 */
4856 "scroll", /* VK_SCROLL 0x91 */
4857 /* Not sure where the following block comes from.
4858 Windows headers have NEC and Fujitsu specific keys in
4859 this block, but nothing generic. */
4860 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4861 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4862 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4863 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4864 "kp-end", /* VK_NUMPAD_END 0x96 */
4865 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4866 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4867 "kp-up", /* VK_NUMPAD_UP 0x99 */
4868 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4869 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4870 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4871 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4873 0, 0, /* 0x9E .. 0x9F */
4876 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4877 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4878 * No other API or message will distinguish left and right keys this way.
4883 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4884 to enable them selectively, and gives access to a few more functions.
4885 See lispy_multimedia_keys below. */
4886 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4887 0, 0, 0, /* 0xAD .. 0xAF Volume */
4888 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4889 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4891 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4892 0, 0, 0, 0, 0, 0, 0, 0, 0,
4894 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4895 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4896 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4899 "ax", /* VK_OEM_AX 0xE1 */
4900 0, /* VK_OEM_102 0xE2 */
4901 "ico-help", /* VK_ICO_HELP 0xE3 */
4902 "ico-00", /* VK_ICO_00 0xE4 */
4903 0, /* VK_PROCESSKEY 0xE5 */
4904 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4905 "packet", /* VK_PACKET 0xE7 */
4907 "reset", /* VK_OEM_RESET 0xE9 */
4908 "jump", /* VK_OEM_JUMP 0xEA */
4909 "oem-pa1", /* VK_OEM_PA1 0xEB */
4910 "oem-pa2", /* VK_OEM_PA2 0xEC */
4911 "oem-pa3", /* VK_OEM_PA3 0xED */
4912 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4913 "cusel", /* VK_OEM_CUSEL 0xEF */
4914 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4915 "finish", /* VK_OEM_FINISH 0xF1 */
4916 "copy", /* VK_OEM_COPY 0xF2 */
4917 "auto", /* VK_OEM_AUTO 0xF3 */
4918 "enlw", /* VK_OEM_ENLW 0xF4 */
4919 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4920 "attn", /* VK_ATTN 0xF6 */
4921 "crsel", /* VK_CRSEL 0xF7 */
4922 "exsel", /* VK_EXSEL 0xF8 */
4923 "ereof", /* VK_EREOF 0xF9 */
4924 "play", /* VK_PLAY 0xFA */
4925 "zoom", /* VK_ZOOM 0xFB */
4926 "noname", /* VK_NONAME 0xFC */
4927 "pa1", /* VK_PA1 0xFD */
4928 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4932 /* Some of these duplicate the "Media keys" on newer keyboards,
4933 but they are delivered to the application in a different way. */
4934 static char *lispy_multimedia_keys
[] =
4942 "browser-favorites",
4979 "toggle-dictate-command",
4985 "media-fast-forward",
4988 "media-channel-down"
4991 #else /* not HAVE_NTGUI */
4993 /* This should be dealt with in XTread_socket now, and that doesn't
4994 depend on the client system having the Kana syms defined. See also
4995 the XK_kana_A case below. */
4998 static char *lispy_kana_keys
[] =
5000 /* X Keysym value */
5001 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5002 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5003 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5004 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5005 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5006 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5007 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5008 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5009 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5011 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5012 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5013 "kana-i", "kana-u", "kana-e", "kana-o",
5014 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5015 "prolongedsound", "kana-A", "kana-I", "kana-U",
5016 "kana-E", "kana-O", "kana-KA", "kana-KI",
5017 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5018 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5019 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5020 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5021 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5022 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5023 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5024 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5025 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5026 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5027 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5028 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5030 #endif /* XK_kana_A */
5033 #define FUNCTION_KEY_OFFSET 0xff00
5035 /* You'll notice that this table is arranged to be conveniently
5036 indexed by X Windows keysym values. */
5037 static char *lispy_function_keys
[] =
5039 /* X Keysym value */
5041 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5042 "backspace", "tab", "linefeed", "clear",
5044 0, 0, 0, "pause", /* 0xff10...1f */
5045 0, 0, 0, 0, 0, 0, 0, "escape",
5047 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5048 "romaji", "hiragana", "katakana", "hiragana-katakana",
5049 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5050 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5051 "eisu-toggle", /* 0xff30...3f */
5052 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5053 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5055 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5056 "down", "prior", "next", "end",
5057 "begin", 0, 0, 0, 0, 0, 0, 0,
5058 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5069 "break", /* 0xff6b */
5072 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5073 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5074 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5075 0, 0, 0, 0, 0, 0, 0, 0,
5076 "kp-tab", /* 0xff89 */
5078 "kp-enter", /* 0xff8d */
5080 "kp-f1", /* 0xff91 */
5084 "kp-home", /* 0xff95 */
5089 "kp-prior", /* kp-page-up */
5090 "kp-next", /* kp-page-down */
5096 0, 0, 0, 0, 0, 0, 0, 0, 0,
5097 "kp-multiply", /* 0xffaa */
5102 "kp-divide", /* 0xffaf */
5103 "kp-0", /* 0xffb0 */
5104 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5107 "kp-equal", /* 0xffbd */
5108 "f1", /* 0xffbe */ /* IsFunctionKey */
5110 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5111 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5112 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5113 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5114 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5115 0, 0, 0, 0, 0, 0, 0, 0,
5116 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5117 0, 0, 0, 0, 0, 0, 0, "delete"
5120 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5121 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5123 static char *iso_lispy_function_keys
[] =
5125 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5126 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5127 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5128 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5129 "iso-lefttab", /* 0xfe20 */
5130 "iso-move-line-up", "iso-move-line-down",
5131 "iso-partial-line-up", "iso-partial-line-down",
5132 "iso-partial-space-left", "iso-partial-space-right",
5133 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5134 "iso-release-margin-left", "iso-release-margin-right",
5135 "iso-release-both-margins",
5136 "iso-fast-cursor-left", "iso-fast-cursor-right",
5137 "iso-fast-cursor-up", "iso-fast-cursor-down",
5138 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5139 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5142 #endif /* not HAVE_NTGUI */
5144 Lisp_Object Vlispy_mouse_stem
;
5146 static char *lispy_wheel_names
[] =
5148 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5151 /* drag-n-drop events are generated when a set of selected files are
5152 dragged from another application and dropped onto an Emacs window. */
5153 static char *lispy_drag_n_drop_names
[] =
5158 /* Scroll bar parts. */
5159 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5160 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5161 Lisp_Object Qtop
, Qratio
;
5163 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5164 Lisp_Object
*scroll_bar_parts
[] = {
5165 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5166 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5169 /* A vector, indexed by button number, giving the down-going location
5170 of currently depressed buttons, both scroll bar and non-scroll bar.
5172 The elements have the form
5173 (BUTTON-NUMBER MODIFIER-MASK . REST)
5174 where REST is the cdr of a position as it would be reported in the event.
5176 The make_lispy_event function stores positions here to tell the
5177 difference between click and drag events, and to store the starting
5178 location to be included in drag events. */
5180 static Lisp_Object button_down_location
;
5182 /* Information about the most recent up-going button event: Which
5183 button, what location, and what time. */
5185 static int last_mouse_button
;
5186 static int last_mouse_x
;
5187 static int last_mouse_y
;
5188 static unsigned long button_down_time
;
5190 /* The maximum time between clicks to make a double-click, or Qnil to
5191 disable double-click detection, or Qt for no time limit. */
5193 Lisp_Object Vdouble_click_time
;
5195 /* Maximum number of pixels the mouse may be moved between clicks
5196 to make a double-click. */
5198 EMACS_INT double_click_fuzz
;
5200 /* The number of clicks in this multiple-click. */
5202 int double_click_count
;
5204 /* Return position of a mouse click or wheel event */
5207 make_lispy_position (struct frame
*f
, Lisp_Object
*x
, Lisp_Object
*y
,
5211 enum window_part part
;
5212 Lisp_Object posn
= Qnil
;
5213 Lisp_Object extra_info
= Qnil
;
5216 /* Set `window' to the window under frame pixel coordinates (x,y) */
5218 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5219 &part
, &wx
, &wy
, 0);
5223 if (WINDOWP (window
))
5225 /* It's a click in window window at frame coordinates (x,y) */
5226 struct window
*w
= XWINDOW (window
);
5227 Lisp_Object string_info
= Qnil
;
5228 int textpos
= -1, rx
= -1, ry
= -1;
5229 int dx
= -1, dy
= -1;
5230 int width
= -1, height
= -1;
5231 Lisp_Object object
= Qnil
;
5233 /* Set event coordinates to window-relative coordinates
5234 for constructing the Lisp event below. */
5238 if (part
== ON_TEXT
)
5240 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5242 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5244 /* Mode line or header line. Look for a string under
5245 the mouse that may have a `local-map' property. */
5249 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5251 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5252 &object
, &dx
, &dy
, &width
, &height
);
5253 if (STRINGP (string
))
5254 string_info
= Fcons (string
, make_number (charpos
));
5255 if (w
== XWINDOW (selected_window
)
5256 && current_buffer
== XBUFFER (w
->buffer
))
5259 textpos
= XMARKER (w
->pointm
)->charpos
;
5261 else if (part
== ON_VERTICAL_BORDER
)
5263 posn
= Qvertical_line
;
5268 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5273 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5275 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5276 &object
, &dx
, &dy
, &width
, &height
);
5277 if (STRINGP (string
))
5278 string_info
= Fcons (string
, make_number (charpos
));
5279 if (part
== ON_LEFT_MARGIN
)
5282 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5284 else if (part
== ON_LEFT_FRINGE
)
5286 posn
= Qleft_fringe
;
5289 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5291 : window_box_width (w
, LEFT_MARGIN_AREA
));
5294 else if (part
== ON_RIGHT_FRINGE
)
5296 posn
= Qright_fringe
;
5299 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5300 + window_box_width (w
, TEXT_AREA
)
5301 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5302 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5308 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5309 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5314 Lisp_Object string2
, object2
= Qnil
;
5315 struct display_pos p
;
5317 int width2
, height2
;
5318 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5319 &object2
, &dx2
, &dy2
,
5321 textpos
= CHARPOS (p
.pos
);
5322 if (rx
< 0) rx
= wx
;
5323 if (ry
< 0) ry
= wy
;
5324 if (dx
< 0) dx
= dx2
;
5325 if (dy
< 0) dy
= dy2
;
5326 if (width
< 0) width
= width2
;
5327 if (height
< 0) height
= height2
;
5331 posn
= make_number (textpos
);
5332 if (STRINGP (string2
))
5333 string_info
= Fcons (string2
,
5334 make_number (CHARPOS (p
.string_pos
)));
5340 #ifdef HAVE_WINDOW_SYSTEM
5341 if (IMAGEP (object
))
5343 Lisp_Object image_map
, hotspot
;
5344 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5346 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5348 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5349 posn
= XCAR (hotspot
);
5354 extra_info
= Fcons (object
,
5355 Fcons (Fcons (make_number (dx
),
5357 Fcons (Fcons (make_number (width
),
5358 make_number (height
)),
5362 extra_info
= Fcons (string_info
,
5363 Fcons (make_number (textpos
),
5364 Fcons (Fcons (make_number (rx
),
5370 XSETFRAME (window
, f
);
5375 XSETFASTINT (*x
, 0);
5376 XSETFASTINT (*y
, 0);
5379 return Fcons (window
,
5381 Fcons (Fcons (*x
, *y
),
5382 Fcons (make_number (time
),
5386 /* Given a struct input_event, build the lisp event which represents
5387 it. If EVENT is 0, build a mouse movement event from the mouse
5388 movement buffer, which should have a movement event in it.
5390 Note that events must be passed to this function in the order they
5391 are received; this function stores the location of button presses
5392 in order to build drag events when the button is released. */
5395 make_lispy_event (struct input_event
*event
)
5399 switch (SWITCH_ENUM_CAST (event
->kind
))
5401 /* A simple keystroke. */
5402 case ASCII_KEYSTROKE_EVENT
:
5403 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5405 Lisp_Object lispy_c
;
5406 int c
= event
->code
;
5407 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5410 eassert (c
== event
->code
);
5411 /* Turn ASCII characters into control characters
5413 if (event
->modifiers
& ctrl_modifier
)
5415 c
= make_ctrl_char (c
);
5416 event
->modifiers
&= ~ctrl_modifier
;
5420 /* Add in the other modifier bits. The shift key was taken care
5421 of by the X code. */
5422 c
|= (event
->modifiers
5423 & (meta_modifier
| alt_modifier
5424 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5425 /* Distinguish Shift-SPC from SPC. */
5426 if ((event
->code
) == 040
5427 && event
->modifiers
& shift_modifier
)
5428 c
|= shift_modifier
;
5429 button_down_time
= 0;
5430 XSETFASTINT (lispy_c
, c
);
5435 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5436 except that they are non-key events (last-nonmenu-event is nil). */
5437 case NS_NONKEY_EVENT
:
5440 /* A function key. The symbol may need to have modifier prefixes
5442 case NON_ASCII_KEYSTROKE_EVENT
:
5443 button_down_time
= 0;
5445 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5446 if (event
->code
== lispy_accent_codes
[i
])
5447 return modify_event_symbol (i
,
5449 Qfunction_key
, Qnil
,
5450 lispy_accent_keys
, &accent_key_syms
,
5451 (sizeof (lispy_accent_keys
)
5452 / sizeof (lispy_accent_keys
[0])));
5456 if (event
->code
>= 0x400 && event
->code
< 0x500)
5457 return modify_event_symbol (event
->code
- 0x400,
5458 event
->modifiers
& ~shift_modifier
,
5459 Qfunction_key
, Qnil
,
5460 lispy_kana_keys
, &func_key_syms
,
5461 (sizeof (lispy_kana_keys
)
5462 / sizeof (lispy_kana_keys
[0])));
5463 #endif /* XK_kana_A */
5466 #ifdef ISO_FUNCTION_KEY_OFFSET
5467 if (event
->code
< FUNCTION_KEY_OFFSET
5468 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5469 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5471 Qfunction_key
, Qnil
,
5472 iso_lispy_function_keys
, &func_key_syms
,
5473 (sizeof (iso_lispy_function_keys
)
5474 / sizeof (iso_lispy_function_keys
[0])));
5477 /* Handle system-specific or unknown keysyms. */
5478 if (event
->code
& (1 << 28)
5479 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5480 || (event
->code
- FUNCTION_KEY_OFFSET
5481 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5482 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5484 /* We need to use an alist rather than a vector as the cache
5485 since we can't make a vector long enuf. */
5486 if (NILP (current_kboard
->system_key_syms
))
5487 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5488 return modify_event_symbol (event
->code
,
5491 current_kboard
->Vsystem_key_alist
,
5492 0, ¤t_kboard
->system_key_syms
,
5496 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5498 Qfunction_key
, Qnil
,
5499 lispy_function_keys
, &func_key_syms
,
5500 (sizeof (lispy_function_keys
)
5501 / sizeof (lispy_function_keys
[0])));
5504 case MULTIMEDIA_KEY_EVENT
:
5505 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5506 / sizeof (lispy_multimedia_keys
[0]))
5507 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5509 return modify_event_symbol (event
->code
, event
->modifiers
,
5510 Qfunction_key
, Qnil
,
5511 lispy_multimedia_keys
, &func_key_syms
,
5512 (sizeof (lispy_multimedia_keys
)
5513 / sizeof (lispy_multimedia_keys
[0])));
5519 /* A mouse click. Figure out where it is, decide whether it's
5520 a press, click or drag, and build the appropriate structure. */
5521 case MOUSE_CLICK_EVENT
:
5522 #ifndef USE_TOOLKIT_SCROLL_BARS
5523 case SCROLL_BAR_CLICK_EVENT
:
5526 int button
= event
->code
;
5528 Lisp_Object position
;
5529 Lisp_Object
*start_pos_ptr
;
5530 Lisp_Object start_pos
;
5534 /* Build the position as appropriate for this mouse click. */
5535 if (event
->kind
== MOUSE_CLICK_EVENT
)
5537 struct frame
*f
= XFRAME (event
->frame_or_window
);
5538 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5542 /* Ignore mouse events that were made on frame that
5543 have been deleted. */
5544 if (! FRAME_LIVE_P (f
))
5547 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5548 /* EVENT->x and EVENT->y are frame-relative pixel
5549 coordinates at this place. Under old redisplay, COLUMN
5550 and ROW are set to frame relative glyph coordinates
5551 which are then used to determine whether this click is
5552 in a menu (non-toolkit version). */
5553 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5554 &column
, &row
, NULL
, 1);
5556 /* In the non-toolkit version, clicks on the menu bar
5557 are ordinary button events in the event buffer.
5558 Distinguish them, and invoke the menu.
5560 (In the toolkit version, the toolkit handles the menu bar
5561 and Emacs doesn't know about it until after the user
5562 makes a selection.) */
5563 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5564 && (event
->modifiers
& down_modifier
))
5566 Lisp_Object items
, item
;
5571 /* Activate the menu bar on the down event. If the
5572 up event comes in before the menu code can deal with it,
5574 if (! (event
->modifiers
& down_modifier
))
5578 /* Find the menu bar item under `column'. */
5580 items
= FRAME_MENU_BAR_ITEMS (f
);
5581 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5583 Lisp_Object pos
, string
;
5584 string
= AREF (items
, i
+ 1);
5585 pos
= AREF (items
, i
+ 3);
5588 if (column
>= XINT (pos
)
5589 && column
< XINT (pos
) + SCHARS (string
))
5591 item
= AREF (items
, i
);
5596 /* ELisp manual 2.4b says (x y) are window relative but
5597 code says they are frame-relative. */
5599 = Fcons (event
->frame_or_window
,
5601 Fcons (Fcons (event
->x
, event
->y
),
5602 Fcons (make_number (event
->timestamp
),
5605 return Fcons (item
, Fcons (position
, Qnil
));
5607 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5609 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5612 #ifndef USE_TOOLKIT_SCROLL_BARS
5615 /* It's a scrollbar click. */
5617 Lisp_Object portion_whole
;
5620 window
= event
->frame_or_window
;
5621 portion_whole
= Fcons (event
->x
, event
->y
);
5622 part
= *scroll_bar_parts
[(int) event
->part
];
5626 Fcons (Qvertical_scroll_bar
,
5627 Fcons (portion_whole
,
5628 Fcons (make_number (event
->timestamp
),
5629 Fcons (part
, Qnil
)))));
5631 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5633 if (button
>= ASIZE (button_down_location
))
5635 button_down_location
= larger_vector (button_down_location
,
5637 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5640 start_pos_ptr
= &AREF (button_down_location
, button
);
5641 start_pos
= *start_pos_ptr
;
5642 *start_pos_ptr
= Qnil
;
5645 /* On window-system frames, use the value of
5646 double-click-fuzz as is. On other frames, interpret it
5647 as a multiple of 1/8 characters. */
5651 if (WINDOWP (event
->frame_or_window
))
5652 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5653 else if (FRAMEP (event
->frame_or_window
))
5654 f
= XFRAME (event
->frame_or_window
);
5658 if (FRAME_WINDOW_P (f
))
5659 fuzz
= double_click_fuzz
;
5661 fuzz
= double_click_fuzz
/ 8;
5663 is_double
= (button
== last_mouse_button
5664 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5665 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5666 && button_down_time
!= 0
5667 && (EQ (Vdouble_click_time
, Qt
)
5668 || (INTEGERP (Vdouble_click_time
)
5669 && ((int)(event
->timestamp
- button_down_time
)
5670 < XINT (Vdouble_click_time
)))));
5673 last_mouse_button
= button
;
5674 last_mouse_x
= XINT (event
->x
);
5675 last_mouse_y
= XINT (event
->y
);
5677 /* If this is a button press, squirrel away the location, so
5678 we can decide later whether it was a click or a drag. */
5679 if (event
->modifiers
& down_modifier
)
5683 double_click_count
++;
5684 event
->modifiers
|= ((double_click_count
> 2)
5689 double_click_count
= 1;
5690 button_down_time
= event
->timestamp
;
5691 *start_pos_ptr
= Fcopy_alist (position
);
5692 ignore_mouse_drag_p
= 0;
5695 /* Now we're releasing a button - check the co-ordinates to
5696 see if this was a click or a drag. */
5697 else if (event
->modifiers
& up_modifier
)
5699 /* If we did not see a down before this up, ignore the up.
5700 Probably this happened because the down event chose a
5701 menu item. It would be an annoyance to treat the
5702 release of the button that chose the menu item as a
5705 if (!CONSP (start_pos
))
5708 event
->modifiers
&= ~up_modifier
;
5709 #if 0 /* Formerly we treated an up with no down as a click event. */
5710 if (!CONSP (start_pos
))
5711 event
->modifiers
|= click_modifier
;
5716 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5718 /* The third element of every position
5719 should be the (x,y) pair. */
5720 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5722 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5724 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5725 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5728 if (ignore_mouse_drag_p
)
5730 event
->modifiers
|= click_modifier
;
5731 ignore_mouse_drag_p
= 0;
5733 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5734 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5735 /* Maybe the mouse has moved a lot, caused scrolling, and
5736 eventually ended up at the same screen position (but
5737 not buffer position) in which case it is a drag, not
5739 /* FIXME: OTOH if the buffer position has changed
5740 because of a timer or process filter rather than
5741 because of mouse movement, it should be considered as
5742 a click. But mouse-drag-region completely ignores
5743 this case and it hasn't caused any real problem, so
5744 it's probably OK to ignore it as well. */
5745 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5746 /* Mouse hasn't moved (much). */
5747 event
->modifiers
|= click_modifier
;
5750 button_down_time
= 0;
5751 event
->modifiers
|= drag_modifier
;
5754 /* Don't check is_double; treat this as multiple
5755 if the down-event was multiple. */
5756 if (double_click_count
> 1)
5757 event
->modifiers
|= ((double_click_count
> 2)
5763 /* Every mouse event should either have the down_modifier or
5764 the up_modifier set. */
5768 /* Get the symbol we should use for the mouse click. */
5771 head
= modify_event_symbol (button
,
5773 Qmouse_click
, Vlispy_mouse_stem
,
5776 XVECTOR (mouse_syms
)->size
);
5777 if (event
->modifiers
& drag_modifier
)
5782 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5785 Fcons (make_number (double_click_count
),
5795 case HORIZ_WHEEL_EVENT
:
5797 Lisp_Object position
;
5800 /* Build the position as appropriate for this mouse click. */
5801 struct frame
*f
= XFRAME (event
->frame_or_window
);
5803 /* Ignore wheel events that were made on frame that have been
5805 if (! FRAME_LIVE_P (f
))
5808 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5811 /* Set double or triple modifiers to indicate the wheel speed. */
5813 /* On window-system frames, use the value of
5814 double-click-fuzz as is. On other frames, interpret it
5815 as a multiple of 1/8 characters. */
5821 if (WINDOWP (event
->frame_or_window
))
5822 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5823 else if (FRAMEP (event
->frame_or_window
))
5824 f
= XFRAME (event
->frame_or_window
);
5828 if (FRAME_WINDOW_P (f
))
5829 fuzz
= double_click_fuzz
;
5831 fuzz
= double_click_fuzz
/ 8;
5833 if (event
->modifiers
& up_modifier
)
5835 /* Emit a wheel-up event. */
5836 event
->modifiers
&= ~up_modifier
;
5839 else if (event
->modifiers
& down_modifier
)
5841 /* Emit a wheel-down event. */
5842 event
->modifiers
&= ~down_modifier
;
5846 /* Every wheel event should either have the down_modifier or
5847 the up_modifier set. */
5850 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5853 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5854 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5855 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5856 && button_down_time
!= 0
5857 && (EQ (Vdouble_click_time
, Qt
)
5858 || (INTEGERP (Vdouble_click_time
)
5859 && ((int)(event
->timestamp
- button_down_time
)
5860 < XINT (Vdouble_click_time
)))));
5863 double_click_count
++;
5864 event
->modifiers
|= ((double_click_count
> 2)
5870 double_click_count
= 1;
5871 event
->modifiers
|= click_modifier
;
5874 button_down_time
= event
->timestamp
;
5875 /* Use a negative value to distinguish wheel from mouse button. */
5876 last_mouse_button
= - (1 + symbol_num
);
5877 last_mouse_x
= XINT (event
->x
);
5878 last_mouse_y
= XINT (event
->y
);
5880 /* Get the symbol we should use for the wheel event. */
5881 head
= modify_event_symbol (symbol_num
,
5887 ASIZE (wheel_syms
));
5890 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5893 Fcons (make_number (double_click_count
),
5902 #ifdef USE_TOOLKIT_SCROLL_BARS
5904 /* We don't have down and up events if using toolkit scroll bars,
5905 so make this always a click event. Store in the `part' of
5906 the Lisp event a symbol which maps to the following actions:
5908 `above_handle' page up
5909 `below_handle' page down
5913 `bottom' bottom of buffer
5914 `handle' thumb has been dragged.
5915 `end-scroll' end of interaction with scroll bar
5917 The incoming input_event contains in its `part' member an
5918 index of type `enum scroll_bar_part' which we can use as an
5919 index in scroll_bar_parts to get the appropriate symbol. */
5921 case SCROLL_BAR_CLICK_EVENT
:
5923 Lisp_Object position
, head
, window
, portion_whole
, part
;
5925 window
= event
->frame_or_window
;
5926 portion_whole
= Fcons (event
->x
, event
->y
);
5927 part
= *scroll_bar_parts
[(int) event
->part
];
5931 Fcons (Qvertical_scroll_bar
,
5932 Fcons (portion_whole
,
5933 Fcons (make_number (event
->timestamp
),
5934 Fcons (part
, Qnil
)))));
5936 /* Always treat scroll bar events as clicks. */
5937 event
->modifiers
|= click_modifier
;
5938 event
->modifiers
&= ~up_modifier
;
5940 if (event
->code
>= ASIZE (mouse_syms
))
5941 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5943 /* Get the symbol we should use for the mouse click. */
5944 head
= modify_event_symbol (event
->code
,
5949 XVECTOR (mouse_syms
)->size
);
5950 return Fcons (head
, Fcons (position
, Qnil
));
5953 #endif /* USE_TOOLKIT_SCROLL_BARS */
5955 case DRAG_N_DROP_EVENT
:
5958 Lisp_Object head
, position
;
5961 f
= XFRAME (event
->frame_or_window
);
5964 /* Ignore mouse events that were made on frames that
5965 have been deleted. */
5966 if (! FRAME_LIVE_P (f
))
5969 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5972 head
= modify_event_symbol (0, event
->modifiers
,
5974 lispy_drag_n_drop_names
,
5975 &drag_n_drop_syms
, 1);
5981 #endif /* HAVE_MOUSE */
5983 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5984 || defined(HAVE_NS) || defined (USE_GTK)
5985 case MENU_BAR_EVENT
:
5986 if (EQ (event
->arg
, event
->frame_or_window
))
5987 /* This is the prefix key. We translate this to
5988 `(menu_bar)' because the code in keyboard.c for menu
5989 events, which we use, relies on this. */
5990 return Fcons (Qmenu_bar
, Qnil
);
5994 case SELECT_WINDOW_EVENT
:
5995 /* Make an event (select-window (WINDOW)). */
5996 return Fcons (Qselect_window
,
5997 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6000 case TOOL_BAR_EVENT
:
6001 if (EQ (event
->arg
, event
->frame_or_window
))
6002 /* This is the prefix key. We translate this to
6003 `(tool_bar)' because the code in keyboard.c for tool bar
6004 events, which we use, relies on this. */
6005 return Fcons (Qtool_bar
, Qnil
);
6006 else if (SYMBOLP (event
->arg
))
6007 return apply_modifiers (event
->modifiers
, event
->arg
);
6010 case USER_SIGNAL_EVENT
:
6011 /* A user signal. */
6013 char *name
= find_user_signal_name (event
->code
);
6016 return intern (name
);
6019 case SAVE_SESSION_EVENT
:
6020 return Qsave_session
;
6025 return Fcons (Qdbus_event
, event
->arg
);
6027 #endif /* HAVE_DBUS */
6029 case CONFIG_CHANGED_EVENT
:
6030 return Fcons (Qconfig_changed_event
,
6032 Fcons (event
->frame_or_window
, Qnil
)));
6034 case GPM_CLICK_EVENT
:
6036 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6037 Lisp_Object head
, position
;
6038 Lisp_Object
*start_pos_ptr
;
6039 Lisp_Object start_pos
;
6040 int button
= event
->code
;
6042 if (button
>= ASIZE (button_down_location
))
6044 button_down_location
= larger_vector (button_down_location
,
6046 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6049 start_pos_ptr
= &AREF (button_down_location
, button
);
6050 start_pos
= *start_pos_ptr
;
6052 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6055 if (event
->modifiers
& down_modifier
)
6056 *start_pos_ptr
= Fcopy_alist (position
);
6057 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6059 if (!CONSP (start_pos
))
6061 event
->modifiers
&= ~up_modifier
;
6064 head
= modify_event_symbol (button
,
6066 Qmouse_click
, Vlispy_mouse_stem
,
6069 XVECTOR (mouse_syms
)->size
);
6071 if (event
->modifiers
& drag_modifier
)
6076 else if (event
->modifiers
& double_modifier
)
6079 Fcons (make_number (2),
6081 else if (event
->modifiers
& triple_modifier
)
6084 Fcons (make_number (3),
6091 #endif /* HAVE_GPM */
6093 /* The 'kind' field of the event is something we don't recognize. */
6099 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6102 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6103 Lisp_Object x
, Lisp_Object y
, unsigned long time
)
6105 /* Is it a scroll bar movement? */
6106 if (frame
&& ! NILP (bar_window
))
6108 Lisp_Object part_sym
;
6110 part_sym
= *scroll_bar_parts
[(int) part
];
6111 return Fcons (Qscroll_bar_movement
,
6112 (Fcons (Fcons (bar_window
,
6113 Fcons (Qvertical_scroll_bar
,
6114 Fcons (Fcons (x
, y
),
6115 Fcons (make_number (time
),
6121 /* Or is it an ordinary mouse movement? */
6124 Lisp_Object position
;
6126 position
= make_lispy_position (frame
, &x
, &y
, time
);
6128 return Fcons (Qmouse_movement
,
6134 #endif /* HAVE_MOUSE || HAVE GPM */
6136 /* Construct a switch frame event. */
6138 make_lispy_switch_frame (Lisp_Object frame
)
6140 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6143 /* Manipulating modifiers. */
6145 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6147 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6148 SYMBOL's name of the end of the modifiers; the string from this
6149 position is the unmodified symbol name.
6151 This doesn't use any caches. */
6154 parse_modifiers_uncached (Lisp_Object symbol
, int *modifier_end
)
6160 CHECK_SYMBOL (symbol
);
6163 name
= SYMBOL_NAME (symbol
);
6165 for (i
= 0; i
+2 <= SBYTES (name
); )
6167 int this_mod_end
= 0;
6170 /* See if the name continues with a modifier word.
6171 Check that the word appears, but don't check what follows it.
6172 Set this_mod and this_mod_end to record what we find. */
6174 switch (SREF (name
, i
))
6176 #define SINGLE_LETTER_MOD(BIT) \
6177 (this_mod_end = i + 1, this_mod = BIT)
6180 SINGLE_LETTER_MOD (alt_modifier
);
6184 SINGLE_LETTER_MOD (ctrl_modifier
);
6188 SINGLE_LETTER_MOD (hyper_modifier
);
6192 SINGLE_LETTER_MOD (meta_modifier
);
6196 SINGLE_LETTER_MOD (shift_modifier
);
6200 SINGLE_LETTER_MOD (super_modifier
);
6203 #undef SINGLE_LETTER_MOD
6205 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6206 if (i + LEN + 1 <= SBYTES (name) \
6207 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6209 this_mod_end = i + LEN; \
6214 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6215 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6216 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6220 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6222 #undef MULTI_LETTER_MOD
6226 /* If we found no modifier, stop looking for them. */
6227 if (this_mod_end
== 0)
6230 /* Check there is a dash after the modifier, so that it
6231 really is a modifier. */
6232 if (this_mod_end
>= SBYTES (name
)
6233 || SREF (name
, this_mod_end
) != '-')
6236 /* This modifier is real; look for another. */
6237 modifiers
|= this_mod
;
6238 i
= this_mod_end
+ 1;
6241 /* Should we include the `click' modifier? */
6242 if (! (modifiers
& (down_modifier
| drag_modifier
6243 | double_modifier
| triple_modifier
))
6244 && i
+ 7 == SBYTES (name
)
6245 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6246 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6247 modifiers
|= click_modifier
;
6249 if (! (modifiers
& (double_modifier
| triple_modifier
))
6250 && i
+ 6 < SBYTES (name
)
6251 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6252 modifiers
|= click_modifier
;
6260 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6261 prepended to the string BASE[0..BASE_LEN-1].
6262 This doesn't use any caches. */
6264 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6266 /* Since BASE could contain nulls, we can't use intern here; we have
6267 to use Fintern, which expects a genuine Lisp_String, and keeps a
6270 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6276 /* Only the event queue may use the `up' modifier; it should always
6277 be turned into a click or drag event before presented to lisp code. */
6278 if (modifiers
& up_modifier
)
6281 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6282 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6283 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6284 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6285 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6286 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6287 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6288 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6289 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6290 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6291 /* The click modifier is denoted by the absence of other modifiers. */
6295 mod_len
= p
- new_mods
;
6299 Lisp_Object new_name
;
6301 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6302 mod_len
+ base_len_byte
);
6303 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6304 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6306 return Fintern (new_name
, Qnil
);
6311 static const char *modifier_names
[] =
6313 "up", "down", "drag", "click", "double", "triple", 0, 0,
6314 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6315 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6317 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6319 static Lisp_Object modifier_symbols
;
6321 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6323 lispy_modifier_list (int modifiers
)
6325 Lisp_Object modifier_list
;
6328 modifier_list
= Qnil
;
6329 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6330 if (modifiers
& (1<<i
))
6331 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6334 return modifier_list
;
6338 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6339 where UNMODIFIED is the unmodified form of SYMBOL,
6340 MASK is the set of modifiers present in SYMBOL's name.
6341 This is similar to parse_modifiers_uncached, but uses the cache in
6342 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6343 Qevent_symbol_elements property. */
6345 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6348 parse_modifiers (Lisp_Object symbol
)
6350 Lisp_Object elements
;
6352 if (INTEGERP (symbol
))
6353 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6354 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6356 else if (!SYMBOLP (symbol
))
6359 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6360 if (CONSP (elements
))
6365 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6366 Lisp_Object unmodified
;
6369 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6370 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6373 if (modifiers
& ~INTMASK
)
6375 XSETFASTINT (mask
, modifiers
);
6376 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6378 /* Cache the parsing results on SYMBOL. */
6379 Fput (symbol
, Qevent_symbol_element_mask
,
6381 Fput (symbol
, Qevent_symbol_elements
,
6382 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6384 /* Since we know that SYMBOL is modifiers applied to unmodified,
6385 it would be nice to put that in unmodified's cache.
6386 But we can't, since we're not sure that parse_modifiers is
6393 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6394 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6395 doc
: /* Parse the event symbol. For internal use. */)
6399 /* Fill the cache if needed. */
6400 parse_modifiers (symbol
);
6401 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6402 and use the Lispier representation stored on Qevent_symbol_elements
6404 return Fget (symbol
, Qevent_symbol_elements
);
6407 /* Apply the modifiers MODIFIERS to the symbol BASE.
6408 BASE must be unmodified.
6410 This is like apply_modifiers_uncached, but uses BASE's
6411 Qmodifier_cache property, if present. It also builds
6412 Qevent_symbol_elements properties, since it has that info anyway.
6414 apply_modifiers copies the value of BASE's Qevent_kind property to
6415 the modified symbol. */
6417 apply_modifiers (int modifiers
, Lisp_Object base
)
6419 Lisp_Object cache
, index
, entry
, new_symbol
;
6421 /* Mask out upper bits. We don't know where this value's been. */
6422 modifiers
&= INTMASK
;
6424 if (INTEGERP (base
))
6425 return make_number (XINT (base
) | modifiers
);
6427 /* The click modifier never figures into cache indices. */
6428 cache
= Fget (base
, Qmodifier_cache
);
6429 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6430 entry
= assq_no_quit (index
, cache
);
6433 new_symbol
= XCDR (entry
);
6436 /* We have to create the symbol ourselves. */
6437 new_symbol
= apply_modifiers_uncached (modifiers
,
6438 SDATA (SYMBOL_NAME (base
)),
6439 SCHARS (SYMBOL_NAME (base
)),
6440 SBYTES (SYMBOL_NAME (base
)));
6442 /* Add the new symbol to the base's cache. */
6443 entry
= Fcons (index
, new_symbol
);
6444 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6446 /* We have the parsing info now for free, so we could add it to
6448 XSETFASTINT (index, modifiers);
6449 Fput (new_symbol, Qevent_symbol_element_mask,
6450 Fcons (base, Fcons (index, Qnil)));
6451 Fput (new_symbol, Qevent_symbol_elements,
6452 Fcons (base, lispy_modifier_list (modifiers)));
6453 Sadly, this is only correct if `base' is indeed a base event,
6454 which is not necessarily the case. -stef */
6457 /* Make sure this symbol is of the same kind as BASE.
6459 You'd think we could just set this once and for all when we
6460 intern the symbol above, but reorder_modifiers may call us when
6461 BASE's property isn't set right; we can't assume that just
6462 because it has a Qmodifier_cache property it must have its
6463 Qevent_kind set right as well. */
6464 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6468 kind
= Fget (base
, Qevent_kind
);
6470 Fput (new_symbol
, Qevent_kind
, kind
);
6477 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6478 return a symbol with the modifiers placed in the canonical order.
6479 Canonical order is alphabetical, except for down and drag, which
6480 always come last. The 'click' modifier is never written out.
6482 Fdefine_key calls this to make sure that (for example) C-M-foo
6483 and M-C-foo end up being equivalent in the keymap. */
6486 reorder_modifiers (Lisp_Object symbol
)
6488 /* It's hopefully okay to write the code this way, since everything
6489 will soon be in caches, and no consing will be done at all. */
6492 parsed
= parse_modifiers (symbol
);
6493 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6498 /* For handling events, we often want to produce a symbol whose name
6499 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6500 to some base, like the name of a function key or mouse button.
6501 modify_event_symbol produces symbols of this sort.
6503 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6504 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6507 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6508 into symbol names, or a string specifying a name stem used to
6509 construct a symbol name or the form `STEM-N', where N is the decimal
6510 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6511 non-nil; otherwise NAME_TABLE is used.
6513 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6514 persist between calls to modify_event_symbol that it can use to
6515 store a cache of the symbols it's generated for this NAME_TABLE
6516 before. The object stored there may be a vector or an alist.
6518 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6520 MODIFIERS is a set of modifier bits (as given in struct input_events)
6521 whose prefixes should be applied to the symbol name.
6523 SYMBOL_KIND is the value to be placed in the event_kind property of
6524 the returned symbol.
6526 The symbols we create are supposed to have an
6527 `event-symbol-elements' property, which lists the modifiers present
6528 in the symbol's name. */
6531 modify_event_symbol (int symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6532 Lisp_Object name_alist_or_stem
, char **name_table
,
6533 Lisp_Object
*symbol_table
, unsigned int table_size
)
6536 Lisp_Object symbol_int
;
6538 /* Get rid of the "vendor-specific" bit here. */
6539 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6541 /* Is this a request for a valid symbol? */
6542 if (symbol_num
< 0 || symbol_num
>= table_size
)
6545 if (CONSP (*symbol_table
))
6546 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6548 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6549 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6550 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6551 we've never used that symbol before. */
6554 if (! VECTORP (*symbol_table
)
6555 || XVECTOR (*symbol_table
)->size
!= table_size
)
6559 XSETFASTINT (size
, table_size
);
6560 *symbol_table
= Fmake_vector (size
, Qnil
);
6563 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6566 /* Have we already used this symbol before? */
6569 /* No; let's create it. */
6570 if (CONSP (name_alist_or_stem
))
6571 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6572 else if (STRINGP (name_alist_or_stem
))
6574 int len
= SBYTES (name_alist_or_stem
);
6575 char *buf
= (char *) alloca (len
+ 50);
6576 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6577 (long) XINT (symbol_int
) + 1);
6578 value
= intern (buf
);
6580 else if (name_table
!= 0 && name_table
[symbol_num
])
6581 value
= intern (name_table
[symbol_num
]);
6583 #ifdef HAVE_WINDOW_SYSTEM
6586 char *name
= x_get_keysym_name (symbol_num
);
6588 value
= intern (name
);
6595 sprintf (buf
, "key-%d", symbol_num
);
6596 value
= intern (buf
);
6599 if (CONSP (*symbol_table
))
6600 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6602 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6604 /* Fill in the cache entries for this symbol; this also
6605 builds the Qevent_symbol_elements property, which the user
6607 apply_modifiers (modifiers
& click_modifier
, value
);
6608 Fput (value
, Qevent_kind
, symbol_kind
);
6611 /* Apply modifiers to that symbol. */
6612 return apply_modifiers (modifiers
, value
);
6615 /* Convert a list that represents an event type,
6616 such as (ctrl meta backspace), into the usual representation of that
6617 event type as a number or a symbol. */
6619 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6620 doc
: /* Convert the event description list EVENT-DESC to an event type.
6621 EVENT-DESC should contain one base event type (a character or symbol)
6622 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6623 drag, down, double or triple). The base must be last.
6624 The return value is an event type (a character or symbol) which
6625 has the same base event type and all the specified modifiers. */)
6627 Lisp_Object event_desc
;
6635 while (CONSP (rest
))
6643 /* Given a symbol, see if it is a modifier name. */
6644 if (SYMBOLP (elt
) && CONSP (rest
))
6645 this = parse_solitary_modifier (elt
);
6649 else if (!NILP (base
))
6650 error ("Two bases given in one event");
6656 /* Let the symbol A refer to the character A. */
6657 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6658 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6660 if (INTEGERP (base
))
6662 /* Turn (shift a) into A. */
6663 if ((modifiers
& shift_modifier
) != 0
6664 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6666 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6667 modifiers
&= ~shift_modifier
;
6670 /* Turn (control a) into C-a. */
6671 if (modifiers
& ctrl_modifier
)
6672 return make_number ((modifiers
& ~ctrl_modifier
)
6673 | make_ctrl_char (XINT (base
)));
6675 return make_number (modifiers
| XINT (base
));
6677 else if (SYMBOLP (base
))
6678 return apply_modifiers (modifiers
, base
);
6681 error ("Invalid base event");
6686 /* Try to recognize SYMBOL as a modifier name.
6687 Return the modifier flag bit, or 0 if not recognized. */
6690 parse_solitary_modifier (Lisp_Object symbol
)
6692 Lisp_Object name
= SYMBOL_NAME (symbol
);
6694 switch (SREF (name
, 0))
6696 #define SINGLE_LETTER_MOD(BIT) \
6697 if (SBYTES (name) == 1) \
6700 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6701 if (LEN == SBYTES (name) \
6702 && ! strncmp (SDATA (name), NAME, LEN)) \
6706 SINGLE_LETTER_MOD (alt_modifier
);
6710 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6714 SINGLE_LETTER_MOD (ctrl_modifier
);
6718 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6719 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6723 SINGLE_LETTER_MOD (hyper_modifier
);
6727 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6731 SINGLE_LETTER_MOD (meta_modifier
);
6735 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6739 SINGLE_LETTER_MOD (shift_modifier
);
6743 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6744 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6745 SINGLE_LETTER_MOD (super_modifier
);
6749 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6750 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6751 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6755 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6758 #undef SINGLE_LETTER_MOD
6759 #undef MULTI_LETTER_MOD
6765 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6766 Such a list is not valid as an event,
6767 but it can be a Lucid-style event type list. */
6770 lucid_event_type_list_p (Lisp_Object object
)
6774 if (! CONSP (object
))
6777 if (EQ (XCAR (object
), Qhelp_echo
)
6778 || EQ (XCAR (object
), Qvertical_line
)
6779 || EQ (XCAR (object
), Qmode_line
)
6780 || EQ (XCAR (object
), Qheader_line
))
6783 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6787 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6794 /* Store into *addr a value nonzero if terminal input chars are available.
6795 Serves the purpose of ioctl (0, FIONREAD, addr)
6796 but works even if FIONREAD does not exist.
6797 (In fact, this may actually read some input.)
6799 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6800 timer events that are ripe.
6801 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6802 events (FOCUS_IN_EVENT).
6803 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6804 movements and toolkit scroll bar thumb drags. */
6807 get_input_pending (int *addr
, int flags
)
6809 /* First of all, have we already counted some input? */
6810 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6812 /* If input is being read as it arrives, and we have none, there is none. */
6813 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6816 /* Try to read some input and see how much we get. */
6818 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6821 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6824 gobble_input (int expected
)
6827 /* Read D-Bus messages. */
6828 xd_read_queued_messages ();
6829 #endif /* HAVE_DBUS */
6832 if (interrupt_input
)
6835 mask
= sigblock (sigmask (SIGIO
));
6836 read_avail_input (expected
);
6840 #ifdef POLL_FOR_INPUT
6841 /* XXX This condition was (read_socket_hook && !interrupt_input),
6842 but read_socket_hook is not global anymore. Let's pretend that
6844 if (!interrupt_input
&& poll_suppress_count
== 0)
6847 mask
= sigblock (sigmask (SIGALRM
));
6848 read_avail_input (expected
);
6854 read_avail_input (expected
);
6857 /* Put a BUFFER_SWITCH_EVENT in the buffer
6858 so that read_key_sequence will notice the new current buffer. */
6861 record_asynch_buffer_change (void)
6863 struct input_event event
;
6867 event
.kind
= BUFFER_SWITCH_EVENT
;
6868 event
.frame_or_window
= Qnil
;
6872 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6873 The purpose of the event is to make read_key_sequence look up the
6874 keymaps again. If we aren't in read_key_sequence, we don't need one,
6875 and the event could cause trouble by messing up (input-pending-p). */
6876 tem
= Fwaiting_for_user_input_p ();
6880 /* We never need these events if we have no asynchronous subprocesses. */
6884 /* Make sure no interrupt happens while storing the event. */
6886 if (interrupt_input
)
6889 mask
= sigblock (sigmask (SIGIO
));
6890 kbd_buffer_store_event (&event
);
6897 kbd_buffer_store_event (&event
);
6902 /* Read any terminal input already buffered up by the system
6903 into the kbd_buffer, but do not wait.
6905 EXPECTED should be nonzero if the caller knows there is some input.
6907 Returns the number of keyboard chars read, or -1 meaning
6908 this is a bad time to try to read input. */
6911 read_avail_input (int expected
)
6917 /* Store pending user signal events, if any. */
6918 if (store_user_signal_events ())
6921 /* Loop through the available terminals, and call their input hooks. */
6925 struct terminal
*next
= t
->next_terminal
;
6927 if (t
->read_socket_hook
)
6930 struct input_event hold_quit
;
6932 EVENT_INIT (hold_quit
);
6933 hold_quit
.kind
= NO_EVENT
;
6935 /* No need for FIONREAD or fcntl; just say don't wait. */
6936 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6942 if (nr
== -1) /* Not OK to read input now. */
6946 else if (nr
== -2) /* Non-transient error. */
6948 /* The terminal device terminated; it should be closed. */
6950 /* Kill Emacs if this was our last terminal. */
6951 if (!terminal_list
->next_terminal
)
6952 /* Formerly simply reported no input, but that
6953 sometimes led to a failure of Emacs to terminate.
6954 SIGHUP seems appropriate if we can't reach the
6956 /* ??? Is it really right to send the signal just to
6957 this process rather than to the whole process
6958 group? Perhaps on systems with FIONREAD Emacs is
6959 alone in its group. */
6960 kill (getpid (), SIGHUP
);
6962 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6965 XSETTERMINAL (tmp
, t
);
6966 Fdelete_terminal (tmp
, Qnoelisp
);
6970 if (hold_quit
.kind
!= NO_EVENT
)
6971 kbd_buffer_store_event (&hold_quit
);
6980 frame_make_pointer_visible ();
6986 decode_keyboard_code (struct tty_display_info
*tty
,
6987 struct coding_system
*coding
,
6988 unsigned char *buf
, int nbytes
)
6990 unsigned char *src
= buf
;
6991 const unsigned char *p
;
6996 if (tty
->meta_key
!= 2)
6997 for (i
= 0; i
< nbytes
; i
++)
6999 if (coding
->carryover_bytes
> 0)
7001 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7002 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7003 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7004 nbytes
+= coding
->carryover_bytes
;
7006 coding
->destination
= alloca (nbytes
* 4);
7007 coding
->dst_bytes
= nbytes
* 4;
7008 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7009 if (coding
->produced_char
== 0)
7011 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7013 struct input_event buf
;
7016 buf
.code
= STRING_CHAR_ADVANCE (p
);
7017 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7018 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7019 /* See the comment in tty_read_avail_input. */
7020 buf
.frame_or_window
= tty
->top_frame
;
7022 kbd_buffer_store_event (&buf
);
7026 /* This is the tty way of reading available input.
7028 Note that each terminal device has its own `struct terminal' object,
7029 and so this function is called once for each individual termcap
7030 terminal. The first parameter indicates which terminal to read from. */
7033 tty_read_avail_input (struct terminal
*terminal
,
7035 struct input_event
*hold_quit
)
7037 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7038 the kbd_buffer can really hold. That may prevent loss
7039 of characters on some systems when input is stuffed at us. */
7040 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7042 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7045 if (!terminal
->name
) /* Don't read from a dead terminal. */
7048 if (terminal
->type
!= output_termcap
7049 && terminal
->type
!= output_msdos_raw
)
7052 /* XXX I think the following code should be moved to separate hook
7053 functions in system-dependent files. */
7056 #else /* not WINDOWSNT */
7057 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7061 return 0; /* The terminal is suspended. */
7064 n_to_read
= dos_keysns ();
7068 cbuf
[0] = dos_keyread ();
7071 #else /* not MSDOS */
7076 struct input_event hold_quit
;
7077 int gpm
, fd
= gpm_fd
;
7079 EVENT_INIT (hold_quit
);
7080 hold_quit
.kind
= NO_EVENT
;
7082 /* gpm==1 if event received.
7083 gpm==0 if the GPM daemon has closed the connection, in which case
7084 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7085 we save it in `fd' so close_gpm can remove it from the
7087 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7088 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7089 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7092 /* Presumably the GPM daemon has closed the connection. */
7094 if (hold_quit
.kind
!= NO_EVENT
)
7095 kbd_buffer_store_event (&hold_quit
);
7099 #endif /* HAVE_GPM */
7101 /* Determine how many characters we should *try* to read. */
7103 /* Find out how much input is available. */
7104 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7106 if (! noninteractive
)
7107 return -2; /* Close this terminal. */
7113 if (n_to_read
> sizeof cbuf
)
7114 n_to_read
= sizeof cbuf
;
7115 #else /* no FIONREAD */
7116 #if defined (USG) || defined(CYGWIN)
7117 /* Read some input if available, but don't wait. */
7118 n_to_read
= sizeof cbuf
;
7119 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7125 /* Now read; for one reason or another, this will not block.
7126 NREAD is set to the number of chars read. */
7129 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7130 /* POSIX infers that processes which are not in the session leader's
7131 process group won't get SIGHUP's at logout time. BSDI adheres to
7132 this part standard and returns -1 from read (0) with errno==EIO
7133 when the control tty is taken away.
7134 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7135 if (nread
== -1 && errno
== EIO
)
7136 return -2; /* Close this terminal. */
7137 #if defined (AIX) && defined (_BSD)
7138 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7139 This looks incorrect, but it isn't, because _BSD causes
7140 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7141 and that causes a value other than 0 when there is no input. */
7143 return -2; /* Close this terminal. */
7147 /* We used to retry the read if it was interrupted.
7148 But this does the wrong thing when O_NDELAY causes
7149 an EAGAIN error. Does anybody know of a situation
7150 where a retry is actually needed? */
7152 nread
< 0 && (errno
== EAGAIN
7166 #if defined (USG) || defined (CYGWIN)
7167 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7168 #endif /* USG or CYGWIN */
7169 #endif /* no FIONREAD */
7174 #endif /* not MSDOS */
7175 #endif /* not WINDOWSNT */
7177 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7178 & CODING_REQUIRE_DECODING_MASK
)
7180 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7183 /* Decode the key sequence except for those with meta
7185 for (i
= from
= 0; ; i
++)
7186 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7188 struct input_event buf
;
7190 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7195 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7196 buf
.modifiers
= meta_modifier
;
7197 buf
.code
= cbuf
[i
] & ~0x80;
7198 /* See the comment below. */
7199 buf
.frame_or_window
= tty
->top_frame
;
7201 kbd_buffer_store_event (&buf
);
7207 for (i
= 0; i
< nread
; i
++)
7209 struct input_event buf
;
7211 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7213 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7214 buf
.modifiers
= meta_modifier
;
7215 if (tty
->meta_key
!= 2)
7219 /* Set the frame corresponding to the active tty. Note that the
7220 value of selected_frame is not reliable here, redisplay tends
7221 to temporarily change it. */
7222 buf
.frame_or_window
= tty
->top_frame
;
7225 kbd_buffer_store_event (&buf
);
7226 /* Don't look at input that follows a C-g too closely.
7227 This reduces lossage due to autorepeat on C-g. */
7228 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7229 && buf
.code
== quit_char
)
7237 handle_async_input (void)
7239 interrupt_input_pending
= 0;
7241 pending_signals
= pending_atimers
;
7243 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7244 doing anything dangerous. */
7251 nread
= read_avail_input (1);
7252 /* -1 means it's not ok to read the input now.
7253 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7254 0 means there was no keyboard input available. */
7264 process_pending_signals (void)
7266 if (interrupt_input_pending
)
7267 handle_async_input ();
7268 do_pending_atimers ();
7271 #ifdef SIGIO /* for entire page */
7272 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7275 input_available_signal (int signo
)
7277 /* Must preserve main program's value of errno. */
7278 int old_errno
= errno
;
7279 SIGNAL_THREAD_CHECK (signo
);
7282 interrupt_input_pending
= 1;
7283 pending_signals
= 1;
7286 if (input_available_clear_time
)
7287 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7290 handle_async_input ();
7297 /* Send ourselves a SIGIO.
7299 This function exists so that the UNBLOCK_INPUT macro in
7300 blockinput.h can have some way to take care of input we put off
7301 dealing with, without assuming that every file which uses
7302 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7304 reinvoke_input_signal (void)
7307 handle_async_input ();
7313 /* User signal events. */
7315 struct user_signal_info
7317 /* Signal number. */
7320 /* Name of the signal. */
7323 /* Number of pending signals. */
7326 struct user_signal_info
*next
;
7329 /* List of user signals. */
7330 static struct user_signal_info
*user_signals
= NULL
;
7333 add_user_signal (int sig
, const char *name
)
7335 struct user_signal_info
*p
;
7337 for (p
= user_signals
; p
; p
= p
->next
)
7339 /* Already added. */
7342 p
= xmalloc (sizeof (struct user_signal_info
));
7344 p
->name
= xstrdup (name
);
7346 p
->next
= user_signals
;
7349 signal (sig
, handle_user_signal
);
7353 handle_user_signal (int sig
)
7355 int old_errno
= errno
;
7356 struct user_signal_info
*p
;
7358 SIGNAL_THREAD_CHECK (sig
);
7360 for (p
= user_signals
; p
; p
= p
->next
)
7365 if (interrupt_input
)
7366 kill (getpid (), SIGIO
);
7370 /* Tell wait_reading_process_output that it needs to wake
7371 up and look around. */
7372 if (input_available_clear_time
)
7373 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7382 find_user_signal_name (int sig
)
7384 struct user_signal_info
*p
;
7386 for (p
= user_signals
; p
; p
= p
->next
)
7394 store_user_signal_events (void)
7396 struct user_signal_info
*p
;
7397 struct input_event buf
;
7400 for (p
= user_signals
; p
; p
= p
->next
)
7401 if (p
->npending
> 0)
7407 bzero (&buf
, sizeof buf
);
7408 buf
.kind
= USER_SIGNAL_EVENT
;
7409 buf
.frame_or_window
= selected_frame
;
7411 nstored
+= p
->npending
;
7413 mask
= sigblock (sigmask (p
->sig
));
7417 kbd_buffer_store_event (&buf
);
7420 while (p
->npending
> 0);
7428 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7429 static Lisp_Object menu_bar_one_keymap_changed_items
;
7431 /* These variables hold the vector under construction within
7432 menu_bar_items and its subroutines, and the current index
7433 for storing into that vector. */
7434 static Lisp_Object menu_bar_items_vector
;
7435 static int menu_bar_items_index
;
7437 /* Return a vector of menu items for a menu bar, appropriate
7438 to the current buffer. Each item has three elements in the vector:
7441 OLD is an old vector we can optionally reuse, or nil. */
7444 menu_bar_items (Lisp_Object old
)
7446 /* The number of keymaps we're scanning right now, and the number of
7447 keymaps we have allocated space for. */
7450 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7451 in the current keymaps, or nil where it is not a prefix. */
7454 Lisp_Object def
, tail
;
7463 /* In order to build the menus, we need to call the keymap
7464 accessors. They all call QUIT. But this function is called
7465 during redisplay, during which a quit is fatal. So inhibit
7466 quitting while building the menus.
7467 We do this instead of specbind because (1) errors will clear it anyway
7468 and (2) this avoids risk of specpdl overflow. */
7469 oquit
= Vinhibit_quit
;
7473 menu_bar_items_vector
= old
;
7475 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7476 menu_bar_items_index
= 0;
7478 /* Build our list of keymaps.
7479 If we recognize a function key and replace its escape sequence in
7480 keybuf with its symbol, or if the sequence starts with a mouse
7481 click and we need to switch buffers, we jump back here to rebuild
7482 the initial keymaps from the current buffer. */
7486 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7487 if (!NILP (Voverriding_local_map_menu_flag
))
7489 /* Yes, use them (if non-nil) as well as the global map. */
7490 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7492 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7493 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7494 if (!NILP (Voverriding_local_map
))
7495 maps
[nmaps
++] = Voverriding_local_map
;
7499 /* No, so use major and minor mode keymaps and keymap property.
7500 Note that menu-bar bindings in the local-map and keymap
7501 properties may not work reliable, as they are only
7502 recognized when the menu-bar (or mode-line) is updated,
7503 which does not normally happen after every command. */
7506 nminor
= current_minor_maps (NULL
, &tmaps
);
7507 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7509 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7510 maps
[nmaps
++] = tem
;
7511 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7513 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7515 maps
[nmaps
++] = current_global_map
;
7518 /* Look up in each map the dummy prefix key `menu-bar'. */
7522 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7523 if (!NILP (maps
[mapno
]))
7525 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7529 menu_bar_one_keymap_changed_items
= Qnil
;
7530 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7534 /* Move to the end those items that should be at the end. */
7536 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7539 int end
= menu_bar_items_index
;
7541 for (i
= 0; i
< end
; i
+= 4)
7542 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7544 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7545 /* Move the item at index I to the end,
7546 shifting all the others forward. */
7547 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7548 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7549 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7550 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7552 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7553 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7554 (end
- i
- 4) * sizeof (Lisp_Object
));
7555 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7556 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7557 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7558 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7563 /* Add nil, nil, nil, nil at the end. */
7564 i
= menu_bar_items_index
;
7565 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7566 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7567 /* Add this item. */
7568 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7569 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7570 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7571 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7572 menu_bar_items_index
= i
;
7574 Vinhibit_quit
= oquit
;
7575 return menu_bar_items_vector
;
7578 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7579 If there's already an item for KEY, add this DEF to it. */
7581 Lisp_Object item_properties
;
7584 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7586 struct gcpro gcpro1
;
7590 if (EQ (item
, Qundefined
))
7592 /* If a map has an explicit `undefined' as definition,
7593 discard any previously made menu bar item. */
7595 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7596 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7598 if (menu_bar_items_index
> i
+ 4)
7599 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7600 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7601 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7602 menu_bar_items_index
-= 4;
7606 /* If this keymap has already contributed to this KEY,
7607 don't contribute to it a second time. */
7608 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7609 if (!NILP (tem
) || NILP (item
))
7612 menu_bar_one_keymap_changed_items
7613 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7615 /* We add to menu_bar_one_keymap_changed_items before doing the
7616 parse_menu_item, so that if it turns out it wasn't a menu item,
7617 it still correctly hides any further menu item. */
7619 i
= parse_menu_item (item
, 1);
7624 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7626 /* Find any existing item for this KEY. */
7627 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7628 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7631 /* If we did not find this KEY, add it at the end. */
7632 if (i
== menu_bar_items_index
)
7634 /* If vector is too small, get a bigger one. */
7635 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7636 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7637 /* Add this item. */
7638 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7639 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7640 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7641 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7642 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7643 menu_bar_items_index
= i
;
7645 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7649 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7650 /* If the new and the old items are not both keymaps,
7651 the lookup will only find `item'. */
7652 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7653 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7657 /* This is used as the handler when calling menu_item_eval_property. */
7659 menu_item_eval_property_1 (Lisp_Object arg
)
7661 /* If we got a quit from within the menu computation,
7662 quit all the way out of it. This takes care of C-] in the debugger. */
7663 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7664 Fsignal (Qquit
, Qnil
);
7669 /* Evaluate an expression and return the result (or nil if something
7670 went wrong). Used to evaluate dynamic parts of menu items. */
7672 menu_item_eval_property (Lisp_Object sexpr
)
7674 int count
= SPECPDL_INDEX ();
7676 specbind (Qinhibit_redisplay
, Qt
);
7677 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7678 menu_item_eval_property_1
);
7679 return unbind_to (count
, val
);
7682 /* This function parses a menu item and leaves the result in the
7683 vector item_properties.
7684 ITEM is a key binding, a possible menu item.
7685 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7687 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7688 parse_menu_item returns true if the item is a menu item and false
7692 parse_menu_item (Lisp_Object item
, int inmenubar
)
7694 Lisp_Object def
, tem
, item_string
, start
;
7696 Lisp_Object keyhint
;
7705 /* Create item_properties vector if necessary. */
7706 if (NILP (item_properties
))
7708 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7710 /* Initialize optional entries. */
7711 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7712 ASET (item_properties
, i
, Qnil
);
7713 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7715 /* Save the item here to protect it from GC. */
7716 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7718 item_string
= XCAR (item
);
7722 if (STRINGP (item_string
))
7724 /* Old format menu item. */
7725 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7727 /* Maybe help string. */
7728 if (CONSP (item
) && STRINGP (XCAR (item
)))
7730 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7735 /* Maybe an obsolete key binding cache. */
7736 if (CONSP (item
) && CONSP (XCAR (item
))
7737 && (NILP (XCAR (XCAR (item
)))
7738 || VECTORP (XCAR (XCAR (item
)))))
7741 /* This is the real definition--the function to run. */
7742 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7744 /* Get enable property, if any. */
7747 tem
= Fget (item
, Qmenu_enable
);
7748 if (!NILP (Venable_disabled_menus_and_buttons
))
7749 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7750 else if (!NILP (tem
))
7751 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7754 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7756 /* New format menu item. */
7757 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7758 start
= XCDR (item
);
7761 /* We have a real binding. */
7762 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7764 item
= XCDR (start
);
7765 /* Is there an obsolete cache list with key equivalences. */
7766 if (CONSP (item
) && CONSP (XCAR (item
)))
7769 /* Parse properties. */
7770 while (CONSP (item
) && CONSP (XCDR (item
)))
7775 if (EQ (tem
, QCenable
))
7777 if (!NILP (Venable_disabled_menus_and_buttons
))
7778 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7780 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7782 else if (EQ (tem
, QCvisible
))
7784 /* If got a visible property and that evaluates to nil
7785 then ignore this item. */
7786 tem
= menu_item_eval_property (XCAR (item
));
7790 else if (EQ (tem
, QChelp
))
7791 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7792 else if (EQ (tem
, QCfilter
))
7794 else if (EQ (tem
, QCkey_sequence
))
7797 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7798 /* Be GC protected. Set keyhint to item instead of tem. */
7801 else if (EQ (tem
, QCkeys
))
7804 if (CONSP (tem
) || STRINGP (tem
))
7805 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7807 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7812 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7814 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7816 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7822 else if (inmenubar
|| !NILP (start
))
7826 return 0; /* not a menu item */
7828 /* If item string is not a string, evaluate it to get string.
7829 If we don't get a string, skip this item. */
7830 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7831 if (!(STRINGP (item_string
)))
7833 item_string
= menu_item_eval_property (item_string
);
7834 if (!STRINGP (item_string
))
7836 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7839 /* If got a filter apply it on definition. */
7840 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7843 def
= menu_item_eval_property (list2 (XCAR (filter
),
7844 list2 (Qquote
, def
)));
7846 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7849 /* Enable or disable selection of item. */
7850 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7853 tem
= menu_item_eval_property (tem
);
7854 if (inmenubar
&& NILP (tem
))
7855 return 0; /* Ignore disabled items in menu bar. */
7856 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7859 /* If we got no definition, this item is just unselectable text which
7860 is OK in a submenu but not in the menubar. */
7862 return (inmenubar
? 0 : 1);
7864 /* See if this is a separate pane or a submenu. */
7865 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7866 tem
= get_keymap (def
, 0, 1);
7867 /* For a subkeymap, just record its details and exit. */
7870 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7871 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7875 /* At the top level in the menu bar, do likewise for commands also.
7876 The menu bar does not display equivalent key bindings anyway.
7877 ITEM_PROPERTY_DEF is already set up properly. */
7881 { /* This is a command. See if there is an equivalent key binding. */
7882 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7884 /* The previous code preferred :key-sequence to :keys, so we
7885 preserve this behavior. */
7886 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7887 keyeq
= Fsubstitute_command_keys (keyeq
);
7890 Lisp_Object prefix
= keyeq
;
7891 Lisp_Object keys
= Qnil
;
7895 def
= XCAR (prefix
);
7896 prefix
= XCDR (prefix
);
7899 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7901 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7903 keys
= XCAR (keyhint
);
7904 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7906 /* We have a suggested key. Is it bound to the command? */
7909 /* If the command is an alias for another
7910 (such as lmenu.el set it up), check if the
7911 original command matches the cached command. */
7912 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7917 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7921 tem
= Fkey_description (keys
, Qnil
);
7924 if (STRINGP (XCAR (prefix
)))
7925 tem
= concat2 (XCAR (prefix
), tem
);
7926 if (STRINGP (XCDR (prefix
)))
7927 tem
= concat2 (tem
, XCDR (prefix
));
7929 keyeq
= concat2 (build_string (" "), tem
);
7930 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7936 /* If we have an equivalent key binding, use that. */
7937 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7940 /* Include this when menu help is implemented.
7941 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7942 if (!(NILP (tem) || STRINGP (tem)))
7944 tem = menu_item_eval_property (tem);
7947 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7951 /* Handle radio buttons or toggle boxes. */
7952 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7954 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7955 menu_item_eval_property (tem
));
7962 /***********************************************************************
7964 ***********************************************************************/
7966 /* A vector holding tool bar items while they are parsed in function
7967 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7970 static Lisp_Object tool_bar_items_vector
;
7972 /* A vector holding the result of parse_tool_bar_item. Layout is like
7973 the one for a single item in tool_bar_items_vector. */
7975 static Lisp_Object tool_bar_item_properties
;
7977 /* Next free index in tool_bar_items_vector. */
7979 static int ntool_bar_items
;
7981 /* The symbols `tool-bar', `:image' and `:rtl'. */
7983 extern Lisp_Object Qtool_bar
;
7984 Lisp_Object QCimage
;
7987 /* Function prototypes. */
7989 static void init_tool_bar_items (Lisp_Object
);
7990 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7991 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7992 static void append_tool_bar_item (void);
7995 /* Return a vector of tool bar items for keymaps currently in effect.
7996 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7997 tool bar items found. */
8000 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8009 /* In order to build the menus, we need to call the keymap
8010 accessors. They all call QUIT. But this function is called
8011 during redisplay, during which a quit is fatal. So inhibit
8012 quitting while building the menus. We do this instead of
8013 specbind because (1) errors will clear it anyway and (2) this
8014 avoids risk of specpdl overflow. */
8015 oquit
= Vinhibit_quit
;
8018 /* Initialize tool_bar_items_vector and protect it from GC. */
8019 init_tool_bar_items (reuse
);
8021 /* Build list of keymaps in maps. Set nmaps to the number of maps
8024 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8025 if (!NILP (Voverriding_local_map_menu_flag
))
8027 /* Yes, use them (if non-nil) as well as the global map. */
8028 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8030 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8031 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8032 if (!NILP (Voverriding_local_map
))
8033 maps
[nmaps
++] = Voverriding_local_map
;
8037 /* No, so use major and minor mode keymaps and keymap property.
8038 Note that tool-bar bindings in the local-map and keymap
8039 properties may not work reliable, as they are only
8040 recognized when the tool-bar (or mode-line) is updated,
8041 which does not normally happen after every command. */
8044 nminor
= current_minor_maps (NULL
, &tmaps
);
8045 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8047 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8048 maps
[nmaps
++] = tem
;
8049 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8051 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8054 /* Add global keymap at the end. */
8055 maps
[nmaps
++] = current_global_map
;
8057 /* Process maps in reverse order and look up in each map the prefix
8059 for (i
= nmaps
- 1; i
>= 0; --i
)
8060 if (!NILP (maps
[i
]))
8064 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8066 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8069 Vinhibit_quit
= oquit
;
8070 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8071 return tool_bar_items_vector
;
8075 /* Process the definition of KEY which is DEF. */
8078 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8081 extern Lisp_Object Qundefined
;
8082 struct gcpro gcpro1
, gcpro2
;
8084 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8088 if (EQ (def
, Qundefined
))
8090 /* If a map has an explicit `undefined' as definition,
8091 discard any previously made item. */
8092 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8094 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8096 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8098 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8099 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8100 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8101 * sizeof (Lisp_Object
)));
8102 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8107 else if (parse_tool_bar_item (key
, def
))
8108 /* Append a new tool bar item to tool_bar_items_vector. Accept
8109 more than one definition for the same key. */
8110 append_tool_bar_item ();
8116 /* Parse a tool bar item specification ITEM for key KEY and return the
8117 result in tool_bar_item_properties. Value is zero if ITEM is
8120 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8122 CAPTION is the caption of the item, If it's not a string, it is
8123 evaluated to get a string.
8125 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8126 as binding are currently ignored.
8128 The following properties are recognized:
8132 FORM is evaluated and specifies whether the tool bar item is
8133 enabled or disabled.
8137 FORM is evaluated and specifies whether the tool bar item is visible.
8139 - `:filter FUNCTION'
8141 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8142 result is stored as the new binding.
8144 - `:button (TYPE SELECTED)'
8146 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8147 and specifies whether the button is selected (pressed) or not.
8151 IMAGES is either a single image specification or a vector of four
8152 image specifications. See enum tool_bar_item_images.
8154 - `:help HELP-STRING'.
8156 Gives a help string to display for the tool bar item.
8158 - `:label LABEL-STRING'.
8160 A text label to show with the tool bar button if labels are enabled. */
8163 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8165 /* Access slot with index IDX of vector tool_bar_item_properties. */
8166 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8168 Lisp_Object filter
= Qnil
;
8169 Lisp_Object caption
;
8170 int i
, have_label
= 0;
8172 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8173 Rule out items that aren't lists, don't start with
8174 `menu-item' or whose rest following `tool-bar-item' is not a
8177 || !EQ (XCAR (item
), Qmenu_item
)
8178 || (item
= XCDR (item
),
8182 /* Create tool_bar_item_properties vector if necessary. Reset it to
8184 if (VECTORP (tool_bar_item_properties
))
8186 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8190 tool_bar_item_properties
8191 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8194 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8195 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8197 /* Get the caption of the item. If the caption is not a string,
8198 evaluate it to get a string. If we don't get a string, skip this
8200 caption
= XCAR (item
);
8201 if (!STRINGP (caption
))
8203 caption
= menu_item_eval_property (caption
);
8204 if (!STRINGP (caption
))
8207 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8209 /* Give up if rest following the caption is not a list. */
8214 /* Store the binding. */
8215 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8218 /* Ignore cached key binding, if any. */
8219 if (CONSP (item
) && CONSP (XCAR (item
)))
8222 /* Process the rest of the properties. */
8223 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8225 Lisp_Object key
, value
;
8228 value
= XCAR (XCDR (item
));
8230 if (EQ (key
, QCenable
))
8232 /* `:enable FORM'. */
8233 if (!NILP (Venable_disabled_menus_and_buttons
))
8234 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8236 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8238 else if (EQ (key
, QCvisible
))
8240 /* `:visible FORM'. If got a visible property and that
8241 evaluates to nil then ignore this item. */
8242 if (NILP (menu_item_eval_property (value
)))
8245 else if (EQ (key
, QChelp
))
8246 /* `:help HELP-STRING'. */
8247 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8248 else if (EQ (key
, QClabel
))
8250 /* `:label LABEL-STRING'. */
8251 PROP (TOOL_BAR_ITEM_LABEL
) = value
;
8254 else if (EQ (key
, QCfilter
))
8255 /* ':filter FORM'. */
8257 else if (EQ (key
, QCbutton
) && CONSP (value
))
8259 /* `:button (TYPE . SELECTED)'. */
8260 Lisp_Object type
, selected
;
8262 type
= XCAR (value
);
8263 selected
= XCDR (value
);
8264 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8266 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8267 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8270 else if (EQ (key
, QCimage
)
8272 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8273 /* Value is either a single image specification or a vector
8274 of 4 such specifications for the different button states. */
8275 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8276 else if (EQ (key
, Qrtl
))
8278 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8284 /* Try to make one from caption and key. */
8285 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8286 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8287 char *label
= SYMBOLP (key
) ? (char *) SDATA (SYMBOL_NAME (key
)) : "";
8288 char *caption
= STRINGP (capt
) ? (char *) SDATA (capt
) : "";
8290 EMACS_INT max_lbl
= 2*tool_bar_max_label_size
;
8291 Lisp_Object new_lbl
;
8293 if (strlen (caption
) < max_lbl
&& caption
[0] != '\0')
8295 strcpy (buf
, caption
);
8296 while (buf
[0] != '\0' && buf
[strlen (buf
) -1] == '.')
8297 buf
[strlen (buf
)-1] = '\0';
8298 if (strlen (buf
) <= max_lbl
)
8302 if (strlen (caption
) <= max_lbl
)
8305 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8308 if (label
!= buf
) strcpy (buf
, label
);
8310 for (i
= 0; i
< strlen (buf
); ++i
)
8312 if (buf
[i
] == '-') buf
[i
] = ' ';
8319 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8320 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8321 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8324 /* If got a filter apply it on binding. */
8326 PROP (TOOL_BAR_ITEM_BINDING
)
8327 = menu_item_eval_property (list2 (filter
,
8329 PROP (TOOL_BAR_ITEM_BINDING
))));
8331 /* See if the binding is a keymap. Give up if it is. */
8332 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8335 /* Enable or disable selection of item. */
8336 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8337 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8338 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8340 /* Handle radio buttons or toggle boxes. */
8341 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8342 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8343 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8351 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8352 that can be reused. */
8355 init_tool_bar_items (Lisp_Object reuse
)
8357 if (VECTORP (reuse
))
8358 tool_bar_items_vector
= reuse
;
8360 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8361 ntool_bar_items
= 0;
8365 /* Append parsed tool bar item properties from
8366 tool_bar_item_properties */
8369 append_tool_bar_item (void)
8371 Lisp_Object
*to
, *from
;
8373 /* Enlarge tool_bar_items_vector if necessary. */
8374 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8375 >= XVECTOR (tool_bar_items_vector
)->size
)
8376 tool_bar_items_vector
8377 = larger_vector (tool_bar_items_vector
,
8378 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8380 /* Append entries from tool_bar_item_properties to the end of
8381 tool_bar_items_vector. */
8382 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8383 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8384 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8385 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8392 /* Read a character using menus based on maps in the array MAPS.
8393 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8394 Return t if we displayed a menu but the user rejected it.
8396 PREV_EVENT is the previous input event, or nil if we are reading
8397 the first event of a key sequence.
8399 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8400 if we used a mouse menu to read the input, or zero otherwise. If
8401 USED_MOUSE_MENU is null, we don't dereference it.
8403 The prompting is done based on the prompt-string of the map
8404 and the strings associated with various map elements.
8406 This can be done with X menus or with menus put in the minibuf.
8407 These are done in different ways, depending on how the input will be read.
8408 Menus using X are done after auto-saving in read-char, getting the input
8409 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8410 and do auto-saving in the inner call of read_char. */
8413 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8414 int *used_mouse_menu
)
8418 if (used_mouse_menu
)
8419 *used_mouse_menu
= 0;
8421 /* Use local over global Menu maps */
8423 if (! menu_prompting
)
8426 /* Optionally disregard all but the global map. */
8427 if (inhibit_local_menu_bar_menus
)
8429 maps
+= (nmaps
- 1);
8434 /* If we got to this point via a mouse click,
8435 use a real menu for mouse selection. */
8436 if (EVENT_HAS_PARAMETERS (prev_event
)
8437 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8438 && !EQ (XCAR (prev_event
), Qtool_bar
))
8440 /* Display the menu and get the selection. */
8441 Lisp_Object
*realmaps
8442 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8446 /* Use the maps that are not nil. */
8447 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8448 if (!NILP (maps
[mapno
]))
8449 realmaps
[nmaps1
++] = maps
[mapno
];
8451 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8456 record_menu_key (XCAR (value
));
8458 /* If we got multiple events, unread all but
8460 There is no way to prevent those unread events
8461 from showing up later in last_nonmenu_event.
8462 So turn symbol and integer events into lists,
8463 to indicate that they came from a mouse menu,
8464 so that when present in last_nonmenu_event
8465 they won't confuse things. */
8466 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8468 record_menu_key (XCAR (tem
));
8469 if (SYMBOLP (XCAR (tem
))
8470 || INTEGERP (XCAR (tem
)))
8471 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8474 /* If we got more than one event, put all but the first
8475 onto this list to be read later.
8476 Return just the first event now. */
8477 Vunread_command_events
8478 = nconc2 (XCDR (value
), Vunread_command_events
);
8479 value
= XCAR (value
);
8481 else if (NILP (value
))
8483 if (used_mouse_menu
)
8484 *used_mouse_menu
= 1;
8487 #endif /* HAVE_MENUS */
8491 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8492 We make this bigger when necessary, and never free it. */
8493 static char *read_char_minibuf_menu_text
;
8494 /* Size of that buffer. */
8495 static int read_char_minibuf_menu_width
;
8498 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8501 register Lisp_Object name
;
8503 /* FIXME: Use the minibuffer's frame width. */
8504 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8507 Lisp_Object rest
, vector
;
8513 if (! menu_prompting
)
8516 /* Get the menu name from the first map that has one (a prompt string). */
8517 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8519 name
= Fkeymap_prompt (maps
[mapno
]);
8524 /* If we don't have any menus, just read a character normally. */
8525 if (!STRINGP (name
))
8528 /* Make sure we have a big enough buffer for the menu text. */
8529 width
= max (width
, SBYTES (name
));
8530 if (read_char_minibuf_menu_text
== 0)
8532 read_char_minibuf_menu_width
= width
+ 4;
8533 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8535 else if (width
+ 4 > read_char_minibuf_menu_width
)
8537 read_char_minibuf_menu_width
= width
+ 4;
8538 read_char_minibuf_menu_text
8539 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8541 menu
= read_char_minibuf_menu_text
;
8543 /* Prompt string always starts with map's prompt, and a space. */
8544 strcpy (menu
, SDATA (name
));
8545 nlength
= SBYTES (name
);
8546 menu
[nlength
++] = ':';
8547 menu
[nlength
++] = ' ';
8550 /* Start prompting at start of first map. */
8554 /* Present the documented bindings, a line at a time. */
8561 Lisp_Object orig_defn_macro
;
8563 /* Loop over elements of map. */
8568 /* If reached end of map, start at beginning of next map. */
8572 /* At end of last map, wrap around to first map if just starting,
8573 or end this line if already have something on it. */
8577 if (notfirst
|| nobindings
) break;
8582 /* Look at the next element of the map. */
8584 elt
= XVECTOR (vector
)->contents
[idx
];
8586 elt
= Fcar_safe (rest
);
8588 if (idx
< 0 && VECTORP (elt
))
8590 /* If we found a dense table in the keymap,
8591 advanced past it, but start scanning its contents. */
8592 rest
= Fcdr_safe (rest
);
8598 /* An ordinary element. */
8599 Lisp_Object event
, tem
;
8603 event
= Fcar_safe (elt
); /* alist */
8604 elt
= Fcdr_safe (elt
);
8608 XSETINT (event
, idx
); /* vector */
8611 /* Ignore the element if it has no prompt string. */
8612 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8614 /* 1 if the char to type matches the string. */
8616 Lisp_Object upcased_event
, downcased_event
;
8617 Lisp_Object desc
= Qnil
;
8619 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8621 upcased_event
= Fupcase (event
);
8622 downcased_event
= Fdowncase (event
);
8623 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8624 || XINT (downcased_event
) == SREF (s
, 0));
8626 desc
= Fsingle_key_description (event
, Qnil
);
8628 #if 0 /* It is redundant to list the equivalent key bindings because
8629 the prefix is what the user has already typed. */
8631 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8633 /* Insert equivalent keybinding. */
8634 s
= concat2 (s
, tem
);
8637 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8638 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8640 /* Insert button prefix. */
8641 Lisp_Object selected
8642 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8643 if (EQ (tem
, QCradio
))
8644 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8646 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8647 s
= concat2 (tem
, s
);
8651 /* If we have room for the prompt string, add it to this line.
8652 If this is the first on the line, always add it. */
8653 if ((SCHARS (s
) + i
+ 2
8654 + (char_matches
? 0 : SCHARS (desc
) + 3))
8660 /* Punctuate between strings. */
8663 strcpy (menu
+ i
, ", ");
8669 /* If the char to type doesn't match the string's
8670 first char, explicitly show what char to type. */
8673 /* Add as much of string as fits. */
8674 thiswidth
= SCHARS (desc
);
8675 if (thiswidth
+ i
> width
)
8676 thiswidth
= width
- i
;
8677 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8679 strcpy (menu
+ i
, " = ");
8683 /* Add as much of string as fits. */
8684 thiswidth
= SCHARS (s
);
8685 if (thiswidth
+ i
> width
)
8686 thiswidth
= width
- i
;
8687 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8693 /* If this element does not fit, end the line now,
8694 and save the element for the next line. */
8695 strcpy (menu
+ i
, "...");
8700 /* Move past this element. */
8701 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8702 /* Handle reaching end of dense table. */
8707 rest
= Fcdr_safe (rest
);
8711 /* Prompt with that and read response. */
8712 message2_nolog (menu
, strlen (menu
),
8713 ! NILP (current_buffer
->enable_multibyte_characters
));
8715 /* Make believe its not a keyboard macro in case the help char
8716 is pressed. Help characters are not recorded because menu prompting
8717 is not used on replay.
8719 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8720 current_kboard
->defining_kbd_macro
= Qnil
;
8722 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8723 while (BUFFERP (obj
));
8724 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8726 if (!INTEGERP (obj
))
8728 else if (XINT (obj
) == -2)
8733 if (! EQ (obj
, menu_prompt_more_char
)
8734 && (!INTEGERP (menu_prompt_more_char
)
8735 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8737 if (!NILP (current_kboard
->defining_kbd_macro
))
8738 store_kbd_macro_char (obj
);
8741 /* Help char - go round again */
8745 /* Reading key sequences. */
8747 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8748 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8749 keymap, or nil otherwise. Return the index of the first keymap in
8750 which KEY has any binding, or NMAPS if no map has a binding.
8752 If KEY is a meta ASCII character, treat it like meta-prefix-char
8753 followed by the corresponding non-meta character. Keymaps in
8754 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8757 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8760 NEXT may be the same array as CURRENT. */
8763 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8766 int i
, first_binding
;
8768 first_binding
= nmaps
;
8769 for (i
= nmaps
- 1; i
>= 0; i
--)
8771 if (! NILP (current
[i
]))
8773 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8774 if (! NILP (defs
[i
]))
8781 /* Given the set of bindings we've found, produce the next set of maps. */
8782 if (first_binding
< nmaps
)
8783 for (i
= 0; i
< nmaps
; i
++)
8784 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8786 return first_binding
;
8789 /* Structure used to keep track of partial application of key remapping
8790 such as Vfunction_key_map and Vkey_translation_map. */
8791 typedef struct keyremap
8793 /* This is the map originally specified for this use. */
8795 /* This is a submap reached by looking up, in PARENT,
8796 the events from START to END. */
8798 /* Positions [START, END) in the key sequence buffer
8799 are the key that we have scanned so far.
8800 Those events are the ones that we will replace
8801 if PAREHT maps them into a key sequence. */
8805 /* Lookup KEY in MAP.
8806 MAP is a keymap mapping keys to key vectors or functions.
8807 If the mapping is a function and DO_FUNCTION is non-zero, then
8808 the function is called with PROMPT as parameter and its return
8809 value is used as the return value of this function (after checking
8810 that it is indeed a vector). */
8813 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8818 next
= access_keymap (map
, key
, 1, 0, 1);
8820 /* Handle symbol with autoload definition. */
8821 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8822 && CONSP (XSYMBOL (next
)->function
)
8823 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8824 do_autoload (XSYMBOL (next
)->function
, next
);
8826 /* Handle a symbol whose function definition is a keymap
8828 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8829 && (ARRAYP (XSYMBOL (next
)->function
)
8830 || KEYMAPP (XSYMBOL (next
)->function
)))
8831 next
= XSYMBOL (next
)->function
;
8833 /* If the keymap gives a function, not an
8834 array, then call the function with one arg and use
8835 its value instead. */
8836 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8841 next
= call1 (next
, prompt
);
8842 /* If the function returned something invalid,
8843 barf--don't ignore it.
8844 (To ignore it safely, we would need to gcpro a bunch of
8845 other variables.) */
8846 if (! (VECTORP (next
) || STRINGP (next
)))
8847 error ("Function %s returns invalid key sequence", tem
);
8852 /* Do one step of the key remapping used for function-key-map and
8853 key-translation-map:
8854 KEYBUF is the buffer holding the input events.
8855 BUFSIZE is its maximum size.
8856 FKEY is a pointer to the keyremap structure to use.
8857 INPUT is the index of the last element in KEYBUF.
8858 DOIT if non-zero says that the remapping can actually take place.
8859 DIFF is used to return the number of keys added/removed by the remapping.
8860 PARENT is the root of the keymap.
8861 PROMPT is the prompt to use if the remapping happens through a function.
8862 The return value is non-zero if the remapping actually took place. */
8865 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8866 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8868 Lisp_Object next
, key
;
8870 key
= keybuf
[fkey
->end
++];
8872 if (KEYMAPP (fkey
->parent
))
8873 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8877 /* If keybuf[fkey->start..fkey->end] is bound in the
8878 map and we're in a position to do the key remapping, replace it with
8879 the binding and restart with fkey->start at the end. */
8880 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8882 int len
= XFASTINT (Flength (next
));
8885 *diff
= len
- (fkey
->end
- fkey
->start
);
8887 if (input
+ *diff
>= bufsize
)
8888 error ("Key sequence too long");
8890 /* Shift the keys that follow fkey->end. */
8892 for (i
= fkey
->end
; i
< input
; i
++)
8893 keybuf
[i
+ *diff
] = keybuf
[i
];
8895 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8896 keybuf
[i
+ *diff
] = keybuf
[i
];
8897 /* Overwrite the old keys with the new ones. */
8898 for (i
= 0; i
< len
; i
++)
8899 keybuf
[fkey
->start
+ i
]
8900 = Faref (next
, make_number (i
));
8902 fkey
->start
= fkey
->end
+= *diff
;
8903 fkey
->map
= fkey
->parent
;
8908 fkey
->map
= get_keymap (next
, 0, 1);
8910 /* If we no longer have a bound suffix, try a new position for
8912 if (!CONSP (fkey
->map
))
8914 fkey
->end
= ++fkey
->start
;
8915 fkey
->map
= fkey
->parent
;
8920 /* Read a sequence of keys that ends with a non prefix character,
8921 storing it in KEYBUF, a buffer of size BUFSIZE.
8923 Return the length of the key sequence stored.
8924 Return -1 if the user rejected a command menu.
8926 Echo starting immediately unless `prompt' is 0.
8928 Where a key sequence ends depends on the currently active keymaps.
8929 These include any minor mode keymaps active in the current buffer,
8930 the current buffer's local map, and the global map.
8932 If a key sequence has no other bindings, we check Vfunction_key_map
8933 to see if some trailing subsequence might be the beginning of a
8934 function key's sequence. If so, we try to read the whole function
8935 key, and substitute its symbolic name into the key sequence.
8937 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8938 `double-' events into similar click events, if that would make them
8939 bound. We try to turn `triple-' events first into `double-' events,
8942 If we get a mouse click in a mode line, vertical divider, or other
8943 non-text area, we treat the click as if it were prefixed by the
8944 symbol denoting that area - `mode-line', `vertical-line', or
8947 If the sequence starts with a mouse click, we read the key sequence
8948 with respect to the buffer clicked on, not the current buffer.
8950 If the user switches frames in the midst of a key sequence, we put
8951 off the switch-frame event until later; the next call to
8952 read_char will return it.
8954 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8955 from the selected window's buffer. */
8958 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8959 int dont_downcase_last
, int can_return_switch_frame
,
8960 int fix_current_buffer
)
8962 volatile Lisp_Object from_string
;
8963 volatile int count
= SPECPDL_INDEX ();
8965 /* How many keys there are in the current key sequence. */
8968 /* The length of the echo buffer when we started reading, and
8969 the length of this_command_keys when we started reading. */
8970 volatile int echo_start
;
8971 volatile int keys_start
;
8973 /* The number of keymaps we're scanning right now, and the number of
8974 keymaps we have allocated space for. */
8976 volatile int nmaps_allocated
= 0;
8978 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8979 the current keymaps. */
8980 Lisp_Object
*volatile defs
= NULL
;
8982 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8983 in the current keymaps, or nil where it is not a prefix. */
8984 Lisp_Object
*volatile submaps
= NULL
;
8986 /* The local map to start out with at start of key sequence. */
8987 volatile Lisp_Object orig_local_map
;
8989 /* The map from the `keymap' property to start out with at start of
8991 volatile Lisp_Object orig_keymap
;
8993 /* 1 if we have already considered switching to the local-map property
8994 of the place where a mouse click occurred. */
8995 volatile int localized_local_map
= 0;
8997 /* The index in submaps[] of the first keymap that has a binding for
8998 this key sequence. In other words, the lowest i such that
8999 submaps[i] is non-nil. */
9000 volatile int first_binding
;
9001 /* Index of the first key that has no binding.
9002 It is useless to try fkey.start larger than that. */
9003 volatile int first_unbound
;
9005 /* If t < mock_input, then KEYBUF[t] should be read as the next
9008 We use this to recover after recognizing a function key. Once we
9009 realize that a suffix of the current key sequence is actually a
9010 function key's escape sequence, we replace the suffix with the
9011 function key's binding from Vfunction_key_map. Now keybuf
9012 contains a new and different key sequence, so the echo area,
9013 this_command_keys, and the submaps and defs arrays are wrong. In
9014 this situation, we set mock_input to t, set t to 0, and jump to
9015 restart_sequence; the loop will read keys from keybuf up until
9016 mock_input, thus rebuilding the state; and then it will resume
9017 reading characters from the keyboard. */
9018 volatile int mock_input
= 0;
9020 /* If the sequence is unbound in submaps[], then
9021 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9022 and fkey.map is its binding.
9024 These might be > t, indicating that all function key scanning
9025 should hold off until t reaches them. We do this when we've just
9026 recognized a function key, to avoid searching for the function
9027 key's again in Vfunction_key_map. */
9028 volatile keyremap fkey
;
9030 /* Likewise, for key_translation_map and input-decode-map. */
9031 volatile keyremap keytran
, indec
;
9033 /* Non-zero if we are trying to map a key by changing an upper-case
9034 letter to lower case, or a shifted function key to an unshifted
9036 volatile int shift_translated
= 0;
9038 /* If we receive a `switch-frame' or `select-window' event in the middle of
9039 a key sequence, we put it off for later.
9040 While we're reading, we keep the event here. */
9041 volatile Lisp_Object delayed_switch_frame
;
9043 /* See the comment below... */
9044 #if defined (GOBBLE_FIRST_EVENT)
9045 Lisp_Object first_event
;
9048 volatile Lisp_Object original_uppercase
;
9049 volatile int original_uppercase_position
= -1;
9051 /* Gets around Microsoft compiler limitations. */
9054 struct buffer
*starting_buffer
;
9056 /* List of events for which a fake prefix key has been generated. */
9057 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9059 #if defined (GOBBLE_FIRST_EVENT)
9063 struct gcpro gcpro1
;
9065 GCPRO1 (fake_prefixed_keys
);
9066 raw_keybuf_count
= 0;
9068 last_nonmenu_event
= Qnil
;
9070 delayed_switch_frame
= Qnil
;
9075 echo_prompt (prompt
);
9076 else if (cursor_in_echo_area
9077 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9078 && NILP (Fzerop (Vecho_keystrokes
)))
9079 /* This doesn't put in a dash if the echo buffer is empty, so
9080 you don't always see a dash hanging out in the minibuffer. */
9084 /* Record the initial state of the echo area and this_command_keys;
9085 we will need to restore them if we replay a key sequence. */
9087 echo_start
= echo_length ();
9088 keys_start
= this_command_key_count
;
9089 this_single_command_key_start
= keys_start
;
9091 #if defined (GOBBLE_FIRST_EVENT)
9092 /* This doesn't quite work, because some of the things that read_char
9093 does cannot safely be bypassed. It seems too risky to try to make
9096 /* Read the first char of the sequence specially, before setting
9097 up any keymaps, in case a filter runs and switches buffers on us. */
9098 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9100 #endif /* GOBBLE_FIRST_EVENT */
9102 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9103 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9106 /* We jump here when we need to reinitialize fkey and keytran; this
9107 happens if we switch keyboards between rescans. */
9108 replay_entire_sequence
:
9110 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9111 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9112 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9113 indec
.start
= indec
.end
= 0;
9114 fkey
.start
= fkey
.end
= 0;
9115 keytran
.start
= keytran
.end
= 0;
9117 /* We jump here when the key sequence has been thoroughly changed, and
9118 we need to rescan it starting from the beginning. When we jump here,
9119 keybuf[0..mock_input] holds the sequence we should reread. */
9122 starting_buffer
= current_buffer
;
9123 first_unbound
= bufsize
+ 1;
9125 /* Build our list of keymaps.
9126 If we recognize a function key and replace its escape sequence in
9127 keybuf with its symbol, or if the sequence starts with a mouse
9128 click and we need to switch buffers, we jump back here to rebuild
9129 the initial keymaps from the current buffer. */
9132 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9134 if (2 > nmaps_allocated
)
9136 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9137 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9138 nmaps_allocated
= 2;
9140 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9142 else if (!NILP (Voverriding_local_map
))
9144 if (2 > nmaps_allocated
)
9146 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9147 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9148 nmaps_allocated
= 2;
9150 submaps
[nmaps
++] = Voverriding_local_map
;
9158 nminor
= current_minor_maps (0, &maps
);
9159 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9161 if (total
> nmaps_allocated
)
9163 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9164 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9165 nmaps_allocated
= total
;
9168 if (!NILP (orig_keymap
))
9169 submaps
[nmaps
++] = orig_keymap
;
9171 bcopy (maps
, (void *) (submaps
+ nmaps
),
9172 nminor
* sizeof (submaps
[0]));
9176 submaps
[nmaps
++] = orig_local_map
;
9178 submaps
[nmaps
++] = current_global_map
;
9180 /* Find an accurate initial value for first_binding. */
9181 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9182 if (! NILP (submaps
[first_binding
]))
9185 /* Start from the beginning in keybuf. */
9188 /* These are no-ops the first time through, but if we restart, they
9189 revert the echo area and this_command_keys to their original state. */
9190 this_command_key_count
= keys_start
;
9191 if (INTERACTIVE
&& t
< mock_input
)
9192 echo_truncate (echo_start
);
9194 /* If the best binding for the current key sequence is a keymap, or
9195 we may be looking at a function key's escape sequence, keep on
9197 while (first_binding
< nmaps
9198 /* Keep reading as long as there's a prefix binding. */
9199 ? !NILP (submaps
[first_binding
])
9200 /* Don't return in the middle of a possible function key sequence,
9201 if the only bindings we found were via case conversion.
9202 Thus, if ESC O a has a function-key-map translation
9203 and ESC o has a binding, don't return after ESC O,
9204 so that we can translate ESC O plus the next character. */
9205 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9208 int used_mouse_menu
= 0;
9210 /* Where the last real key started. If we need to throw away a
9211 key that has expanded into more than one element of keybuf
9212 (say, a mouse click on the mode line which is being treated
9213 as [mode-line (mouse-...)], then we backtrack to this point
9215 volatile int last_real_key_start
;
9217 /* These variables are analogous to echo_start and keys_start;
9218 while those allow us to restart the entire key sequence,
9219 echo_local_start and keys_local_start allow us to throw away
9221 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9223 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9224 eassert (indec
.start
<= indec
.end
);
9225 eassert (fkey
.start
<= fkey
.end
);
9226 eassert (keytran
.start
<= keytran
.end
);
9227 /* key-translation-map is applied *after* function-key-map
9228 which is itself applied *after* input-decode-map. */
9229 eassert (fkey
.end
<= indec
.start
);
9230 eassert (keytran
.end
<= fkey
.start
);
9232 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9233 first_unbound
< keytran
.start
)
9234 { /* The prefix upto first_unbound has no binding and has
9235 no translation left to do either, so we know it's unbound.
9236 If we don't stop now, we risk staying here indefinitely
9237 (if the user keeps entering fkey or keytran prefixes
9238 like C-c ESC ESC ESC ESC ...) */
9240 for (i
= first_unbound
+ 1; i
< t
; i
++)
9241 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9242 mock_input
= t
- first_unbound
- 1;
9243 indec
.end
= indec
.start
-= first_unbound
+ 1;
9244 indec
.map
= indec
.parent
;
9245 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9246 fkey
.map
= fkey
.parent
;
9247 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9248 keytran
.map
= keytran
.parent
;
9249 goto replay_sequence
;
9253 error ("Key sequence too long");
9256 echo_local_start
= echo_length ();
9257 keys_local_start
= this_command_key_count
;
9258 local_first_binding
= first_binding
;
9261 /* These are no-ops, unless we throw away a keystroke below and
9262 jumped back up to replay_key; in that case, these restore the
9263 variables to their original state, allowing us to replay the
9265 if (INTERACTIVE
&& t
< mock_input
)
9266 echo_truncate (echo_local_start
);
9267 this_command_key_count
= keys_local_start
;
9268 first_binding
= local_first_binding
;
9270 /* By default, assume each event is "real". */
9271 last_real_key_start
= t
;
9273 /* Does mock_input indicate that we are re-reading a key sequence? */
9277 add_command_key (key
);
9278 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9279 && NILP (Fzerop (Vecho_keystrokes
)))
9283 /* If not, we should actually read a character. */
9287 KBOARD
*interrupted_kboard
= current_kboard
;
9288 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9289 key
= read_char (NILP (prompt
), nmaps
,
9290 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9291 &used_mouse_menu
, NULL
);
9292 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9293 /* When switching to a new tty (with a new keyboard),
9294 read_char returns the new buffer, rather than -2
9295 (Bug#5095). This is because `terminal-init-xterm'
9296 calls read-char, which eats the wrong_kboard_jmpbuf
9297 return. Any better way to fix this? -- cyd */
9298 || (interrupted_kboard
!= current_kboard
))
9303 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9304 if (k
== interrupted_kboard
)
9309 /* Don't touch interrupted_kboard when it's been
9311 delayed_switch_frame
= Qnil
;
9312 goto replay_entire_sequence
;
9315 if (!NILP (delayed_switch_frame
))
9317 interrupted_kboard
->kbd_queue
9318 = Fcons (delayed_switch_frame
,
9319 interrupted_kboard
->kbd_queue
);
9320 delayed_switch_frame
= Qnil
;
9324 interrupted_kboard
->kbd_queue
9325 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9327 /* If the side queue is non-empty, ensure it begins with a
9328 switch-frame, so we'll replay it in the right context. */
9329 if (CONSP (interrupted_kboard
->kbd_queue
)
9330 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9331 !(EVENT_HAS_PARAMETERS (key
)
9332 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9336 XSETFRAME (frame
, interrupted_frame
);
9337 interrupted_kboard
->kbd_queue
9338 = Fcons (make_lispy_switch_frame (frame
),
9339 interrupted_kboard
->kbd_queue
);
9342 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9343 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9344 goto replay_entire_sequence
;
9348 /* read_char returns t when it shows a menu and the user rejects it.
9352 unbind_to (count
, Qnil
);
9357 /* read_char returns -1 at the end of a macro.
9358 Emacs 18 handles this by returning immediately with a
9359 zero, so that's what we'll do. */
9360 if (INTEGERP (key
) && XINT (key
) == -1)
9363 /* The Microsoft C compiler can't handle the goto that
9369 /* If the current buffer has been changed from under us, the
9370 keymap may have changed, so replay the sequence. */
9373 timer_resume_idle ();
9376 /* Reset the current buffer from the selected window
9377 in case something changed the former and not the latter.
9378 This is to be more consistent with the behavior
9379 of the command_loop_1. */
9380 if (fix_current_buffer
)
9382 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9384 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9385 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9388 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9389 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9390 goto replay_sequence
;
9393 /* If we have a quit that was typed in another frame, and
9394 quit_throw_to_read_char switched buffers,
9395 replay to get the right keymap. */
9397 && XINT (key
) == quit_char
9398 && current_buffer
!= starting_buffer
)
9401 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9405 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9406 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9407 goto replay_sequence
;
9412 if (EVENT_HAS_PARAMETERS (key
)
9413 /* Either a `switch-frame' or a `select-window' event. */
9414 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9416 /* If we're at the beginning of a key sequence, and the caller
9417 says it's okay, go ahead and return this event. If we're
9418 in the midst of a key sequence, delay it until the end. */
9419 if (t
> 0 || !can_return_switch_frame
)
9421 delayed_switch_frame
= key
;
9427 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9431 /* Clicks in non-text areas get prefixed by the symbol
9432 in their CHAR-ADDRESS field. For example, a click on
9433 the mode line is prefixed by the symbol `mode-line'.
9435 Furthermore, key sequences beginning with mouse clicks
9436 are read using the keymaps of the buffer clicked on, not
9437 the current buffer. So we may have to switch the buffer
9440 When we turn one event into two events, we must make sure
9441 that neither of the two looks like the original--so that,
9442 if we replay the events, they won't be expanded again.
9443 If not for this, such reexpansion could happen either here
9444 or when user programs play with this-command-keys. */
9445 if (EVENT_HAS_PARAMETERS (key
))
9450 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9451 if (EQ (kind
, Qmouse_click
))
9453 Lisp_Object window
, posn
;
9455 window
= POSN_WINDOW (EVENT_START (key
));
9456 posn
= POSN_POSN (EVENT_START (key
));
9459 || (!NILP (fake_prefixed_keys
)
9460 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9462 /* We're looking a second time at an event for which
9463 we generated a fake prefix key. Set
9464 last_real_key_start appropriately. */
9466 last_real_key_start
= t
- 1;
9469 /* Key sequences beginning with mouse clicks are
9470 read using the keymaps in the buffer clicked on,
9471 not the current buffer. If we're at the
9472 beginning of a key sequence, switch buffers. */
9473 if (last_real_key_start
== 0
9475 && BUFFERP (XWINDOW (window
)->buffer
)
9476 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9478 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9482 /* Arrange to go back to the original buffer once we're
9483 done reading the key sequence. Note that we can't
9484 use save_excursion_{save,restore} here, because they
9485 save point as well as the current buffer; we don't
9486 want to save point, because redisplay may change it,
9487 to accommodate a Fset_window_start or something. We
9488 don't want to do this at the top of the function,
9489 because we may get input from a subprocess which
9490 wants to change the selected window and stuff (say,
9492 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9494 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9496 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9497 orig_local_map
= get_local_map (PT
, current_buffer
,
9499 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9500 goto replay_sequence
;
9503 /* For a mouse click, get the local text-property keymap
9504 of the place clicked on, rather than point. */
9505 if (last_real_key_start
== 0
9506 && CONSP (XCDR (key
))
9507 && ! localized_local_map
)
9509 Lisp_Object map_here
, start
, pos
;
9511 localized_local_map
= 1;
9512 start
= EVENT_START (key
);
9514 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9516 pos
= POSN_BUFFER_POSN (start
);
9518 && XINT (pos
) >= BEGV
9519 && XINT (pos
) <= ZV
)
9521 map_here
= get_local_map (XINT (pos
),
9522 current_buffer
, Qlocal_map
);
9523 if (!EQ (map_here
, orig_local_map
))
9525 orig_local_map
= map_here
;
9526 ++localized_local_map
;
9529 map_here
= get_local_map (XINT (pos
),
9530 current_buffer
, Qkeymap
);
9531 if (!EQ (map_here
, orig_keymap
))
9533 orig_keymap
= map_here
;
9534 ++localized_local_map
;
9537 if (localized_local_map
> 1)
9542 goto replay_sequence
;
9548 /* Expand mode-line and scroll-bar events into two events:
9549 use posn as a fake prefix key. */
9551 && (NILP (fake_prefixed_keys
)
9552 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9554 if (t
+ 1 >= bufsize
)
9555 error ("Key sequence too long");
9558 keybuf
[t
+ 1] = key
;
9561 /* Record that a fake prefix key has been generated
9562 for KEY. Don't modify the event; this would
9563 prevent proper action when the event is pushed
9564 back into unread-command-events. */
9565 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9567 /* If on a mode line string with a local keymap,
9568 reconsider the key sequence with that keymap. */
9569 if (string
= POSN_STRING (EVENT_START (key
)),
9570 (CONSP (string
) && STRINGP (XCAR (string
))))
9572 Lisp_Object pos
, map
, map2
;
9574 pos
= XCDR (string
);
9575 string
= XCAR (string
);
9577 && XINT (pos
) < SCHARS (string
))
9579 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9581 orig_local_map
= map
;
9582 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9585 if (!NILP (map
) || !NILP (map2
))
9586 goto replay_sequence
;
9592 else if (NILP (from_string
)
9593 && (string
= POSN_STRING (EVENT_START (key
)),
9594 (CONSP (string
) && STRINGP (XCAR (string
)))))
9596 /* For a click on a string, i.e. overlay string or a
9597 string displayed via the `display' property,
9598 consider `local-map' and `keymap' properties of
9600 Lisp_Object pos
, map
, map2
;
9602 pos
= XCDR (string
);
9603 string
= XCAR (string
);
9605 && XINT (pos
) < SCHARS (string
))
9607 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9609 orig_local_map
= map
;
9610 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9614 if (!NILP (map
) || !NILP (map2
))
9616 from_string
= string
;
9619 goto replay_sequence
;
9624 else if (CONSP (XCDR (key
))
9625 && CONSP (EVENT_START (key
))
9626 && CONSP (XCDR (EVENT_START (key
))))
9630 posn
= POSN_POSN (EVENT_START (key
));
9631 /* Handle menu-bar events:
9632 insert the dummy prefix event `menu-bar'. */
9633 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9635 if (t
+ 1 >= bufsize
)
9636 error ("Key sequence too long");
9640 /* Zap the position in key, so we know that we've
9641 expanded it, and don't try to do so again. */
9642 POSN_SET_POSN (EVENT_START (key
),
9643 Fcons (posn
, Qnil
));
9646 goto replay_sequence
;
9648 else if (CONSP (posn
))
9650 /* We're looking at the second event of a
9651 sequence which we expanded before. Set
9652 last_real_key_start appropriately. */
9653 if (last_real_key_start
== t
&& t
> 0)
9654 last_real_key_start
= t
- 1;
9659 /* We have finally decided that KEY is something we might want
9661 first_binding
= (follow_key (key
,
9662 nmaps
- first_binding
,
9663 submaps
+ first_binding
,
9664 defs
+ first_binding
,
9665 submaps
+ first_binding
)
9668 /* If KEY wasn't bound, we'll try some fallbacks. */
9669 if (first_binding
< nmaps
)
9670 /* This is needed for the following scenario:
9671 event 0: a down-event that gets dropped by calling replay_key.
9672 event 1: some normal prefix like C-h.
9673 After event 0, first_unbound is 0, after event 1 indec.start,
9674 fkey.start, and keytran.start are all 1, so when we see that
9675 C-h is bound, we need to update first_unbound. */
9676 first_unbound
= max (t
+ 1, first_unbound
);
9681 /* Remember the position to put an upper bound on indec.start. */
9682 first_unbound
= min (t
, first_unbound
);
9684 head
= EVENT_HEAD (key
);
9685 if (help_char_p (head
) && t
> 0)
9687 read_key_sequence_cmd
= Vprefix_help_command
;
9689 last_nonmenu_event
= key
;
9690 /* The Microsoft C compiler can't handle the goto that
9698 Lisp_Object breakdown
;
9701 breakdown
= parse_modifiers (head
);
9702 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9703 /* Attempt to reduce an unbound mouse event to a simpler
9704 event that is bound:
9705 Drags reduce to clicks.
9706 Double-clicks reduce to clicks.
9707 Triple-clicks reduce to double-clicks, then to clicks.
9708 Down-clicks are eliminated.
9709 Double-downs reduce to downs, then are eliminated.
9710 Triple-downs reduce to double-downs, then to downs,
9711 then are eliminated. */
9712 if (modifiers
& (down_modifier
| drag_modifier
9713 | double_modifier
| triple_modifier
))
9715 while (modifiers
& (down_modifier
| drag_modifier
9716 | double_modifier
| triple_modifier
))
9718 Lisp_Object new_head
, new_click
;
9719 if (modifiers
& triple_modifier
)
9720 modifiers
^= (double_modifier
| triple_modifier
);
9721 else if (modifiers
& double_modifier
)
9722 modifiers
&= ~double_modifier
;
9723 else if (modifiers
& drag_modifier
)
9724 modifiers
&= ~drag_modifier
;
9727 /* Dispose of this `down' event by simply jumping
9728 back to replay_key, to get another event.
9730 Note that if this event came from mock input,
9731 then just jumping back to replay_key will just
9732 hand it to us again. So we have to wipe out any
9735 We could delete keybuf[t] and shift everything
9736 after that to the left by one spot, but we'd also
9737 have to fix up any variable that points into
9738 keybuf, and shifting isn't really necessary
9741 Adding prefixes for non-textual mouse clicks
9742 creates two characters of mock input, and both
9743 must be thrown away. If we're only looking at
9744 the prefix now, we can just jump back to
9745 replay_key. On the other hand, if we've already
9746 processed the prefix, and now the actual click
9747 itself is giving us trouble, then we've lost the
9748 state of the keymaps we want to backtrack to, and
9749 we need to replay the whole sequence to rebuild
9752 Beyond that, only function key expansion could
9753 create more than two keys, but that should never
9754 generate mouse events, so it's okay to zero
9755 mock_input in that case too.
9757 FIXME: The above paragraph seems just plain
9758 wrong, if you consider things like
9759 xterm-mouse-mode. -stef
9761 Isn't this just the most wonderful code ever? */
9763 /* If mock_input > t + 1, the above simplification
9764 will actually end up dropping keys on the floor.
9765 This is probably OK for now, but even
9766 if mock_input <= t + 1, we need to adjust indec,
9768 Typical case [header-line down-mouse-N]:
9769 mock_input = 2, t = 1, fkey.end = 1,
9770 last_real_key_start = 0. */
9771 if (indec
.end
> last_real_key_start
)
9773 indec
.end
= indec
.start
9774 = min (last_real_key_start
, indec
.start
);
9775 indec
.map
= indec
.parent
;
9776 if (fkey
.end
> last_real_key_start
)
9778 fkey
.end
= fkey
.start
9779 = min (last_real_key_start
, fkey
.start
);
9780 fkey
.map
= fkey
.parent
;
9781 if (keytran
.end
> last_real_key_start
)
9783 keytran
.end
= keytran
.start
9784 = min (last_real_key_start
, keytran
.start
);
9785 keytran
.map
= keytran
.parent
;
9789 if (t
== last_real_key_start
)
9796 mock_input
= last_real_key_start
;
9797 goto replay_sequence
;
9802 = apply_modifiers (modifiers
, XCAR (breakdown
));
9804 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9806 /* Look for a binding for this new key. follow_key
9807 promises that it didn't munge submaps the
9808 last time we called it, since key was unbound. */
9810 = (follow_key (new_click
,
9811 nmaps
- local_first_binding
,
9812 submaps
+ local_first_binding
,
9813 defs
+ local_first_binding
,
9814 submaps
+ local_first_binding
)
9815 + local_first_binding
);
9817 /* If that click is bound, go for it. */
9818 if (first_binding
< nmaps
)
9823 /* Otherwise, we'll leave key set to the drag event. */
9830 /* Normally, last_nonmenu_event gets the previous key we read.
9831 But when a mouse popup menu is being used,
9832 we don't update last_nonmenu_event; it continues to hold the mouse
9833 event that preceded the first level of menu. */
9834 if (!used_mouse_menu
)
9835 last_nonmenu_event
= key
;
9837 /* Record what part of this_command_keys is the current key sequence. */
9838 this_single_command_key_start
= this_command_key_count
- t
;
9840 /* Look for this sequence in input-decode-map.
9841 Scan from indec.end until we find a bound suffix. */
9842 while (indec
.end
< t
)
9844 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9847 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9848 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9853 mock_input
= diff
+ max (t
, mock_input
);
9854 goto replay_sequence
;
9858 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9859 && indec
.start
>= t
)
9860 /* There is a binding and it's not a prefix.
9861 (and it doesn't have any input-decode-map translation pending).
9862 There is thus no function-key in this sequence.
9863 Moving fkey.start is important in this case to allow keytran.start
9864 to go over the sequence before we return (since we keep the
9865 invariant that keytran.end <= fkey.start). */
9868 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9871 /* If the sequence is unbound, see if we can hang a function key
9872 off the end of it. */
9873 /* Continue scan from fkey.end until we find a bound suffix. */
9874 while (fkey
.end
< indec
.start
)
9876 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9879 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9880 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9881 max (t
, mock_input
),
9882 /* If there's a binding (i.e.
9883 first_binding >= nmaps) we don't want
9884 to apply this function-key-mapping. */
9885 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9890 mock_input
= diff
+ max (t
, mock_input
);
9891 /* Adjust the input-decode-map counters. */
9893 indec
.start
+= diff
;
9895 goto replay_sequence
;
9899 /* Look for this sequence in key-translation-map.
9900 Scan from keytran.end until we find a bound suffix. */
9901 while (keytran
.end
< fkey
.start
)
9903 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9906 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9907 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9912 mock_input
= diff
+ max (t
, mock_input
);
9913 /* Adjust the function-key-map and input-decode-map counters. */
9915 indec
.start
+= diff
;
9919 goto replay_sequence
;
9923 /* If KEY is not defined in any of the keymaps,
9924 and cannot be part of a function key or translation,
9925 and is an upper case letter
9926 use the corresponding lower-case letter instead. */
9927 if (first_binding
>= nmaps
9928 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9930 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9931 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9932 || (XINT (key
) & shift_modifier
)))
9934 Lisp_Object new_key
;
9936 original_uppercase
= key
;
9937 original_uppercase_position
= t
- 1;
9939 if (XINT (key
) & shift_modifier
)
9940 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9942 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9943 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9945 /* We have to do this unconditionally, regardless of whether
9946 the lower-case char is defined in the keymaps, because they
9947 might get translated through function-key-map. */
9948 keybuf
[t
- 1] = new_key
;
9949 mock_input
= max (t
, mock_input
);
9950 shift_translated
= 1;
9952 goto replay_sequence
;
9954 /* If KEY is not defined in any of the keymaps,
9955 and cannot be part of a function key or translation,
9956 and is a shifted function key,
9957 use the corresponding unshifted function key instead. */
9958 if (first_binding
>= nmaps
9959 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9961 Lisp_Object breakdown
= parse_modifiers (key
);
9963 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9965 if (modifiers
& shift_modifier
9966 /* Treat uppercase keys as shifted. */
9968 && (KEY_TO_CHAR (key
)
9969 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9970 && UPPERCASEP (KEY_TO_CHAR (key
))))
9973 = (modifiers
& shift_modifier
9974 ? apply_modifiers (modifiers
& ~shift_modifier
,
9976 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
9978 original_uppercase
= key
;
9979 original_uppercase_position
= t
- 1;
9981 /* We have to do this unconditionally, regardless of whether
9982 the lower-case char is defined in the keymaps, because they
9983 might get translated through function-key-map. */
9984 keybuf
[t
- 1] = new_key
;
9985 mock_input
= max (t
, mock_input
);
9986 /* Reset fkey (and consequently keytran) to apply
9987 function-key-map on the result, so that S-backspace is
9988 correctly mapped to DEL (via backspace). OTOH,
9989 input-decode-map doesn't need to go through it again. */
9990 fkey
.start
= fkey
.end
= 0;
9991 keytran
.start
= keytran
.end
= 0;
9992 shift_translated
= 1;
9994 goto replay_sequence
;
9999 read_key_sequence_cmd
= (first_binding
< nmaps
10000 ? defs
[first_binding
]
10003 unread_switch_frame
= delayed_switch_frame
;
10004 unbind_to (count
, Qnil
);
10006 /* Don't downcase the last character if the caller says don't.
10007 Don't downcase it if the result is undefined, either. */
10008 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10010 && t
- 1 == original_uppercase_position
)
10012 keybuf
[t
- 1] = original_uppercase
;
10013 shift_translated
= 0;
10016 if (shift_translated
)
10017 Vthis_command_keys_shift_translated
= Qt
;
10019 /* Occasionally we fabricate events, perhaps by expanding something
10020 according to function-key-map, or by adding a prefix symbol to a
10021 mouse click in the scroll bar or modeline. In this cases, return
10022 the entire generated key sequence, even if we hit an unbound
10023 prefix or a definition before the end. This means that you will
10024 be able to push back the event properly, and also means that
10025 read-key-sequence will always return a logical unit.
10028 for (; t
< mock_input
; t
++)
10030 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10031 && NILP (Fzerop (Vecho_keystrokes
)))
10032 echo_char (keybuf
[t
]);
10033 add_command_key (keybuf
[t
]);
10040 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10041 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10042 The sequence is sufficient to specify a non-prefix command in the
10043 current local and global maps.
10045 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10046 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10047 as a continuation of the previous key.
10049 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10050 convert the last event to lower case. (Normally any upper case event
10051 is converted to lower case if the original event is undefined and the lower
10052 case equivalent is defined.) A non-nil value is appropriate for reading
10053 a key sequence to be defined.
10055 A C-g typed while in this function is treated like any other character,
10056 and `quit-flag' is not set.
10058 If the key sequence starts with a mouse click, then the sequence is read
10059 using the keymaps of the buffer of the window clicked in, not the buffer
10060 of the selected window as normal.
10062 `read-key-sequence' drops unbound button-down events, since you normally
10063 only care about the click or drag events which follow them. If a drag
10064 or multi-click event is unbound, but the corresponding click event would
10065 be bound, `read-key-sequence' turns the event into a click event at the
10066 drag's starting position. This means that you don't have to distinguish
10067 between click and drag, double, or triple events unless you want to.
10069 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10070 lines separating windows, and scroll bars with imaginary keys
10071 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10073 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10074 function will process a switch-frame event if the user switches frames
10075 before typing anything. If the user switches frames in the middle of a
10076 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10077 is nil, then the event will be put off until after the current key sequence.
10079 `read-key-sequence' checks `function-key-map' for function key
10080 sequences, where they wouldn't conflict with ordinary bindings. See
10081 `function-key-map' for more details.
10083 The optional fifth argument COMMAND-LOOP, if non-nil, means
10084 that this key sequence is being read by something that will
10085 read commands one after another. It should be nil if the caller
10086 will read just one key sequence. */)
10087 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10089 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10090 Lisp_Object can_return_switch_frame
, command_loop
;
10092 Lisp_Object keybuf
[30];
10094 struct gcpro gcpro1
;
10095 int count
= SPECPDL_INDEX ();
10097 if (!NILP (prompt
))
10098 CHECK_STRING (prompt
);
10101 specbind (Qinput_method_exit_on_first_char
,
10102 (NILP (command_loop
) ? Qt
: Qnil
));
10103 specbind (Qinput_method_use_echo_area
,
10104 (NILP (command_loop
) ? Qt
: Qnil
));
10106 bzero (keybuf
, sizeof keybuf
);
10107 GCPRO1 (keybuf
[0]);
10108 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10110 if (NILP (continue_echo
))
10112 this_command_key_count
= 0;
10113 this_command_key_count_reset
= 0;
10114 this_single_command_key_start
= 0;
10117 #ifdef HAVE_WINDOW_SYSTEM
10118 if (display_hourglass_p
)
10119 cancel_hourglass ();
10122 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10123 prompt
, ! NILP (dont_downcase_last
),
10124 ! NILP (can_return_switch_frame
), 0);
10126 #if 0 /* The following is fine for code reading a key sequence and
10127 then proceeding with a lenghty computation, but it's not good
10128 for code reading keys in a loop, like an input method. */
10129 #ifdef HAVE_WINDOW_SYSTEM
10130 if (display_hourglass_p
)
10131 start_hourglass ();
10141 return unbind_to (count
, make_event_array (i
, keybuf
));
10144 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10145 Sread_key_sequence_vector
, 1, 5, 0,
10146 doc
: /* Like `read-key-sequence' but always return a vector. */)
10147 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10149 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10150 Lisp_Object can_return_switch_frame
, command_loop
;
10152 Lisp_Object keybuf
[30];
10154 struct gcpro gcpro1
;
10155 int count
= SPECPDL_INDEX ();
10157 if (!NILP (prompt
))
10158 CHECK_STRING (prompt
);
10161 specbind (Qinput_method_exit_on_first_char
,
10162 (NILP (command_loop
) ? Qt
: Qnil
));
10163 specbind (Qinput_method_use_echo_area
,
10164 (NILP (command_loop
) ? Qt
: Qnil
));
10166 bzero (keybuf
, sizeof keybuf
);
10167 GCPRO1 (keybuf
[0]);
10168 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10170 if (NILP (continue_echo
))
10172 this_command_key_count
= 0;
10173 this_command_key_count_reset
= 0;
10174 this_single_command_key_start
= 0;
10177 #ifdef HAVE_WINDOW_SYSTEM
10178 if (display_hourglass_p
)
10179 cancel_hourglass ();
10182 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10183 prompt
, ! NILP (dont_downcase_last
),
10184 ! NILP (can_return_switch_frame
), 0);
10186 #ifdef HAVE_WINDOW_SYSTEM
10187 if (display_hourglass_p
)
10188 start_hourglass ();
10197 return unbind_to (count
, Fvector (i
, keybuf
));
10200 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10201 doc
: /* Execute CMD as an editor command.
10202 CMD must be a symbol that satisfies the `commandp' predicate.
10203 Optional second arg RECORD-FLAG non-nil
10204 means unconditionally put this command in `command-history'.
10205 Otherwise, that is done only if an arg is read using the minibuffer.
10206 The argument KEYS specifies the value to use instead of (this-command-keys)
10207 when reading the arguments; if it is nil, (this-command-keys) is used.
10208 The argument SPECIAL, if non-nil, means that this command is executing
10209 a special event, so ignore the prefix argument and don't clear it. */)
10210 (cmd
, record_flag
, keys
, special
)
10211 Lisp_Object cmd
, record_flag
, keys
, special
;
10213 register Lisp_Object final
;
10214 register Lisp_Object tem
;
10215 Lisp_Object prefixarg
;
10216 extern int debug_on_next_call
;
10218 debug_on_next_call
= 0;
10220 if (NILP (special
))
10222 prefixarg
= current_kboard
->Vprefix_arg
;
10223 Vcurrent_prefix_arg
= prefixarg
;
10224 current_kboard
->Vprefix_arg
= Qnil
;
10231 tem
= Fget (cmd
, Qdisabled
);
10232 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10234 tem
= Fsymbol_value (Qdisabled_command_function
);
10236 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10242 final
= Findirect_function (cmd
, Qnil
);
10244 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10246 struct gcpro gcpro1
, gcpro2
;
10248 GCPRO2 (cmd
, prefixarg
);
10249 do_autoload (final
, cmd
);
10256 if (STRINGP (final
) || VECTORP (final
))
10258 /* If requested, place the macro in the command history. For
10259 other sorts of commands, call-interactively takes care of
10261 if (!NILP (record_flag
))
10264 = Fcons (Fcons (Qexecute_kbd_macro
,
10265 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10268 /* Don't keep command history around forever. */
10269 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10271 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10273 XSETCDR (tem
, Qnil
);
10277 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10280 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10281 /* Don't call Fcall_interactively directly because we want to make
10282 sure the backtrace has an entry for `call-interactively'.
10283 For the same reason, pass `cmd' rather than `final'. */
10284 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10291 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10293 doc
: /* Read function name, then read its arguments and call it.
10295 To pass a numeric argument to the command you are invoking with, specify
10296 the numeric argument to this command.
10298 Noninteractively, the argument PREFIXARG is the prefix argument to
10299 give to the command you invoke, if it asks for an argument. */)
10301 Lisp_Object prefixarg
;
10303 Lisp_Object function
;
10305 int saved_last_point_position
;
10306 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10307 Lisp_Object bindings
, value
;
10308 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10309 #ifdef HAVE_WINDOW_SYSTEM
10310 /* The call to Fcompleting_read wil start and cancel the hourglass,
10311 but if the hourglass was already scheduled, this means that no
10312 hourglass will be shown for the actual M-x command itself.
10313 So we restart it if it is already scheduled. Note that checking
10314 hourglass_shown_p is not enough, normally the hourglass is not shown,
10315 just scheduled to be shown. */
10316 int hstarted
= hourglass_started ();
10319 saved_keys
= Fvector (this_command_key_count
,
10320 XVECTOR (this_command_keys
)->contents
);
10321 saved_last_point_position_buffer
= last_point_position_buffer
;
10322 saved_last_point_position
= last_point_position
;
10324 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10326 if (EQ (prefixarg
, Qminus
))
10327 strcpy (buf
, "- ");
10328 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10329 strcpy (buf
, "C-u ");
10330 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10331 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10332 else if (INTEGERP (prefixarg
))
10333 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10335 /* This isn't strictly correct if execute-extended-command
10336 is bound to anything else. Perhaps it should use
10337 this_command_keys? */
10338 strcat (buf
, "M-x ");
10340 /* Prompt with buf, and then read a string, completing from and
10341 restricting to the set of all defined commands. Don't provide
10342 any initial input. Save the command read on the extended-command
10344 function
= Fcompleting_read (build_string (buf
),
10345 Vobarray
, Qcommandp
,
10346 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10349 #ifdef HAVE_WINDOW_SYSTEM
10350 if (hstarted
) start_hourglass ();
10353 if (STRINGP (function
) && SCHARS (function
) == 0)
10354 error ("No command name given");
10356 /* Set this_command_keys to the concatenation of saved_keys and
10357 function, followed by a RET. */
10362 this_command_key_count
= 0;
10363 this_command_key_count_reset
= 0;
10364 this_single_command_key_start
= 0;
10366 keys
= XVECTOR (saved_keys
)->contents
;
10367 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10368 add_command_key (keys
[i
]);
10370 for (i
= 0; i
< SCHARS (function
); i
++)
10371 add_command_key (Faref (function
, make_number (i
)));
10373 add_command_key (make_number ('\015'));
10376 last_point_position
= saved_last_point_position
;
10377 last_point_position_buffer
= saved_last_point_position_buffer
;
10381 function
= Fintern (function
, Qnil
);
10382 current_kboard
->Vprefix_arg
= prefixarg
;
10383 Vthis_command
= function
;
10384 real_this_command
= function
;
10386 /* If enabled, show which key runs this command. */
10387 if (!NILP (Vsuggest_key_bindings
)
10388 && NILP (Vexecuting_kbd_macro
)
10389 && SYMBOLP (function
))
10390 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10396 GCPRO3 (bindings
, value
, function
);
10397 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10399 /* If the command has a key binding, print it now. */
10400 if (!NILP (bindings
)
10401 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10404 /* But first wait, and skip the message if there is input. */
10405 Lisp_Object waited
;
10407 /* If this command displayed something in the echo area;
10408 wait a few seconds, then display our suggestion message. */
10409 if (NILP (echo_area_buffer
[0]))
10410 waited
= sit_for (make_number (0), 0, 2);
10411 else if (NUMBERP (Vsuggest_key_bindings
))
10412 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10414 waited
= sit_for (make_number (2), 0, 2);
10416 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10418 Lisp_Object binding
;
10420 int message_p
= push_message ();
10421 int count
= SPECPDL_INDEX ();
10423 record_unwind_protect (pop_message_unwind
, Qnil
);
10424 binding
= Fkey_description (bindings
, Qnil
);
10427 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10430 sprintf (newmessage
, "You can run the command `%s' with %s",
10431 SDATA (SYMBOL_NAME (function
)),
10433 message2_nolog (newmessage
,
10434 strlen (newmessage
),
10435 STRING_MULTIBYTE (binding
));
10436 if (NUMBERP (Vsuggest_key_bindings
))
10437 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10439 waited
= sit_for (make_number (2), 0, 2);
10441 if (!NILP (waited
) && message_p
)
10442 restore_message ();
10444 unbind_to (count
, Qnil
);
10448 RETURN_UNGCPRO (value
);
10452 /* Return nonzero if input events are pending. */
10455 detect_input_pending (void)
10457 if (!input_pending
)
10458 get_input_pending (&input_pending
, 0);
10460 return input_pending
;
10463 /* Return nonzero if input events other than mouse movements are
10467 detect_input_pending_ignore_squeezables (void)
10469 if (!input_pending
)
10470 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10472 return input_pending
;
10475 /* Return nonzero if input events are pending, and run any pending timers. */
10478 detect_input_pending_run_timers (int do_display
)
10480 int old_timers_run
= timers_run
;
10482 if (!input_pending
)
10483 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10485 if (old_timers_run
!= timers_run
&& do_display
)
10487 redisplay_preserve_echo_area (8);
10488 /* The following fixes a bug when using lazy-lock with
10489 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10490 from an idle timer function. The symptom of the bug is that
10491 the cursor sometimes doesn't become visible until the next X
10492 event is processed. --gerd. */
10494 Lisp_Object tail
, frame
;
10495 FOR_EACH_FRAME (tail
, frame
)
10496 if (FRAME_RIF (XFRAME (frame
)))
10497 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10501 return input_pending
;
10504 /* This is called in some cases before a possible quit.
10505 It cases the next call to detect_input_pending to recompute input_pending.
10506 So calling this function unnecessarily can't do any harm. */
10509 clear_input_pending (void)
10514 /* Return nonzero if there are pending requeued events.
10515 This isn't used yet. The hope is to make wait_reading_process_output
10516 call it, and return if it runs Lisp code that unreads something.
10517 The problem is, kbd_buffer_get_event needs to be fixed to know what
10518 to do in that case. It isn't trivial. */
10521 requeued_events_pending_p (void)
10523 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10527 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10528 doc
: /* Return t if command input is currently available with no wait.
10529 Actually, the value is nil only if we can be sure that no input is available;
10530 if there is a doubt, the value is t. */)
10533 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10534 || !NILP (Vunread_post_input_method_events
)
10535 || !NILP (Vunread_input_method_events
))
10538 get_input_pending (&input_pending
,
10539 READABLE_EVENTS_DO_TIMERS_NOW
10540 | READABLE_EVENTS_FILTER_EVENTS
);
10541 return input_pending
> 0 ? Qt
: Qnil
;
10544 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10545 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10548 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10551 if (total_keys
< NUM_RECENT_KEYS
)
10552 return Fvector (total_keys
, keys
);
10555 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10556 bcopy (keys
+ recent_keys_index
,
10557 XVECTOR (val
)->contents
,
10558 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10560 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10561 recent_keys_index
* sizeof (Lisp_Object
));
10566 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10567 doc
: /* Return the key sequence that invoked this command.
10568 However, if the command has called `read-key-sequence', it returns
10569 the last key sequence that has been read.
10570 The value is a string or a vector.
10572 See also `this-command-keys-vector'. */)
10575 return make_event_array (this_command_key_count
,
10576 XVECTOR (this_command_keys
)->contents
);
10579 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10580 doc
: /* Return the key sequence that invoked this command, as a vector.
10581 However, if the command has called `read-key-sequence', it returns
10582 the last key sequence that has been read.
10584 See also `this-command-keys'. */)
10587 return Fvector (this_command_key_count
,
10588 XVECTOR (this_command_keys
)->contents
);
10591 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10592 Sthis_single_command_keys
, 0, 0, 0,
10593 doc
: /* Return the key sequence that invoked this command.
10594 More generally, it returns the last key sequence read, either by
10595 the command loop or by `read-key-sequence'.
10596 Unlike `this-command-keys', this function's value
10597 does not include prefix arguments.
10598 The value is always a vector. */)
10601 return Fvector (this_command_key_count
10602 - this_single_command_key_start
,
10603 (XVECTOR (this_command_keys
)->contents
10604 + this_single_command_key_start
));
10607 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10608 Sthis_single_command_raw_keys
, 0, 0, 0,
10609 doc
: /* Return the raw events that were read for this command.
10610 More generally, it returns the last key sequence read, either by
10611 the command loop or by `read-key-sequence'.
10612 Unlike `this-single-command-keys', this function's value
10613 shows the events before all translations (except for input methods).
10614 The value is always a vector. */)
10617 return Fvector (raw_keybuf_count
,
10618 (XVECTOR (raw_keybuf
)->contents
));
10621 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10622 Sreset_this_command_lengths
, 0, 0, 0,
10623 doc
: /* Make the unread events replace the last command and echo.
10624 Used in `universal-argument-other-key'.
10626 `universal-argument-other-key' rereads the event just typed.
10627 It then gets translated through `function-key-map'.
10628 The translated event has to replace the real events,
10629 both in the value of (this-command-keys) and in echoing.
10630 To achieve this, `universal-argument-other-key' calls
10631 `reset-this-command-lengths', which discards the record of reading
10632 these events the first time. */)
10635 this_command_key_count
= before_command_key_count
;
10636 if (this_command_key_count
< this_single_command_key_start
)
10637 this_single_command_key_start
= this_command_key_count
;
10639 echo_truncate (before_command_echo_length
);
10641 /* Cause whatever we put into unread-command-events
10642 to echo as if it were being freshly read from the keyboard. */
10643 this_command_key_count_reset
= 1;
10648 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10649 Sclear_this_command_keys
, 0, 1, 0,
10650 doc
: /* Clear out the vector that `this-command-keys' returns.
10651 Also clear the record of the last 100 events, unless optional arg
10652 KEEP-RECORD is non-nil. */)
10654 Lisp_Object keep_record
;
10658 this_command_key_count
= 0;
10659 this_command_key_count_reset
= 0;
10661 if (NILP (keep_record
))
10663 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10664 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10666 recent_keys_index
= 0;
10671 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10672 doc
: /* Return the current depth in recursive edits. */)
10676 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10680 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10681 "FOpen dribble file: ",
10682 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10683 If FILE is nil, close any open dribble file. */)
10696 file
= Fexpand_file_name (file
, Qnil
);
10697 dribble
= fopen (SDATA (file
), "w");
10699 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10704 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10705 doc
: /* Discard the contents of the terminal input buffer.
10706 Also end any kbd macro being defined. */)
10709 if (!NILP (current_kboard
->defining_kbd_macro
))
10711 /* Discard the last command from the macro. */
10712 Fcancel_kbd_macro_events ();
10716 update_mode_lines
++;
10718 Vunread_command_events
= Qnil
;
10719 unread_command_char
= -1;
10721 discard_tty_input ();
10723 kbd_fetch_ptr
= kbd_store_ptr
;
10729 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10730 doc
: /* Stop Emacs and return to superior process. You can resume later.
10731 If `cannot-suspend' is non-nil, or if the system doesn't support job
10732 control, run a subshell instead.
10734 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10735 to be read as terminal input by Emacs's parent, after suspension.
10737 Before suspending, run the normal hook `suspend-hook'.
10738 After resumption run the normal hook `suspend-resume-hook'.
10740 Some operating systems cannot stop the Emacs process and resume it later.
10741 On such systems, Emacs starts a subshell instead of suspending. */)
10743 Lisp_Object stuffstring
;
10745 int count
= SPECPDL_INDEX ();
10746 int old_height
, old_width
;
10748 struct gcpro gcpro1
;
10750 if (tty_list
&& tty_list
->next
)
10751 error ("There are other tty frames open; close them before suspending Emacs");
10753 if (!NILP (stuffstring
))
10754 CHECK_STRING (stuffstring
);
10756 /* Run the functions in suspend-hook. */
10757 if (!NILP (Vrun_hooks
))
10758 call1 (Vrun_hooks
, intern ("suspend-hook"));
10760 GCPRO1 (stuffstring
);
10761 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10762 reset_all_sys_modes ();
10763 /* sys_suspend can get an error if it tries to fork a subshell
10764 and the system resources aren't available for that. */
10765 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10767 stuff_buffered_input (stuffstring
);
10768 if (cannot_suspend
)
10772 unbind_to (count
, Qnil
);
10774 /* Check if terminal/window size has changed.
10775 Note that this is not useful when we are running directly
10776 with a window system; but suspend should be disabled in that case. */
10777 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10778 if (width
!= old_width
|| height
!= old_height
)
10779 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10781 /* Run suspend-resume-hook. */
10782 if (!NILP (Vrun_hooks
))
10783 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10789 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10790 Then in any case stuff anything Emacs has read ahead and not used. */
10793 stuff_buffered_input (Lisp_Object stuffstring
)
10795 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10796 register unsigned char *p
;
10798 if (STRINGP (stuffstring
))
10800 register int count
;
10802 p
= SDATA (stuffstring
);
10803 count
= SBYTES (stuffstring
);
10804 while (count
-- > 0)
10809 /* Anything we have read ahead, put back for the shell to read. */
10810 /* ?? What should this do when we have multiple keyboards??
10811 Should we ignore anything that was typed in at the "wrong" kboard?
10813 rms: we should stuff everything back into the kboard
10815 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10818 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10819 kbd_fetch_ptr
= kbd_buffer
;
10820 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10821 stuff_char (kbd_fetch_ptr
->code
);
10823 clear_event (kbd_fetch_ptr
);
10827 #endif /* SIGTSTP */
10831 set_waiting_for_input (struct timeval
*time_to_clear
)
10833 input_available_clear_time
= time_to_clear
;
10835 /* Tell handle_interrupt to throw back to read_char, */
10836 waiting_for_input
= 1;
10838 /* If handle_interrupt was called before and buffered a C-g,
10839 make it run again now, to avoid timing error. */
10840 if (!NILP (Vquit_flag
))
10841 quit_throw_to_read_char ();
10845 clear_waiting_for_input (void)
10847 /* Tell handle_interrupt not to throw back to read_char, */
10848 waiting_for_input
= 0;
10849 input_available_clear_time
= 0;
10852 /* The SIGINT handler.
10854 If we have a frame on the controlling tty, we assume that the
10855 SIGINT was generated by C-g, so we call handle_interrupt.
10856 Otherwise, the handler kills Emacs. */
10859 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10860 /* compilers complain in signal calls. */
10862 /* Must preserve main program's value of errno. */
10863 int old_errno
= errno
;
10864 struct terminal
*terminal
;
10866 SIGNAL_THREAD_CHECK (signalnum
);
10868 /* See if we have an active terminal on our controlling tty. */
10869 terminal
= get_named_tty ("/dev/tty");
10872 /* If there are no frames there, let's pretend that we are a
10873 well-behaving UN*X program and quit. */
10874 Fkill_emacs (Qnil
);
10878 /* Otherwise, the SIGINT was probably generated by C-g. */
10880 /* Set internal_last_event_frame to the top frame of the
10881 controlling tty, if we have a frame there. We disable the
10882 interrupt key on secondary ttys, so the SIGINT must have come
10883 from the controlling tty. */
10884 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10886 handle_interrupt ();
10892 /* This routine is called at interrupt level in response to C-g.
10894 It is called from the SIGINT handler or kbd_buffer_store_event.
10896 If `waiting_for_input' is non zero, then unless `echoing' is
10897 nonzero, immediately throw back to read_char.
10899 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10900 eval to throw, when it gets a chance. If quit-flag is already
10901 non-nil, it stops the job right away. */
10904 handle_interrupt (void)
10910 /* XXX This code needs to be revised for multi-tty support. */
10911 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10913 /* If SIGINT isn't blocked, don't let us be interrupted by
10914 another SIGINT, it might be harmful due to non-reentrancy
10915 in I/O functions. */
10916 sigblock (sigmask (SIGINT
));
10919 reset_all_sys_modes ();
10921 #ifdef SIGTSTP /* Support possible in later USG versions */
10923 * On systems which can suspend the current process and return to the original
10924 * shell, this command causes the user to end up back at the shell.
10925 * The "Auto-save" and "Abort" questions are not asked until
10926 * the user elects to return to emacs, at which point he can save the current
10927 * job and either dump core or continue.
10931 /* Perhaps should really fork an inferior shell?
10932 But that would not provide any way to get back
10933 to the original shell, ever. */
10934 printf ("No support for stopping a process on this operating system;\n");
10935 printf ("you can continue or abort.\n");
10936 #endif /* not SIGTSTP */
10938 /* We must remain inside the screen area when the internal terminal
10939 is used. Note that [Enter] is not echoed by dos. */
10940 cursor_to (SELECTED_FRAME (), 0, 0);
10942 /* It doesn't work to autosave while GC is in progress;
10943 the code used for auto-saving doesn't cope with the mark bit. */
10944 if (!gc_in_progress
)
10946 printf ("Auto-save? (y or n) ");
10948 if (((c
= getchar ()) & ~040) == 'Y')
10950 Fdo_auto_save (Qt
, Qnil
);
10952 printf ("\r\nAuto-save done");
10953 #else /* not MSDOS */
10954 printf ("Auto-save done\n");
10955 #endif /* not MSDOS */
10957 while (c
!= '\n') c
= getchar ();
10961 /* During GC, it must be safe to reenable quitting again. */
10962 Vinhibit_quit
= Qnil
;
10965 #endif /* not MSDOS */
10966 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10967 printf ("but will instead do a real quit after garbage collection ends\r\n");
10972 printf ("\r\nAbort? (y or n) ");
10973 #else /* not MSDOS */
10974 printf ("Abort (and dump core)? (y or n) ");
10975 #endif /* not MSDOS */
10977 if (((c
= getchar ()) & ~040) == 'Y')
10979 while (c
!= '\n') c
= getchar ();
10981 printf ("\r\nContinuing...\r\n");
10982 #else /* not MSDOS */
10983 printf ("Continuing...\n");
10984 #endif /* not MSDOS */
10986 init_all_sys_modes ();
10991 /* If executing a function that wants to be interrupted out of
10992 and the user has not deferred quitting by binding `inhibit-quit'
10993 then quit right away. */
10994 if (immediate_quit
&& NILP (Vinhibit_quit
))
10996 struct gl_state_s saved
;
10997 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10999 immediate_quit
= 0;
11002 GCPRO4 (saved
.object
, saved
.global_code
,
11003 saved
.current_syntax_table
, saved
.old_prop
);
11004 Fsignal (Qquit
, Qnil
);
11005 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11010 /* Else request quit when it's safe */
11014 /* TODO: The longjmp in this call throws the NS event loop integration off,
11015 and it seems to do fine without this. Probably some attention
11016 needs to be paid to the setting of waiting_for_input in
11017 wait_reading_process_output() under HAVE_NS because of the call
11018 to ns_select there (needed because otherwise events aren't picked up
11019 outside of polling since we don't get SIGIO like X and we don't have a
11020 separate event loop thread like W32. */
11022 if (waiting_for_input
&& !echoing
)
11023 quit_throw_to_read_char ();
11027 /* Handle a C-g by making read_char return C-g. */
11030 quit_throw_to_read_char (void)
11033 /* Prevent another signal from doing this before we finish. */
11034 clear_waiting_for_input ();
11037 Vunread_command_events
= Qnil
;
11038 unread_command_char
= -1;
11040 #if 0 /* Currently, sit_for is called from read_char without turning
11041 off polling. And that can call set_waiting_for_input.
11042 It seems to be harmless. */
11043 #ifdef POLL_FOR_INPUT
11044 /* May be > 1 if in recursive minibuffer. */
11045 if (poll_suppress_count
== 0)
11049 if (FRAMEP (internal_last_event_frame
)
11050 && !EQ (internal_last_event_frame
, selected_frame
))
11051 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11054 _longjmp (getcjmp
, 1);
11057 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11058 doc
: /* Set interrupt mode of reading keyboard input.
11059 If INTERRUPT is non-nil, Emacs will use input interrupts;
11060 otherwise Emacs uses CBREAK mode.
11062 See also `current-input-mode'. */)
11064 Lisp_Object interrupt
;
11066 int new_interrupt_input
;
11068 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11069 #ifdef HAVE_X_WINDOWS
11070 if (x_display_list
!= NULL
)
11072 /* When using X, don't give the user a real choice,
11073 because we haven't implemented the mechanisms to support it. */
11074 new_interrupt_input
= 1;
11077 #endif /* HAVE_X_WINDOWS */
11078 new_interrupt_input
= !NILP (interrupt
);
11079 #else /* not SIGIO */
11080 new_interrupt_input
= 0;
11081 #endif /* not SIGIO */
11083 if (new_interrupt_input
!= interrupt_input
)
11085 #ifdef POLL_FOR_INPUT
11089 /* this causes startup screen to be restored and messes with the mouse */
11090 reset_all_sys_modes ();
11092 interrupt_input
= new_interrupt_input
;
11094 init_all_sys_modes ();
11097 #ifdef POLL_FOR_INPUT
11098 poll_suppress_count
= 1;
11105 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11106 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11107 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11108 C-q in key sequences.
11110 This setting only has an effect on tty terminals and only when
11111 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11113 See also `current-input-mode'. */)
11115 Lisp_Object flow
, terminal
;
11117 struct terminal
*t
= get_terminal (terminal
, 1);
11118 struct tty_display_info
*tty
;
11119 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11121 tty
= t
->display_info
.tty
;
11123 if (tty
->flow_control
!= !NILP (flow
))
11126 /* this causes startup screen to be restored and messes with the mouse */
11127 reset_sys_modes (tty
);
11130 tty
->flow_control
= !NILP (flow
);
11133 init_sys_modes (tty
);
11139 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11140 doc
: /* Enable or disable 8-bit input on TERMINAL.
11141 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11142 bit as the Meta modifier.
11144 If META is nil, Emacs will ignore the top bit, on the assumption it is
11147 Otherwise, Emacs will accept and pass through 8-bit input without
11148 specially interpreting the top bit.
11150 This setting only has an effect on tty terminal devices.
11152 Optional parameter TERMINAL specifies the tty terminal device to use.
11153 It may be a terminal object, a frame, or nil for the terminal used by
11154 the currently selected frame.
11156 See also `current-input-mode'. */)
11158 Lisp_Object meta
, terminal
;
11160 struct terminal
*t
= get_terminal (terminal
, 1);
11161 struct tty_display_info
*tty
;
11164 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11166 tty
= t
->display_info
.tty
;
11170 else if (EQ (meta
, Qt
))
11175 if (tty
->meta_key
!= new_meta
)
11178 /* this causes startup screen to be restored and messes with the mouse */
11179 reset_sys_modes (tty
);
11182 tty
->meta_key
= new_meta
;
11185 init_sys_modes (tty
);
11191 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11192 doc
: /* Specify character used for quitting.
11193 QUIT must be an ASCII character.
11195 This function only has an effect on the controlling tty of the Emacs
11198 See also `current-input-mode'. */)
11202 struct terminal
*t
= get_named_tty ("/dev/tty");
11203 struct tty_display_info
*tty
;
11204 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11206 tty
= t
->display_info
.tty
;
11208 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11209 error ("QUIT must be an ASCII character");
11212 /* this causes startup screen to be restored and messes with the mouse */
11213 reset_sys_modes (tty
);
11216 /* Don't let this value be out of range. */
11217 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11220 init_sys_modes (tty
);
11226 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11227 doc
: /* Set mode of reading keyboard input.
11228 First arg INTERRUPT non-nil means use input interrupts;
11229 nil means use CBREAK mode.
11230 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11231 (no effect except in CBREAK mode).
11232 Third arg META t means accept 8-bit input (for a Meta key).
11233 META nil means ignore the top bit, on the assumption it is parity.
11234 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11235 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11236 See also `current-input-mode'. */)
11237 (interrupt
, flow
, meta
, quit
)
11238 Lisp_Object interrupt
, flow
, meta
, quit
;
11240 Fset_input_interrupt_mode (interrupt
);
11241 Fset_output_flow_control (flow
, Qnil
);
11242 Fset_input_meta_mode (meta
, Qnil
);
11244 Fset_quit_char (quit
);
11248 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11249 doc
: /* Return information about the way Emacs currently reads keyboard input.
11250 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11251 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11252 nil, Emacs is using CBREAK mode.
11253 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11254 terminal; this does not apply if Emacs uses interrupt-driven input.
11255 META is t if accepting 8-bit input with 8th bit as Meta flag.
11256 META nil means ignoring the top bit, on the assumption it is parity.
11257 META is neither t nor nil if accepting 8-bit input and using
11258 all 8 bits as the character code.
11259 QUIT is the character Emacs currently uses to quit.
11260 The elements of this list correspond to the arguments of
11261 `set-input-mode'. */)
11264 Lisp_Object val
[4];
11265 struct frame
*sf
= XFRAME (selected_frame
);
11267 val
[0] = interrupt_input
? Qt
: Qnil
;
11268 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11270 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11271 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11273 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11280 XSETFASTINT (val
[3], quit_char
);
11282 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11285 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11286 doc
: /* Return position information for pixel coordinates X and Y.
11287 By default, X and Y are relative to text area of the selected window.
11288 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11289 If optional fourth arg WHOLE is non-nil, X is relative to the left
11290 edge of the window.
11292 The return value is similar to a mouse click position:
11293 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11294 IMAGE (DX . DY) (WIDTH . HEIGHT))
11295 The `posn-' functions access elements of such lists. */)
11296 (x
, y
, frame_or_window
, whole
)
11297 Lisp_Object x
, y
, frame_or_window
, whole
;
11302 if (NILP (frame_or_window
))
11303 frame_or_window
= selected_window
;
11305 if (WINDOWP (frame_or_window
))
11309 CHECK_LIVE_WINDOW (frame_or_window
);
11311 w
= XWINDOW (frame_or_window
);
11312 XSETINT (x
, (XINT (x
)
11313 + WINDOW_LEFT_EDGE_X (w
)
11315 ? window_box_left_offset (w
, TEXT_AREA
)
11317 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11318 frame_or_window
= w
->frame
;
11321 CHECK_LIVE_FRAME (frame_or_window
);
11323 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11326 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11327 doc
: /* Return position information for buffer POS in WINDOW.
11328 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11330 Return nil if position is not visible in window. Otherwise,
11331 the return value is similar to that returned by `event-start' for
11332 a mouse click at the upper left corner of the glyph corresponding
11333 to the given buffer position:
11334 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11335 IMAGE (DX . DY) (WIDTH . HEIGHT))
11336 The `posn-' functions access elements of such lists. */)
11338 Lisp_Object pos
, window
;
11343 window
= selected_window
;
11345 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11348 Lisp_Object x
= XCAR (tem
);
11349 Lisp_Object y
= XCAR (XCDR (tem
));
11351 /* Point invisible due to hscrolling? */
11354 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11362 * Set up a new kboard object with reasonable initial values.
11365 init_kboard (KBOARD
*kb
)
11367 kb
->Voverriding_terminal_local_map
= Qnil
;
11368 kb
->Vlast_command
= Qnil
;
11369 kb
->Vreal_last_command
= Qnil
;
11370 kb
->Vkeyboard_translate_table
= Qnil
;
11371 kb
->Vlast_repeatable_command
= Qnil
;
11372 kb
->Vprefix_arg
= Qnil
;
11373 kb
->Vlast_prefix_arg
= Qnil
;
11374 kb
->kbd_queue
= Qnil
;
11375 kb
->kbd_queue_has_data
= 0;
11376 kb
->immediate_echo
= 0;
11377 kb
->echo_string
= Qnil
;
11378 kb
->echo_after_prompt
= -1;
11379 kb
->kbd_macro_buffer
= 0;
11380 kb
->kbd_macro_bufsize
= 0;
11381 kb
->defining_kbd_macro
= Qnil
;
11382 kb
->Vlast_kbd_macro
= Qnil
;
11383 kb
->reference_count
= 0;
11384 kb
->Vsystem_key_alist
= Qnil
;
11385 kb
->system_key_syms
= Qnil
;
11386 kb
->Vwindow_system
= Qt
; /* Unset. */
11387 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11388 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11389 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11390 kb
->Vdefault_minibuffer_frame
= Qnil
;
11394 * Destroy the contents of a kboard object, but not the object itself.
11395 * We use this just before deleting it, or if we're going to initialize
11396 * it a second time.
11399 wipe_kboard (KBOARD
*kb
)
11401 xfree (kb
->kbd_macro_buffer
);
11404 /* Free KB and memory referenced from it. */
11407 delete_kboard (KBOARD
*kb
)
11411 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11414 *kbp
= kb
->next_kboard
;
11416 /* Prevent a dangling reference to KB. */
11417 if (kb
== current_kboard
11418 && FRAMEP (selected_frame
)
11419 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11421 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11423 if (current_kboard
== kb
)
11432 init_keyboard (void)
11434 /* This is correct before outermost invocation of the editor loop */
11435 command_loop_level
= -1;
11436 immediate_quit
= 0;
11437 quit_char
= Ctl ('g');
11438 Vunread_command_events
= Qnil
;
11439 unread_command_char
= -1;
11440 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11442 recent_keys_index
= 0;
11443 kbd_fetch_ptr
= kbd_buffer
;
11444 kbd_store_ptr
= kbd_buffer
;
11445 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11446 do_mouse_tracking
= Qnil
;
11449 interrupt_input_blocked
= 0;
11450 interrupt_input_pending
= 0;
11452 pending_signals
= 0;
11455 /* This means that command_loop_1 won't try to select anything the first
11457 internal_last_event_frame
= Qnil
;
11458 Vlast_event_frame
= internal_last_event_frame
;
11460 current_kboard
= initial_kboard
;
11461 /* Re-initialize the keyboard again. */
11462 wipe_kboard (current_kboard
);
11463 init_kboard (current_kboard
);
11464 /* A value of nil for Vwindow_system normally means a tty, but we also use
11465 it for the initial terminal since there is no window system there. */
11466 current_kboard
->Vwindow_system
= Qnil
;
11468 if (!noninteractive
)
11470 /* Before multi-tty support, these handlers used to be installed
11471 only if the current session was a tty session. Now an Emacs
11472 session may have multiple display types, so we always handle
11473 SIGINT. There is special code in interrupt_signal to exit
11474 Emacs on SIGINT when there are no termcap frames on the
11475 controlling terminal. */
11476 signal (SIGINT
, interrupt_signal
);
11477 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11478 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11479 SIGQUIT and we can't tell which one it will give us. */
11480 signal (SIGQUIT
, interrupt_signal
);
11481 #endif /* HAVE_TERMIO */
11483 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11485 if (!noninteractive
)
11486 signal (SIGIO
, input_available_signal
);
11489 /* Use interrupt input by default, if it works and noninterrupt input
11490 has deficiencies. */
11492 #ifdef INTERRUPT_INPUT
11493 interrupt_input
= 1;
11495 interrupt_input
= 0;
11501 if (keyboard_init_hook
)
11502 (*keyboard_init_hook
) ();
11504 #ifdef POLL_FOR_INPUT
11506 poll_suppress_count
= 1;
11511 /* This type's only use is in syms_of_keyboard, to initialize the
11512 event header symbols and put properties on them. */
11513 struct event_head
{
11519 struct event_head head_table
[] = {
11520 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11521 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11522 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11523 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11524 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11525 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11526 /* `select-window' should be handled just like `switch-frame'
11527 in read_key_sequence. */
11528 {&Qselect_window
, "select-window", &Qswitch_frame
}
11532 syms_of_keyboard (void)
11534 pending_funcalls
= Qnil
;
11535 staticpro (&pending_funcalls
);
11537 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11538 staticpro (&Vlispy_mouse_stem
);
11541 QCimage
= intern_c_string (":image");
11542 staticpro (&QCimage
);
11544 staticpro (&Qhelp_echo
);
11545 Qhelp_echo
= intern_c_string ("help-echo");
11548 Qrtl
= intern_c_string (":rtl");
11550 staticpro (&item_properties
);
11551 item_properties
= Qnil
;
11553 staticpro (&tool_bar_item_properties
);
11554 tool_bar_item_properties
= Qnil
;
11555 staticpro (&tool_bar_items_vector
);
11556 tool_bar_items_vector
= Qnil
;
11558 staticpro (&real_this_command
);
11559 real_this_command
= Qnil
;
11561 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11562 staticpro (&Qtimer_event_handler
);
11564 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11565 staticpro (&Qdisabled_command_function
);
11567 Qself_insert_command
= intern_c_string ("self-insert-command");
11568 staticpro (&Qself_insert_command
);
11570 Qforward_char
= intern_c_string ("forward-char");
11571 staticpro (&Qforward_char
);
11573 Qbackward_char
= intern_c_string ("backward-char");
11574 staticpro (&Qbackward_char
);
11576 Qdisabled
= intern_c_string ("disabled");
11577 staticpro (&Qdisabled
);
11579 Qundefined
= intern_c_string ("undefined");
11580 staticpro (&Qundefined
);
11582 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11583 staticpro (&Qpre_command_hook
);
11585 Qpost_command_hook
= intern_c_string ("post-command-hook");
11586 staticpro (&Qpost_command_hook
);
11588 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11589 staticpro (&Qdeferred_action_function
);
11591 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11592 staticpro (&Qcommand_hook_internal
);
11594 Qfunction_key
= intern_c_string ("function-key");
11595 staticpro (&Qfunction_key
);
11596 Qmouse_click
= intern_c_string ("mouse-click");
11597 staticpro (&Qmouse_click
);
11598 #if defined (WINDOWSNT)
11599 Qlanguage_change
= intern_c_string ("language-change");
11600 staticpro (&Qlanguage_change
);
11602 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11603 staticpro (&Qdrag_n_drop
);
11605 Qsave_session
= intern_c_string ("save-session");
11606 staticpro (&Qsave_session
);
11609 Qdbus_event
= intern_c_string ("dbus-event");
11610 staticpro (&Qdbus_event
);
11613 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11614 staticpro (&Qconfig_changed_event
);
11616 Qmenu_enable
= intern_c_string ("menu-enable");
11617 staticpro (&Qmenu_enable
);
11618 QCenable
= intern_c_string (":enable");
11619 staticpro (&QCenable
);
11620 QCvisible
= intern_c_string (":visible");
11621 staticpro (&QCvisible
);
11622 QChelp
= intern_c_string (":help");
11623 staticpro (&QChelp
);
11624 QCfilter
= intern_c_string (":filter");
11625 staticpro (&QCfilter
);
11626 QCbutton
= intern_c_string (":button");
11627 staticpro (&QCbutton
);
11628 QCkeys
= intern_c_string (":keys");
11629 staticpro (&QCkeys
);
11630 QCkey_sequence
= intern_c_string (":key-sequence");
11631 staticpro (&QCkey_sequence
);
11632 QCtoggle
= intern_c_string (":toggle");
11633 staticpro (&QCtoggle
);
11634 QCradio
= intern_c_string (":radio");
11635 staticpro (&QCradio
);
11636 QClabel
= intern_c_string (":label");
11637 staticpro (&QClabel
);
11639 Qmode_line
= intern_c_string ("mode-line");
11640 staticpro (&Qmode_line
);
11641 Qvertical_line
= intern_c_string ("vertical-line");
11642 staticpro (&Qvertical_line
);
11643 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11644 staticpro (&Qvertical_scroll_bar
);
11645 Qmenu_bar
= intern_c_string ("menu-bar");
11646 staticpro (&Qmenu_bar
);
11648 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11649 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11650 staticpro (&Qmouse_fixup_help_message
);
11653 Qabove_handle
= intern_c_string ("above-handle");
11654 staticpro (&Qabove_handle
);
11655 Qhandle
= intern_c_string ("handle");
11656 staticpro (&Qhandle
);
11657 Qbelow_handle
= intern_c_string ("below-handle");
11658 staticpro (&Qbelow_handle
);
11659 Qup
= intern_c_string ("up");
11661 Qdown
= intern_c_string ("down");
11662 staticpro (&Qdown
);
11663 Qtop
= intern_c_string ("top");
11665 Qbottom
= intern_c_string ("bottom");
11666 staticpro (&Qbottom
);
11667 Qend_scroll
= intern_c_string ("end-scroll");
11668 staticpro (&Qend_scroll
);
11669 Qratio
= intern_c_string ("ratio");
11670 staticpro (&Qratio
);
11672 Qevent_kind
= intern_c_string ("event-kind");
11673 staticpro (&Qevent_kind
);
11674 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11675 staticpro (&Qevent_symbol_elements
);
11676 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11677 staticpro (&Qevent_symbol_element_mask
);
11678 Qmodifier_cache
= intern_c_string ("modifier-cache");
11679 staticpro (&Qmodifier_cache
);
11681 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11682 staticpro (&Qrecompute_lucid_menubar
);
11683 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11684 staticpro (&Qactivate_menubar_hook
);
11686 Qpolling_period
= intern_c_string ("polling-period");
11687 staticpro (&Qpolling_period
);
11689 Qinput_method_function
= intern_c_string ("input-method-function");
11690 staticpro (&Qinput_method_function
);
11692 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11693 staticpro (&Qinput_method_exit_on_first_char
);
11694 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11695 staticpro (&Qinput_method_use_echo_area
);
11697 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11698 Fset (Qinput_method_use_echo_area
, Qnil
);
11700 last_point_position_buffer
= Qnil
;
11701 last_point_position_window
= Qnil
;
11704 struct event_head
*p
;
11706 for (p
= head_table
;
11707 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11710 *p
->var
= intern_c_string (p
->name
);
11711 staticpro (p
->var
);
11712 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11713 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11717 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11718 staticpro (&button_down_location
);
11719 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11720 staticpro (&mouse_syms
);
11721 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11722 / sizeof (lispy_wheel_names
[0])),
11724 staticpro (&wheel_syms
);
11728 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11730 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11731 for (i
= 0; i
< len
; i
++)
11732 if (modifier_names
[i
])
11733 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11734 staticpro (&modifier_symbols
);
11737 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11738 staticpro (&recent_keys
);
11740 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11741 staticpro (&this_command_keys
);
11743 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11744 staticpro (&raw_keybuf
);
11746 Qextended_command_history
= intern_c_string ("extended-command-history");
11747 Fset (Qextended_command_history
, Qnil
);
11748 staticpro (&Qextended_command_history
);
11750 accent_key_syms
= Qnil
;
11751 staticpro (&accent_key_syms
);
11753 func_key_syms
= Qnil
;
11754 staticpro (&func_key_syms
);
11756 drag_n_drop_syms
= Qnil
;
11757 staticpro (&drag_n_drop_syms
);
11759 unread_switch_frame
= Qnil
;
11760 staticpro (&unread_switch_frame
);
11762 internal_last_event_frame
= Qnil
;
11763 staticpro (&internal_last_event_frame
);
11765 read_key_sequence_cmd
= Qnil
;
11766 staticpro (&read_key_sequence_cmd
);
11768 menu_bar_one_keymap_changed_items
= Qnil
;
11769 staticpro (&menu_bar_one_keymap_changed_items
);
11771 menu_bar_items_vector
= Qnil
;
11772 staticpro (&menu_bar_items_vector
);
11774 help_form_saved_window_configs
= Qnil
;
11775 staticpro (&help_form_saved_window_configs
);
11777 defsubr (&Scurrent_idle_time
);
11778 defsubr (&Sevent_symbol_parse_modifiers
);
11779 defsubr (&Sevent_convert_list
);
11780 defsubr (&Sread_key_sequence
);
11781 defsubr (&Sread_key_sequence_vector
);
11782 defsubr (&Srecursive_edit
);
11783 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11784 defsubr (&Strack_mouse
);
11786 defsubr (&Sinput_pending_p
);
11787 defsubr (&Scommand_execute
);
11788 defsubr (&Srecent_keys
);
11789 defsubr (&Sthis_command_keys
);
11790 defsubr (&Sthis_command_keys_vector
);
11791 defsubr (&Sthis_single_command_keys
);
11792 defsubr (&Sthis_single_command_raw_keys
);
11793 defsubr (&Sreset_this_command_lengths
);
11794 defsubr (&Sclear_this_command_keys
);
11795 defsubr (&Ssuspend_emacs
);
11796 defsubr (&Sabort_recursive_edit
);
11797 defsubr (&Sexit_recursive_edit
);
11798 defsubr (&Srecursion_depth
);
11799 defsubr (&Stop_level
);
11800 defsubr (&Sdiscard_input
);
11801 defsubr (&Sopen_dribble_file
);
11802 defsubr (&Sset_input_interrupt_mode
);
11803 defsubr (&Sset_output_flow_control
);
11804 defsubr (&Sset_input_meta_mode
);
11805 defsubr (&Sset_quit_char
);
11806 defsubr (&Sset_input_mode
);
11807 defsubr (&Scurrent_input_mode
);
11808 defsubr (&Sexecute_extended_command
);
11809 defsubr (&Sposn_at_point
);
11810 defsubr (&Sposn_at_x_y
);
11812 DEFVAR_LISP ("last-command-event", &last_command_event
,
11813 doc
: /* Last input event that was part of a command. */);
11815 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11816 doc
: /* Last input event in a command, except for mouse menu events.
11817 Mouse menus give back keys that don't look like mouse events;
11818 this variable holds the actual mouse event that led to the menu,
11819 so that you can determine whether the command was run by mouse or not. */);
11821 DEFVAR_LISP ("last-input-event", &last_input_event
,
11822 doc
: /* Last input event. */);
11824 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11825 doc
: /* List of events to be read as the command input.
11826 These events are processed first, before actual keyboard input.
11827 Events read from this list are not normally added to `this-command-keys',
11828 as they will already have been added once as they were read for the first time.
11829 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11830 Vunread_command_events
= Qnil
;
11832 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11833 doc
: /* If not -1, an object to be read as next command input event. */);
11835 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11836 doc
: /* List of events to be processed as input by input methods.
11837 These events are processed before `unread-command-events'
11838 and actual keyboard input, but are not given to `input-method-function'. */);
11839 Vunread_post_input_method_events
= Qnil
;
11841 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11842 doc
: /* List of events to be processed as input by input methods.
11843 These events are processed after `unread-command-events', but
11844 before actual keyboard input.
11845 If there's an active input method, the events are given to
11846 `input-method-function'. */);
11847 Vunread_input_method_events
= Qnil
;
11849 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11850 doc
: /* Meta-prefix character code.
11851 Meta-foo as command input turns into this character followed by foo. */);
11852 XSETINT (meta_prefix_char
, 033);
11854 DEFVAR_KBOARD ("last-command", Vlast_command
,
11855 doc
: /* The last command executed.
11856 Normally a symbol with a function definition, but can be whatever was found
11857 in the keymap, or whatever the variable `this-command' was set to by that
11860 The value `mode-exit' is special; it means that the previous command
11861 read an event that told it to exit, and it did so and unread that event.
11862 In other words, the present command is the event that made the previous
11865 The value `kill-region' is special; it means that the previous command
11866 was a kill command.
11868 `last-command' has a separate binding for each terminal device.
11869 See Info node `(elisp)Multiple Terminals'. */);
11871 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11872 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11874 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11875 doc
: /* Last command that may be repeated.
11876 The last command executed that was not bound to an input event.
11877 This is the command `repeat' will try to repeat. */);
11879 DEFVAR_LISP ("this-command", &Vthis_command
,
11880 doc
: /* The command now being executed.
11881 The command can set this variable; whatever is put here
11882 will be in `last-command' during the following command. */);
11883 Vthis_command
= Qnil
;
11885 DEFVAR_LISP ("this-command-keys-shift-translated",
11886 &Vthis_command_keys_shift_translated
,
11887 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11888 Shift-translation occurs when there is no binding for the key sequence
11889 as entered, but a binding was found by changing an upper-case letter
11890 to lower-case, or a shifted function key to an unshifted one. */);
11891 Vthis_command_keys_shift_translated
= Qnil
;
11893 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11894 doc
: /* The command bound to the current key sequence before remapping.
11895 It equals `this-command' if the original command was not remapped through
11896 any of the active keymaps. Otherwise, the value of `this-command' is the
11897 result of looking up the original command in the active keymaps. */);
11898 Vthis_original_command
= Qnil
;
11900 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11901 doc
: /* *Number of input events between auto-saves.
11902 Zero means disable autosaving due to number of characters typed. */);
11903 auto_save_interval
= 300;
11905 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11906 doc
: /* *Number of seconds idle time before auto-save.
11907 Zero or nil means disable auto-saving due to idleness.
11908 After auto-saving due to this many seconds of idle time,
11909 Emacs also does a garbage collection if that seems to be warranted. */);
11910 XSETFASTINT (Vauto_save_timeout
, 30);
11912 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11913 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11914 The value may be integer or floating point. */);
11915 Vecho_keystrokes
= make_number (1);
11917 DEFVAR_INT ("polling-period", &polling_period
,
11918 doc
: /* *Interval between polling for input during Lisp execution.
11919 The reason for polling is to make C-g work to stop a running program.
11920 Polling is needed only when using X windows and SIGIO does not work.
11921 Polling is automatically disabled in all other cases. */);
11922 polling_period
= 2;
11924 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11925 doc
: /* *Maximum time between mouse clicks to make a double-click.
11926 Measured in milliseconds. The value nil means disable double-click
11927 recognition; t means double-clicks have no time limit and are detected
11928 by position only. */);
11929 Vdouble_click_time
= make_number (500);
11931 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11932 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11933 On window-system frames, value is the number of pixels the mouse may have
11934 moved horizontally or vertically between two clicks to make a double-click.
11935 On non window-system frames, value is interpreted in units of 1/8 characters
11938 This variable is also the threshold for motion of the mouse
11939 to count as a drag. */);
11940 double_click_fuzz
= 3;
11942 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11943 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11944 inhibit_local_menu_bar_menus
= 0;
11946 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11947 doc
: /* Number of complete key sequences read as input so far.
11948 This includes key sequences read from keyboard macros.
11949 The number is effectively the number of interactive command invocations. */);
11950 num_input_keys
= 0;
11952 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11953 doc
: /* Number of input events read from the keyboard so far.
11954 This does not include events generated by keyboard macros. */);
11955 num_nonmacro_input_events
= 0;
11957 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11958 doc
: /* The frame in which the most recently read event occurred.
11959 If the last event came from a keyboard macro, this is set to `macro'. */);
11960 Vlast_event_frame
= Qnil
;
11962 /* This variable is set up in sysdep.c. */
11963 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11964 doc
: /* The ERASE character as set by the user with stty. */);
11966 DEFVAR_LISP ("help-char", &Vhelp_char
,
11967 doc
: /* Character to recognize as meaning Help.
11968 When it is read, do `(eval help-form)', and display result if it's a string.
11969 If the value of `help-form' is nil, this char can be read normally. */);
11970 XSETINT (Vhelp_char
, Ctl ('H'));
11972 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11973 doc
: /* List of input events to recognize as meaning Help.
11974 These work just like the value of `help-char' (see that). */);
11975 Vhelp_event_list
= Qnil
;
11977 DEFVAR_LISP ("help-form", &Vhelp_form
,
11978 doc
: /* Form to execute when character `help-char' is read.
11979 If the form returns a string, that string is displayed.
11980 If `help-form' is nil, the help char is not recognized. */);
11983 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11984 doc
: /* Command to run when `help-char' character follows a prefix key.
11985 This command is used only when there is no actual binding
11986 for that character after that prefix key. */);
11987 Vprefix_help_command
= Qnil
;
11989 DEFVAR_LISP ("top-level", &Vtop_level
,
11990 doc
: /* Form to evaluate when Emacs starts up.
11991 Useful to set before you dump a modified Emacs. */);
11994 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11995 doc
: /* Translate table for local keyboard input, or nil.
11996 If non-nil, the value should be a char-table. Each character read
11997 from the keyboard is looked up in this char-table. If the value found
11998 there is non-nil, then it is used instead of the actual input character.
12000 The value can also be a string or vector, but this is considered obsolete.
12001 If it is a string or vector of length N, character codes N and up are left
12002 untranslated. In a vector, an element which is nil means "no translation".
12004 This is applied to the characters supplied to input methods, not their
12005 output. See also `translation-table-for-input'.
12007 This variable has a separate binding for each terminal.
12008 See Info node `(elisp)Multiple Terminals'. */);
12010 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12011 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12012 \(Even if the operating system has support for stopping a process.\) */);
12013 cannot_suspend
= 0;
12015 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12016 doc
: /* Non-nil means prompt with menus when appropriate.
12017 This is done when reading from a keymap that has a prompt string,
12018 for elements that have prompt strings.
12019 The menu is displayed on the screen
12020 if X menus were enabled at configuration
12021 time and the previous event was a mouse click prefix key.
12022 Otherwise, menu prompting uses the echo area. */);
12023 menu_prompting
= 1;
12025 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12026 doc
: /* Character to see next line of menu prompt.
12027 Type this character while in a menu prompt to rotate around the lines of it. */);
12028 XSETINT (menu_prompt_more_char
, ' ');
12030 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12031 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12032 Emacs applies the modifiers of the character stored here to each keyboard
12033 character it reads. For example, after evaluating the expression
12034 (setq extra-keyboard-modifiers ?\\C-x)
12035 all input characters will have the control modifier applied to them.
12037 Note that the character ?\\C-@, equivalent to the integer zero, does
12038 not count as a control character; rather, it counts as a character
12039 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12040 cancels any modification. */);
12041 extra_keyboard_modifiers
= 0;
12043 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12044 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12045 The command loop sets this to nil before each command,
12046 and tests the value when the command returns.
12047 Buffer modification stores t in this variable. */);
12048 Vdeactivate_mark
= Qnil
;
12049 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12050 staticpro (&Qdeactivate_mark
);
12052 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12053 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12054 Vcommand_hook_internal
= Qnil
;
12056 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12057 doc
: /* Normal hook run before each command is executed.
12058 If an unhandled error happens in running this hook,
12059 the hook value is set to nil, since otherwise the error
12060 might happen repeatedly and make Emacs nonfunctional. */);
12061 Vpre_command_hook
= Qnil
;
12063 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12064 doc
: /* Normal hook run after each command is executed.
12065 If an unhandled error happens in running this hook,
12066 the hook value is set to nil, since otherwise the error
12067 might happen repeatedly and make Emacs nonfunctional. */);
12068 Vpost_command_hook
= Qnil
;
12071 DEFVAR_LISP ("echo-area-clear-hook", ...,
12072 doc
: /* Normal hook run when clearing the echo area. */);
12074 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12075 staticpro (&Qecho_area_clear_hook
);
12076 Fset (Qecho_area_clear_hook
, Qnil
);
12078 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12079 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12080 Vlucid_menu_bar_dirty_flag
= Qnil
;
12082 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12083 doc
: /* List of menu bar items to move to the end of the menu bar.
12084 The elements of the list are event types that may have menu bar bindings. */);
12085 Vmenu_bar_final_items
= Qnil
;
12087 DEFVAR_KBOARD ("overriding-terminal-local-map",
12088 Voverriding_terminal_local_map
,
12089 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12090 If this variable is non-nil, it is used as a keymap instead of the
12091 buffer's local map, and the minor mode keymaps and text property keymaps.
12092 It also replaces `overriding-local-map'.
12094 This variable is intended to let commands such as `universal-argument'
12095 set up a different keymap for reading the next command.
12097 `overriding-terminal-local-map' has a separate binding for each
12099 See Info node `(elisp)Multiple Terminals'. */);
12101 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12102 doc
: /* Keymap that overrides all other local keymaps.
12103 If this variable is non-nil, it is used as a keymap--replacing the
12104 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12105 Voverriding_local_map
= Qnil
;
12107 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12108 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12109 Otherwise, the menu bar continues to reflect the buffer's local map
12110 and the minor mode maps regardless of `overriding-local-map'. */);
12111 Voverriding_local_map_menu_flag
= Qnil
;
12113 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12114 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12115 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12117 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12118 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12120 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12121 doc
: /* Alist of system-specific X windows key symbols.
12122 Each element should have the form (N . SYMBOL) where N is the
12123 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12124 and SYMBOL is its name.
12126 `system-key-alist' has a separate binding for each terminal device.
12127 See Info node `(elisp)Multiple Terminals'. */);
12129 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12130 doc
: /* Keymap that translates key sequences to key sequences during input.
12131 This is used mainly for mapping key sequences into some preferred
12132 key events (symbols).
12134 The `read-key-sequence' function replaces any subsequence bound by
12135 `local-function-key-map' with its binding. More precisely, when the
12136 active keymaps have no binding for the current key sequence but
12137 `local-function-key-map' binds a suffix of the sequence to a vector or
12138 string, `read-key-sequence' replaces the matching suffix with its
12139 binding, and continues with the new sequence.
12141 If the binding is a function, it is called with one argument (the prompt)
12142 and its return value (a key sequence) is used.
12144 The events that come from bindings in `local-function-key-map' are not
12145 themselves looked up in `local-function-key-map'.
12147 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12148 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12149 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12150 typing `ESC O P x' would return [f1 x].
12152 `local-function-key-map' has a separate binding for each terminal
12153 device. See Info node `(elisp)Multiple Terminals'. If you need to
12154 define a binding on all terminals, change `function-key-map'
12155 instead. Initially, `local-function-key-map' is an empty keymap that
12156 has `function-key-map' as its parent on all terminal devices. */);
12158 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12159 doc
: /* Keymap that decodes input escape sequences.
12160 This is used mainly for mapping ASCII function key sequences into
12161 real Emacs function key events (symbols).
12163 The `read-key-sequence' function replaces any subsequence bound by
12164 `input-decode-map' with its binding. Contrary to `function-key-map',
12165 this map applies its rebinding regardless of the presence of an ordinary
12166 binding. So it is more like `key-translation-map' except that it applies
12167 before `function-key-map' rather than after.
12169 If the binding is a function, it is called with one argument (the prompt)
12170 and its return value (a key sequence) is used.
12172 The events that come from bindings in `input-decode-map' are not
12173 themselves looked up in `input-decode-map'.
12175 This variable is keyboard-local. */);
12177 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12178 doc
: /* The parent keymap of all `local-function-key-map' instances.
12179 Function key definitions that apply to all terminal devices should go
12180 here. If a mapping is defined in both the current
12181 `local-function-key-map' binding and this variable, then the local
12182 definition will take precendence. */);
12183 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12185 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12186 doc
: /* Keymap of key translations that can override keymaps.
12187 This keymap works like `function-key-map', but comes after that,
12188 and its non-prefix bindings override ordinary bindings.
12189 Another difference is that it is global rather than keyboard-local. */);
12190 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12192 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12193 doc
: /* List of deferred actions to be performed at a later time.
12194 The precise format isn't relevant here; we just check whether it is nil. */);
12195 Vdeferred_action_list
= Qnil
;
12197 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12198 doc
: /* Function to call to handle deferred actions, after each command.
12199 This function is called with no arguments after each command
12200 whenever `deferred-action-list' is non-nil. */);
12201 Vdeferred_action_function
= Qnil
;
12203 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12204 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12205 The value can be a length of time to show the message for.
12206 If the value is non-nil and not a number, we wait 2 seconds. */);
12207 Vsuggest_key_bindings
= Qt
;
12209 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12210 doc
: /* List of active absolute time timers in order of increasing time. */);
12211 Vtimer_list
= Qnil
;
12213 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12214 doc
: /* List of active idle-time timers in order of increasing time. */);
12215 Vtimer_idle_list
= Qnil
;
12217 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12218 doc
: /* If non-nil, the function that implements the current input method.
12219 It's called with one argument, a printing character that was just read.
12220 \(That means a character with code 040...0176.)
12221 Typically this function uses `read-event' to read additional events.
12222 When it does so, it should first bind `input-method-function' to nil
12223 so it will not be called recursively.
12225 The function should return a list of zero or more events
12226 to be used as input. If it wants to put back some events
12227 to be reconsidered, separately, by the input method,
12228 it can add them to the beginning of `unread-command-events'.
12230 The input method function can find in `input-method-previous-message'
12231 the previous echo area message.
12233 The input method function should refer to the variables
12234 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12235 for guidance on what to do. */);
12236 Vinput_method_function
= Qnil
;
12238 DEFVAR_LISP ("input-method-previous-message",
12239 &Vinput_method_previous_message
,
12240 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12241 This variable exists because `read-event' clears the echo area
12242 before running the input method. It is nil if there was no message. */);
12243 Vinput_method_previous_message
= Qnil
;
12245 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12246 doc
: /* If non-nil, the function that implements the display of help.
12247 It's called with one argument, the help string to display. */);
12248 Vshow_help_function
= Qnil
;
12250 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12251 doc
: /* If non-nil, suppress point adjustment after executing a command.
12253 After a command is executed, if point is moved into a region that has
12254 special properties (e.g. composition, display), we adjust point to
12255 the boundary of the region. But, when a command sets this variable to
12256 non-nil, we suppress the point adjustment.
12258 This variable is set to nil before reading a command, and is checked
12259 just after executing the command. */);
12260 Vdisable_point_adjustment
= Qnil
;
12262 DEFVAR_LISP ("global-disable-point-adjustment",
12263 &Vglobal_disable_point_adjustment
,
12264 doc
: /* *If non-nil, always suppress point adjustment.
12266 The default value is nil, in which case, point adjustment are
12267 suppressed only after special commands that set
12268 `disable-point-adjustment' (which see) to non-nil. */);
12269 Vglobal_disable_point_adjustment
= Qnil
;
12271 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12272 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12273 If the value is not a number, such messages don't time out. */);
12274 Vminibuffer_message_timeout
= make_number (2);
12276 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12277 doc
: /* If non-nil, any keyboard input throws to this symbol.
12278 The value of that variable is passed to `quit-flag' and later causes a
12279 peculiar kind of quitting. */);
12280 Vthrow_on_input
= Qnil
;
12282 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12283 doc
: /* If non-nil, function to output error messages.
12284 The arguments are the error data, a list of the form
12285 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12286 such as just as `condition-case' would bind its variable to,
12287 the context (a string which normally goes at the start of the message),
12288 and the Lisp function within which the error was signaled. */);
12289 Vcommand_error_function
= Qnil
;
12291 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12292 &Venable_disabled_menus_and_buttons
,
12293 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12295 Help functions bind this to allow help on disabled menu items
12296 and tool-bar buttons. */);
12297 Venable_disabled_menus_and_buttons
= Qnil
;
12299 /* Create the initial keyboard. */
12300 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12301 init_kboard (initial_kboard
);
12302 /* Vwindow_system is left at t for now. */
12303 initial_kboard
->next_kboard
= all_kboards
;
12304 all_kboards
= initial_kboard
;
12308 keys_of_keyboard (void)
12310 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12311 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12312 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12313 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12314 initial_define_key (meta_map
, 'x', "execute-extended-command");
12316 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12317 "handle-delete-frame");
12318 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12319 "ns-put-working-text");
12320 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12321 "ns-unput-working-text");
12322 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12323 current-prefix-arg, as is done in `handle-switch-frame'.
12324 But `handle-switch-frame is not run from the special-map.
12325 Commands from that map are run in a special way that automatically
12326 preserves the prefix-arg. Restoring the prefix arg here is not just
12327 redundant but harmful:
12329 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12330 - after the first prompt, the exit-minibuffer-hook is run which may
12331 iconify a frame and thus push a `iconify-frame' event.
12332 - after running exit-minibuffer-hook, current-prefix-arg is
12333 restored to the non-nil value it had before the prompt.
12334 - we enter the second prompt.
12335 current-prefix-arg is non-nil, prefix-arg is nil.
12336 - before running the first real event, we run the special iconify-frame
12337 event, but we pass the `special' arg to execute-command so
12338 current-prefix-arg and prefix-arg are left untouched.
12339 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12340 - the next key event will have a spuriously non-nil current-prefix-arg. */
12341 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12343 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12345 /* Handling it at such a low-level causes read_key_sequence to get
12346 * confused because it doesn't realize that the current_buffer was
12347 * changed by read_char.
12349 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12350 * "handle-select-window"); */
12351 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12352 "handle-save-session");
12355 /* Define a special event which is raised for dbus callback
12357 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12358 "dbus-handle-event");
12361 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12365 /* Mark the pointers in the kboard objects.
12366 Called by the Fgarbage_collector. */
12368 mark_kboards (void)
12372 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12374 if (kb
->kbd_macro_buffer
)
12375 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12377 mark_object (kb
->Voverriding_terminal_local_map
);
12378 mark_object (kb
->Vlast_command
);
12379 mark_object (kb
->Vreal_last_command
);
12380 mark_object (kb
->Vkeyboard_translate_table
);
12381 mark_object (kb
->Vlast_repeatable_command
);
12382 mark_object (kb
->Vprefix_arg
);
12383 mark_object (kb
->Vlast_prefix_arg
);
12384 mark_object (kb
->kbd_queue
);
12385 mark_object (kb
->defining_kbd_macro
);
12386 mark_object (kb
->Vlast_kbd_macro
);
12387 mark_object (kb
->Vsystem_key_alist
);
12388 mark_object (kb
->system_key_syms
);
12389 mark_object (kb
->Vwindow_system
);
12390 mark_object (kb
->Vinput_decode_map
);
12391 mark_object (kb
->Vlocal_function_key_map
);
12392 mark_object (kb
->Vdefault_minibuffer_frame
);
12393 mark_object (kb
->echo_string
);
12396 struct input_event
*event
;
12397 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12399 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12400 event
= kbd_buffer
;
12401 if (event
->kind
!= SELECTION_REQUEST_EVENT
12402 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12404 mark_object (event
->x
);
12405 mark_object (event
->y
);
12407 mark_object (event
->frame_or_window
);
12408 mark_object (event
->arg
);
12413 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12414 (do not change this comment) */