1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #include "syssignal.h"
60 #include <sys/types.h>
69 /* This is to get the definitions of the XK_ symbols. */
76 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 volatile int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
91 /* This var should be (interrupt_input_pending || pending_atimers).
92 The QUIT macro checks this instead of interrupt_input_pending and
93 pending_atimers separately, to reduce code size. So, any code that
94 changes interrupt_input_pending or pending_atimers should update
100 #define KBD_BUFFER_SIZE 4096
102 KBOARD
*initial_kboard
;
103 KBOARD
*current_kboard
;
107 /* Non-nil disable property on a command means
108 do not execute it; call disabled-command-function's value instead. */
109 Lisp_Object Qdisabled
, Qdisabled_command_function
;
111 #define NUM_RECENT_KEYS (300)
112 int recent_keys_index
; /* Index for storing next element into recent_keys */
113 int total_keys
; /* Total number of elements stored into recent_keys */
114 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
116 /* Vector holding the key sequence that invoked the current command.
117 It is reused for each command, and it may be longer than the current
118 sequence; this_command_key_count indicates how many elements
119 actually mean something.
120 It's easier to staticpro a single Lisp_Object than an array. */
121 Lisp_Object this_command_keys
;
122 int this_command_key_count
;
124 /* 1 after calling Freset_this_command_lengths.
126 int this_command_key_count_reset
;
128 /* This vector is used as a buffer to record the events that were actually read
129 by read_key_sequence. */
130 Lisp_Object raw_keybuf
;
131 int raw_keybuf_count
;
133 /* Non-nil if the present key sequence was obtained by shift translation. */
134 Lisp_Object Vthis_command_keys_shift_translated
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
138 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 int this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static int before_command_key_count
;
147 static int before_command_echo_length
;
149 extern int minbuf_level
;
151 extern int message_enable_multibyte
;
153 /* If non-nil, the function that implements the display of help.
154 It's called with one argument, the help string to display. */
156 Lisp_Object Vshow_help_function
;
158 /* Nonzero means do menu prompting. */
160 static int menu_prompting
;
162 /* Character to see next line of menu prompt. */
164 static Lisp_Object menu_prompt_more_char
;
166 /* For longjmp to where kbd input is being done. */
168 static jmp_buf getcjmp
;
170 /* True while doing kbd input. */
171 int waiting_for_input
;
173 /* True while displaying for echoing. Delays C-g throwing. */
177 /* Non-null means we can start echoing at the next input pause even
178 though there is something in the echo area. */
180 static struct kboard
*ok_to_echo_at_next_pause
;
182 /* The kboard last echoing, or null for none. Reset to 0 in
183 cancel_echoing. If non-null, and a current echo area message
184 exists, and echo_message_buffer is eq to the current message
185 buffer, we know that the message comes from echo_kboard. */
187 struct kboard
*echo_kboard
;
189 /* The buffer used for echoing. Set in echo_now, reset in
192 Lisp_Object echo_message_buffer
;
194 /* Nonzero means disregard local maps for the menu bar. */
195 static int inhibit_local_menu_bar_menus
;
197 /* Nonzero means C-g should cause immediate error-signal. */
200 /* The user's hook function for outputting an error message. */
201 Lisp_Object Vcommand_error_function
;
203 /* The user's ERASE setting. */
204 Lisp_Object Vtty_erase_char
;
206 /* Character to recognize as the help char. */
207 Lisp_Object Vhelp_char
;
209 /* List of other event types to recognize as meaning "help". */
210 Lisp_Object Vhelp_event_list
;
212 /* Form to execute when help char is typed. */
213 Lisp_Object Vhelp_form
;
215 /* Command to run when the help character follows a prefix key. */
216 Lisp_Object Vprefix_help_command
;
218 /* List of items that should move to the end of the menu bar. */
219 Lisp_Object Vmenu_bar_final_items
;
221 /* Non-nil means show the equivalent key-binding for
222 any M-x command that has one.
223 The value can be a length of time to show the message for.
224 If the value is non-nil and not a number, we wait 2 seconds. */
225 Lisp_Object Vsuggest_key_bindings
;
227 /* How long to display an echo-area message when the minibuffer is active.
228 If the value is not a number, such messages don't time out. */
229 Lisp_Object Vminibuffer_message_timeout
;
231 /* Character that causes a quit. Normally C-g.
233 If we are running on an ordinary terminal, this must be an ordinary
234 ASCII char, since we want to make it our interrupt character.
236 If we are not running on an ordinary terminal, it still needs to be
237 an ordinary ASCII char. This character needs to be recognized in
238 the input interrupt handler. At this point, the keystroke is
239 represented as a struct input_event, while the desired quit
240 character is specified as a lispy event. The mapping from struct
241 input_events to lispy events cannot run in an interrupt handler,
242 and the reverse mapping is difficult for anything but ASCII
245 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
249 /* If non-nil, this is a map that overrides all other local maps. */
250 Lisp_Object Voverriding_local_map
;
252 /* If non-nil, Voverriding_local_map applies to the menu bar. */
253 Lisp_Object Voverriding_local_map_menu_flag
;
255 /* Keymap that defines special misc events that should
256 be processed immediately at a low level. */
257 Lisp_Object Vspecial_event_map
;
259 /* Current depth in recursive edits. */
260 int command_loop_level
;
262 /* Total number of times command_loop has read a key sequence. */
263 EMACS_INT num_input_keys
;
265 /* Last input event read as a command. */
266 Lisp_Object last_command_event
;
268 /* Last input character read as a command, not counting menus
269 reached by the mouse. */
270 Lisp_Object last_nonmenu_event
;
272 /* Last input event read for any purpose. */
273 Lisp_Object last_input_event
;
275 /* If not Qnil, a list of objects to be read as subsequent command input. */
276 Lisp_Object Vunread_command_events
;
278 /* If not Qnil, a list of objects to be read as subsequent command input
279 including input method processing. */
280 Lisp_Object Vunread_input_method_events
;
282 /* If not Qnil, a list of objects to be read as subsequent command input
283 but NOT including input method processing. */
284 Lisp_Object Vunread_post_input_method_events
;
286 /* If not -1, an event to be read as subsequent command input. */
287 EMACS_INT unread_command_char
;
289 /* If not Qnil, this is a switch-frame event which we decided to put
290 off until the end of a key sequence. This should be read as the
291 next command input, after any unread_command_events.
293 read_key_sequence uses this to delay switch-frame events until the
294 end of the key sequence; Fread_char uses it to put off switch-frame
295 events until a non-ASCII event is acceptable as input. */
296 Lisp_Object unread_switch_frame
;
298 /* A mask of extra modifier bits to put into every keyboard char. */
299 EMACS_INT extra_keyboard_modifiers
;
301 /* Char to use as prefix when a meta character is typed in.
302 This is bound on entry to minibuffer in case ESC is changed there. */
304 Lisp_Object meta_prefix_char
;
306 /* Last size recorded for a current buffer which is not a minibuffer. */
307 static int last_non_minibuf_size
;
309 /* Number of idle seconds before an auto-save and garbage collection. */
310 static Lisp_Object Vauto_save_timeout
;
312 /* Total number of times read_char has returned. */
313 int num_input_events
;
315 /* Total number of times read_char has returned, outside of macros. */
316 EMACS_INT num_nonmacro_input_events
;
318 /* Auto-save automatically when this many characters have been typed
319 since the last time. */
321 static EMACS_INT auto_save_interval
;
323 /* Value of num_nonmacro_input_events as of last auto save. */
327 /* The command being executed by the command loop.
328 Commands may set this, and the value set will be copied into
329 current_kboard->Vlast_command instead of the actual command. */
330 Lisp_Object Vthis_command
;
332 /* This is like Vthis_command, except that commands never set it. */
333 Lisp_Object real_this_command
;
335 /* If the lookup of the command returns a binding, the original
336 command is stored in this-original-command. It is nil otherwise. */
337 Lisp_Object Vthis_original_command
;
339 /* The value of point when the last command was started. */
340 int last_point_position
;
342 /* The buffer that was current when the last command was started. */
343 Lisp_Object last_point_position_buffer
;
345 /* The window that was selected when the last command was started. */
346 Lisp_Object last_point_position_window
;
348 /* The frame in which the last input event occurred, or Qmacro if the
349 last event came from a macro. We use this to determine when to
350 generate switch-frame events. This may be cleared by functions
351 like Fselect_frame, to make sure that a switch-frame event is
352 generated by the next character. */
353 Lisp_Object internal_last_event_frame
;
355 /* A user-visible version of the above, intended to allow users to
356 figure out where the last event came from, if the event doesn't
357 carry that information itself (i.e. if it was a character). */
358 Lisp_Object Vlast_event_frame
;
360 /* The timestamp of the last input event we received from the X server.
361 X Windows wants this for selection ownership. */
362 unsigned long last_event_timestamp
;
364 Lisp_Object Qself_insert_command
;
365 Lisp_Object Qforward_char
;
366 Lisp_Object Qbackward_char
;
367 Lisp_Object Qundefined
;
368 Lisp_Object Qtimer_event_handler
;
370 /* read_key_sequence stores here the command definition of the
371 key sequence that it reads. */
372 Lisp_Object read_key_sequence_cmd
;
374 /* Echo unfinished commands after this many seconds of pause. */
375 Lisp_Object Vecho_keystrokes
;
377 /* Form to evaluate (if non-nil) when Emacs is started. */
378 Lisp_Object Vtop_level
;
380 /* If non-nil, this implements the current input method. */
381 Lisp_Object Vinput_method_function
;
382 Lisp_Object Qinput_method_function
;
384 /* When we call Vinput_method_function,
385 this holds the echo area message that was just erased. */
386 Lisp_Object Vinput_method_previous_message
;
388 /* Non-nil means deactivate the mark at end of this command. */
389 Lisp_Object Vdeactivate_mark
;
390 Lisp_Object Qdeactivate_mark
;
392 /* Menu bar specified in Lucid Emacs fashion. */
394 Lisp_Object Vlucid_menu_bar_dirty_flag
;
395 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
397 Lisp_Object Qecho_area_clear_hook
;
399 /* Hooks to run before and after each command. */
400 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
401 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
402 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
404 /* Parent keymap of terminal-local function-key-map instances. */
405 Lisp_Object Vfunction_key_map
;
407 /* Keymap of key translations that can override keymaps. */
408 Lisp_Object Vkey_translation_map
;
410 /* List of deferred actions to be performed at a later time.
411 The precise format isn't relevant here; we just check whether it is nil. */
412 Lisp_Object Vdeferred_action_list
;
414 /* Function to call to handle deferred actions, when there are any. */
415 Lisp_Object Vdeferred_action_function
;
416 Lisp_Object Qdeferred_action_function
;
418 Lisp_Object Qinput_method_exit_on_first_char
;
419 Lisp_Object Qinput_method_use_echo_area
;
421 /* File in which we write all commands we read. */
424 /* Nonzero if input is available. */
427 extern char *pending_malloc_warning
;
429 /* Circular buffer for pre-read keyboard input. */
431 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
433 /* Pointer to next available character in kbd_buffer.
434 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
435 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
436 next available char is in kbd_buffer[0]. */
437 static struct input_event
*kbd_fetch_ptr
;
439 /* Pointer to next place to store character in kbd_buffer. This
440 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
441 character should go in kbd_buffer[0]. */
442 static struct input_event
* volatile kbd_store_ptr
;
444 /* The above pair of variables forms a "queue empty" flag. When we
445 enqueue a non-hook event, we increment kbd_store_ptr. When we
446 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
447 there is input available if the two pointers are not equal.
449 Why not just have a flag set and cleared by the enqueuing and
450 dequeuing functions? Such a flag could be screwed up by interrupts
451 at inopportune times. */
453 /* If this flag is non-nil, we check mouse_moved to see when the
454 mouse moves, and motion events will appear in the input stream.
455 Otherwise, mouse motion is ignored. */
456 Lisp_Object do_mouse_tracking
;
458 /* Symbols to head events. */
459 Lisp_Object Qmouse_movement
;
460 Lisp_Object Qscroll_bar_movement
;
461 Lisp_Object Qswitch_frame
;
462 Lisp_Object Qdelete_frame
;
463 Lisp_Object Qiconify_frame
;
464 Lisp_Object Qmake_frame_visible
;
465 Lisp_Object Qselect_window
;
466 Lisp_Object Qhelp_echo
;
468 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
469 Lisp_Object Qmouse_fixup_help_message
;
472 /* Symbols to denote kinds of events. */
473 Lisp_Object Qfunction_key
;
474 Lisp_Object Qmouse_click
;
475 #if defined (WINDOWSNT)
476 Lisp_Object Qlanguage_change
;
478 Lisp_Object Qdrag_n_drop
;
479 Lisp_Object Qsave_session
;
481 Lisp_Object Qdbus_event
;
483 Lisp_Object Qconfig_changed_event
;
485 /* Lisp_Object Qmouse_movement; - also an event header */
487 /* Properties of event headers. */
488 Lisp_Object Qevent_kind
;
489 Lisp_Object Qevent_symbol_elements
;
491 /* menu item parts */
492 Lisp_Object Qmenu_enable
;
493 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
494 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
;
496 /* An event header symbol HEAD may have a property named
497 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
498 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
499 mask of modifiers applied to it. If present, this is used to help
500 speed up parse_modifiers. */
501 Lisp_Object Qevent_symbol_element_mask
;
503 /* An unmodified event header BASE may have a property named
504 Qmodifier_cache, which is an alist mapping modifier masks onto
505 modified versions of BASE. If present, this helps speed up
507 Lisp_Object Qmodifier_cache
;
509 /* Symbols to use for parts of windows. */
510 Lisp_Object Qmode_line
;
511 Lisp_Object Qvertical_line
;
512 Lisp_Object Qvertical_scroll_bar
;
513 Lisp_Object Qmenu_bar
;
515 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
516 Lisp_Object
Fthis_command_keys (void);
517 Lisp_Object Qextended_command_history
;
518 EMACS_TIME
timer_check (int do_it_now
);
520 static void record_menu_key (Lisp_Object c
);
521 static int echo_length (void);
523 Lisp_Object Qpolling_period
;
525 /* List of absolute timers. Appears in order of next scheduled event. */
526 Lisp_Object Vtimer_list
;
528 /* List of idle time timers. Appears in order of next scheduled event. */
529 Lisp_Object Vtimer_idle_list
;
531 /* Incremented whenever a timer is run. */
534 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
536 EMACS_TIME
*input_available_clear_time
;
538 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
539 Default is 1 if INTERRUPT_INPUT is defined. */
542 /* Nonzero while interrupts are temporarily deferred during redisplay. */
543 int interrupts_deferred
;
545 /* Allow m- file to inhibit use of FIONREAD. */
546 #ifdef BROKEN_FIONREAD
550 /* We are unable to use interrupts if FIONREAD is not available,
551 so flush SIGIO so we won't try. */
552 #if !defined (FIONREAD)
558 /* If we support a window system, turn on the code to poll periodically
559 to detect C-g. It isn't actually used when doing interrupt input. */
560 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
561 #define POLL_FOR_INPUT
564 /* After a command is executed, if point is moved into a region that
565 has specific properties (e.g. composition, display), we adjust
566 point to the boundary of the region. But, if a command sets this
567 variable to non-nil, we suppress this point adjustment. This
568 variable is set to nil before reading a command. */
570 Lisp_Object Vdisable_point_adjustment
;
572 /* If non-nil, always disable point adjustment. */
574 Lisp_Object Vglobal_disable_point_adjustment
;
576 /* The time when Emacs started being idle. */
578 static EMACS_TIME timer_idleness_start_time
;
580 /* After Emacs stops being idle, this saves the last value
581 of timer_idleness_start_time from when it was idle. */
583 static EMACS_TIME timer_last_idleness_start_time
;
585 /* If non-nil, events produced by disabled menu items and tool-bar
586 buttons are not ignored. Help functions bind this to allow help on
587 those items and buttons. */
588 Lisp_Object Venable_disabled_menus_and_buttons
;
591 /* Global variable declarations. */
593 /* Flags for readable_events. */
594 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
595 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
596 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
598 /* Function for init_keyboard to call with no args (if nonzero). */
599 void (*keyboard_init_hook
) (void);
601 static int read_avail_input (int);
602 static void get_input_pending (int *, int);
603 static int readable_events (int);
604 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
606 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
608 static Lisp_Object
make_lispy_event (struct input_event
*);
609 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
610 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
611 enum scroll_bar_part
,
612 Lisp_Object
, Lisp_Object
,
615 static Lisp_Object
modify_event_symbol (int, unsigned, Lisp_Object
,
616 Lisp_Object
, char **,
617 Lisp_Object
*, unsigned);
618 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
619 static void save_getcjmp (jmp_buf);
620 static void restore_getcjmp (jmp_buf);
621 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
622 static void clear_event (struct input_event
*);
623 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
624 static SIGTYPE
interrupt_signal (int signalnum
);
626 static SIGTYPE
input_available_signal (int signo
);
628 static void handle_interrupt (void);
629 static void timer_start_idle (void);
630 static void timer_stop_idle (void);
631 static void timer_resume_idle (void);
632 static SIGTYPE
handle_user_signal (int);
633 static char *find_user_signal_name (int);
634 static int store_user_signal_events (void);
636 /* Nonzero means don't try to suspend even if the operating system seems
638 static int cannot_suspend
;
641 /* Install the string STR as the beginning of the string of echoing,
642 so that it serves as a prompt for the next character.
643 Also start echoing. */
646 echo_prompt (Lisp_Object str
)
648 current_kboard
->echo_string
= str
;
649 current_kboard
->echo_after_prompt
= SCHARS (str
);
653 /* Add C to the echo string, if echoing is going on.
654 C can be a character, which is printed prettily ("M-C-x" and all that
655 jazz), or a symbol, whose name is printed. */
658 echo_char (Lisp_Object c
)
660 if (current_kboard
->immediate_echo
)
662 int size
= KEY_DESCRIPTION_SIZE
+ 100;
663 char *buffer
= (char *) alloca (size
);
665 Lisp_Object echo_string
;
667 echo_string
= current_kboard
->echo_string
;
669 /* If someone has passed us a composite event, use its head symbol. */
674 ptr
= push_key_description (XINT (c
), ptr
, 1);
676 else if (SYMBOLP (c
))
678 Lisp_Object name
= SYMBOL_NAME (c
);
679 int nbytes
= SBYTES (name
);
681 if (size
- (ptr
- buffer
) < nbytes
)
683 int offset
= ptr
- buffer
;
684 size
= max (2 * size
, size
+ nbytes
);
685 buffer
= (char *) alloca (size
);
686 ptr
= buffer
+ offset
;
689 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
690 STRING_MULTIBYTE (name
), 1);
693 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
696 const char *text
= " (Type ? for further options)";
697 int len
= strlen (text
);
699 if (size
- (ptr
- buffer
) < len
)
701 int offset
= ptr
- buffer
;
703 buffer
= (char *) alloca (size
);
704 ptr
= buffer
+ offset
;
707 memcpy (ptr
, text
, len
);
711 /* Replace a dash from echo_dash with a space, otherwise
712 add a space at the end as a separator between keys. */
713 if (STRINGP (echo_string
)
714 && SCHARS (echo_string
) > 1)
716 Lisp_Object last_char
, prev_char
, idx
;
718 idx
= make_number (SCHARS (echo_string
) - 2);
719 prev_char
= Faref (echo_string
, idx
);
721 idx
= make_number (SCHARS (echo_string
) - 1);
722 last_char
= Faref (echo_string
, idx
);
724 /* We test PREV_CHAR to make sure this isn't the echoing
726 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
727 Faset (echo_string
, idx
, make_number (' '));
729 echo_string
= concat2 (echo_string
, build_string (" "));
731 else if (STRINGP (echo_string
))
732 echo_string
= concat2 (echo_string
, build_string (" "));
734 current_kboard
->echo_string
735 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
741 /* Temporarily add a dash to the end of the echo string if it's not
742 empty, so that it serves as a mini-prompt for the very next character. */
747 /* Do nothing if not echoing at all. */
748 if (NILP (current_kboard
->echo_string
))
751 if (!current_kboard
->immediate_echo
752 && SCHARS (current_kboard
->echo_string
) == 0)
755 /* Do nothing if we just printed a prompt. */
756 if (current_kboard
->echo_after_prompt
757 == SCHARS (current_kboard
->echo_string
))
760 /* Do nothing if we have already put a dash at the end. */
761 if (SCHARS (current_kboard
->echo_string
) > 1)
763 Lisp_Object last_char
, prev_char
, idx
;
765 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
766 prev_char
= Faref (current_kboard
->echo_string
, idx
);
768 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
769 last_char
= Faref (current_kboard
->echo_string
, idx
);
771 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
775 /* Put a dash at the end of the buffer temporarily,
776 but make it go away when the next character is added. */
777 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
782 /* Display the current echo string, and begin echoing if not already
788 if (!current_kboard
->immediate_echo
)
791 current_kboard
->immediate_echo
= 1;
793 for (i
= 0; i
< this_command_key_count
; i
++)
797 /* Set before_command_echo_length to the value that would
798 have been saved before the start of this subcommand in
799 command_loop_1, if we had already been echoing then. */
800 if (i
== this_single_command_key_start
)
801 before_command_echo_length
= echo_length ();
803 c
= XVECTOR (this_command_keys
)->contents
[i
];
804 if (! (EVENT_HAS_PARAMETERS (c
)
805 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
809 /* Set before_command_echo_length to the value that would
810 have been saved before the start of this subcommand in
811 command_loop_1, if we had already been echoing then. */
812 if (this_command_key_count
== this_single_command_key_start
)
813 before_command_echo_length
= echo_length ();
815 /* Put a dash at the end to invite the user to type more. */
820 message3_nolog (current_kboard
->echo_string
,
821 SBYTES (current_kboard
->echo_string
),
822 STRING_MULTIBYTE (current_kboard
->echo_string
));
825 /* Record in what buffer we echoed, and from which kboard. */
826 echo_message_buffer
= echo_area_buffer
[0];
827 echo_kboard
= current_kboard
;
829 if (waiting_for_input
&& !NILP (Vquit_flag
))
830 quit_throw_to_read_char ();
833 /* Turn off echoing, for the start of a new command. */
836 cancel_echoing (void)
838 current_kboard
->immediate_echo
= 0;
839 current_kboard
->echo_after_prompt
= -1;
840 current_kboard
->echo_string
= Qnil
;
841 ok_to_echo_at_next_pause
= NULL
;
843 echo_message_buffer
= Qnil
;
846 /* Return the length of the current echo string. */
851 return (STRINGP (current_kboard
->echo_string
)
852 ? SCHARS (current_kboard
->echo_string
)
856 /* Truncate the current echo message to its first LEN chars.
857 This and echo_char get used by read_key_sequence when the user
858 switches frames while entering a key sequence. */
861 echo_truncate (int nchars
)
863 if (STRINGP (current_kboard
->echo_string
))
864 current_kboard
->echo_string
865 = Fsubstring (current_kboard
->echo_string
,
866 make_number (0), make_number (nchars
));
867 truncate_echo_area (nchars
);
871 /* Functions for manipulating this_command_keys. */
873 add_command_key (Lisp_Object key
)
875 #if 0 /* Not needed after we made Freset_this_command_lengths
876 do the job immediately. */
877 /* If reset-this-command-length was called recently, obey it now.
878 See the doc string of that function for an explanation of why. */
879 if (before_command_restore_flag
)
881 this_command_key_count
= before_command_key_count_1
;
882 if (this_command_key_count
< this_single_command_key_start
)
883 this_single_command_key_start
= this_command_key_count
;
884 echo_truncate (before_command_echo_length_1
);
885 before_command_restore_flag
= 0;
889 if (this_command_key_count
>= ASIZE (this_command_keys
))
890 this_command_keys
= larger_vector (this_command_keys
,
891 2 * ASIZE (this_command_keys
),
894 ASET (this_command_keys
, this_command_key_count
, key
);
895 ++this_command_key_count
;
900 recursive_edit_1 (void)
902 int count
= SPECPDL_INDEX ();
905 if (command_loop_level
> 0)
907 specbind (Qstandard_output
, Qt
);
908 specbind (Qstandard_input
, Qt
);
911 #ifdef HAVE_WINDOW_SYSTEM
912 /* The command loop has started an hourglass timer, so we have to
913 cancel it here, otherwise it will fire because the recursive edit
914 can take some time. Do not check for display_hourglass_p here,
915 because it could already be nil. */
919 /* This function may have been called from a debugger called from
920 within redisplay, for instance by Edebugging a function called
921 from fontification-functions. We want to allow redisplay in
922 the debugging session.
924 The recursive edit is left with a `(throw exit ...)'. The `exit'
925 tag is not caught anywhere in redisplay, i.e. when we leave the
926 recursive edit, the original redisplay leading to the recursive
927 edit will be unwound. The outcome should therefore be safe. */
928 specbind (Qinhibit_redisplay
, Qnil
);
931 val
= command_loop ();
933 Fsignal (Qquit
, Qnil
);
934 /* Handle throw from read_minibuf when using minibuffer
935 while it's active but we're in another window. */
937 xsignal1 (Qerror
, val
);
939 return unbind_to (count
, Qnil
);
942 /* When an auto-save happens, record the "time", and don't do again soon. */
945 record_auto_save (void)
947 last_auto_save
= num_nonmacro_input_events
;
950 /* Make an auto save happen as soon as possible at command level. */
953 force_auto_save_soon (void)
955 last_auto_save
= - auto_save_interval
- 1;
957 record_asynch_buffer_change ();
960 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
961 doc
: /* Invoke the editor command loop recursively.
962 To get out of the recursive edit, a command can do `(throw 'exit nil)';
963 that tells this function to return.
964 Alternatively, `(throw 'exit t)' makes this function signal an error.
965 This function is called by the editor initialization to begin editing. */)
968 int count
= SPECPDL_INDEX ();
971 /* If we enter while input is blocked, don't lock up here.
972 This may happen through the debugger during redisplay. */
976 command_loop_level
++;
977 update_mode_lines
= 1;
979 if (command_loop_level
980 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
981 buffer
= Fcurrent_buffer ();
985 /* If we leave recursive_edit_1 below with a `throw' for instance,
986 like it is done in the splash screen display, we have to
987 make sure that we restore single_kboard as command_loop_1
988 would have done if it were left normally. */
989 if (command_loop_level
> 0)
990 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
991 record_unwind_protect (recursive_edit_unwind
, buffer
);
994 return unbind_to (count
, Qnil
);
998 recursive_edit_unwind (Lisp_Object buffer
)
1000 if (BUFFERP (buffer
))
1001 Fset_buffer (buffer
);
1003 command_loop_level
--;
1004 update_mode_lines
= 1;
1009 #if 0 /* These two functions are now replaced with
1010 temporarily_switch_to_single_kboard. */
1014 #if 0 /* Theory: if there's anything in Vunread_command_events,
1015 it will right away be read by read_key_sequence,
1016 and then if we do switch KBOARDS, it will go into the side
1017 queue then. So we don't need to do anything special here -- rms. */
1018 if (CONSP (Vunread_command_events
))
1020 current_kboard
->kbd_queue
1021 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1022 current_kboard
->kbd_queue_has_data
= 1;
1024 Vunread_command_events
= Qnil
;
1029 /* Switch to the single-kboard state, making current_kboard
1030 the only KBOARD from which further input is accepted. */
1033 single_kboard_state ()
1039 /* If we're in single_kboard state for kboard KBOARD,
1043 not_single_kboard_state (KBOARD
*kboard
)
1045 if (kboard
== current_kboard
)
1049 /* Maintain a stack of kboards, so other parts of Emacs
1050 can switch temporarily to the kboard of a given frame
1051 and then revert to the previous status. */
1056 struct kboard_stack
*next
;
1059 static struct kboard_stack
*kboard_stack
;
1062 push_kboard (struct kboard
*k
)
1064 struct kboard_stack
*p
1065 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1067 p
->next
= kboard_stack
;
1068 p
->kboard
= current_kboard
;
1078 struct kboard_stack
*p
= kboard_stack
;
1080 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1082 if (t
->kboard
== p
->kboard
)
1084 current_kboard
= p
->kboard
;
1091 /* The terminal we remembered has been deleted. */
1092 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1095 kboard_stack
= p
->next
;
1099 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1100 from which further input is accepted. If F is non-nil, set its
1101 KBOARD as the current keyboard.
1103 This function uses record_unwind_protect to return to the previous
1106 If Emacs is already in single_kboard mode, and F's keyboard is
1107 locked, then this function will throw an errow. */
1110 temporarily_switch_to_single_kboard (struct frame
*f
)
1112 int was_locked
= single_kboard
;
1115 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1116 /* We can not switch keyboards while in single_kboard mode.
1117 In rare cases, Lisp code may call `recursive-edit' (or
1118 `read-minibuffer' or `y-or-n-p') after it switched to a
1119 locked frame. For example, this is likely to happen
1120 when server.el connects to a new terminal while Emacs is in
1121 single_kboard mode. It is best to throw an error instead
1122 of presenting the user with a frozen screen. */
1123 error ("Terminal %d is locked, cannot read from it",
1124 FRAME_TERMINAL (f
)->id
);
1126 /* This call is unnecessary, but helps
1127 `restore_kboard_configuration' discover if somebody changed
1128 `current_kboard' behind our back. */
1129 push_kboard (current_kboard
);
1132 current_kboard
= FRAME_KBOARD (f
);
1134 record_unwind_protect (restore_kboard_configuration
,
1135 (was_locked
? Qt
: Qnil
));
1138 #if 0 /* This function is not needed anymore. */
1140 record_single_kboard_state ()
1143 push_kboard (current_kboard
);
1144 record_unwind_protect (restore_kboard_configuration
,
1145 (single_kboard
? Qt
: Qnil
));
1150 restore_kboard_configuration (Lisp_Object was_locked
)
1152 if (NILP (was_locked
))
1156 struct kboard
*prev
= current_kboard
;
1159 /* The pop should not change the kboard. */
1160 if (single_kboard
&& current_kboard
!= prev
)
1167 /* Handle errors that are not handled at inner levels
1168 by printing an error message and returning to the editor command loop. */
1171 cmd_error (Lisp_Object data
)
1173 Lisp_Object old_level
, old_length
;
1174 char macroerror
[50];
1176 #ifdef HAVE_WINDOW_SYSTEM
1177 if (display_hourglass_p
)
1178 cancel_hourglass ();
1181 if (!NILP (executing_kbd_macro
))
1183 if (executing_kbd_macro_iterations
== 1)
1184 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1186 sprintf (macroerror
, "After %d kbd macro iterations: ",
1187 executing_kbd_macro_iterations
);
1192 Vstandard_output
= Qt
;
1193 Vstandard_input
= Qt
;
1194 Vexecuting_kbd_macro
= Qnil
;
1195 executing_kbd_macro
= Qnil
;
1196 current_kboard
->Vprefix_arg
= Qnil
;
1197 current_kboard
->Vlast_prefix_arg
= Qnil
;
1200 /* Avoid unquittable loop if data contains a circular list. */
1201 old_level
= Vprint_level
;
1202 old_length
= Vprint_length
;
1203 XSETFASTINT (Vprint_level
, 10);
1204 XSETFASTINT (Vprint_length
, 10);
1205 cmd_error_internal (data
, macroerror
);
1206 Vprint_level
= old_level
;
1207 Vprint_length
= old_length
;
1211 Vinhibit_quit
= Qnil
;
1212 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1213 if (command_loop_level
== 0 && minibuf_level
== 0)
1214 any_kboard_state ();
1217 return make_number (0);
1220 /* Take actions on handling an error. DATA is the data that describes
1223 CONTEXT is a C-string containing ASCII characters only which
1224 describes the context in which the error happened. If we need to
1225 generalize CONTEXT to allow multibyte characters, make it a Lisp
1229 cmd_error_internal (Lisp_Object data
, const char *context
)
1231 struct frame
*sf
= SELECTED_FRAME ();
1233 /* The immediate context is not interesting for Quits,
1234 since they are asyncronous. */
1235 if (EQ (XCAR (data
), Qquit
))
1236 Vsignaling_function
= Qnil
;
1241 /* Use user's specified output function if any. */
1242 if (!NILP (Vcommand_error_function
))
1243 call3 (Vcommand_error_function
, data
,
1244 context
? build_string (context
) : empty_unibyte_string
,
1245 Vsignaling_function
);
1246 /* If the window system or terminal frame hasn't been initialized
1247 yet, or we're not interactive, write the message to stderr and exit. */
1248 else if (!sf
->glyphs_initialized_p
1249 /* The initial frame is a special non-displaying frame. It
1250 will be current in daemon mode when there are no frames
1251 to display, and in non-daemon mode before the real frame
1252 has finished initializing. If an error is thrown in the
1253 latter case while creating the frame, then the frame
1254 will never be displayed, so the safest thing to do is
1255 write to stderr and quit. In daemon mode, there are
1256 many other potential errors that do not prevent frames
1257 from being created, so continuing as normal is better in
1259 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1262 print_error_message (data
, Qexternal_debugging_output
,
1263 context
, Vsignaling_function
);
1264 Fterpri (Qexternal_debugging_output
);
1265 Fkill_emacs (make_number (-1));
1269 clear_message (1, 0);
1271 message_log_maybe_newline ();
1274 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1277 Vsignaling_function
= Qnil
;
1280 Lisp_Object
command_loop_1 (void);
1281 Lisp_Object
command_loop_2 (Lisp_Object
);
1282 Lisp_Object
top_level_1 (Lisp_Object
);
1284 /* Entry to editor-command-loop.
1285 This level has the catches for exiting/returning to editor command loop.
1286 It returns nil to exit recursive edit, t to abort it. */
1291 if (command_loop_level
> 0 || minibuf_level
> 0)
1294 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1295 executing_kbd_macro
= Qnil
;
1301 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1302 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1303 /* Reset single_kboard in case top-level set it while
1304 evaluating an -f option, or we are stuck there for some
1306 any_kboard_state ();
1308 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1309 executing_kbd_macro
= Qnil
;
1311 /* End of file in -batch run causes exit here. */
1317 /* Here we catch errors in execution of commands within the
1318 editing loop, and reenter the editing loop.
1319 When there is an error, cmd_error runs and returns a non-nil
1320 value to us. A value of nil means that command_loop_1 itself
1321 returned due to end of file (or end of kbd macro). */
1324 command_loop_2 (Lisp_Object ignore
)
1326 register Lisp_Object val
;
1329 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1330 while (!NILP (val
));
1338 return Feval (Vtop_level
);
1342 top_level_1 (Lisp_Object ignore
)
1344 /* On entry to the outer level, run the startup file */
1345 if (!NILP (Vtop_level
))
1346 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1347 else if (!NILP (Vpurify_flag
))
1348 message ("Bare impure Emacs (standard Lisp code not loaded)");
1350 message ("Bare Emacs (standard Lisp code not loaded)");
1354 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1355 doc
: /* Exit all recursive editing levels.
1356 This also exits all active minibuffers. */)
1359 #ifdef HAVE_WINDOW_SYSTEM
1360 if (display_hourglass_p
)
1361 cancel_hourglass ();
1364 /* Unblock input if we enter with input blocked. This may happen if
1365 redisplay traps e.g. during tool-bar update with input blocked. */
1366 while (INPUT_BLOCKED_P
)
1369 Fthrow (Qtop_level
, Qnil
);
1372 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1373 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1376 if (command_loop_level
> 0 || minibuf_level
> 0)
1377 Fthrow (Qexit
, Qnil
);
1379 error ("No recursive edit is in progress");
1382 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1383 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1386 if (command_loop_level
> 0 || minibuf_level
> 0)
1389 error ("No recursive edit is in progress");
1392 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1394 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1395 of this function. */
1398 tracking_off (Lisp_Object old_value
)
1400 do_mouse_tracking
= old_value
;
1401 if (NILP (old_value
))
1403 /* Redisplay may have been preempted because there was input
1404 available, and it assumes it will be called again after the
1405 input has been processed. If the only input available was
1406 the sort that we have just disabled, then we need to call
1408 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1410 redisplay_preserve_echo_area (6);
1411 get_input_pending (&input_pending
,
1412 READABLE_EVENTS_DO_TIMERS_NOW
);
1418 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1419 doc
: /* Evaluate BODY with mouse movement events enabled.
1420 Within a `track-mouse' form, mouse motion generates input events that
1421 you can read with `read-event'.
1422 Normally, mouse motion is ignored.
1423 usage: (track-mouse BODY...) */)
1426 int count
= SPECPDL_INDEX ();
1429 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1431 do_mouse_tracking
= Qt
;
1433 val
= Fprogn (args
);
1434 return unbind_to (count
, val
);
1437 /* If mouse has moved on some frame, return one of those frames.
1441 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1442 after resizing the tool-bar window. */
1444 int ignore_mouse_drag_p
;
1447 some_mouse_moved (void)
1449 Lisp_Object tail
, frame
;
1451 if (ignore_mouse_drag_p
)
1453 /* ignore_mouse_drag_p = 0; */
1457 FOR_EACH_FRAME (tail
, frame
)
1459 if (XFRAME (frame
)->mouse_moved
)
1460 return XFRAME (frame
);
1466 #endif /* HAVE_MOUSE || HAVE_GPM */
1468 /* This is the actual command reading loop,
1469 sans error-handling encapsulation. */
1471 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1473 void safe_run_hooks (Lisp_Object
);
1474 static void adjust_point_for_property (int, int);
1476 /* Cancel hourglass from protect_unwind.
1478 #ifdef HAVE_WINDOW_SYSTEM
1480 cancel_hourglass_unwind (Lisp_Object arg
)
1482 cancel_hourglass ();
1488 command_loop_1 (void)
1491 Lisp_Object keybuf
[30];
1493 int prev_modiff
= 0;
1494 struct buffer
*prev_buffer
= NULL
;
1495 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1496 int was_locked
= single_kboard
;
1498 int already_adjusted
= 0;
1500 current_kboard
->Vprefix_arg
= Qnil
;
1501 current_kboard
->Vlast_prefix_arg
= Qnil
;
1502 Vdeactivate_mark
= Qnil
;
1503 waiting_for_input
= 0;
1506 this_command_key_count
= 0;
1507 this_command_key_count_reset
= 0;
1508 this_single_command_key_start
= 0;
1510 if (NILP (Vmemory_full
))
1512 /* Make sure this hook runs after commands that get errors and
1513 throw to top level. */
1514 /* Note that the value cell will never directly contain nil
1515 if the symbol is a local variable. */
1516 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1517 safe_run_hooks (Qpost_command_hook
);
1519 /* If displaying a message, resize the echo area window to fit
1520 that message's size exactly. */
1521 if (!NILP (echo_area_buffer
[0]))
1522 resize_echo_area_exactly ();
1524 if (!NILP (Vdeferred_action_list
))
1525 safe_run_hooks (Qdeferred_action_function
);
1528 /* Do this after running Vpost_command_hook, for consistency. */
1529 current_kboard
->Vlast_command
= Vthis_command
;
1530 current_kboard
->Vreal_last_command
= real_this_command
;
1531 if (!CONSP (last_command_event
))
1532 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1536 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1539 /* Make sure the current window's buffer is selected. */
1540 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1541 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1543 /* Display any malloc warning that just came out. Use while because
1544 displaying one warning can cause another. */
1546 while (pending_malloc_warning
)
1547 display_malloc_warning ();
1549 Vdeactivate_mark
= Qnil
;
1551 /* If minibuffer on and echo area in use,
1552 wait a short time and redraw minibuffer. */
1555 && !NILP (echo_area_buffer
[0])
1556 && EQ (minibuf_window
, echo_area_window
)
1557 && NUMBERP (Vminibuffer_message_timeout
))
1559 /* Bind inhibit-quit to t so that C-g gets read in
1560 rather than quitting back to the minibuffer. */
1561 int count
= SPECPDL_INDEX ();
1562 specbind (Qinhibit_quit
, Qt
);
1564 sit_for (Vminibuffer_message_timeout
, 0, 2);
1566 /* Clear the echo area. */
1568 safe_run_hooks (Qecho_area_clear_hook
);
1570 unbind_to (count
, Qnil
);
1572 /* If a C-g came in before, treat it as input now. */
1573 if (!NILP (Vquit_flag
))
1576 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1581 /* Select the frame that the last event came from. Usually,
1582 switch-frame events will take care of this, but if some lisp
1583 code swallows a switch-frame event, we'll fix things up here.
1584 Is this a good idea? */
1585 if (FRAMEP (internal_last_event_frame
)
1586 && !EQ (internal_last_event_frame
, selected_frame
))
1587 Fselect_frame (internal_last_event_frame
, Qnil
);
1589 /* If it has changed current-menubar from previous value,
1590 really recompute the menubar from the value. */
1591 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1592 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1593 call0 (Qrecompute_lucid_menubar
);
1595 before_command_key_count
= this_command_key_count
;
1596 before_command_echo_length
= echo_length ();
1598 Vthis_command
= Qnil
;
1599 real_this_command
= Qnil
;
1600 Vthis_original_command
= Qnil
;
1601 Vthis_command_keys_shift_translated
= Qnil
;
1603 /* Read next key sequence; i gets its length. */
1604 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1607 /* A filter may have run while we were reading the input. */
1608 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1610 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1611 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1615 /* Now we have read a key sequence of length I,
1616 or else I is 0 and we found end of file. */
1618 if (i
== 0) /* End of file -- happens only in */
1619 return Qnil
; /* a kbd macro, at the end. */
1620 /* -1 means read_key_sequence got a menu that was rejected.
1621 Just loop around and read another command. */
1625 this_command_key_count
= 0;
1626 this_command_key_count_reset
= 0;
1627 this_single_command_key_start
= 0;
1631 last_command_event
= keybuf
[i
- 1];
1633 /* If the previous command tried to force a specific window-start,
1634 forget about that, in case this command moves point far away
1635 from that position. But also throw away beg_unchanged and
1636 end_unchanged information in that case, so that redisplay will
1637 update the whole window properly. */
1638 if (!NILP (XWINDOW (selected_window
)->force_start
))
1641 XWINDOW (selected_window
)->force_start
= Qnil
;
1642 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1643 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1646 cmd
= read_key_sequence_cmd
;
1647 if (!NILP (Vexecuting_kbd_macro
))
1649 if (!NILP (Vquit_flag
))
1651 Vexecuting_kbd_macro
= Qt
;
1652 QUIT
; /* Make some noise. */
1653 /* Will return since macro now empty. */
1657 /* Do redisplay processing after this command except in special
1658 cases identified below. */
1659 prev_buffer
= current_buffer
;
1660 prev_modiff
= MODIFF
;
1661 last_point_position
= PT
;
1662 last_point_position_window
= selected_window
;
1663 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1665 /* By default, we adjust point to a boundary of a region that
1666 has such a property that should be treated intangible
1667 (e.g. composition, display). But, some commands will set
1668 this variable differently. */
1669 Vdisable_point_adjustment
= Qnil
;
1671 /* Process filters and timers may have messed with deactivate-mark.
1672 reset it before we execute the command. */
1673 Vdeactivate_mark
= Qnil
;
1675 /* Remap command through active keymaps */
1676 Vthis_original_command
= cmd
;
1680 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1684 /* Execute the command. */
1686 Vthis_command
= cmd
;
1687 real_this_command
= cmd
;
1688 /* Note that the value cell will never directly contain nil
1689 if the symbol is a local variable. */
1690 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1691 safe_run_hooks (Qpre_command_hook
);
1693 already_adjusted
= 0;
1695 if (NILP (Vthis_command
))
1697 /* nil means key is undefined. */
1698 Lisp_Object keys
= Fvector (i
, keybuf
);
1699 keys
= Fkey_description (keys
, Qnil
);
1701 message_with_string ("%s is undefined", keys
, 0);
1702 current_kboard
->defining_kbd_macro
= Qnil
;
1703 update_mode_lines
= 1;
1704 current_kboard
->Vprefix_arg
= Qnil
;
1708 /* Here for a command that isn't executed directly */
1710 #ifdef HAVE_WINDOW_SYSTEM
1711 int scount
= SPECPDL_INDEX ();
1713 if (display_hourglass_p
1714 && NILP (Vexecuting_kbd_macro
))
1716 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1721 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1723 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1725 #ifdef HAVE_WINDOW_SYSTEM
1726 /* Do not check display_hourglass_p here, because
1727 Fcommand_execute could change it, but we should cancel
1728 hourglass cursor anyway.
1729 But don't cancel the hourglass within a macro
1730 just because a command in the macro finishes. */
1731 if (NILP (Vexecuting_kbd_macro
))
1732 unbind_to (scount
, Qnil
);
1735 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1737 /* Note that the value cell will never directly contain nil
1738 if the symbol is a local variable. */
1739 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1740 safe_run_hooks (Qpost_command_hook
);
1742 /* If displaying a message, resize the echo area window to fit
1743 that message's size exactly. */
1744 if (!NILP (echo_area_buffer
[0]))
1745 resize_echo_area_exactly ();
1747 if (!NILP (Vdeferred_action_list
))
1748 safe_run_hooks (Qdeferred_action_function
);
1750 /* If there is a prefix argument,
1751 1) We don't want Vlast_command to be ``universal-argument''
1752 (that would be dumb), so don't set Vlast_command,
1753 2) we want to leave echoing on so that the prefix will be
1754 echoed as part of this key sequence, so don't call
1756 3) we want to leave this_command_key_count non-zero, so that
1757 read_char will realize that it is re-reading a character, and
1758 not echo it a second time.
1760 If the command didn't actually create a prefix arg,
1761 but is merely a frame event that is transparent to prefix args,
1762 then the above doesn't apply. */
1763 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1765 current_kboard
->Vlast_command
= Vthis_command
;
1766 current_kboard
->Vreal_last_command
= real_this_command
;
1767 if (!CONSP (last_command_event
))
1768 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1770 this_command_key_count
= 0;
1771 this_command_key_count_reset
= 0;
1772 this_single_command_key_start
= 0;
1775 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1777 /* In Emacs 22, setting transient-mark-mode to `only' was a
1778 way of turning it on for just one command. This usage is
1779 obsolete, but support it anyway. */
1780 if (EQ (Vtransient_mark_mode
, Qidentity
))
1781 Vtransient_mark_mode
= Qnil
;
1782 else if (EQ (Vtransient_mark_mode
, Qonly
))
1783 Vtransient_mark_mode
= Qidentity
;
1785 if (!NILP (Vdeactivate_mark
))
1786 call0 (Qdeactivate_mark
);
1787 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1788 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1793 if (current_buffer
== prev_buffer
1794 && last_point_position
!= PT
1795 && NILP (Vdisable_point_adjustment
)
1796 && NILP (Vglobal_disable_point_adjustment
))
1798 if (last_point_position
> BEGV
1799 && last_point_position
< ZV
1800 && (composition_adjust_point (last_point_position
,
1801 last_point_position
)
1802 != last_point_position
))
1803 /* The last point was temporarily set within a grapheme
1804 cluster to prevent automatic composition. To recover
1805 the automatic composition, we must update the
1807 windows_or_buffers_changed
++;
1808 if (!already_adjusted
)
1809 adjust_point_for_property (last_point_position
,
1810 MODIFF
!= prev_modiff
);
1813 /* Install chars successfully executed in kbd macro. */
1815 if (!NILP (current_kboard
->defining_kbd_macro
)
1816 && NILP (current_kboard
->Vprefix_arg
))
1817 finalize_kbd_macro_chars ();
1818 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1820 any_kboard_state ();
1825 /* Adjust point to a boundary of a region that has such a property
1826 that should be treated intangible. For the moment, we check
1827 `composition', `display' and `invisible' properties.
1828 LAST_PT is the last position of point. */
1831 adjust_point_for_property (int last_pt
, int modified
)
1834 Lisp_Object val
, overlay
, tmp
;
1835 /* When called after buffer modification, we should temporarily
1836 suppress the point adjustment for automatic composition so that a
1837 user can keep inserting another character at point or keep
1838 deleting characters around point. */
1839 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1842 /* FIXME: cycling is probably not necessary because these properties
1843 can't be usefully combined anyway. */
1844 while (check_composition
|| check_display
|| check_invisible
)
1846 /* FIXME: check `intangible'. */
1847 if (check_composition
1848 && PT
> BEGV
&& PT
< ZV
1849 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1852 check_display
= check_invisible
= 1;
1854 check_composition
= 0;
1856 && PT
> BEGV
&& PT
< ZV
1857 && !NILP (val
= get_char_property_and_overlay
1858 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1859 && display_prop_intangible_p (val
)
1860 && (!OVERLAYP (overlay
)
1861 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1862 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1863 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1864 && (beg
< PT
/* && end > PT <- It's always the case. */
1865 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1868 SET_PT (PT
< last_pt
1869 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1871 check_composition
= check_invisible
= 1;
1874 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1876 int inv
, ellipsis
= 0;
1879 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1882 /* FIXME: We should stop if we find a spot between
1883 two runs of `invisible' where inserted text would
1884 be visible. This is important when we have two
1885 invisible boundaries that enclose an area: if the
1886 area is empty, we need this test in order to make
1887 it possible to place point in the middle rather
1888 than skip both boundaries. However, this code
1889 also stops anywhere in a non-sticky text-property,
1890 which breaks (e.g.) Org mode. */
1891 && (val
= get_pos_property (make_number (end
),
1893 TEXT_PROP_MEANS_INVISIBLE (val
))
1895 && !NILP (val
= get_char_property_and_overlay
1896 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1897 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1899 ellipsis
= ellipsis
|| inv
> 1
1900 || (OVERLAYP (overlay
)
1901 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1902 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1903 tmp
= Fnext_single_char_property_change
1904 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1905 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1909 && (val
= get_pos_property (make_number (beg
),
1911 TEXT_PROP_MEANS_INVISIBLE (val
))
1913 && !NILP (val
= get_char_property_and_overlay
1914 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1915 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1917 ellipsis
= ellipsis
|| inv
> 1
1918 || (OVERLAYP (overlay
)
1919 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1920 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1921 tmp
= Fprevious_single_char_property_change
1922 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1923 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1926 /* Move away from the inside area. */
1927 if (beg
< PT
&& end
> PT
)
1929 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1930 /* We haven't moved yet (so we don't need to fear
1931 infinite-looping) and we were outside the range
1932 before (so either end of the range still corresponds
1933 to a move in the right direction): pretend we moved
1934 less than we actually did, so that we still have
1935 more freedom below in choosing which end of the range
1937 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1938 /* We either have moved already or the last point
1939 was already in the range: we don't get to choose
1940 which end of the range we have to go to. */
1941 : (PT
< last_pt
? beg
: end
));
1942 check_composition
= check_display
= 1;
1944 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1945 the point to something other than its argument, due to
1946 point-motion hooks, intangibility, etc. */
1947 xassert (PT
== beg
|| PT
== end
);
1950 /* Pretend the area doesn't exist if the buffer is not
1952 if (!modified
&& !ellipsis
&& beg
< end
)
1954 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1955 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1956 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1957 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1958 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1959 /* We've already moved as far as we can. Trying to go
1960 to the other end would mean moving backwards and thus
1961 could lead to an infinite loop. */
1963 else if (val
= get_pos_property (make_number (PT
),
1965 TEXT_PROP_MEANS_INVISIBLE (val
)
1966 && (val
= get_pos_property
1967 (make_number (PT
== beg
? end
: beg
),
1969 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1970 (check_composition
= check_display
= 1,
1971 SET_PT (PT
== beg
? end
: beg
));
1974 check_invisible
= 0;
1978 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1981 safe_run_hooks_1 (void)
1983 if (NILP (Vrun_hooks
))
1985 return call1 (Vrun_hooks
, Vinhibit_quit
);
1988 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1991 safe_run_hooks_error (Lisp_Object data
)
1993 Lisp_Object args
[3];
1994 args
[0] = build_string ("Error in %s: %s");
1995 args
[1] = Vinhibit_quit
;
1998 return Fset (Vinhibit_quit
, Qnil
);
2001 /* If we get an error while running the hook, cause the hook variable
2002 to be nil. Also inhibit quits, so that C-g won't cause the hook
2003 to mysteriously evaporate. */
2006 safe_run_hooks (Lisp_Object hook
)
2008 int count
= SPECPDL_INDEX ();
2009 specbind (Qinhibit_quit
, hook
);
2011 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2013 unbind_to (count
, Qnil
);
2017 /* Number of seconds between polling for input. This is a Lisp
2018 variable that can be bound. */
2020 EMACS_INT polling_period
;
2022 /* Nonzero means polling for input is temporarily suppressed. */
2024 int poll_suppress_count
;
2026 /* Asynchronous timer for polling. */
2028 struct atimer
*poll_timer
;
2031 #ifdef POLL_FOR_INPUT
2033 /* Poll for input, so that we catch a C-g if it comes in. This
2034 function is called from x_make_frame_visible, see comment
2038 poll_for_input_1 (void)
2040 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2041 doing anything dangerous. */
2045 if (interrupt_input_blocked
== 0
2046 && !waiting_for_input
)
2047 read_avail_input (0);
2053 /* Timer callback function for poll_timer. TIMER is equal to
2057 poll_for_input (struct atimer
*timer
)
2059 if (poll_suppress_count
== 0)
2062 interrupt_input_pending
= 1;
2063 pending_signals
= 1;
2065 poll_for_input_1 ();
2070 #endif /* POLL_FOR_INPUT */
2072 /* Begin signals to poll for input, if they are appropriate.
2073 This function is called unconditionally from various places. */
2076 start_polling (void)
2078 #ifdef POLL_FOR_INPUT
2079 /* XXX This condition was (read_socket_hook && !interrupt_input),
2080 but read_socket_hook is not global anymore. Let's pretend that
2082 if (!interrupt_input
)
2084 /* Turn alarm handling on unconditionally. It might have
2085 been turned off in process.c. */
2086 turn_on_atimers (1);
2088 /* If poll timer doesn't exist, are we need one with
2089 a different interval, start a new one. */
2090 if (poll_timer
== NULL
2091 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2093 EMACS_TIME interval
;
2096 cancel_atimer (poll_timer
);
2098 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2099 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2100 poll_for_input
, NULL
);
2103 /* Let the timer's callback function poll for input
2104 if this becomes zero. */
2105 --poll_suppress_count
;
2110 /* Nonzero if we are using polling to handle input asynchronously. */
2113 input_polling_used (void)
2115 #ifdef POLL_FOR_INPUT
2116 /* XXX This condition was (read_socket_hook && !interrupt_input),
2117 but read_socket_hook is not global anymore. Let's pretend that
2119 return !interrupt_input
;
2125 /* Turn off polling. */
2130 #ifdef POLL_FOR_INPUT
2131 /* XXX This condition was (read_socket_hook && !interrupt_input),
2132 but read_socket_hook is not global anymore. Let's pretend that
2134 if (!interrupt_input
)
2135 ++poll_suppress_count
;
2139 /* Set the value of poll_suppress_count to COUNT
2140 and start or stop polling accordingly. */
2143 set_poll_suppress_count (int count
)
2145 #ifdef POLL_FOR_INPUT
2146 if (count
== 0 && poll_suppress_count
!= 0)
2148 poll_suppress_count
= 1;
2151 else if (count
!= 0 && poll_suppress_count
== 0)
2155 poll_suppress_count
= count
;
2159 /* Bind polling_period to a value at least N.
2160 But don't decrease it. */
2163 bind_polling_period (int n
)
2165 #ifdef POLL_FOR_INPUT
2166 int new = polling_period
;
2171 stop_other_atimers (poll_timer
);
2173 specbind (Qpolling_period
, make_number (new));
2174 /* Start a new alarm with the new period. */
2179 /* Apply the control modifier to CHARACTER. */
2182 make_ctrl_char (int c
)
2184 /* Save the upper bits here. */
2185 int upper
= c
& ~0177;
2187 if (! ASCII_BYTE_P (c
))
2188 return c
|= ctrl_modifier
;
2192 /* Everything in the columns containing the upper-case letters
2193 denotes a control character. */
2194 if (c
>= 0100 && c
< 0140)
2198 /* Set the shift modifier for a control char
2199 made from a shifted letter. But only for letters! */
2200 if (oc
>= 'A' && oc
<= 'Z')
2201 c
|= shift_modifier
;
2204 /* The lower-case letters denote control characters too. */
2205 else if (c
>= 'a' && c
<= 'z')
2208 /* Include the bits for control and shift
2209 only if the basic ASCII code can't indicate them. */
2213 /* Replace the high bits. */
2214 c
|= (upper
& ~ctrl_modifier
);
2219 /* Display the help-echo property of the character after the mouse pointer.
2220 Either show it in the echo area, or call show-help-function to display
2221 it by other means (maybe in a tooltip).
2223 If HELP is nil, that means clear the previous help echo.
2225 If HELP is a string, display that string. If HELP is a function,
2226 call it with OBJECT and POS as arguments; the function should
2227 return a help string or nil for none. For all other types of HELP,
2228 evaluate it to obtain a string.
2230 WINDOW is the window in which the help was generated, if any.
2231 It is nil if not in a window.
2233 If OBJECT is a buffer, POS is the position in the buffer where the
2234 `help-echo' text property was found.
2236 If OBJECT is an overlay, that overlay has a `help-echo' property,
2237 and POS is the position in the overlay's buffer under the mouse.
2239 If OBJECT is a string (an overlay string or a string displayed with
2240 the `display' property). POS is the position in that string under
2243 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2244 echo overwrites a keystroke echo currently displayed in the echo
2247 Note: this function may only be called with HELP nil or a string
2248 from X code running asynchronously. */
2251 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2252 Lisp_Object pos
, int ok_to_overwrite_keystroke_echo
)
2254 if (!NILP (help
) && !STRINGP (help
))
2256 if (FUNCTIONP (help
))
2258 Lisp_Object args
[4];
2263 help
= safe_call (4, args
);
2266 help
= safe_eval (help
);
2268 if (!STRINGP (help
))
2272 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2273 if (!noninteractive
&& STRINGP (help
))
2275 /* The mouse-fixup-help-message Lisp function can call
2276 mouse_position_hook, which resets the mouse_moved flags.
2277 This causes trouble if we are trying to read a mouse motion
2278 event (i.e., if we are inside a `track-mouse' form), so we
2279 restore the mouse_moved flag. */
2280 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2281 help
= call1 (Qmouse_fixup_help_message
, help
);
2287 if (STRINGP (help
) || NILP (help
))
2289 if (!NILP (Vshow_help_function
))
2290 call1 (Vshow_help_function
, help
);
2291 help_echo_showing_p
= STRINGP (help
);
2297 /* Input of single characters from keyboard */
2299 Lisp_Object
print_help (Lisp_Object object
);
2300 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2301 struct timeval
*end_time
);
2302 static void record_char (Lisp_Object c
);
2304 static Lisp_Object help_form_saved_window_configs
;
2306 read_char_help_form_unwind (Lisp_Object arg
)
2308 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2309 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2310 if (!NILP (window_config
))
2311 Fset_window_configuration (window_config
);
2315 #define STOP_POLLING \
2316 do { if (! polling_stopped_here) stop_polling (); \
2317 polling_stopped_here = 1; } while (0)
2319 #define RESUME_POLLING \
2320 do { if (polling_stopped_here) start_polling (); \
2321 polling_stopped_here = 0; } while (0)
2323 /* read a character from the keyboard; call the redisplay if needed */
2324 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2325 -1 means do not do redisplay, but do do autosaving.
2328 /* The arguments MAPS and NMAPS are for menu prompting.
2329 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2331 PREV_EVENT is the previous input event, or nil if we are reading
2332 the first event of a key sequence (or not reading a key sequence).
2333 If PREV_EVENT is t, that is a "magic" value that says
2334 not to run input methods, but in other respects to act as if
2335 not reading a key sequence.
2337 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2338 if we used a mouse menu to read the input, or zero otherwise. If
2339 USED_MOUSE_MENU is null, we don't dereference it.
2341 Value is -2 when we find input on another keyboard. A second call
2342 to read_char will read it.
2344 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2345 specifying the maximum time to wait until. If no input arrives by
2346 that time, stop waiting and return nil.
2348 Value is t if we showed a menu and the user rejected it. */
2351 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2352 int *used_mouse_menu
, struct timeval
*end_time
)
2354 volatile Lisp_Object c
;
2355 int count
, jmpcount
;
2356 jmp_buf local_getcjmp
;
2358 volatile int key_already_recorded
= 0;
2359 Lisp_Object tem
, save
;
2360 volatile Lisp_Object previous_echo_area_message
;
2361 volatile Lisp_Object also_record
;
2362 volatile int reread
;
2363 struct gcpro gcpro1
, gcpro2
;
2364 int polling_stopped_here
= 0;
2365 struct kboard
*orig_kboard
= current_kboard
;
2369 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2370 before_command_key_count
= this_command_key_count
;
2371 before_command_echo_length
= echo_length ();
2374 previous_echo_area_message
= Qnil
;
2376 GCPRO2 (c
, previous_echo_area_message
);
2381 if (CONSP (Vunread_post_input_method_events
))
2383 c
= XCAR (Vunread_post_input_method_events
);
2384 Vunread_post_input_method_events
2385 = XCDR (Vunread_post_input_method_events
);
2387 /* Undo what read_char_x_menu_prompt did when it unread
2388 additional keys returned by Fx_popup_menu. */
2390 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2398 if (unread_command_char
!= -1)
2400 XSETINT (c
, unread_command_char
);
2401 unread_command_char
= -1;
2407 if (CONSP (Vunread_command_events
))
2409 int was_disabled
= 0;
2411 c
= XCAR (Vunread_command_events
);
2412 Vunread_command_events
= XCDR (Vunread_command_events
);
2416 /* Undo what sit-for did when it unread additional keys
2417 inside universal-argument. */
2420 && EQ (XCAR (c
), Qt
))
2426 /* Undo what read_char_x_menu_prompt did when it unread
2427 additional keys returned by Fx_popup_menu. */
2429 && EQ (XCDR (c
), Qdisabled
)
2430 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2436 /* If the queued event is something that used the mouse,
2437 set used_mouse_menu accordingly. */
2439 /* Also check was_disabled so last-nonmenu-event won't return
2440 a bad value when submenus are involved. (Bug#447) */
2441 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2442 *used_mouse_menu
= 1;
2444 goto reread_for_input_method
;
2447 if (CONSP (Vunread_input_method_events
))
2449 c
= XCAR (Vunread_input_method_events
);
2450 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2452 /* Undo what read_char_x_menu_prompt did when it unread
2453 additional keys returned by Fx_popup_menu. */
2455 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2459 goto reread_for_input_method
;
2462 this_command_key_count_reset
= 0;
2464 if (!NILP (Vexecuting_kbd_macro
))
2466 /* We set this to Qmacro; since that's not a frame, nobody will
2467 try to switch frames on us, and the selected window will
2470 Since this event came from a macro, it would be misleading to
2471 leave internal_last_event_frame set to wherever the last
2472 real event came from. Normally, a switch-frame event selects
2473 internal_last_event_frame after each command is read, but
2474 events read from a macro should never cause a new frame to be
2476 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2478 /* Exit the macro if we are at the end.
2479 Also, some things replace the macro with t
2480 to force an early exit. */
2481 if (EQ (Vexecuting_kbd_macro
, Qt
)
2482 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2488 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2489 if (STRINGP (Vexecuting_kbd_macro
)
2490 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2491 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2493 executing_kbd_macro_index
++;
2498 if (!NILP (unread_switch_frame
))
2500 c
= unread_switch_frame
;
2501 unread_switch_frame
= Qnil
;
2503 /* This event should make it into this_command_keys, and get echoed
2504 again, so we do not set `reread'. */
2508 /* if redisplay was requested */
2509 if (commandflag
>= 0)
2511 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2513 /* If there is pending input, process any events which are not
2514 user-visible, such as X selection_request events. */
2516 || detect_input_pending_run_timers (0))
2517 swallow_events (0); /* may clear input_pending */
2519 /* Redisplay if no pending input. */
2520 while (!input_pending
)
2522 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2523 redisplay_preserve_echo_area (5);
2528 /* Normal case: no input arrived during redisplay. */
2531 /* Input arrived and pre-empted redisplay.
2532 Process any events which are not user-visible. */
2534 /* If that cleared input_pending, try again to redisplay. */
2537 /* Prevent the redisplay we just did
2538 from messing up echoing of the input after the prompt. */
2539 if (commandflag
== 0 && echo_current
)
2540 echo_message_buffer
= echo_area_buffer
[0];
2544 /* Message turns off echoing unless more keystrokes turn it on again.
2546 The code in 20.x for the condition was
2548 1. echo_area_glyphs && *echo_area_glyphs
2549 2. && echo_area_glyphs != current_kboard->echobuf
2550 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2552 (1) means there's a current message displayed
2554 (2) means it's not the message from echoing from the current
2557 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2558 is set to a non-null value. This is done in read_char and it is
2559 set to echo_area_glyphs after a call to echo_char. That means
2560 ok_to_echo_at_next_pause is either null or
2561 current_kboard->echobuf with the appropriate current_kboard at
2564 So, condition (3) means in clear text ok_to_echo_at_next_pause
2565 must be either null, or the current message isn't from echoing at
2566 all, or it's from echoing from a different kboard than the
2569 if (/* There currently is something in the echo area. */
2570 !NILP (echo_area_buffer
[0])
2571 && (/* And it's either not from echoing. */
2572 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2573 /* Or it's an echo from a different kboard. */
2574 || echo_kboard
!= current_kboard
2575 /* Or we explicitly allow overwriting whatever there is. */
2576 || ok_to_echo_at_next_pause
== NULL
))
2581 /* Try reading a character via menu prompting in the minibuf.
2582 Try this before the sit-for, because the sit-for
2583 would do the wrong thing if we are supposed to do
2584 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2585 after a mouse event so don't try a minibuf menu. */
2587 if (nmaps
> 0 && INTERACTIVE
2588 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2589 /* Don't bring up a menu if we already have another event. */
2590 && NILP (Vunread_command_events
)
2591 && unread_command_char
< 0
2592 && !detect_input_pending_run_timers (0))
2594 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2596 if (INTEGERP (c
) && XINT (c
) == -2)
2597 return c
; /* wrong_kboard_jmpbuf */
2601 key_already_recorded
= 1;
2606 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2607 We will do that below, temporarily for short sections of code,
2608 when appropriate. local_getcjmp must be in effect
2609 around any call to sit_for or kbd_buffer_get_event;
2610 it *must not* be in effect when we call redisplay. */
2612 jmpcount
= SPECPDL_INDEX ();
2613 if (_setjmp (local_getcjmp
))
2615 /* Handle quits while reading the keyboard. */
2616 /* We must have saved the outer value of getcjmp here,
2617 so restore it now. */
2618 restore_getcjmp (save_jump
);
2619 unbind_to (jmpcount
, Qnil
);
2620 XSETINT (c
, quit_char
);
2621 internal_last_event_frame
= selected_frame
;
2622 Vlast_event_frame
= internal_last_event_frame
;
2623 /* If we report the quit char as an event,
2624 don't do so more than once. */
2625 if (!NILP (Vinhibit_quit
))
2629 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2630 if (kb
!= current_kboard
)
2632 Lisp_Object link
= kb
->kbd_queue
;
2633 /* We shouldn't get here if we were in single-kboard mode! */
2638 while (CONSP (XCDR (link
)))
2640 if (!NILP (XCDR (link
)))
2644 kb
->kbd_queue
= Fcons (c
, Qnil
);
2646 XSETCDR (link
, Fcons (c
, Qnil
));
2647 kb
->kbd_queue_has_data
= 1;
2648 current_kboard
= kb
;
2649 /* This is going to exit from read_char
2650 so we had better get rid of this frame's stuff. */
2652 return make_number (-2); /* wrong_kboard_jmpbuf */
2658 /* Start idle timers if no time limit is supplied. We don't do it
2659 if a time limit is supplied to avoid an infinite recursion in the
2660 situation where an idle timer calls `sit-for'. */
2663 timer_start_idle ();
2665 /* If in middle of key sequence and minibuffer not active,
2666 start echoing if enough time elapses. */
2668 if (minibuf_level
== 0
2670 && !current_kboard
->immediate_echo
2671 && this_command_key_count
> 0
2673 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2674 && NILP (Fzerop (Vecho_keystrokes
))
2675 && (/* No message. */
2676 NILP (echo_area_buffer
[0])
2677 /* Or empty message. */
2678 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2679 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2680 /* Or already echoing from same kboard. */
2681 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2682 /* Or not echoing before and echoing allowed. */
2683 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2685 /* After a mouse event, start echoing right away.
2686 This is because we are probably about to display a menu,
2687 and we don't want to delay before doing so. */
2688 if (EVENT_HAS_PARAMETERS (prev_event
))
2694 save_getcjmp (save_jump
);
2695 restore_getcjmp (local_getcjmp
);
2696 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2697 restore_getcjmp (save_jump
);
2699 && ! CONSP (Vunread_command_events
))
2704 /* Maybe auto save due to number of keystrokes. */
2706 if (commandflag
!= 0
2707 && auto_save_interval
> 0
2708 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2709 && !detect_input_pending_run_timers (0))
2711 Fdo_auto_save (Qnil
, Qnil
);
2712 /* Hooks can actually change some buffers in auto save. */
2716 /* Try reading using an X menu.
2717 This is never confused with reading using the minibuf
2718 because the recursive call of read_char in read_char_minibuf_menu_prompt
2719 does not pass on any keymaps. */
2721 if (nmaps
> 0 && INTERACTIVE
2722 && !NILP (prev_event
)
2723 && EVENT_HAS_PARAMETERS (prev_event
)
2724 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2725 && !EQ (XCAR (prev_event
), Qtool_bar
)
2726 /* Don't bring up a menu if we already have another event. */
2727 && NILP (Vunread_command_events
)
2728 && unread_command_char
< 0)
2730 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2732 /* Now that we have read an event, Emacs is not idle. */
2739 /* Maybe autosave and/or garbage collect due to idleness. */
2741 if (INTERACTIVE
&& NILP (c
))
2743 int delay_level
, buffer_size
;
2745 /* Slow down auto saves logarithmically in size of current buffer,
2746 and garbage collect while we're at it. */
2747 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2748 last_non_minibuf_size
= Z
- BEG
;
2749 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2751 while (buffer_size
> 64)
2752 delay_level
++, buffer_size
-= buffer_size
>> 2;
2753 if (delay_level
< 4) delay_level
= 4;
2754 /* delay_level is 4 for files under around 50k, 7 at 100k,
2755 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2757 /* Auto save if enough time goes by without input. */
2758 if (commandflag
!= 0
2759 && num_nonmacro_input_events
> last_auto_save
2760 && INTEGERP (Vauto_save_timeout
)
2761 && XINT (Vauto_save_timeout
) > 0)
2764 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2766 save_getcjmp (save_jump
);
2767 restore_getcjmp (local_getcjmp
);
2768 tem0
= sit_for (make_number (timeout
), 1, 1);
2769 restore_getcjmp (save_jump
);
2772 && ! CONSP (Vunread_command_events
))
2774 Fdo_auto_save (Qnil
, Qnil
);
2776 /* If we have auto-saved and there is still no input
2777 available, garbage collect if there has been enough
2778 consing going on to make it worthwhile. */
2779 if (!detect_input_pending_run_timers (0)
2780 && consing_since_gc
> gc_cons_threshold
/ 2)
2781 Fgarbage_collect ();
2788 /* Notify the caller if an autosave hook, or a timer, sentinel or
2789 filter in the sit_for calls above have changed the current
2790 kboard. This could happen if they use the minibuffer or start a
2791 recursive edit, like the fancy splash screen in server.el's
2792 filter. If this longjmp wasn't here, read_key_sequence would
2793 interpret the next key sequence using the wrong translation
2794 tables and function keymaps. */
2795 if (NILP (c
) && current_kboard
!= orig_kboard
)
2798 return make_number (-2); /* wrong_kboard_jmpbuf */
2801 /* If this has become non-nil here, it has been set by a timer
2802 or sentinel or filter. */
2803 if (CONSP (Vunread_command_events
))
2805 c
= XCAR (Vunread_command_events
);
2806 Vunread_command_events
= XCDR (Vunread_command_events
);
2809 /* Read something from current KBOARD's side queue, if possible. */
2813 if (current_kboard
->kbd_queue_has_data
)
2815 if (!CONSP (current_kboard
->kbd_queue
))
2817 c
= XCAR (current_kboard
->kbd_queue
);
2818 current_kboard
->kbd_queue
2819 = XCDR (current_kboard
->kbd_queue
);
2820 if (NILP (current_kboard
->kbd_queue
))
2821 current_kboard
->kbd_queue_has_data
= 0;
2822 input_pending
= readable_events (0);
2823 if (EVENT_HAS_PARAMETERS (c
)
2824 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2825 internal_last_event_frame
= XCAR (XCDR (c
));
2826 Vlast_event_frame
= internal_last_event_frame
;
2830 /* If current_kboard's side queue is empty check the other kboards.
2831 If one of them has data that we have not yet seen here,
2832 switch to it and process the data waiting for it.
2834 Note: if the events queued up for another kboard
2835 have already been seen here, and therefore are not a complete command,
2836 the kbd_queue_has_data field is 0, so we skip that kboard here.
2837 That's to avoid an infinite loop switching between kboards here. */
2838 if (NILP (c
) && !single_kboard
)
2841 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2842 if (kb
->kbd_queue_has_data
)
2844 current_kboard
= kb
;
2845 /* This is going to exit from read_char
2846 so we had better get rid of this frame's stuff. */
2848 return make_number (-2); /* wrong_kboard_jmpbuf */
2856 /* Finally, we read from the main queue,
2857 and if that gives us something we can't use yet, we put it on the
2858 appropriate side queue and try again. */
2867 EMACS_GET_TIME (now
);
2868 if (EMACS_TIME_GE (now
, *end_time
))
2872 /* Actually read a character, waiting if necessary. */
2873 save_getcjmp (save_jump
);
2874 restore_getcjmp (local_getcjmp
);
2876 timer_start_idle ();
2877 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2878 restore_getcjmp (save_jump
);
2880 if (! NILP (c
) && (kb
!= current_kboard
))
2882 Lisp_Object link
= kb
->kbd_queue
;
2885 while (CONSP (XCDR (link
)))
2887 if (!NILP (XCDR (link
)))
2891 kb
->kbd_queue
= Fcons (c
, Qnil
);
2893 XSETCDR (link
, Fcons (c
, Qnil
));
2894 kb
->kbd_queue_has_data
= 1;
2898 current_kboard
= kb
;
2899 /* This is going to exit from read_char
2900 so we had better get rid of this frame's stuff. */
2902 return make_number (-2);
2906 /* Terminate Emacs in batch mode if at eof. */
2907 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2908 Fkill_emacs (make_number (1));
2912 /* Add in any extra modifiers, where appropriate. */
2913 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2914 || ((extra_keyboard_modifiers
& 0177) < ' '
2915 && (extra_keyboard_modifiers
& 0177) != 0))
2916 XSETINT (c
, make_ctrl_char (XINT (c
)));
2918 /* Transfer any other modifier bits directly from
2919 extra_keyboard_modifiers to c. Ignore the actual character code
2920 in the low 16 bits of extra_keyboard_modifiers. */
2921 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2932 if (commandflag
>= 0
2933 && !input_pending
&& !detect_input_pending_run_timers (0))
2941 /* Buffer switch events are only for internal wakeups
2942 so don't show them to the user.
2943 Also, don't record a key if we already did. */
2944 if (BUFFERP (c
) || key_already_recorded
)
2947 /* Process special events within read_char
2948 and loop around to read another event. */
2951 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2956 struct buffer
*prev_buffer
= current_buffer
;
2957 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2958 int was_locked
= single_kboard
;
2959 int count
= SPECPDL_INDEX ();
2960 record_single_kboard_state ();
2963 last_input_event
= c
;
2964 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2966 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2967 /* We stopped being idle for this event; undo that. This
2968 prevents automatic window selection (under
2969 mouse_autoselect_window from acting as a real input event, for
2970 example banishing the mouse under mouse-avoidance-mode. */
2971 timer_resume_idle ();
2973 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2974 /* Resume allowing input from any kboard, if that was true before. */
2976 any_kboard_state ();
2977 unbind_to (count
, Qnil
);
2980 if (current_buffer
!= prev_buffer
)
2982 /* The command may have changed the keymaps. Pretend there
2983 is input in another keyboard and return. This will
2984 recalculate keymaps. */
2985 c
= make_number (-2);
2992 /* Handle things that only apply to characters. */
2995 /* If kbd_buffer_get_event gave us an EOF, return that. */
2999 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3000 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3001 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3002 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3003 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3007 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3008 /* nil in keyboard-translate-table means no translation. */
3014 /* If this event is a mouse click in the menu bar,
3015 return just menu-bar for now. Modify the mouse click event
3016 so we won't do this twice, then queue it up. */
3017 if (EVENT_HAS_PARAMETERS (c
)
3019 && CONSP (EVENT_START (c
))
3020 && CONSP (XCDR (EVENT_START (c
))))
3024 posn
= POSN_POSN (EVENT_START (c
));
3025 /* Handle menu-bar events:
3026 insert the dummy prefix event `menu-bar'. */
3027 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3029 /* Change menu-bar to (menu-bar) as the event "position". */
3030 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3033 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3038 /* Store these characters into recent_keys, the dribble file if any,
3039 and the keyboard macro being defined, if any. */
3041 if (! NILP (also_record
))
3042 record_char (also_record
);
3044 /* Wipe the echo area.
3045 But first, if we are about to use an input method,
3046 save the echo area contents for it to refer to. */
3048 && ! NILP (Vinput_method_function
)
3049 && (unsigned) XINT (c
) >= ' '
3050 && (unsigned) XINT (c
) != 127
3051 && (unsigned) XINT (c
) < 256)
3053 previous_echo_area_message
= Fcurrent_message ();
3054 Vinput_method_previous_message
= previous_echo_area_message
;
3057 /* Now wipe the echo area, except for help events which do their
3058 own stuff with the echo area. */
3060 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3061 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3063 if (!NILP (echo_area_buffer
[0]))
3064 safe_run_hooks (Qecho_area_clear_hook
);
3065 clear_message (1, 0);
3068 reread_for_input_method
:
3070 /* Pass this to the input method, if appropriate. */
3072 && ! NILP (Vinput_method_function
)
3073 /* Don't run the input method within a key sequence,
3074 after the first event of the key sequence. */
3075 && NILP (prev_event
)
3076 && (unsigned) XINT (c
) >= ' '
3077 && (unsigned) XINT (c
) != 127
3078 && (unsigned) XINT (c
) < 256)
3081 int key_count
, key_count_reset
;
3082 struct gcpro gcpro1
;
3083 int count
= SPECPDL_INDEX ();
3085 /* Save the echo status. */
3086 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3087 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3088 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3089 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3092 if (before_command_restore_flag
)
3094 this_command_key_count
= before_command_key_count_1
;
3095 if (this_command_key_count
< this_single_command_key_start
)
3096 this_single_command_key_start
= this_command_key_count
;
3097 echo_truncate (before_command_echo_length_1
);
3098 before_command_restore_flag
= 0;
3102 /* Save the this_command_keys status. */
3103 key_count
= this_command_key_count
;
3104 key_count_reset
= this_command_key_count_reset
;
3107 keys
= Fcopy_sequence (this_command_keys
);
3112 /* Clear out this_command_keys. */
3113 this_command_key_count
= 0;
3114 this_command_key_count_reset
= 0;
3116 /* Now wipe the echo area. */
3117 if (!NILP (echo_area_buffer
[0]))
3118 safe_run_hooks (Qecho_area_clear_hook
);
3119 clear_message (1, 0);
3122 /* If we are not reading a key sequence,
3123 never use the echo area. */
3126 specbind (Qinput_method_use_echo_area
, Qt
);
3129 /* Call the input method. */
3130 tem
= call1 (Vinput_method_function
, c
);
3132 tem
= unbind_to (count
, tem
);
3134 /* Restore the saved echoing state
3135 and this_command_keys state. */
3136 this_command_key_count
= key_count
;
3137 this_command_key_count_reset
= key_count_reset
;
3139 this_command_keys
= keys
;
3142 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3143 current_kboard
->echo_string
= saved_echo_string
;
3144 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3145 if (saved_immediate_echo
)
3150 /* The input method can return no events. */
3153 /* Bring back the previous message, if any. */
3154 if (! NILP (previous_echo_area_message
))
3155 message_with_string ("%s", previous_echo_area_message
, 0);
3158 /* It returned one event or more. */
3160 Vunread_post_input_method_events
3161 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3166 /* Display help if not echoing. */
3167 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3169 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3170 Lisp_Object help
, object
, position
, window
, tem
;
3172 tem
= Fcdr (XCDR (c
));
3175 window
= Fcar (tem
);
3177 object
= Fcar (tem
);
3179 position
= Fcar (tem
);
3181 show_help_echo (help
, window
, object
, position
, 0);
3183 /* We stopped being idle for this event; undo that. */
3185 timer_resume_idle ();
3189 if ((! reread
|| this_command_key_count
== 0
3190 || this_command_key_count_reset
)
3194 /* Don't echo mouse motion events. */
3195 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3196 && NILP (Fzerop (Vecho_keystrokes
))
3197 && ! (EVENT_HAS_PARAMETERS (c
)
3198 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3201 if (! NILP (also_record
))
3202 echo_char (also_record
);
3203 /* Once we reread a character, echoing can happen
3204 the next time we pause to read a new one. */
3205 ok_to_echo_at_next_pause
= current_kboard
;
3208 /* Record this character as part of the current key. */
3209 add_command_key (c
);
3210 if (! NILP (also_record
))
3211 add_command_key (also_record
);
3214 last_input_event
= c
;
3217 /* Process the help character specially if enabled */
3218 if (!NILP (Vhelp_form
) && help_char_p (c
))
3221 count
= SPECPDL_INDEX ();
3223 help_form_saved_window_configs
3224 = Fcons (Fcurrent_window_configuration (Qnil
),
3225 help_form_saved_window_configs
);
3226 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3228 tem0
= Feval (Vhelp_form
);
3230 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3235 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3236 if (EVENT_HAS_PARAMETERS (c
)
3237 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3238 XSETCAR (help_form_saved_window_configs
, Qnil
);
3240 while (BUFFERP (c
));
3241 /* Remove the help from the frame */
3242 unbind_to (count
, Qnil
);
3245 if (EQ (c
, make_number (040)))
3249 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3250 while (BUFFERP (c
));
3259 /* Record a key that came from a mouse menu.
3260 Record it for echoing, for this-command-keys, and so on. */
3263 record_menu_key (Lisp_Object c
)
3265 /* Wipe the echo area. */
3266 clear_message (1, 0);
3271 before_command_key_count
= this_command_key_count
;
3272 before_command_echo_length
= echo_length ();
3275 /* Don't echo mouse motion events. */
3276 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3277 && NILP (Fzerop (Vecho_keystrokes
)))
3281 /* Once we reread a character, echoing can happen
3282 the next time we pause to read a new one. */
3283 ok_to_echo_at_next_pause
= 0;
3286 /* Record this character as part of the current key. */
3287 add_command_key (c
);
3289 /* Re-reading in the middle of a command */
3290 last_input_event
= c
;
3294 /* Return 1 if should recognize C as "the help character". */
3297 help_char_p (Lisp_Object c
)
3301 if (EQ (c
, Vhelp_char
))
3303 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3304 if (EQ (c
, XCAR (tail
)))
3309 /* Record the input event C in various ways. */
3312 record_char (Lisp_Object c
)
3316 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3318 /* To avoid filling recent_keys with help-echo and mouse-movement
3319 events, we filter out repeated help-echo events, only store the
3320 first and last in a series of mouse-movement events, and don't
3321 store repeated help-echo events which are only separated by
3322 mouse-movement events. */
3324 Lisp_Object ev1
, ev2
, ev3
;
3327 if ((ix1
= recent_keys_index
- 1) < 0)
3328 ix1
= NUM_RECENT_KEYS
- 1;
3329 ev1
= AREF (recent_keys
, ix1
);
3331 if ((ix2
= ix1
- 1) < 0)
3332 ix2
= NUM_RECENT_KEYS
- 1;
3333 ev2
= AREF (recent_keys
, ix2
);
3335 if ((ix3
= ix2
- 1) < 0)
3336 ix3
= NUM_RECENT_KEYS
- 1;
3337 ev3
= AREF (recent_keys
, ix3
);
3339 if (EQ (XCAR (c
), Qhelp_echo
))
3341 /* Don't record `help-echo' in recent_keys unless it shows some help
3342 message, and a different help than the previously recorded
3344 Lisp_Object help
, last_help
;
3346 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3347 if (!STRINGP (help
))
3349 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3350 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3352 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3353 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3354 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3356 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3357 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3358 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3359 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3362 else if (EQ (XCAR (c
), Qmouse_movement
))
3364 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3365 So additional mouse movement events replace the last element. */
3366 Lisp_Object last_window
, window
;
3368 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3369 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3370 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3371 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3372 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3374 ASET (recent_keys
, ix1
, c
);
3380 store_kbd_macro_char (c
);
3385 ASET (recent_keys
, recent_keys_index
, c
);
3386 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3387 recent_keys_index
= 0;
3389 else if (recorded
< 0)
3391 /* We need to remove one or two events from recent_keys.
3392 To do this, we simply put nil at those events and move the
3393 recent_keys_index backwards over those events. Usually,
3394 users will never see those nil events, as they will be
3395 overwritten by the command keys entered to see recent_keys
3398 while (recorded
++ < 0 && total_keys
> 0)
3400 if (total_keys
< NUM_RECENT_KEYS
)
3402 if (--recent_keys_index
< 0)
3403 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3404 ASET (recent_keys
, recent_keys_index
, Qnil
);
3408 num_nonmacro_input_events
++;
3410 /* Write c to the dribble file. If c is a lispy event, write
3411 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3412 If you, dear reader, have a better idea, you've got the source. :-) */
3418 if (XUINT (c
) < 0x100)
3419 putc (XINT (c
), dribble
);
3421 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3425 Lisp_Object dribblee
;
3427 /* If it's a structured event, take the event header. */
3428 dribblee
= EVENT_HEAD (c
);
3430 if (SYMBOLP (dribblee
))
3432 putc ('<', dribble
);
3433 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3434 SBYTES (SYMBOL_NAME (dribblee
)),
3436 putc ('>', dribble
);
3446 print_help (Lisp_Object object
)
3448 struct buffer
*old
= current_buffer
;
3449 Fprinc (object
, Qnil
);
3450 set_buffer_internal (XBUFFER (Vstandard_output
));
3451 call0 (intern ("help-mode"));
3452 set_buffer_internal (old
);
3456 /* Copy out or in the info on where C-g should throw to.
3457 This is used when running Lisp code from within get_char,
3458 in case get_char is called recursively.
3459 See read_process_output. */
3462 save_getcjmp (jmp_buf temp
)
3464 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3468 restore_getcjmp (jmp_buf temp
)
3470 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3473 /* Low level keyboard/mouse input.
3474 kbd_buffer_store_event places events in kbd_buffer, and
3475 kbd_buffer_get_event retrieves them. */
3477 /* Return true if there are any events in the queue that read-char
3478 would return. If this returns false, a read-char would block. */
3480 readable_events (int flags
)
3483 /* Check whether a D-Bus message has arrived. */
3484 if (xd_pending_messages () > 0)
3486 #endif /* HAVE_DBUS */
3488 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3491 /* If the buffer contains only FOCUS_IN_EVENT events, and
3492 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3493 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3495 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3496 #ifdef USE_TOOLKIT_SCROLL_BARS
3497 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3501 struct input_event
*event
;
3503 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3510 #ifdef USE_TOOLKIT_SCROLL_BARS
3511 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3513 event
->kind
== FOCUS_IN_EVENT
)
3514 #ifdef USE_TOOLKIT_SCROLL_BARS
3515 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3516 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3517 && event
->part
== scroll_bar_handle
3518 && event
->modifiers
== 0)
3523 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3526 while (event
!= kbd_store_ptr
);
3532 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3533 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3534 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3539 if (current_kboard
->kbd_queue_has_data
)
3545 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3546 if (kb
->kbd_queue_has_data
)
3552 /* Set this for debugging, to have a way to get out */
3556 event_to_kboard (struct input_event
*event
)
3559 frame
= event
->frame_or_window
;
3561 frame
= XCAR (frame
);
3562 else if (WINDOWP (frame
))
3563 frame
= WINDOW_FRAME (XWINDOW (frame
));
3565 /* There are still some events that don't set this field.
3566 For now, just ignore the problem.
3567 Also ignore dead frames here. */
3568 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3571 return FRAME_KBOARD (XFRAME (frame
));
3574 /* Return the number of slots occupied in kbd_buffer. */
3577 kbd_buffer_nr_stored (void)
3579 return kbd_fetch_ptr
== kbd_store_ptr
3581 : (kbd_fetch_ptr
< kbd_store_ptr
3582 ? kbd_store_ptr
- kbd_fetch_ptr
3583 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3584 + (kbd_store_ptr
- kbd_buffer
)));
3587 Lisp_Object Vthrow_on_input
;
3589 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3592 kbd_buffer_store_event (register struct input_event
*event
)
3594 kbd_buffer_store_event_hold (event
, 0);
3597 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3599 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3600 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3601 Else, if EVENT is a quit event, store the quit event
3602 in HOLD_QUIT, and return (thus ignoring further events).
3604 This is used in read_avail_input to postpone the processing
3605 of the quit event until all subsequent input events have been
3606 parsed (and discarded).
3610 kbd_buffer_store_event_hold (register struct input_event
*event
,
3611 struct input_event
*hold_quit
)
3613 if (event
->kind
== NO_EVENT
)
3616 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3619 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3621 register int c
= event
->code
& 0377;
3623 if (event
->modifiers
& ctrl_modifier
)
3624 c
= make_ctrl_char (c
);
3626 c
|= (event
->modifiers
3627 & (meta_modifier
| alt_modifier
3628 | hyper_modifier
| super_modifier
));
3632 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3633 struct input_event
*sp
;
3635 if (single_kboard
&& kb
!= current_kboard
)
3638 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3639 Fcons (make_number (c
), Qnil
));
3640 kb
->kbd_queue_has_data
= 1;
3641 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3643 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3646 if (event_to_kboard (sp
) == kb
)
3648 sp
->kind
= NO_EVENT
;
3649 sp
->frame_or_window
= Qnil
;
3658 memcpy (hold_quit
, event
, sizeof (*event
));
3662 /* If this results in a quit_char being returned to Emacs as
3663 input, set Vlast_event_frame properly. If this doesn't
3664 get returned to Emacs as an event, the next event read
3665 will set Vlast_event_frame again, so this is safe to do. */
3669 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3671 focus
= event
->frame_or_window
;
3672 internal_last_event_frame
= focus
;
3673 Vlast_event_frame
= focus
;
3676 last_event_timestamp
= event
->timestamp
;
3677 handle_interrupt ();
3681 if (c
&& c
== stop_character
)
3687 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3688 Just ignore the second one. */
3689 else if (event
->kind
== BUFFER_SWITCH_EVENT
3690 && kbd_fetch_ptr
!= kbd_store_ptr
3691 && ((kbd_store_ptr
== kbd_buffer
3692 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3693 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3696 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3697 kbd_store_ptr
= kbd_buffer
;
3699 /* Don't let the very last slot in the buffer become full,
3700 since that would make the two pointers equal,
3701 and that is indistinguishable from an empty buffer.
3702 Discard the event if it would fill the last slot. */
3703 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3705 *kbd_store_ptr
= *event
;
3707 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3709 /* Don't read keyboard input until we have processed kbd_buffer.
3710 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3711 hold_keyboard_input ();
3713 if (!noninteractive
)
3714 signal (SIGIO
, SIG_IGN
);
3720 /* If we're inside while-no-input, and this event qualifies
3721 as input, set quit-flag to cause an interrupt. */
3722 if (!NILP (Vthrow_on_input
)
3723 && event
->kind
!= FOCUS_IN_EVENT
3724 && event
->kind
!= HELP_EVENT
3725 && event
->kind
!= DEICONIFY_EVENT
)
3727 Vquit_flag
= Vthrow_on_input
;
3728 /* If we're inside a function that wants immediate quits,
3730 if (immediate_quit
&& NILP (Vinhibit_quit
))
3740 /* Put an input event back in the head of the event queue. */
3743 kbd_buffer_unget_event (register struct input_event
*event
)
3745 if (kbd_fetch_ptr
== kbd_buffer
)
3746 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3748 /* Don't let the very last slot in the buffer become full, */
3749 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3752 *kbd_fetch_ptr
= *event
;
3757 /* Generate HELP_EVENT input_events in BUFP which has room for
3758 SIZE events. If there's not enough room in BUFP, ignore this
3761 HELP is the help form.
3763 FRAME is the frame on which the help is generated. OBJECT is the
3764 Lisp object where the help was found (a buffer, a string, an
3765 overlay, or nil if neither from a string nor from a buffer. POS is
3766 the position within OBJECT where the help was found.
3768 Value is the number of input_events generated. */
3771 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3772 Lisp_Object object
, int pos
)
3774 struct input_event event
;
3778 event
.kind
= HELP_EVENT
;
3779 event
.frame_or_window
= frame
;
3781 event
.x
= WINDOWP (window
) ? window
: frame
;
3784 kbd_buffer_store_event (&event
);
3788 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3791 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3793 struct input_event event
;
3795 event
.kind
= HELP_EVENT
;
3796 event
.frame_or_window
= frame
;
3801 kbd_buffer_store_event (&event
);
3805 /* Discard any mouse events in the event buffer by setting them to
3808 discard_mouse_events (void)
3810 struct input_event
*sp
;
3811 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3813 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3816 if (sp
->kind
== MOUSE_CLICK_EVENT
3817 || sp
->kind
== WHEEL_EVENT
3818 || sp
->kind
== HORIZ_WHEEL_EVENT
3820 || sp
->kind
== GPM_CLICK_EVENT
3822 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3824 sp
->kind
= NO_EVENT
;
3830 /* Return non-zero if there are any real events waiting in the event
3831 buffer, not counting `NO_EVENT's.
3833 If DISCARD is non-zero, discard NO_EVENT events at the front of
3834 the input queue, possibly leaving the input queue empty if there
3835 are no real input events. */
3838 kbd_buffer_events_waiting (int discard
)
3840 struct input_event
*sp
;
3842 for (sp
= kbd_fetch_ptr
;
3843 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3846 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3853 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3857 /* Clear input event EVENT. */
3860 clear_event (struct input_event
*event
)
3862 event
->kind
= NO_EVENT
;
3866 /* Read one event from the event buffer, waiting if necessary.
3867 The value is a Lisp object representing the event.
3868 The value is nil for an event that should be ignored,
3869 or that was handled here.
3870 We always read and discard one event. */
3873 kbd_buffer_get_event (KBOARD
**kbp
,
3874 int *used_mouse_menu
,
3875 struct timeval
*end_time
)
3880 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3882 /* Start reading input again, we have processed enough so we can
3883 accept new events again. */
3884 unhold_keyboard_input ();
3886 if (!noninteractive
)
3887 signal (SIGIO
, input_available_signal
);
3893 /* In case we are running as a daemon, only do this before
3894 detaching from the terminal. */
3895 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3899 *kbp
= current_kboard
;
3903 /* Wait until there is input available. */
3906 /* Break loop if there's an unread command event. Needed in
3907 moused window autoselection which uses a timer to insert such
3909 if (CONSP (Vunread_command_events
))
3912 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3914 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3915 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3919 /* If the quit flag is set, then read_char will return
3920 quit_char, so that counts as "available input." */
3921 if (!NILP (Vquit_flag
))
3922 quit_throw_to_read_char ();
3924 /* One way or another, wait until input is available; then, if
3925 interrupt handlers have not read it, read it now. */
3927 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3931 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3933 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3934 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3939 EMACS_TIME duration
;
3940 EMACS_GET_TIME (duration
);
3941 if (EMACS_TIME_GE (duration
, *end_time
))
3942 return Qnil
; /* finished waiting */
3945 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3946 wait_reading_process_output (EMACS_SECS (duration
),
3947 EMACS_USECS (duration
),
3948 -1, 1, Qnil
, NULL
, 0);
3952 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3954 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3955 /* Pass 1 for EXPECT since we just waited to have input. */
3956 read_avail_input (1);
3959 if (CONSP (Vunread_command_events
))
3962 first
= XCAR (Vunread_command_events
);
3963 Vunread_command_events
= XCDR (Vunread_command_events
);
3964 *kbp
= current_kboard
;
3968 /* At this point, we know that there is a readable event available
3969 somewhere. If the event queue is empty, then there must be a
3970 mouse movement enabled and available. */
3971 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3973 struct input_event
*event
;
3975 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3979 last_event_timestamp
= event
->timestamp
;
3981 *kbp
= event_to_kboard (event
);
3983 *kbp
= current_kboard
; /* Better than returning null ptr? */
3987 /* These two kinds of events get special handling
3988 and don't actually appear to the command loop.
3989 We return nil for them. */
3990 if (event
->kind
== SELECTION_REQUEST_EVENT
3991 || event
->kind
== SELECTION_CLEAR_EVENT
)
3994 struct input_event copy
;
3996 /* Remove it from the buffer before processing it,
3997 since otherwise swallow_events will see it
3998 and process it again. */
4000 kbd_fetch_ptr
= event
+ 1;
4001 input_pending
= readable_events (0);
4002 x_handle_selection_event (©
);
4004 /* We're getting selection request events, but we don't have
4010 #if defined (HAVE_NS)
4011 else if (event
->kind
== NS_TEXT_EVENT
)
4013 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4014 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4016 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4017 kbd_fetch_ptr
= event
+ 1;
4018 if (used_mouse_menu
)
4019 *used_mouse_menu
= 1;
4023 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4024 || defined (HAVE_NS)
4025 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4027 /* Make an event (delete-frame (FRAME)). */
4028 obj
= Fcons (event
->frame_or_window
, Qnil
);
4029 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4030 kbd_fetch_ptr
= event
+ 1;
4033 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4034 || defined (HAVE_NS)
4035 else if (event
->kind
== ICONIFY_EVENT
)
4037 /* Make an event (iconify-frame (FRAME)). */
4038 obj
= Fcons (event
->frame_or_window
, Qnil
);
4039 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4040 kbd_fetch_ptr
= event
+ 1;
4042 else if (event
->kind
== DEICONIFY_EVENT
)
4044 /* Make an event (make-frame-visible (FRAME)). */
4045 obj
= Fcons (event
->frame_or_window
, Qnil
);
4046 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4047 kbd_fetch_ptr
= event
+ 1;
4050 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4052 /* The value doesn't matter here; only the type is tested. */
4053 XSETBUFFER (obj
, current_buffer
);
4054 kbd_fetch_ptr
= event
+ 1;
4056 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4057 || defined(HAVE_NS) || defined (USE_GTK)
4058 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4060 kbd_fetch_ptr
= event
+ 1;
4061 input_pending
= readable_events (0);
4062 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4063 x_activate_menubar (XFRAME (event
->frame_or_window
));
4066 #if defined (WINDOWSNT)
4067 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4069 /* Make an event (language-change (FRAME CHARSET LCID)). */
4070 obj
= Fcons (event
->frame_or_window
, Qnil
);
4071 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4072 kbd_fetch_ptr
= event
+ 1;
4075 else if (event
->kind
== SAVE_SESSION_EVENT
)
4077 obj
= Fcons (Qsave_session
, Qnil
);
4078 kbd_fetch_ptr
= event
+ 1;
4080 /* Just discard these, by returning nil.
4081 With MULTI_KBOARD, these events are used as placeholders
4082 when we need to randomly delete events from the queue.
4083 (They shouldn't otherwise be found in the buffer,
4084 but on some machines it appears they do show up
4085 even without MULTI_KBOARD.) */
4086 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4087 mouse events during a popup-menu call. */
4088 else if (event
->kind
== NO_EVENT
)
4089 kbd_fetch_ptr
= event
+ 1;
4090 else if (event
->kind
== HELP_EVENT
)
4092 Lisp_Object object
, position
, help
, frame
, window
;
4094 frame
= event
->frame_or_window
;
4095 object
= event
->arg
;
4096 position
= make_number (event
->code
);
4099 clear_event (event
);
4101 kbd_fetch_ptr
= event
+ 1;
4102 if (!WINDOWP (window
))
4104 obj
= Fcons (Qhelp_echo
,
4105 list5 (frame
, help
, window
, object
, position
));
4107 else if (event
->kind
== FOCUS_IN_EVENT
)
4109 /* Notification of a FocusIn event. The frame receiving the
4110 focus is in event->frame_or_window. Generate a
4111 switch-frame event if necessary. */
4112 Lisp_Object frame
, focus
;
4114 frame
= event
->frame_or_window
;
4115 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4119 if (!EQ (frame
, internal_last_event_frame
)
4120 && !EQ (frame
, selected_frame
))
4121 obj
= make_lispy_switch_frame (frame
);
4122 internal_last_event_frame
= frame
;
4123 kbd_fetch_ptr
= event
+ 1;
4126 else if (event
->kind
== DBUS_EVENT
)
4128 obj
= make_lispy_event (event
);
4129 kbd_fetch_ptr
= event
+ 1;
4132 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4134 obj
= make_lispy_event (event
);
4135 kbd_fetch_ptr
= event
+ 1;
4139 /* If this event is on a different frame, return a switch-frame this
4140 time, and leave the event in the queue for next time. */
4144 frame
= event
->frame_or_window
;
4146 frame
= XCAR (frame
);
4147 else if (WINDOWP (frame
))
4148 frame
= WINDOW_FRAME (XWINDOW (frame
));
4150 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4154 if (! EQ (frame
, internal_last_event_frame
)
4155 && !EQ (frame
, selected_frame
))
4156 obj
= make_lispy_switch_frame (frame
);
4157 internal_last_event_frame
= frame
;
4159 /* If we didn't decide to make a switch-frame event, go ahead
4160 and build a real event from the queue entry. */
4164 obj
= make_lispy_event (event
);
4166 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4167 || defined(HAVE_NS) || defined (USE_GTK)
4168 /* If this was a menu selection, then set the flag to inhibit
4169 writing to last_nonmenu_event. Don't do this if the event
4170 we're returning is (menu-bar), though; that indicates the
4171 beginning of the menu sequence, and we might as well leave
4172 that as the `event with parameters' for this selection. */
4174 && !EQ (event
->frame_or_window
, event
->arg
)
4175 && (event
->kind
== MENU_BAR_EVENT
4176 || event
->kind
== TOOL_BAR_EVENT
))
4177 *used_mouse_menu
= 1;
4180 /* certain system events are non-key events */
4182 && event
->kind
== NS_NONKEY_EVENT
)
4183 *used_mouse_menu
= 1;
4186 /* Wipe out this event, to catch bugs. */
4187 clear_event (event
);
4188 kbd_fetch_ptr
= event
+ 1;
4192 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4193 /* Try generating a mouse motion event. */
4194 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4196 FRAME_PTR f
= some_mouse_moved ();
4197 Lisp_Object bar_window
;
4198 enum scroll_bar_part part
;
4202 *kbp
= current_kboard
;
4203 /* Note that this uses F to determine which terminal to look at.
4204 If there is no valid info, it does not store anything
4205 so x remains nil. */
4208 /* XXX Can f or mouse_position_hook be NULL here? */
4209 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4210 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4211 &part
, &x
, &y
, &time
);
4215 /* Decide if we should generate a switch-frame event. Don't
4216 generate switch-frame events for motion outside of all Emacs
4222 frame
= FRAME_FOCUS_FRAME (f
);
4224 XSETFRAME (frame
, f
);
4226 if (! EQ (frame
, internal_last_event_frame
)
4227 && !EQ (frame
, selected_frame
))
4228 obj
= make_lispy_switch_frame (frame
);
4229 internal_last_event_frame
= frame
;
4232 /* If we didn't decide to make a switch-frame event, go ahead and
4233 return a mouse-motion event. */
4234 if (!NILP (x
) && NILP (obj
))
4235 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4237 #endif /* HAVE_MOUSE || HAVE GPM */
4239 /* We were promised by the above while loop that there was
4240 something for us to read! */
4243 input_pending
= readable_events (0);
4245 Vlast_event_frame
= internal_last_event_frame
;
4250 /* Process any events that are not user-visible,
4251 then return, without reading any user-visible events. */
4254 swallow_events (int do_display
)
4258 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4260 struct input_event
*event
;
4262 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4266 last_event_timestamp
= event
->timestamp
;
4268 /* These two kinds of events get special handling
4269 and don't actually appear to the command loop. */
4270 if (event
->kind
== SELECTION_REQUEST_EVENT
4271 || event
->kind
== SELECTION_CLEAR_EVENT
)
4274 struct input_event copy
;
4276 /* Remove it from the buffer before processing it,
4277 since otherwise swallow_events called recursively could see it
4278 and process it again. */
4280 kbd_fetch_ptr
= event
+ 1;
4281 input_pending
= readable_events (0);
4282 x_handle_selection_event (©
);
4284 /* We're getting selection request events, but we don't have
4293 old_timers_run
= timers_run
;
4294 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4296 if (timers_run
!= old_timers_run
&& do_display
)
4297 redisplay_preserve_echo_area (7);
4300 /* Record the start of when Emacs is idle,
4301 for the sake of running idle-time timers. */
4304 timer_start_idle (void)
4308 /* If we are already in the idle state, do nothing. */
4309 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4312 EMACS_GET_TIME (timer_idleness_start_time
);
4314 timer_last_idleness_start_time
= timer_idleness_start_time
;
4316 /* Mark all idle-time timers as once again candidates for running. */
4317 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4321 timer
= XCAR (timers
);
4323 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4325 XVECTOR (timer
)->contents
[0] = Qnil
;
4329 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4332 timer_stop_idle (void)
4334 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4337 /* Resume idle timer from last idle start time. */
4340 timer_resume_idle (void)
4342 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4345 timer_idleness_start_time
= timer_last_idleness_start_time
;
4348 /* This is only for debugging. */
4349 struct input_event last_timer_event
;
4351 /* List of elisp functions to call, delayed because they were generated in
4352 a context where Elisp could not be safely run (e.g. redisplay, signal,
4353 ...). Each element has the form (FUN . ARGS). */
4354 Lisp_Object pending_funcalls
;
4356 /* Check whether a timer has fired. To prevent larger problems we simply
4357 disregard elements that are not proper timers. Do not make a circular
4358 timer list for the time being.
4360 Returns the time to wait until the next timer fires. If a
4361 timer is triggering now, return zero.
4362 If no timer is active, return -1.
4364 If a timer is ripe, we run it, with quitting turned off.
4365 In that case we return 0 to indicate that a new timer_check_2 call
4369 timer_check_2 (void)
4371 EMACS_TIME nexttime
;
4372 EMACS_TIME now
, idleness_now
;
4373 Lisp_Object timers
, idle_timers
, chosen_timer
;
4374 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4376 EMACS_SET_SECS (nexttime
, -1);
4377 EMACS_SET_USECS (nexttime
, -1);
4379 /* Always consider the ordinary timers. */
4380 timers
= Vtimer_list
;
4381 /* Consider the idle timers only if Emacs is idle. */
4382 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4383 idle_timers
= Vtimer_idle_list
;
4386 chosen_timer
= Qnil
;
4387 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4389 /* First run the code that was delayed. */
4390 while (CONSP (pending_funcalls
))
4392 Lisp_Object funcall
= XCAR (pending_funcalls
);
4393 pending_funcalls
= XCDR (pending_funcalls
);
4394 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4397 if (CONSP (timers
) || CONSP (idle_timers
))
4399 EMACS_GET_TIME (now
);
4400 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4401 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4404 while (CONSP (timers
) || CONSP (idle_timers
))
4406 Lisp_Object
*vector
;
4407 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4408 EMACS_TIME timer_time
, idle_timer_time
;
4409 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4411 /* Skip past invalid timers and timers already handled. */
4414 timer
= XCAR (timers
);
4415 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4417 timers
= XCDR (timers
);
4420 vector
= XVECTOR (timer
)->contents
;
4422 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4423 || !INTEGERP (vector
[3])
4424 || ! NILP (vector
[0]))
4426 timers
= XCDR (timers
);
4430 if (!NILP (idle_timers
))
4432 timer
= XCAR (idle_timers
);
4433 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4435 idle_timers
= XCDR (idle_timers
);
4438 vector
= XVECTOR (timer
)->contents
;
4440 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4441 || !INTEGERP (vector
[3])
4442 || ! NILP (vector
[0]))
4444 idle_timers
= XCDR (idle_timers
);
4449 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4450 based on the next ordinary timer.
4451 TIMER_DIFFERENCE is the distance in time from NOW to when
4452 this timer becomes ripe (negative if it's already ripe). */
4455 timer
= XCAR (timers
);
4456 vector
= XVECTOR (timer
)->contents
;
4457 EMACS_SET_SECS (timer_time
,
4458 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4459 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4460 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4463 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4464 based on the next idle timer. */
4465 if (!NILP (idle_timers
))
4467 idle_timer
= XCAR (idle_timers
);
4468 vector
= XVECTOR (idle_timer
)->contents
;
4469 EMACS_SET_SECS (idle_timer_time
,
4470 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4471 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4472 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4475 /* Decide which timer is the next timer,
4476 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4477 Also step down the list where we found that timer. */
4479 if (! NILP (timers
) && ! NILP (idle_timers
))
4482 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4483 if (EMACS_TIME_NEG_P (temp
))
4485 chosen_timer
= timer
;
4486 timers
= XCDR (timers
);
4487 difference
= timer_difference
;
4491 chosen_timer
= idle_timer
;
4492 idle_timers
= XCDR (idle_timers
);
4493 difference
= idle_timer_difference
;
4496 else if (! NILP (timers
))
4498 chosen_timer
= timer
;
4499 timers
= XCDR (timers
);
4500 difference
= timer_difference
;
4504 chosen_timer
= idle_timer
;
4505 idle_timers
= XCDR (idle_timers
);
4506 difference
= idle_timer_difference
;
4508 vector
= XVECTOR (chosen_timer
)->contents
;
4510 /* If timer is ripe, run it if it hasn't been run. */
4511 if (EMACS_TIME_NEG_P (difference
)
4512 || (EMACS_SECS (difference
) == 0
4513 && EMACS_USECS (difference
) == 0))
4515 if (NILP (vector
[0]))
4517 int count
= SPECPDL_INDEX ();
4518 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4520 /* Mark the timer as triggered to prevent problems if the lisp
4521 code fails to reschedule it right. */
4524 specbind (Qinhibit_quit
, Qt
);
4526 call1 (Qtimer_event_handler
, chosen_timer
);
4527 Vdeactivate_mark
= old_deactivate_mark
;
4529 unbind_to (count
, Qnil
);
4531 /* Since we have handled the event,
4532 we don't need to tell the caller to wake up and do it. */
4533 /* But the caller must still wait for the next timer, so
4534 return 0 to indicate that. */
4537 EMACS_SET_SECS (nexttime
, 0);
4538 EMACS_SET_USECS (nexttime
, 0);
4541 /* When we encounter a timer that is still waiting,
4542 return the amount of time to wait before it is ripe. */
4549 /* No timers are pending in the future. */
4550 /* Return 0 if we generated an event, and -1 if not. */
4556 /* Check whether a timer has fired. To prevent larger problems we simply
4557 disregard elements that are not proper timers. Do not make a circular
4558 timer list for the time being.
4560 Returns the time to wait until the next timer fires.
4561 If no timer is active, return -1.
4563 As long as any timer is ripe, we run it.
4565 DO_IT_NOW is now ignored. It used to mean that we should
4566 run the timer directly instead of queueing a timer-event.
4567 Now we always run timers directly. */
4570 timer_check (int do_it_now
)
4572 EMACS_TIME nexttime
;
4576 nexttime
= timer_check_2 ();
4578 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4583 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4584 doc
: /* Return the current length of Emacs idleness, or nil.
4585 The value when Emacs is idle is a list of three integers. The first has
4586 the most significant 16 bits of the seconds, while the second has the least
4587 significant 16 bits. The third integer gives the microsecond count.
4589 The value when Emacs is not idle is nil.
4591 The microsecond count is zero on systems that do not provide
4592 resolution finer than a second. */)
4595 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4597 EMACS_TIME now
, idleness_now
;
4599 EMACS_GET_TIME (now
);
4600 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4602 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4603 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4604 make_number (EMACS_USECS (idleness_now
)));
4610 /* Caches for modify_event_symbol. */
4611 static Lisp_Object accent_key_syms
;
4612 static Lisp_Object func_key_syms
;
4613 static Lisp_Object mouse_syms
;
4614 static Lisp_Object wheel_syms
;
4615 static Lisp_Object drag_n_drop_syms
;
4617 /* This is a list of keysym codes for special "accent" characters.
4618 It parallels lispy_accent_keys. */
4620 static const int lispy_accent_codes
[] =
4622 #ifdef XK_dead_circumflex
4627 #ifdef XK_dead_grave
4632 #ifdef XK_dead_tilde
4637 #ifdef XK_dead_diaeresis
4642 #ifdef XK_dead_macron
4647 #ifdef XK_dead_degree
4652 #ifdef XK_dead_acute
4657 #ifdef XK_dead_cedilla
4662 #ifdef XK_dead_breve
4667 #ifdef XK_dead_ogonek
4672 #ifdef XK_dead_caron
4677 #ifdef XK_dead_doubleacute
4678 XK_dead_doubleacute
,
4682 #ifdef XK_dead_abovedot
4687 #ifdef XK_dead_abovering
4697 #ifdef XK_dead_belowdot
4702 #ifdef XK_dead_voiced_sound
4703 XK_dead_voiced_sound
,
4707 #ifdef XK_dead_semivoiced_sound
4708 XK_dead_semivoiced_sound
,
4724 /* This is a list of Lisp names for special "accent" characters.
4725 It parallels lispy_accent_codes. */
4727 static char *lispy_accent_keys
[] =
4745 "dead-voiced-sound",
4746 "dead-semivoiced-sound",
4752 #define FUNCTION_KEY_OFFSET 0x0
4754 char *lispy_function_keys
[] =
4758 0, /* VK_LBUTTON 0x01 */
4759 0, /* VK_RBUTTON 0x02 */
4760 "cancel", /* VK_CANCEL 0x03 */
4761 0, /* VK_MBUTTON 0x04 */
4763 0, 0, 0, /* 0x05 .. 0x07 */
4765 "backspace", /* VK_BACK 0x08 */
4766 "tab", /* VK_TAB 0x09 */
4768 0, 0, /* 0x0A .. 0x0B */
4770 "clear", /* VK_CLEAR 0x0C */
4771 "return", /* VK_RETURN 0x0D */
4773 0, 0, /* 0x0E .. 0x0F */
4775 0, /* VK_SHIFT 0x10 */
4776 0, /* VK_CONTROL 0x11 */
4777 0, /* VK_MENU 0x12 */
4778 "pause", /* VK_PAUSE 0x13 */
4779 "capslock", /* VK_CAPITAL 0x14 */
4780 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4782 "junja", /* VK_JUNJA 0x17 */
4783 "final", /* VK_FINAL 0x18 */
4784 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4786 "escape", /* VK_ESCAPE 0x1B */
4787 "convert", /* VK_CONVERT 0x1C */
4788 "non-convert", /* VK_NONCONVERT 0x1D */
4789 "accept", /* VK_ACCEPT 0x1E */
4790 "mode-change", /* VK_MODECHANGE 0x1F */
4791 0, /* VK_SPACE 0x20 */
4792 "prior", /* VK_PRIOR 0x21 */
4793 "next", /* VK_NEXT 0x22 */
4794 "end", /* VK_END 0x23 */
4795 "home", /* VK_HOME 0x24 */
4796 "left", /* VK_LEFT 0x25 */
4797 "up", /* VK_UP 0x26 */
4798 "right", /* VK_RIGHT 0x27 */
4799 "down", /* VK_DOWN 0x28 */
4800 "select", /* VK_SELECT 0x29 */
4801 "print", /* VK_PRINT 0x2A */
4802 "execute", /* VK_EXECUTE 0x2B */
4803 "snapshot", /* VK_SNAPSHOT 0x2C */
4804 "insert", /* VK_INSERT 0x2D */
4805 "delete", /* VK_DELETE 0x2E */
4806 "help", /* VK_HELP 0x2F */
4808 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4810 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4812 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4814 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4816 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, 0, 0,
4818 0, 0, 0, 0, 0, 0, 0, 0,
4820 "lwindow", /* VK_LWIN 0x5B */
4821 "rwindow", /* VK_RWIN 0x5C */
4822 "apps", /* VK_APPS 0x5D */
4825 "kp-0", /* VK_NUMPAD0 0x60 */
4826 "kp-1", /* VK_NUMPAD1 0x61 */
4827 "kp-2", /* VK_NUMPAD2 0x62 */
4828 "kp-3", /* VK_NUMPAD3 0x63 */
4829 "kp-4", /* VK_NUMPAD4 0x64 */
4830 "kp-5", /* VK_NUMPAD5 0x65 */
4831 "kp-6", /* VK_NUMPAD6 0x66 */
4832 "kp-7", /* VK_NUMPAD7 0x67 */
4833 "kp-8", /* VK_NUMPAD8 0x68 */
4834 "kp-9", /* VK_NUMPAD9 0x69 */
4835 "kp-multiply", /* VK_MULTIPLY 0x6A */
4836 "kp-add", /* VK_ADD 0x6B */
4837 "kp-separator", /* VK_SEPARATOR 0x6C */
4838 "kp-subtract", /* VK_SUBTRACT 0x6D */
4839 "kp-decimal", /* VK_DECIMAL 0x6E */
4840 "kp-divide", /* VK_DIVIDE 0x6F */
4841 "f1", /* VK_F1 0x70 */
4842 "f2", /* VK_F2 0x71 */
4843 "f3", /* VK_F3 0x72 */
4844 "f4", /* VK_F4 0x73 */
4845 "f5", /* VK_F5 0x74 */
4846 "f6", /* VK_F6 0x75 */
4847 "f7", /* VK_F7 0x76 */
4848 "f8", /* VK_F8 0x77 */
4849 "f9", /* VK_F9 0x78 */
4850 "f10", /* VK_F10 0x79 */
4851 "f11", /* VK_F11 0x7A */
4852 "f12", /* VK_F12 0x7B */
4853 "f13", /* VK_F13 0x7C */
4854 "f14", /* VK_F14 0x7D */
4855 "f15", /* VK_F15 0x7E */
4856 "f16", /* VK_F16 0x7F */
4857 "f17", /* VK_F17 0x80 */
4858 "f18", /* VK_F18 0x81 */
4859 "f19", /* VK_F19 0x82 */
4860 "f20", /* VK_F20 0x83 */
4861 "f21", /* VK_F21 0x84 */
4862 "f22", /* VK_F22 0x85 */
4863 "f23", /* VK_F23 0x86 */
4864 "f24", /* VK_F24 0x87 */
4866 0, 0, 0, 0, /* 0x88 .. 0x8B */
4867 0, 0, 0, 0, /* 0x8C .. 0x8F */
4869 "kp-numlock", /* VK_NUMLOCK 0x90 */
4870 "scroll", /* VK_SCROLL 0x91 */
4871 /* Not sure where the following block comes from.
4872 Windows headers have NEC and Fujitsu specific keys in
4873 this block, but nothing generic. */
4874 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4875 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4876 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4877 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4878 "kp-end", /* VK_NUMPAD_END 0x96 */
4879 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4880 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4881 "kp-up", /* VK_NUMPAD_UP 0x99 */
4882 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4883 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4884 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4885 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4887 0, 0, /* 0x9E .. 0x9F */
4890 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4891 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4892 * No other API or message will distinguish left and right keys this way.
4897 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4898 to enable them selectively, and gives access to a few more functions.
4899 See lispy_multimedia_keys below. */
4900 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4901 0, 0, 0, /* 0xAD .. 0xAF Volume */
4902 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4903 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4905 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4906 0, 0, 0, 0, 0, 0, 0, 0, 0,
4908 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4909 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4910 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4913 "ax", /* VK_OEM_AX 0xE1 */
4914 0, /* VK_OEM_102 0xE2 */
4915 "ico-help", /* VK_ICO_HELP 0xE3 */
4916 "ico-00", /* VK_ICO_00 0xE4 */
4917 0, /* VK_PROCESSKEY 0xE5 */
4918 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4919 "packet", /* VK_PACKET 0xE7 */
4921 "reset", /* VK_OEM_RESET 0xE9 */
4922 "jump", /* VK_OEM_JUMP 0xEA */
4923 "oem-pa1", /* VK_OEM_PA1 0xEB */
4924 "oem-pa2", /* VK_OEM_PA2 0xEC */
4925 "oem-pa3", /* VK_OEM_PA3 0xED */
4926 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4927 "cusel", /* VK_OEM_CUSEL 0xEF */
4928 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4929 "finish", /* VK_OEM_FINISH 0xF1 */
4930 "copy", /* VK_OEM_COPY 0xF2 */
4931 "auto", /* VK_OEM_AUTO 0xF3 */
4932 "enlw", /* VK_OEM_ENLW 0xF4 */
4933 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4934 "attn", /* VK_ATTN 0xF6 */
4935 "crsel", /* VK_CRSEL 0xF7 */
4936 "exsel", /* VK_EXSEL 0xF8 */
4937 "ereof", /* VK_EREOF 0xF9 */
4938 "play", /* VK_PLAY 0xFA */
4939 "zoom", /* VK_ZOOM 0xFB */
4940 "noname", /* VK_NONAME 0xFC */
4941 "pa1", /* VK_PA1 0xFD */
4942 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4946 /* Some of these duplicate the "Media keys" on newer keyboards,
4947 but they are delivered to the application in a different way. */
4948 static char *lispy_multimedia_keys
[] =
4956 "browser-favorites",
4993 "toggle-dictate-command",
4999 "media-fast-forward",
5002 "media-channel-down"
5005 #else /* not HAVE_NTGUI */
5007 /* This should be dealt with in XTread_socket now, and that doesn't
5008 depend on the client system having the Kana syms defined. See also
5009 the XK_kana_A case below. */
5012 static char *lispy_kana_keys
[] =
5014 /* X Keysym value */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5024 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5025 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5026 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5027 "kana-i", "kana-u", "kana-e", "kana-o",
5028 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5029 "prolongedsound", "kana-A", "kana-I", "kana-U",
5030 "kana-E", "kana-O", "kana-KA", "kana-KI",
5031 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5032 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5033 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5034 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5035 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5036 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5037 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5038 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5039 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5040 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5041 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5042 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5044 #endif /* XK_kana_A */
5047 #define FUNCTION_KEY_OFFSET 0xff00
5049 /* You'll notice that this table is arranged to be conveniently
5050 indexed by X Windows keysym values. */
5051 static char *lispy_function_keys
[] =
5053 /* X Keysym value */
5055 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5056 "backspace", "tab", "linefeed", "clear",
5058 0, 0, 0, "pause", /* 0xff10...1f */
5059 0, 0, 0, 0, 0, 0, 0, "escape",
5061 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5062 "romaji", "hiragana", "katakana", "hiragana-katakana",
5063 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5064 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5065 "eisu-toggle", /* 0xff30...3f */
5066 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5067 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5069 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5070 "down", "prior", "next", "end",
5071 "begin", 0, 0, 0, 0, 0, 0, 0,
5072 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5083 "break", /* 0xff6b */
5086 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5087 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5088 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5089 0, 0, 0, 0, 0, 0, 0, 0,
5090 "kp-tab", /* 0xff89 */
5092 "kp-enter", /* 0xff8d */
5094 "kp-f1", /* 0xff91 */
5098 "kp-home", /* 0xff95 */
5103 "kp-prior", /* kp-page-up */
5104 "kp-next", /* kp-page-down */
5110 0, 0, 0, 0, 0, 0, 0, 0, 0,
5111 "kp-multiply", /* 0xffaa */
5116 "kp-divide", /* 0xffaf */
5117 "kp-0", /* 0xffb0 */
5118 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5121 "kp-equal", /* 0xffbd */
5122 "f1", /* 0xffbe */ /* IsFunctionKey */
5124 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5125 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5126 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5127 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5128 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5129 0, 0, 0, 0, 0, 0, 0, 0,
5130 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5131 0, 0, 0, 0, 0, 0, 0, "delete"
5134 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5135 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5137 static char *iso_lispy_function_keys
[] =
5139 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5140 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5141 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5142 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5143 "iso-lefttab", /* 0xfe20 */
5144 "iso-move-line-up", "iso-move-line-down",
5145 "iso-partial-line-up", "iso-partial-line-down",
5146 "iso-partial-space-left", "iso-partial-space-right",
5147 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5148 "iso-release-margin-left", "iso-release-margin-right",
5149 "iso-release-both-margins",
5150 "iso-fast-cursor-left", "iso-fast-cursor-right",
5151 "iso-fast-cursor-up", "iso-fast-cursor-down",
5152 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5153 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5156 #endif /* not HAVE_NTGUI */
5158 Lisp_Object Vlispy_mouse_stem
;
5160 static char *lispy_wheel_names
[] =
5162 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5165 /* drag-n-drop events are generated when a set of selected files are
5166 dragged from another application and dropped onto an Emacs window. */
5167 static char *lispy_drag_n_drop_names
[] =
5172 /* Scroll bar parts. */
5173 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5174 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5175 Lisp_Object Qtop
, Qratio
;
5177 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5178 Lisp_Object
*scroll_bar_parts
[] = {
5179 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5180 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5183 /* A vector, indexed by button number, giving the down-going location
5184 of currently depressed buttons, both scroll bar and non-scroll bar.
5186 The elements have the form
5187 (BUTTON-NUMBER MODIFIER-MASK . REST)
5188 where REST is the cdr of a position as it would be reported in the event.
5190 The make_lispy_event function stores positions here to tell the
5191 difference between click and drag events, and to store the starting
5192 location to be included in drag events. */
5194 static Lisp_Object button_down_location
;
5196 /* Information about the most recent up-going button event: Which
5197 button, what location, and what time. */
5199 static int last_mouse_button
;
5200 static int last_mouse_x
;
5201 static int last_mouse_y
;
5202 static unsigned long button_down_time
;
5204 /* The maximum time between clicks to make a double-click, or Qnil to
5205 disable double-click detection, or Qt for no time limit. */
5207 Lisp_Object Vdouble_click_time
;
5209 /* Maximum number of pixels the mouse may be moved between clicks
5210 to make a double-click. */
5212 EMACS_INT double_click_fuzz
;
5214 /* The number of clicks in this multiple-click. */
5216 int double_click_count
;
5218 /* Return position of a mouse click or wheel event */
5221 make_lispy_position (struct frame
*f
, Lisp_Object
*x
, Lisp_Object
*y
,
5225 enum window_part part
;
5226 Lisp_Object posn
= Qnil
;
5227 Lisp_Object extra_info
= Qnil
;
5230 /* Set `window' to the window under frame pixel coordinates (x,y) */
5232 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5233 &part
, &wx
, &wy
, 0);
5237 if (WINDOWP (window
))
5239 /* It's a click in window window at frame coordinates (x,y) */
5240 struct window
*w
= XWINDOW (window
);
5241 Lisp_Object string_info
= Qnil
;
5242 int textpos
= -1, rx
= -1, ry
= -1;
5243 int dx
= -1, dy
= -1;
5244 int width
= -1, height
= -1;
5245 Lisp_Object object
= Qnil
;
5247 /* Set event coordinates to window-relative coordinates
5248 for constructing the Lisp event below. */
5252 if (part
== ON_TEXT
)
5254 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5256 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5258 /* Mode line or header line. Look for a string under
5259 the mouse that may have a `local-map' property. */
5263 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5265 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5266 &object
, &dx
, &dy
, &width
, &height
);
5267 if (STRINGP (string
))
5268 string_info
= Fcons (string
, make_number (charpos
));
5269 if (w
== XWINDOW (selected_window
)
5270 && current_buffer
== XBUFFER (w
->buffer
))
5273 textpos
= XMARKER (w
->pointm
)->charpos
;
5275 else if (part
== ON_VERTICAL_BORDER
)
5277 posn
= Qvertical_line
;
5282 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5287 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5289 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5290 &object
, &dx
, &dy
, &width
, &height
);
5291 if (STRINGP (string
))
5292 string_info
= Fcons (string
, make_number (charpos
));
5293 if (part
== ON_LEFT_MARGIN
)
5296 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5298 else if (part
== ON_LEFT_FRINGE
)
5300 posn
= Qleft_fringe
;
5303 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5305 : window_box_width (w
, LEFT_MARGIN_AREA
));
5308 else if (part
== ON_RIGHT_FRINGE
)
5310 posn
= Qright_fringe
;
5313 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5314 + window_box_width (w
, TEXT_AREA
)
5315 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5316 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5322 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5323 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5328 Lisp_Object string2
, object2
= Qnil
;
5329 struct display_pos p
;
5331 int width2
, height2
;
5332 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5333 &object2
, &dx2
, &dy2
,
5335 textpos
= CHARPOS (p
.pos
);
5336 if (rx
< 0) rx
= wx
;
5337 if (ry
< 0) ry
= wy
;
5338 if (dx
< 0) dx
= dx2
;
5339 if (dy
< 0) dy
= dy2
;
5340 if (width
< 0) width
= width2
;
5341 if (height
< 0) height
= height2
;
5345 posn
= make_number (textpos
);
5346 if (STRINGP (string2
))
5347 string_info
= Fcons (string2
,
5348 make_number (CHARPOS (p
.string_pos
)));
5354 #ifdef HAVE_WINDOW_SYSTEM
5355 if (IMAGEP (object
))
5357 Lisp_Object image_map
, hotspot
;
5358 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5360 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5362 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5363 posn
= XCAR (hotspot
);
5368 extra_info
= Fcons (object
,
5369 Fcons (Fcons (make_number (dx
),
5371 Fcons (Fcons (make_number (width
),
5372 make_number (height
)),
5376 extra_info
= Fcons (string_info
,
5377 Fcons (make_number (textpos
),
5378 Fcons (Fcons (make_number (rx
),
5384 XSETFRAME (window
, f
);
5389 XSETFASTINT (*x
, 0);
5390 XSETFASTINT (*y
, 0);
5393 return Fcons (window
,
5395 Fcons (Fcons (*x
, *y
),
5396 Fcons (make_number (time
),
5400 /* Given a struct input_event, build the lisp event which represents
5401 it. If EVENT is 0, build a mouse movement event from the mouse
5402 movement buffer, which should have a movement event in it.
5404 Note that events must be passed to this function in the order they
5405 are received; this function stores the location of button presses
5406 in order to build drag events when the button is released. */
5409 make_lispy_event (struct input_event
*event
)
5413 switch (SWITCH_ENUM_CAST (event
->kind
))
5415 /* A simple keystroke. */
5416 case ASCII_KEYSTROKE_EVENT
:
5417 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5419 Lisp_Object lispy_c
;
5420 int c
= event
->code
;
5421 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5424 eassert (c
== event
->code
);
5425 /* Turn ASCII characters into control characters
5427 if (event
->modifiers
& ctrl_modifier
)
5429 c
= make_ctrl_char (c
);
5430 event
->modifiers
&= ~ctrl_modifier
;
5434 /* Add in the other modifier bits. The shift key was taken care
5435 of by the X code. */
5436 c
|= (event
->modifiers
5437 & (meta_modifier
| alt_modifier
5438 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5439 /* Distinguish Shift-SPC from SPC. */
5440 if ((event
->code
) == 040
5441 && event
->modifiers
& shift_modifier
)
5442 c
|= shift_modifier
;
5443 button_down_time
= 0;
5444 XSETFASTINT (lispy_c
, c
);
5449 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5450 except that they are non-key events (last-nonmenu-event is nil). */
5451 case NS_NONKEY_EVENT
:
5454 /* A function key. The symbol may need to have modifier prefixes
5456 case NON_ASCII_KEYSTROKE_EVENT
:
5457 button_down_time
= 0;
5459 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5460 if (event
->code
== lispy_accent_codes
[i
])
5461 return modify_event_symbol (i
,
5463 Qfunction_key
, Qnil
,
5464 lispy_accent_keys
, &accent_key_syms
,
5465 (sizeof (lispy_accent_keys
)
5466 / sizeof (lispy_accent_keys
[0])));
5470 if (event
->code
>= 0x400 && event
->code
< 0x500)
5471 return modify_event_symbol (event
->code
- 0x400,
5472 event
->modifiers
& ~shift_modifier
,
5473 Qfunction_key
, Qnil
,
5474 lispy_kana_keys
, &func_key_syms
,
5475 (sizeof (lispy_kana_keys
)
5476 / sizeof (lispy_kana_keys
[0])));
5477 #endif /* XK_kana_A */
5480 #ifdef ISO_FUNCTION_KEY_OFFSET
5481 if (event
->code
< FUNCTION_KEY_OFFSET
5482 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5483 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5485 Qfunction_key
, Qnil
,
5486 iso_lispy_function_keys
, &func_key_syms
,
5487 (sizeof (iso_lispy_function_keys
)
5488 / sizeof (iso_lispy_function_keys
[0])));
5491 /* Handle system-specific or unknown keysyms. */
5492 if (event
->code
& (1 << 28)
5493 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5494 || (event
->code
- FUNCTION_KEY_OFFSET
5495 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5496 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5498 /* We need to use an alist rather than a vector as the cache
5499 since we can't make a vector long enuf. */
5500 if (NILP (current_kboard
->system_key_syms
))
5501 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5502 return modify_event_symbol (event
->code
,
5505 current_kboard
->Vsystem_key_alist
,
5506 0, ¤t_kboard
->system_key_syms
,
5510 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5512 Qfunction_key
, Qnil
,
5513 lispy_function_keys
, &func_key_syms
,
5514 (sizeof (lispy_function_keys
)
5515 / sizeof (lispy_function_keys
[0])));
5518 case MULTIMEDIA_KEY_EVENT
:
5519 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5520 / sizeof (lispy_multimedia_keys
[0]))
5521 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5523 return modify_event_symbol (event
->code
, event
->modifiers
,
5524 Qfunction_key
, Qnil
,
5525 lispy_multimedia_keys
, &func_key_syms
,
5526 (sizeof (lispy_multimedia_keys
)
5527 / sizeof (lispy_multimedia_keys
[0])));
5533 /* A mouse click. Figure out where it is, decide whether it's
5534 a press, click or drag, and build the appropriate structure. */
5535 case MOUSE_CLICK_EVENT
:
5536 #ifndef USE_TOOLKIT_SCROLL_BARS
5537 case SCROLL_BAR_CLICK_EVENT
:
5540 int button
= event
->code
;
5542 Lisp_Object position
;
5543 Lisp_Object
*start_pos_ptr
;
5544 Lisp_Object start_pos
;
5548 /* Build the position as appropriate for this mouse click. */
5549 if (event
->kind
== MOUSE_CLICK_EVENT
)
5551 struct frame
*f
= XFRAME (event
->frame_or_window
);
5552 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5556 /* Ignore mouse events that were made on frame that
5557 have been deleted. */
5558 if (! FRAME_LIVE_P (f
))
5561 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5562 /* EVENT->x and EVENT->y are frame-relative pixel
5563 coordinates at this place. Under old redisplay, COLUMN
5564 and ROW are set to frame relative glyph coordinates
5565 which are then used to determine whether this click is
5566 in a menu (non-toolkit version). */
5567 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5568 &column
, &row
, NULL
, 1);
5570 /* In the non-toolkit version, clicks on the menu bar
5571 are ordinary button events in the event buffer.
5572 Distinguish them, and invoke the menu.
5574 (In the toolkit version, the toolkit handles the menu bar
5575 and Emacs doesn't know about it until after the user
5576 makes a selection.) */
5577 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5578 && (event
->modifiers
& down_modifier
))
5580 Lisp_Object items
, item
;
5585 /* Activate the menu bar on the down event. If the
5586 up event comes in before the menu code can deal with it,
5588 if (! (event
->modifiers
& down_modifier
))
5592 /* Find the menu bar item under `column'. */
5594 items
= FRAME_MENU_BAR_ITEMS (f
);
5595 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5597 Lisp_Object pos
, string
;
5598 string
= AREF (items
, i
+ 1);
5599 pos
= AREF (items
, i
+ 3);
5602 if (column
>= XINT (pos
)
5603 && column
< XINT (pos
) + SCHARS (string
))
5605 item
= AREF (items
, i
);
5610 /* ELisp manual 2.4b says (x y) are window relative but
5611 code says they are frame-relative. */
5613 = Fcons (event
->frame_or_window
,
5615 Fcons (Fcons (event
->x
, event
->y
),
5616 Fcons (make_number (event
->timestamp
),
5619 return Fcons (item
, Fcons (position
, Qnil
));
5621 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5623 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5626 #ifndef USE_TOOLKIT_SCROLL_BARS
5629 /* It's a scrollbar click. */
5631 Lisp_Object portion_whole
;
5634 window
= event
->frame_or_window
;
5635 portion_whole
= Fcons (event
->x
, event
->y
);
5636 part
= *scroll_bar_parts
[(int) event
->part
];
5640 Fcons (Qvertical_scroll_bar
,
5641 Fcons (portion_whole
,
5642 Fcons (make_number (event
->timestamp
),
5643 Fcons (part
, Qnil
)))));
5645 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5647 if (button
>= ASIZE (button_down_location
))
5649 button_down_location
= larger_vector (button_down_location
,
5651 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5654 start_pos_ptr
= &AREF (button_down_location
, button
);
5655 start_pos
= *start_pos_ptr
;
5656 *start_pos_ptr
= Qnil
;
5659 /* On window-system frames, use the value of
5660 double-click-fuzz as is. On other frames, interpret it
5661 as a multiple of 1/8 characters. */
5665 if (WINDOWP (event
->frame_or_window
))
5666 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5667 else if (FRAMEP (event
->frame_or_window
))
5668 f
= XFRAME (event
->frame_or_window
);
5672 if (FRAME_WINDOW_P (f
))
5673 fuzz
= double_click_fuzz
;
5675 fuzz
= double_click_fuzz
/ 8;
5677 is_double
= (button
== last_mouse_button
5678 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5679 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5680 && button_down_time
!= 0
5681 && (EQ (Vdouble_click_time
, Qt
)
5682 || (INTEGERP (Vdouble_click_time
)
5683 && ((int)(event
->timestamp
- button_down_time
)
5684 < XINT (Vdouble_click_time
)))));
5687 last_mouse_button
= button
;
5688 last_mouse_x
= XINT (event
->x
);
5689 last_mouse_y
= XINT (event
->y
);
5691 /* If this is a button press, squirrel away the location, so
5692 we can decide later whether it was a click or a drag. */
5693 if (event
->modifiers
& down_modifier
)
5697 double_click_count
++;
5698 event
->modifiers
|= ((double_click_count
> 2)
5703 double_click_count
= 1;
5704 button_down_time
= event
->timestamp
;
5705 *start_pos_ptr
= Fcopy_alist (position
);
5706 ignore_mouse_drag_p
= 0;
5709 /* Now we're releasing a button - check the co-ordinates to
5710 see if this was a click or a drag. */
5711 else if (event
->modifiers
& up_modifier
)
5713 /* If we did not see a down before this up, ignore the up.
5714 Probably this happened because the down event chose a
5715 menu item. It would be an annoyance to treat the
5716 release of the button that chose the menu item as a
5719 if (!CONSP (start_pos
))
5722 event
->modifiers
&= ~up_modifier
;
5723 #if 0 /* Formerly we treated an up with no down as a click event. */
5724 if (!CONSP (start_pos
))
5725 event
->modifiers
|= click_modifier
;
5730 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5732 /* The third element of every position
5733 should be the (x,y) pair. */
5734 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5736 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5738 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5739 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5742 if (ignore_mouse_drag_p
)
5744 event
->modifiers
|= click_modifier
;
5745 ignore_mouse_drag_p
= 0;
5747 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5748 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5749 /* Maybe the mouse has moved a lot, caused scrolling, and
5750 eventually ended up at the same screen position (but
5751 not buffer position) in which case it is a drag, not
5753 /* FIXME: OTOH if the buffer position has changed
5754 because of a timer or process filter rather than
5755 because of mouse movement, it should be considered as
5756 a click. But mouse-drag-region completely ignores
5757 this case and it hasn't caused any real problem, so
5758 it's probably OK to ignore it as well. */
5759 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5760 /* Mouse hasn't moved (much). */
5761 event
->modifiers
|= click_modifier
;
5764 button_down_time
= 0;
5765 event
->modifiers
|= drag_modifier
;
5768 /* Don't check is_double; treat this as multiple
5769 if the down-event was multiple. */
5770 if (double_click_count
> 1)
5771 event
->modifiers
|= ((double_click_count
> 2)
5777 /* Every mouse event should either have the down_modifier or
5778 the up_modifier set. */
5782 /* Get the symbol we should use for the mouse click. */
5785 head
= modify_event_symbol (button
,
5787 Qmouse_click
, Vlispy_mouse_stem
,
5790 XVECTOR (mouse_syms
)->size
);
5791 if (event
->modifiers
& drag_modifier
)
5796 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5799 Fcons (make_number (double_click_count
),
5809 case HORIZ_WHEEL_EVENT
:
5811 Lisp_Object position
;
5814 /* Build the position as appropriate for this mouse click. */
5815 struct frame
*f
= XFRAME (event
->frame_or_window
);
5817 /* Ignore wheel events that were made on frame that have been
5819 if (! FRAME_LIVE_P (f
))
5822 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5825 /* Set double or triple modifiers to indicate the wheel speed. */
5827 /* On window-system frames, use the value of
5828 double-click-fuzz as is. On other frames, interpret it
5829 as a multiple of 1/8 characters. */
5835 if (WINDOWP (event
->frame_or_window
))
5836 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5837 else if (FRAMEP (event
->frame_or_window
))
5838 f
= XFRAME (event
->frame_or_window
);
5842 if (FRAME_WINDOW_P (f
))
5843 fuzz
= double_click_fuzz
;
5845 fuzz
= double_click_fuzz
/ 8;
5847 if (event
->modifiers
& up_modifier
)
5849 /* Emit a wheel-up event. */
5850 event
->modifiers
&= ~up_modifier
;
5853 else if (event
->modifiers
& down_modifier
)
5855 /* Emit a wheel-down event. */
5856 event
->modifiers
&= ~down_modifier
;
5860 /* Every wheel event should either have the down_modifier or
5861 the up_modifier set. */
5864 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5867 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5868 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5869 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5870 && button_down_time
!= 0
5871 && (EQ (Vdouble_click_time
, Qt
)
5872 || (INTEGERP (Vdouble_click_time
)
5873 && ((int)(event
->timestamp
- button_down_time
)
5874 < XINT (Vdouble_click_time
)))));
5877 double_click_count
++;
5878 event
->modifiers
|= ((double_click_count
> 2)
5884 double_click_count
= 1;
5885 event
->modifiers
|= click_modifier
;
5888 button_down_time
= event
->timestamp
;
5889 /* Use a negative value to distinguish wheel from mouse button. */
5890 last_mouse_button
= - (1 + symbol_num
);
5891 last_mouse_x
= XINT (event
->x
);
5892 last_mouse_y
= XINT (event
->y
);
5894 /* Get the symbol we should use for the wheel event. */
5895 head
= modify_event_symbol (symbol_num
,
5901 ASIZE (wheel_syms
));
5904 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5907 Fcons (make_number (double_click_count
),
5916 #ifdef USE_TOOLKIT_SCROLL_BARS
5918 /* We don't have down and up events if using toolkit scroll bars,
5919 so make this always a click event. Store in the `part' of
5920 the Lisp event a symbol which maps to the following actions:
5922 `above_handle' page up
5923 `below_handle' page down
5927 `bottom' bottom of buffer
5928 `handle' thumb has been dragged.
5929 `end-scroll' end of interaction with scroll bar
5931 The incoming input_event contains in its `part' member an
5932 index of type `enum scroll_bar_part' which we can use as an
5933 index in scroll_bar_parts to get the appropriate symbol. */
5935 case SCROLL_BAR_CLICK_EVENT
:
5937 Lisp_Object position
, head
, window
, portion_whole
, part
;
5939 window
= event
->frame_or_window
;
5940 portion_whole
= Fcons (event
->x
, event
->y
);
5941 part
= *scroll_bar_parts
[(int) event
->part
];
5945 Fcons (Qvertical_scroll_bar
,
5946 Fcons (portion_whole
,
5947 Fcons (make_number (event
->timestamp
),
5948 Fcons (part
, Qnil
)))));
5950 /* Always treat scroll bar events as clicks. */
5951 event
->modifiers
|= click_modifier
;
5952 event
->modifiers
&= ~up_modifier
;
5954 if (event
->code
>= ASIZE (mouse_syms
))
5955 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5957 /* Get the symbol we should use for the mouse click. */
5958 head
= modify_event_symbol (event
->code
,
5963 XVECTOR (mouse_syms
)->size
);
5964 return Fcons (head
, Fcons (position
, Qnil
));
5967 #endif /* USE_TOOLKIT_SCROLL_BARS */
5969 case DRAG_N_DROP_EVENT
:
5972 Lisp_Object head
, position
;
5975 f
= XFRAME (event
->frame_or_window
);
5978 /* Ignore mouse events that were made on frames that
5979 have been deleted. */
5980 if (! FRAME_LIVE_P (f
))
5983 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5986 head
= modify_event_symbol (0, event
->modifiers
,
5988 lispy_drag_n_drop_names
,
5989 &drag_n_drop_syms
, 1);
5995 #endif /* HAVE_MOUSE */
5997 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5998 || defined(HAVE_NS) || defined (USE_GTK)
5999 case MENU_BAR_EVENT
:
6000 if (EQ (event
->arg
, event
->frame_or_window
))
6001 /* This is the prefix key. We translate this to
6002 `(menu_bar)' because the code in keyboard.c for menu
6003 events, which we use, relies on this. */
6004 return Fcons (Qmenu_bar
, Qnil
);
6008 case SELECT_WINDOW_EVENT
:
6009 /* Make an event (select-window (WINDOW)). */
6010 return Fcons (Qselect_window
,
6011 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6014 case TOOL_BAR_EVENT
:
6015 if (EQ (event
->arg
, event
->frame_or_window
))
6016 /* This is the prefix key. We translate this to
6017 `(tool_bar)' because the code in keyboard.c for tool bar
6018 events, which we use, relies on this. */
6019 return Fcons (Qtool_bar
, Qnil
);
6020 else if (SYMBOLP (event
->arg
))
6021 return apply_modifiers (event
->modifiers
, event
->arg
);
6024 case USER_SIGNAL_EVENT
:
6025 /* A user signal. */
6027 char *name
= find_user_signal_name (event
->code
);
6030 return intern (name
);
6033 case SAVE_SESSION_EVENT
:
6034 return Qsave_session
;
6039 return Fcons (Qdbus_event
, event
->arg
);
6041 #endif /* HAVE_DBUS */
6043 case CONFIG_CHANGED_EVENT
:
6044 return Fcons (Qconfig_changed_event
,
6046 Fcons (event
->frame_or_window
, Qnil
)));
6048 case GPM_CLICK_EVENT
:
6050 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6051 Lisp_Object head
, position
;
6052 Lisp_Object
*start_pos_ptr
;
6053 Lisp_Object start_pos
;
6054 int button
= event
->code
;
6056 if (button
>= ASIZE (button_down_location
))
6058 button_down_location
= larger_vector (button_down_location
,
6060 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6063 start_pos_ptr
= &AREF (button_down_location
, button
);
6064 start_pos
= *start_pos_ptr
;
6066 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6069 if (event
->modifiers
& down_modifier
)
6070 *start_pos_ptr
= Fcopy_alist (position
);
6071 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6073 if (!CONSP (start_pos
))
6075 event
->modifiers
&= ~up_modifier
;
6078 head
= modify_event_symbol (button
,
6080 Qmouse_click
, Vlispy_mouse_stem
,
6083 XVECTOR (mouse_syms
)->size
);
6085 if (event
->modifiers
& drag_modifier
)
6090 else if (event
->modifiers
& double_modifier
)
6093 Fcons (make_number (2),
6095 else if (event
->modifiers
& triple_modifier
)
6098 Fcons (make_number (3),
6105 #endif /* HAVE_GPM */
6107 /* The 'kind' field of the event is something we don't recognize. */
6113 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6116 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6117 Lisp_Object x
, Lisp_Object y
, unsigned long time
)
6119 /* Is it a scroll bar movement? */
6120 if (frame
&& ! NILP (bar_window
))
6122 Lisp_Object part_sym
;
6124 part_sym
= *scroll_bar_parts
[(int) part
];
6125 return Fcons (Qscroll_bar_movement
,
6126 (Fcons (Fcons (bar_window
,
6127 Fcons (Qvertical_scroll_bar
,
6128 Fcons (Fcons (x
, y
),
6129 Fcons (make_number (time
),
6135 /* Or is it an ordinary mouse movement? */
6138 Lisp_Object position
;
6140 position
= make_lispy_position (frame
, &x
, &y
, time
);
6142 return Fcons (Qmouse_movement
,
6148 #endif /* HAVE_MOUSE || HAVE GPM */
6150 /* Construct a switch frame event. */
6152 make_lispy_switch_frame (Lisp_Object frame
)
6154 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6157 /* Manipulating modifiers. */
6159 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6161 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6162 SYMBOL's name of the end of the modifiers; the string from this
6163 position is the unmodified symbol name.
6165 This doesn't use any caches. */
6168 parse_modifiers_uncached (Lisp_Object symbol
, int *modifier_end
)
6174 CHECK_SYMBOL (symbol
);
6177 name
= SYMBOL_NAME (symbol
);
6179 for (i
= 0; i
+2 <= SBYTES (name
); )
6181 int this_mod_end
= 0;
6184 /* See if the name continues with a modifier word.
6185 Check that the word appears, but don't check what follows it.
6186 Set this_mod and this_mod_end to record what we find. */
6188 switch (SREF (name
, i
))
6190 #define SINGLE_LETTER_MOD(BIT) \
6191 (this_mod_end = i + 1, this_mod = BIT)
6194 SINGLE_LETTER_MOD (alt_modifier
);
6198 SINGLE_LETTER_MOD (ctrl_modifier
);
6202 SINGLE_LETTER_MOD (hyper_modifier
);
6206 SINGLE_LETTER_MOD (meta_modifier
);
6210 SINGLE_LETTER_MOD (shift_modifier
);
6214 SINGLE_LETTER_MOD (super_modifier
);
6217 #undef SINGLE_LETTER_MOD
6219 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6220 if (i + LEN + 1 <= SBYTES (name) \
6221 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6223 this_mod_end = i + LEN; \
6228 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6229 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6230 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6234 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6236 #undef MULTI_LETTER_MOD
6240 /* If we found no modifier, stop looking for them. */
6241 if (this_mod_end
== 0)
6244 /* Check there is a dash after the modifier, so that it
6245 really is a modifier. */
6246 if (this_mod_end
>= SBYTES (name
)
6247 || SREF (name
, this_mod_end
) != '-')
6250 /* This modifier is real; look for another. */
6251 modifiers
|= this_mod
;
6252 i
= this_mod_end
+ 1;
6255 /* Should we include the `click' modifier? */
6256 if (! (modifiers
& (down_modifier
| drag_modifier
6257 | double_modifier
| triple_modifier
))
6258 && i
+ 7 == SBYTES (name
)
6259 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6260 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6261 modifiers
|= click_modifier
;
6263 if (! (modifiers
& (double_modifier
| triple_modifier
))
6264 && i
+ 6 < SBYTES (name
)
6265 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6266 modifiers
|= click_modifier
;
6274 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6275 prepended to the string BASE[0..BASE_LEN-1].
6276 This doesn't use any caches. */
6278 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6280 /* Since BASE could contain nulls, we can't use intern here; we have
6281 to use Fintern, which expects a genuine Lisp_String, and keeps a
6284 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6290 /* Only the event queue may use the `up' modifier; it should always
6291 be turned into a click or drag event before presented to lisp code. */
6292 if (modifiers
& up_modifier
)
6295 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6296 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6297 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6298 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6299 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6300 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6301 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6302 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6303 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6304 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6305 /* The click modifier is denoted by the absence of other modifiers. */
6309 mod_len
= p
- new_mods
;
6313 Lisp_Object new_name
;
6315 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6316 mod_len
+ base_len_byte
);
6317 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6318 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6320 return Fintern (new_name
, Qnil
);
6325 static const char *modifier_names
[] =
6327 "up", "down", "drag", "click", "double", "triple", 0, 0,
6328 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6329 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6331 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6333 static Lisp_Object modifier_symbols
;
6335 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6337 lispy_modifier_list (int modifiers
)
6339 Lisp_Object modifier_list
;
6342 modifier_list
= Qnil
;
6343 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6344 if (modifiers
& (1<<i
))
6345 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6348 return modifier_list
;
6352 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6353 where UNMODIFIED is the unmodified form of SYMBOL,
6354 MASK is the set of modifiers present in SYMBOL's name.
6355 This is similar to parse_modifiers_uncached, but uses the cache in
6356 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6357 Qevent_symbol_elements property. */
6359 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6362 parse_modifiers (Lisp_Object symbol
)
6364 Lisp_Object elements
;
6366 if (INTEGERP (symbol
))
6367 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6368 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6370 else if (!SYMBOLP (symbol
))
6373 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6374 if (CONSP (elements
))
6379 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6380 Lisp_Object unmodified
;
6383 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6384 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6387 if (modifiers
& ~INTMASK
)
6389 XSETFASTINT (mask
, modifiers
);
6390 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6392 /* Cache the parsing results on SYMBOL. */
6393 Fput (symbol
, Qevent_symbol_element_mask
,
6395 Fput (symbol
, Qevent_symbol_elements
,
6396 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6398 /* Since we know that SYMBOL is modifiers applied to unmodified,
6399 it would be nice to put that in unmodified's cache.
6400 But we can't, since we're not sure that parse_modifiers is
6407 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6408 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6409 doc
: /* Parse the event symbol. For internal use. */)
6410 (Lisp_Object symbol
)
6412 /* Fill the cache if needed. */
6413 parse_modifiers (symbol
);
6414 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6415 and use the Lispier representation stored on Qevent_symbol_elements
6417 return Fget (symbol
, Qevent_symbol_elements
);
6420 /* Apply the modifiers MODIFIERS to the symbol BASE.
6421 BASE must be unmodified.
6423 This is like apply_modifiers_uncached, but uses BASE's
6424 Qmodifier_cache property, if present. It also builds
6425 Qevent_symbol_elements properties, since it has that info anyway.
6427 apply_modifiers copies the value of BASE's Qevent_kind property to
6428 the modified symbol. */
6430 apply_modifiers (int modifiers
, Lisp_Object base
)
6432 Lisp_Object cache
, index
, entry
, new_symbol
;
6434 /* Mask out upper bits. We don't know where this value's been. */
6435 modifiers
&= INTMASK
;
6437 if (INTEGERP (base
))
6438 return make_number (XINT (base
) | modifiers
);
6440 /* The click modifier never figures into cache indices. */
6441 cache
= Fget (base
, Qmodifier_cache
);
6442 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6443 entry
= assq_no_quit (index
, cache
);
6446 new_symbol
= XCDR (entry
);
6449 /* We have to create the symbol ourselves. */
6450 new_symbol
= apply_modifiers_uncached (modifiers
,
6451 SDATA (SYMBOL_NAME (base
)),
6452 SCHARS (SYMBOL_NAME (base
)),
6453 SBYTES (SYMBOL_NAME (base
)));
6455 /* Add the new symbol to the base's cache. */
6456 entry
= Fcons (index
, new_symbol
);
6457 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6459 /* We have the parsing info now for free, so we could add it to
6461 XSETFASTINT (index, modifiers);
6462 Fput (new_symbol, Qevent_symbol_element_mask,
6463 Fcons (base, Fcons (index, Qnil)));
6464 Fput (new_symbol, Qevent_symbol_elements,
6465 Fcons (base, lispy_modifier_list (modifiers)));
6466 Sadly, this is only correct if `base' is indeed a base event,
6467 which is not necessarily the case. -stef */
6470 /* Make sure this symbol is of the same kind as BASE.
6472 You'd think we could just set this once and for all when we
6473 intern the symbol above, but reorder_modifiers may call us when
6474 BASE's property isn't set right; we can't assume that just
6475 because it has a Qmodifier_cache property it must have its
6476 Qevent_kind set right as well. */
6477 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6481 kind
= Fget (base
, Qevent_kind
);
6483 Fput (new_symbol
, Qevent_kind
, kind
);
6490 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6491 return a symbol with the modifiers placed in the canonical order.
6492 Canonical order is alphabetical, except for down and drag, which
6493 always come last. The 'click' modifier is never written out.
6495 Fdefine_key calls this to make sure that (for example) C-M-foo
6496 and M-C-foo end up being equivalent in the keymap. */
6499 reorder_modifiers (Lisp_Object symbol
)
6501 /* It's hopefully okay to write the code this way, since everything
6502 will soon be in caches, and no consing will be done at all. */
6505 parsed
= parse_modifiers (symbol
);
6506 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6511 /* For handling events, we often want to produce a symbol whose name
6512 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6513 to some base, like the name of a function key or mouse button.
6514 modify_event_symbol produces symbols of this sort.
6516 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6517 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6520 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6521 into symbol names, or a string specifying a name stem used to
6522 construct a symbol name or the form `STEM-N', where N is the decimal
6523 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6524 non-nil; otherwise NAME_TABLE is used.
6526 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6527 persist between calls to modify_event_symbol that it can use to
6528 store a cache of the symbols it's generated for this NAME_TABLE
6529 before. The object stored there may be a vector or an alist.
6531 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6533 MODIFIERS is a set of modifier bits (as given in struct input_events)
6534 whose prefixes should be applied to the symbol name.
6536 SYMBOL_KIND is the value to be placed in the event_kind property of
6537 the returned symbol.
6539 The symbols we create are supposed to have an
6540 `event-symbol-elements' property, which lists the modifiers present
6541 in the symbol's name. */
6544 modify_event_symbol (int symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6545 Lisp_Object name_alist_or_stem
, char **name_table
,
6546 Lisp_Object
*symbol_table
, unsigned int table_size
)
6549 Lisp_Object symbol_int
;
6551 /* Get rid of the "vendor-specific" bit here. */
6552 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6554 /* Is this a request for a valid symbol? */
6555 if (symbol_num
< 0 || symbol_num
>= table_size
)
6558 if (CONSP (*symbol_table
))
6559 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6561 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6562 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6563 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6564 we've never used that symbol before. */
6567 if (! VECTORP (*symbol_table
)
6568 || XVECTOR (*symbol_table
)->size
!= table_size
)
6572 XSETFASTINT (size
, table_size
);
6573 *symbol_table
= Fmake_vector (size
, Qnil
);
6576 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6579 /* Have we already used this symbol before? */
6582 /* No; let's create it. */
6583 if (CONSP (name_alist_or_stem
))
6584 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6585 else if (STRINGP (name_alist_or_stem
))
6587 int len
= SBYTES (name_alist_or_stem
);
6588 char *buf
= (char *) alloca (len
+ 50);
6589 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6590 (long) XINT (symbol_int
) + 1);
6591 value
= intern (buf
);
6593 else if (name_table
!= 0 && name_table
[symbol_num
])
6594 value
= intern (name_table
[symbol_num
]);
6596 #ifdef HAVE_WINDOW_SYSTEM
6599 char *name
= x_get_keysym_name (symbol_num
);
6601 value
= intern (name
);
6608 sprintf (buf
, "key-%d", symbol_num
);
6609 value
= intern (buf
);
6612 if (CONSP (*symbol_table
))
6613 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6615 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6617 /* Fill in the cache entries for this symbol; this also
6618 builds the Qevent_symbol_elements property, which the user
6620 apply_modifiers (modifiers
& click_modifier
, value
);
6621 Fput (value
, Qevent_kind
, symbol_kind
);
6624 /* Apply modifiers to that symbol. */
6625 return apply_modifiers (modifiers
, value
);
6628 /* Convert a list that represents an event type,
6629 such as (ctrl meta backspace), into the usual representation of that
6630 event type as a number or a symbol. */
6632 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6633 doc
: /* Convert the event description list EVENT-DESC to an event type.
6634 EVENT-DESC should contain one base event type (a character or symbol)
6635 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6636 drag, down, double or triple). The base must be last.
6637 The return value is an event type (a character or symbol) which
6638 has the same base event type and all the specified modifiers. */)
6639 (Lisp_Object event_desc
)
6647 while (CONSP (rest
))
6655 /* Given a symbol, see if it is a modifier name. */
6656 if (SYMBOLP (elt
) && CONSP (rest
))
6657 this = parse_solitary_modifier (elt
);
6661 else if (!NILP (base
))
6662 error ("Two bases given in one event");
6668 /* Let the symbol A refer to the character A. */
6669 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6670 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6672 if (INTEGERP (base
))
6674 /* Turn (shift a) into A. */
6675 if ((modifiers
& shift_modifier
) != 0
6676 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6678 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6679 modifiers
&= ~shift_modifier
;
6682 /* Turn (control a) into C-a. */
6683 if (modifiers
& ctrl_modifier
)
6684 return make_number ((modifiers
& ~ctrl_modifier
)
6685 | make_ctrl_char (XINT (base
)));
6687 return make_number (modifiers
| XINT (base
));
6689 else if (SYMBOLP (base
))
6690 return apply_modifiers (modifiers
, base
);
6693 error ("Invalid base event");
6698 /* Try to recognize SYMBOL as a modifier name.
6699 Return the modifier flag bit, or 0 if not recognized. */
6702 parse_solitary_modifier (Lisp_Object symbol
)
6704 Lisp_Object name
= SYMBOL_NAME (symbol
);
6706 switch (SREF (name
, 0))
6708 #define SINGLE_LETTER_MOD(BIT) \
6709 if (SBYTES (name) == 1) \
6712 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6713 if (LEN == SBYTES (name) \
6714 && ! strncmp (SDATA (name), NAME, LEN)) \
6718 SINGLE_LETTER_MOD (alt_modifier
);
6722 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6726 SINGLE_LETTER_MOD (ctrl_modifier
);
6730 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6731 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6735 SINGLE_LETTER_MOD (hyper_modifier
);
6739 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6743 SINGLE_LETTER_MOD (meta_modifier
);
6747 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6751 SINGLE_LETTER_MOD (shift_modifier
);
6755 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6756 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6757 SINGLE_LETTER_MOD (super_modifier
);
6761 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6762 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6763 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6767 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6770 #undef SINGLE_LETTER_MOD
6771 #undef MULTI_LETTER_MOD
6777 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6778 Such a list is not valid as an event,
6779 but it can be a Lucid-style event type list. */
6782 lucid_event_type_list_p (Lisp_Object object
)
6786 if (! CONSP (object
))
6789 if (EQ (XCAR (object
), Qhelp_echo
)
6790 || EQ (XCAR (object
), Qvertical_line
)
6791 || EQ (XCAR (object
), Qmode_line
)
6792 || EQ (XCAR (object
), Qheader_line
))
6795 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6799 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6806 /* Store into *addr a value nonzero if terminal input chars are available.
6807 Serves the purpose of ioctl (0, FIONREAD, addr)
6808 but works even if FIONREAD does not exist.
6809 (In fact, this may actually read some input.)
6811 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6812 timer events that are ripe.
6813 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6814 events (FOCUS_IN_EVENT).
6815 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6816 movements and toolkit scroll bar thumb drags. */
6819 get_input_pending (int *addr
, int flags
)
6821 /* First of all, have we already counted some input? */
6822 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6824 /* If input is being read as it arrives, and we have none, there is none. */
6825 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6828 /* Try to read some input and see how much we get. */
6830 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6833 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6836 gobble_input (int expected
)
6839 /* Read D-Bus messages. */
6840 xd_read_queued_messages ();
6841 #endif /* HAVE_DBUS */
6844 if (interrupt_input
)
6847 mask
= sigblock (sigmask (SIGIO
));
6848 read_avail_input (expected
);
6852 #ifdef POLL_FOR_INPUT
6853 /* XXX This condition was (read_socket_hook && !interrupt_input),
6854 but read_socket_hook is not global anymore. Let's pretend that
6856 if (!interrupt_input
&& poll_suppress_count
== 0)
6859 mask
= sigblock (sigmask (SIGALRM
));
6860 read_avail_input (expected
);
6866 read_avail_input (expected
);
6869 /* Put a BUFFER_SWITCH_EVENT in the buffer
6870 so that read_key_sequence will notice the new current buffer. */
6873 record_asynch_buffer_change (void)
6875 struct input_event event
;
6879 event
.kind
= BUFFER_SWITCH_EVENT
;
6880 event
.frame_or_window
= Qnil
;
6883 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6884 The purpose of the event is to make read_key_sequence look up the
6885 keymaps again. If we aren't in read_key_sequence, we don't need one,
6886 and the event could cause trouble by messing up (input-pending-p).
6887 Note: Fwaiting_for_user_input_p always returns nil when async
6888 subprocesses aren't supported. */
6889 tem
= Fwaiting_for_user_input_p ();
6893 /* Make sure no interrupt happens while storing the event. */
6895 if (interrupt_input
)
6898 mask
= sigblock (sigmask (SIGIO
));
6899 kbd_buffer_store_event (&event
);
6906 kbd_buffer_store_event (&event
);
6911 /* Read any terminal input already buffered up by the system
6912 into the kbd_buffer, but do not wait.
6914 EXPECTED should be nonzero if the caller knows there is some input.
6916 Returns the number of keyboard chars read, or -1 meaning
6917 this is a bad time to try to read input. */
6920 read_avail_input (int expected
)
6926 /* Store pending user signal events, if any. */
6927 if (store_user_signal_events ())
6930 /* Loop through the available terminals, and call their input hooks. */
6934 struct terminal
*next
= t
->next_terminal
;
6936 if (t
->read_socket_hook
)
6939 struct input_event hold_quit
;
6941 EVENT_INIT (hold_quit
);
6942 hold_quit
.kind
= NO_EVENT
;
6944 /* No need for FIONREAD or fcntl; just say don't wait. */
6945 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6951 if (nr
== -1) /* Not OK to read input now. */
6955 else if (nr
== -2) /* Non-transient error. */
6957 /* The terminal device terminated; it should be closed. */
6959 /* Kill Emacs if this was our last terminal. */
6960 if (!terminal_list
->next_terminal
)
6961 /* Formerly simply reported no input, but that
6962 sometimes led to a failure of Emacs to terminate.
6963 SIGHUP seems appropriate if we can't reach the
6965 /* ??? Is it really right to send the signal just to
6966 this process rather than to the whole process
6967 group? Perhaps on systems with FIONREAD Emacs is
6968 alone in its group. */
6969 kill (getpid (), SIGHUP
);
6971 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6974 XSETTERMINAL (tmp
, t
);
6975 Fdelete_terminal (tmp
, Qnoelisp
);
6979 if (hold_quit
.kind
!= NO_EVENT
)
6980 kbd_buffer_store_event (&hold_quit
);
6989 frame_make_pointer_visible ();
6995 decode_keyboard_code (struct tty_display_info
*tty
,
6996 struct coding_system
*coding
,
6997 unsigned char *buf
, int nbytes
)
6999 unsigned char *src
= buf
;
7000 const unsigned char *p
;
7005 if (tty
->meta_key
!= 2)
7006 for (i
= 0; i
< nbytes
; i
++)
7008 if (coding
->carryover_bytes
> 0)
7010 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7011 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7012 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7013 nbytes
+= coding
->carryover_bytes
;
7015 coding
->destination
= alloca (nbytes
* 4);
7016 coding
->dst_bytes
= nbytes
* 4;
7017 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7018 if (coding
->produced_char
== 0)
7020 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7022 struct input_event buf
;
7025 buf
.code
= STRING_CHAR_ADVANCE (p
);
7026 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7027 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7028 /* See the comment in tty_read_avail_input. */
7029 buf
.frame_or_window
= tty
->top_frame
;
7031 kbd_buffer_store_event (&buf
);
7035 /* This is the tty way of reading available input.
7037 Note that each terminal device has its own `struct terminal' object,
7038 and so this function is called once for each individual termcap
7039 terminal. The first parameter indicates which terminal to read from. */
7042 tty_read_avail_input (struct terminal
*terminal
,
7044 struct input_event
*hold_quit
)
7046 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7047 the kbd_buffer can really hold. That may prevent loss
7048 of characters on some systems when input is stuffed at us. */
7049 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7051 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7053 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7055 if (kbd_on_hold_p () || buffer_free
<= 0)
7058 if (!terminal
->name
) /* Don't read from a dead terminal. */
7061 if (terminal
->type
!= output_termcap
7062 && terminal
->type
!= output_msdos_raw
)
7065 /* XXX I think the following code should be moved to separate hook
7066 functions in system-dependent files. */
7069 #else /* not WINDOWSNT */
7070 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7074 return 0; /* The terminal is suspended. */
7077 n_to_read
= dos_keysns ();
7081 cbuf
[0] = dos_keyread ();
7084 #else /* not MSDOS */
7089 struct input_event hold_quit
;
7090 int gpm
, fd
= gpm_fd
;
7092 EVENT_INIT (hold_quit
);
7093 hold_quit
.kind
= NO_EVENT
;
7095 /* gpm==1 if event received.
7096 gpm==0 if the GPM daemon has closed the connection, in which case
7097 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7098 we save it in `fd' so close_gpm can remove it from the
7100 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7101 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7102 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7105 /* Presumably the GPM daemon has closed the connection. */
7107 if (hold_quit
.kind
!= NO_EVENT
)
7108 kbd_buffer_store_event (&hold_quit
);
7112 #endif /* HAVE_GPM */
7114 /* Determine how many characters we should *try* to read. */
7116 /* Find out how much input is available. */
7117 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7119 if (! noninteractive
)
7120 return -2; /* Close this terminal. */
7126 if (n_to_read
> sizeof cbuf
)
7127 n_to_read
= sizeof cbuf
;
7128 #else /* no FIONREAD */
7129 #if defined (USG) || defined(CYGWIN)
7130 /* Read some input if available, but don't wait. */
7131 n_to_read
= sizeof cbuf
;
7132 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7138 /* Don't read more than we can store. */
7139 if (n_to_read
> buffer_free
)
7140 n_to_read
= buffer_free
;
7142 /* Now read; for one reason or another, this will not block.
7143 NREAD is set to the number of chars read. */
7146 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7147 /* POSIX infers that processes which are not in the session leader's
7148 process group won't get SIGHUP's at logout time. BSDI adheres to
7149 this part standard and returns -1 from read (0) with errno==EIO
7150 when the control tty is taken away.
7151 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7152 if (nread
== -1 && errno
== EIO
)
7153 return -2; /* Close this terminal. */
7154 #if defined (AIX) && defined (_BSD)
7155 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7156 This looks incorrect, but it isn't, because _BSD causes
7157 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7158 and that causes a value other than 0 when there is no input. */
7160 return -2; /* Close this terminal. */
7164 /* We used to retry the read if it was interrupted.
7165 But this does the wrong thing when O_NDELAY causes
7166 an EAGAIN error. Does anybody know of a situation
7167 where a retry is actually needed? */
7169 nread
< 0 && (errno
== EAGAIN
7183 #if defined (USG) || defined (CYGWIN)
7184 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7185 #endif /* USG or CYGWIN */
7186 #endif /* no FIONREAD */
7191 #endif /* not MSDOS */
7192 #endif /* not WINDOWSNT */
7194 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7195 & CODING_REQUIRE_DECODING_MASK
)
7197 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7200 /* Decode the key sequence except for those with meta
7202 for (i
= from
= 0; ; i
++)
7203 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7205 struct input_event buf
;
7207 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7212 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7213 buf
.modifiers
= meta_modifier
;
7214 buf
.code
= cbuf
[i
] & ~0x80;
7215 /* See the comment below. */
7216 buf
.frame_or_window
= tty
->top_frame
;
7218 kbd_buffer_store_event (&buf
);
7224 for (i
= 0; i
< nread
; i
++)
7226 struct input_event buf
;
7228 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7230 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7231 buf
.modifiers
= meta_modifier
;
7232 if (tty
->meta_key
!= 2)
7236 /* Set the frame corresponding to the active tty. Note that the
7237 value of selected_frame is not reliable here, redisplay tends
7238 to temporarily change it. */
7239 buf
.frame_or_window
= tty
->top_frame
;
7242 kbd_buffer_store_event (&buf
);
7243 /* Don't look at input that follows a C-g too closely.
7244 This reduces lossage due to autorepeat on C-g. */
7245 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7246 && buf
.code
== quit_char
)
7254 handle_async_input (void)
7256 interrupt_input_pending
= 0;
7258 pending_signals
= pending_atimers
;
7260 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7261 doing anything dangerous. */
7268 nread
= read_avail_input (1);
7269 /* -1 means it's not ok to read the input now.
7270 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7271 0 means there was no keyboard input available. */
7281 process_pending_signals (void)
7283 if (interrupt_input_pending
)
7284 handle_async_input ();
7285 do_pending_atimers ();
7288 #ifdef SIGIO /* for entire page */
7289 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7292 input_available_signal (int signo
)
7294 /* Must preserve main program's value of errno. */
7295 int old_errno
= errno
;
7296 SIGNAL_THREAD_CHECK (signo
);
7299 interrupt_input_pending
= 1;
7300 pending_signals
= 1;
7303 if (input_available_clear_time
)
7304 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7307 handle_async_input ();
7314 /* Send ourselves a SIGIO.
7316 This function exists so that the UNBLOCK_INPUT macro in
7317 blockinput.h can have some way to take care of input we put off
7318 dealing with, without assuming that every file which uses
7319 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7321 reinvoke_input_signal (void)
7324 handle_async_input ();
7330 /* User signal events. */
7332 struct user_signal_info
7334 /* Signal number. */
7337 /* Name of the signal. */
7340 /* Number of pending signals. */
7343 struct user_signal_info
*next
;
7346 /* List of user signals. */
7347 static struct user_signal_info
*user_signals
= NULL
;
7350 add_user_signal (int sig
, const char *name
)
7352 struct user_signal_info
*p
;
7354 for (p
= user_signals
; p
; p
= p
->next
)
7356 /* Already added. */
7359 p
= xmalloc (sizeof (struct user_signal_info
));
7361 p
->name
= xstrdup (name
);
7363 p
->next
= user_signals
;
7366 signal (sig
, handle_user_signal
);
7370 handle_user_signal (int sig
)
7372 int old_errno
= errno
;
7373 struct user_signal_info
*p
;
7375 SIGNAL_THREAD_CHECK (sig
);
7377 for (p
= user_signals
; p
; p
= p
->next
)
7382 if (interrupt_input
)
7383 kill (getpid (), SIGIO
);
7387 /* Tell wait_reading_process_output that it needs to wake
7388 up and look around. */
7389 if (input_available_clear_time
)
7390 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7399 find_user_signal_name (int sig
)
7401 struct user_signal_info
*p
;
7403 for (p
= user_signals
; p
; p
= p
->next
)
7411 store_user_signal_events (void)
7413 struct user_signal_info
*p
;
7414 struct input_event buf
;
7417 for (p
= user_signals
; p
; p
= p
->next
)
7418 if (p
->npending
> 0)
7424 memset (&buf
, 0, sizeof buf
);
7425 buf
.kind
= USER_SIGNAL_EVENT
;
7426 buf
.frame_or_window
= selected_frame
;
7428 nstored
+= p
->npending
;
7430 mask
= sigblock (sigmask (p
->sig
));
7434 kbd_buffer_store_event (&buf
);
7437 while (p
->npending
> 0);
7445 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7446 static Lisp_Object menu_bar_one_keymap_changed_items
;
7448 /* These variables hold the vector under construction within
7449 menu_bar_items and its subroutines, and the current index
7450 for storing into that vector. */
7451 static Lisp_Object menu_bar_items_vector
;
7452 static int menu_bar_items_index
;
7454 /* Return a vector of menu items for a menu bar, appropriate
7455 to the current buffer. Each item has three elements in the vector:
7458 OLD is an old vector we can optionally reuse, or nil. */
7461 menu_bar_items (Lisp_Object old
)
7463 /* The number of keymaps we're scanning right now, and the number of
7464 keymaps we have allocated space for. */
7467 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7468 in the current keymaps, or nil where it is not a prefix. */
7471 Lisp_Object def
, tail
;
7480 /* In order to build the menus, we need to call the keymap
7481 accessors. They all call QUIT. But this function is called
7482 during redisplay, during which a quit is fatal. So inhibit
7483 quitting while building the menus.
7484 We do this instead of specbind because (1) errors will clear it anyway
7485 and (2) this avoids risk of specpdl overflow. */
7486 oquit
= Vinhibit_quit
;
7490 menu_bar_items_vector
= old
;
7492 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7493 menu_bar_items_index
= 0;
7495 /* Build our list of keymaps.
7496 If we recognize a function key and replace its escape sequence in
7497 keybuf with its symbol, or if the sequence starts with a mouse
7498 click and we need to switch buffers, we jump back here to rebuild
7499 the initial keymaps from the current buffer. */
7503 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7504 if (!NILP (Voverriding_local_map_menu_flag
))
7506 /* Yes, use them (if non-nil) as well as the global map. */
7507 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7509 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7510 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7511 if (!NILP (Voverriding_local_map
))
7512 maps
[nmaps
++] = Voverriding_local_map
;
7516 /* No, so use major and minor mode keymaps and keymap property.
7517 Note that menu-bar bindings in the local-map and keymap
7518 properties may not work reliable, as they are only
7519 recognized when the menu-bar (or mode-line) is updated,
7520 which does not normally happen after every command. */
7523 nminor
= current_minor_maps (NULL
, &tmaps
);
7524 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7526 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7527 maps
[nmaps
++] = tem
;
7528 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7530 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7532 maps
[nmaps
++] = current_global_map
;
7535 /* Look up in each map the dummy prefix key `menu-bar'. */
7539 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7540 if (!NILP (maps
[mapno
]))
7542 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7546 menu_bar_one_keymap_changed_items
= Qnil
;
7547 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7551 /* Move to the end those items that should be at the end. */
7553 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7556 int end
= menu_bar_items_index
;
7558 for (i
= 0; i
< end
; i
+= 4)
7559 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7561 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7562 /* Move the item at index I to the end,
7563 shifting all the others forward. */
7564 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7565 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7566 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7567 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7569 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7570 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7571 (end
- i
- 4) * sizeof (Lisp_Object
));
7572 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7573 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7574 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7575 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7580 /* Add nil, nil, nil, nil at the end. */
7581 i
= menu_bar_items_index
;
7582 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7583 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7584 /* Add this item. */
7585 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7586 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7587 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7588 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7589 menu_bar_items_index
= i
;
7591 Vinhibit_quit
= oquit
;
7592 return menu_bar_items_vector
;
7595 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7596 If there's already an item for KEY, add this DEF to it. */
7598 Lisp_Object item_properties
;
7601 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7603 struct gcpro gcpro1
;
7607 if (EQ (item
, Qundefined
))
7609 /* If a map has an explicit `undefined' as definition,
7610 discard any previously made menu bar item. */
7612 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7613 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7615 if (menu_bar_items_index
> i
+ 4)
7616 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7617 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7618 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7619 menu_bar_items_index
-= 4;
7623 /* If this keymap has already contributed to this KEY,
7624 don't contribute to it a second time. */
7625 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7626 if (!NILP (tem
) || NILP (item
))
7629 menu_bar_one_keymap_changed_items
7630 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7632 /* We add to menu_bar_one_keymap_changed_items before doing the
7633 parse_menu_item, so that if it turns out it wasn't a menu item,
7634 it still correctly hides any further menu item. */
7636 i
= parse_menu_item (item
, 1);
7641 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7643 /* Find any existing item for this KEY. */
7644 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7645 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7648 /* If we did not find this KEY, add it at the end. */
7649 if (i
== menu_bar_items_index
)
7651 /* If vector is too small, get a bigger one. */
7652 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7653 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7654 /* Add this item. */
7655 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7656 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7657 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7658 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7659 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7660 menu_bar_items_index
= i
;
7662 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7666 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7667 /* If the new and the old items are not both keymaps,
7668 the lookup will only find `item'. */
7669 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7670 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7674 /* This is used as the handler when calling menu_item_eval_property. */
7676 menu_item_eval_property_1 (Lisp_Object arg
)
7678 /* If we got a quit from within the menu computation,
7679 quit all the way out of it. This takes care of C-] in the debugger. */
7680 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7681 Fsignal (Qquit
, Qnil
);
7686 /* Evaluate an expression and return the result (or nil if something
7687 went wrong). Used to evaluate dynamic parts of menu items. */
7689 menu_item_eval_property (Lisp_Object sexpr
)
7691 int count
= SPECPDL_INDEX ();
7693 specbind (Qinhibit_redisplay
, Qt
);
7694 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7695 menu_item_eval_property_1
);
7696 return unbind_to (count
, val
);
7699 /* This function parses a menu item and leaves the result in the
7700 vector item_properties.
7701 ITEM is a key binding, a possible menu item.
7702 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7704 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7705 parse_menu_item returns true if the item is a menu item and false
7709 parse_menu_item (Lisp_Object item
, int inmenubar
)
7711 Lisp_Object def
, tem
, item_string
, start
;
7713 Lisp_Object keyhint
;
7722 /* Create item_properties vector if necessary. */
7723 if (NILP (item_properties
))
7725 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7727 /* Initialize optional entries. */
7728 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7729 ASET (item_properties
, i
, Qnil
);
7730 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7732 /* Save the item here to protect it from GC. */
7733 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7735 item_string
= XCAR (item
);
7739 if (STRINGP (item_string
))
7741 /* Old format menu item. */
7742 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7744 /* Maybe help string. */
7745 if (CONSP (item
) && STRINGP (XCAR (item
)))
7747 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7752 /* Maybe an obsolete key binding cache. */
7753 if (CONSP (item
) && CONSP (XCAR (item
))
7754 && (NILP (XCAR (XCAR (item
)))
7755 || VECTORP (XCAR (XCAR (item
)))))
7758 /* This is the real definition--the function to run. */
7759 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7761 /* Get enable property, if any. */
7764 tem
= Fget (item
, Qmenu_enable
);
7765 if (!NILP (Venable_disabled_menus_and_buttons
))
7766 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7767 else if (!NILP (tem
))
7768 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7771 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7773 /* New format menu item. */
7774 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7775 start
= XCDR (item
);
7778 /* We have a real binding. */
7779 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7781 item
= XCDR (start
);
7782 /* Is there an obsolete cache list with key equivalences. */
7783 if (CONSP (item
) && CONSP (XCAR (item
)))
7786 /* Parse properties. */
7787 while (CONSP (item
) && CONSP (XCDR (item
)))
7792 if (EQ (tem
, QCenable
))
7794 if (!NILP (Venable_disabled_menus_and_buttons
))
7795 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7797 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7799 else if (EQ (tem
, QCvisible
))
7801 /* If got a visible property and that evaluates to nil
7802 then ignore this item. */
7803 tem
= menu_item_eval_property (XCAR (item
));
7807 else if (EQ (tem
, QChelp
))
7808 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7809 else if (EQ (tem
, QCfilter
))
7811 else if (EQ (tem
, QCkey_sequence
))
7814 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7815 /* Be GC protected. Set keyhint to item instead of tem. */
7818 else if (EQ (tem
, QCkeys
))
7821 if (CONSP (tem
) || STRINGP (tem
))
7822 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7824 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7829 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7831 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7833 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7839 else if (inmenubar
|| !NILP (start
))
7843 return 0; /* not a menu item */
7845 /* If item string is not a string, evaluate it to get string.
7846 If we don't get a string, skip this item. */
7847 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7848 if (!(STRINGP (item_string
)))
7850 item_string
= menu_item_eval_property (item_string
);
7851 if (!STRINGP (item_string
))
7853 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7856 /* If got a filter apply it on definition. */
7857 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7860 def
= menu_item_eval_property (list2 (XCAR (filter
),
7861 list2 (Qquote
, def
)));
7863 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7866 /* Enable or disable selection of item. */
7867 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7870 tem
= menu_item_eval_property (tem
);
7871 if (inmenubar
&& NILP (tem
))
7872 return 0; /* Ignore disabled items in menu bar. */
7873 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7876 /* If we got no definition, this item is just unselectable text which
7877 is OK in a submenu but not in the menubar. */
7879 return (inmenubar
? 0 : 1);
7881 /* See if this is a separate pane or a submenu. */
7882 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7883 tem
= get_keymap (def
, 0, 1);
7884 /* For a subkeymap, just record its details and exit. */
7887 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7888 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7892 /* At the top level in the menu bar, do likewise for commands also.
7893 The menu bar does not display equivalent key bindings anyway.
7894 ITEM_PROPERTY_DEF is already set up properly. */
7898 { /* This is a command. See if there is an equivalent key binding. */
7899 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7901 /* The previous code preferred :key-sequence to :keys, so we
7902 preserve this behavior. */
7903 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7904 keyeq
= Fsubstitute_command_keys (keyeq
);
7907 Lisp_Object prefix
= keyeq
;
7908 Lisp_Object keys
= Qnil
;
7912 def
= XCAR (prefix
);
7913 prefix
= XCDR (prefix
);
7916 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7918 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7920 keys
= XCAR (keyhint
);
7921 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7923 /* We have a suggested key. Is it bound to the command? */
7926 /* If the command is an alias for another
7927 (such as lmenu.el set it up), check if the
7928 original command matches the cached command. */
7929 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7934 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7938 tem
= Fkey_description (keys
, Qnil
);
7941 if (STRINGP (XCAR (prefix
)))
7942 tem
= concat2 (XCAR (prefix
), tem
);
7943 if (STRINGP (XCDR (prefix
)))
7944 tem
= concat2 (tem
, XCDR (prefix
));
7946 keyeq
= concat2 (build_string (" "), tem
);
7947 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7953 /* If we have an equivalent key binding, use that. */
7954 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7957 /* Include this when menu help is implemented.
7958 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7959 if (!(NILP (tem) || STRINGP (tem)))
7961 tem = menu_item_eval_property (tem);
7964 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7968 /* Handle radio buttons or toggle boxes. */
7969 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7971 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7972 menu_item_eval_property (tem
));
7979 /***********************************************************************
7981 ***********************************************************************/
7983 /* A vector holding tool bar items while they are parsed in function
7984 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7987 static Lisp_Object tool_bar_items_vector
;
7989 /* A vector holding the result of parse_tool_bar_item. Layout is like
7990 the one for a single item in tool_bar_items_vector. */
7992 static Lisp_Object tool_bar_item_properties
;
7994 /* Next free index in tool_bar_items_vector. */
7996 static int ntool_bar_items
;
7998 /* The symbols `:image' and `:rtl'. */
8000 Lisp_Object QCimage
;
8003 /* Function prototypes. */
8005 static void init_tool_bar_items (Lisp_Object
);
8006 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8007 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8008 static void append_tool_bar_item (void);
8011 /* Return a vector of tool bar items for keymaps currently in effect.
8012 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8013 tool bar items found. */
8016 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8025 /* In order to build the menus, we need to call the keymap
8026 accessors. They all call QUIT. But this function is called
8027 during redisplay, during which a quit is fatal. So inhibit
8028 quitting while building the menus. We do this instead of
8029 specbind because (1) errors will clear it anyway and (2) this
8030 avoids risk of specpdl overflow. */
8031 oquit
= Vinhibit_quit
;
8034 /* Initialize tool_bar_items_vector and protect it from GC. */
8035 init_tool_bar_items (reuse
);
8037 /* Build list of keymaps in maps. Set nmaps to the number of maps
8040 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8041 if (!NILP (Voverriding_local_map_menu_flag
))
8043 /* Yes, use them (if non-nil) as well as the global map. */
8044 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8046 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8047 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8048 if (!NILP (Voverriding_local_map
))
8049 maps
[nmaps
++] = Voverriding_local_map
;
8053 /* No, so use major and minor mode keymaps and keymap property.
8054 Note that tool-bar bindings in the local-map and keymap
8055 properties may not work reliable, as they are only
8056 recognized when the tool-bar (or mode-line) is updated,
8057 which does not normally happen after every command. */
8060 nminor
= current_minor_maps (NULL
, &tmaps
);
8061 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8063 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8064 maps
[nmaps
++] = tem
;
8065 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8067 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8070 /* Add global keymap at the end. */
8071 maps
[nmaps
++] = current_global_map
;
8073 /* Process maps in reverse order and look up in each map the prefix
8075 for (i
= nmaps
- 1; i
>= 0; --i
)
8076 if (!NILP (maps
[i
]))
8080 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8082 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8085 Vinhibit_quit
= oquit
;
8086 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8087 return tool_bar_items_vector
;
8091 /* Process the definition of KEY which is DEF. */
8094 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8097 struct gcpro gcpro1
, gcpro2
;
8099 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8103 if (EQ (def
, Qundefined
))
8105 /* If a map has an explicit `undefined' as definition,
8106 discard any previously made item. */
8107 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8109 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8111 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8113 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8114 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8115 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8116 * sizeof (Lisp_Object
)));
8117 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8122 else if (parse_tool_bar_item (key
, def
))
8123 /* Append a new tool bar item to tool_bar_items_vector. Accept
8124 more than one definition for the same key. */
8125 append_tool_bar_item ();
8131 /* Parse a tool bar item specification ITEM for key KEY and return the
8132 result in tool_bar_item_properties. Value is zero if ITEM is
8135 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8137 CAPTION is the caption of the item, If it's not a string, it is
8138 evaluated to get a string.
8140 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8141 as binding are currently ignored.
8143 The following properties are recognized:
8147 FORM is evaluated and specifies whether the tool bar item is
8148 enabled or disabled.
8152 FORM is evaluated and specifies whether the tool bar item is visible.
8154 - `:filter FUNCTION'
8156 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8157 result is stored as the new binding.
8159 - `:button (TYPE SELECTED)'
8161 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8162 and specifies whether the button is selected (pressed) or not.
8166 IMAGES is either a single image specification or a vector of four
8167 image specifications. See enum tool_bar_item_images.
8169 - `:help HELP-STRING'.
8171 Gives a help string to display for the tool bar item.
8173 - `:label LABEL-STRING'.
8175 A text label to show with the tool bar button if labels are enabled. */
8178 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8180 /* Access slot with index IDX of vector tool_bar_item_properties. */
8181 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8183 Lisp_Object filter
= Qnil
;
8184 Lisp_Object caption
;
8185 int i
, have_label
= 0;
8187 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8188 Rule out items that aren't lists, don't start with
8189 `menu-item' or whose rest following `tool-bar-item' is not a
8192 || !EQ (XCAR (item
), Qmenu_item
)
8193 || (item
= XCDR (item
),
8197 /* Create tool_bar_item_properties vector if necessary. Reset it to
8199 if (VECTORP (tool_bar_item_properties
))
8201 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8205 tool_bar_item_properties
8206 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8209 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8210 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8212 /* Get the caption of the item. If the caption is not a string,
8213 evaluate it to get a string. If we don't get a string, skip this
8215 caption
= XCAR (item
);
8216 if (!STRINGP (caption
))
8218 caption
= menu_item_eval_property (caption
);
8219 if (!STRINGP (caption
))
8222 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8224 /* Give up if rest following the caption is not a list. */
8229 /* Store the binding. */
8230 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8233 /* Ignore cached key binding, if any. */
8234 if (CONSP (item
) && CONSP (XCAR (item
)))
8237 /* Process the rest of the properties. */
8238 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8240 Lisp_Object key
, value
;
8243 value
= XCAR (XCDR (item
));
8245 if (EQ (key
, QCenable
))
8247 /* `:enable FORM'. */
8248 if (!NILP (Venable_disabled_menus_and_buttons
))
8249 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8251 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8253 else if (EQ (key
, QCvisible
))
8255 /* `:visible FORM'. If got a visible property and that
8256 evaluates to nil then ignore this item. */
8257 if (NILP (menu_item_eval_property (value
)))
8260 else if (EQ (key
, QChelp
))
8261 /* `:help HELP-STRING'. */
8262 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8263 else if (EQ (key
, QClabel
))
8265 /* `:label LABEL-STRING'. */
8266 PROP (TOOL_BAR_ITEM_LABEL
) = value
;
8269 else if (EQ (key
, QCfilter
))
8270 /* ':filter FORM'. */
8272 else if (EQ (key
, QCbutton
) && CONSP (value
))
8274 /* `:button (TYPE . SELECTED)'. */
8275 Lisp_Object type
, selected
;
8277 type
= XCAR (value
);
8278 selected
= XCDR (value
);
8279 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8281 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8282 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8285 else if (EQ (key
, QCimage
)
8287 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8288 /* Value is either a single image specification or a vector
8289 of 4 such specifications for the different button states. */
8290 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8291 else if (EQ (key
, Qrtl
))
8293 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8299 /* Try to make one from caption and key. */
8300 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8301 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8302 char *label
= SYMBOLP (key
) ? (char *) SDATA (SYMBOL_NAME (key
)) : "";
8303 char *caption
= STRINGP (capt
) ? (char *) SDATA (capt
) : "";
8305 EMACS_INT max_lbl
= 2*tool_bar_max_label_size
;
8306 Lisp_Object new_lbl
;
8308 if (strlen (caption
) < max_lbl
&& caption
[0] != '\0')
8310 strcpy (buf
, caption
);
8311 while (buf
[0] != '\0' && buf
[strlen (buf
) -1] == '.')
8312 buf
[strlen (buf
)-1] = '\0';
8313 if (strlen (buf
) <= max_lbl
)
8317 if (strlen (caption
) <= max_lbl
)
8320 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8323 if (label
!= buf
) strcpy (buf
, label
);
8325 for (i
= 0; i
< strlen (buf
); ++i
)
8327 if (buf
[i
] == '-') buf
[i
] = ' ';
8334 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8335 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8336 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8339 /* If got a filter apply it on binding. */
8341 PROP (TOOL_BAR_ITEM_BINDING
)
8342 = menu_item_eval_property (list2 (filter
,
8344 PROP (TOOL_BAR_ITEM_BINDING
))));
8346 /* See if the binding is a keymap. Give up if it is. */
8347 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8350 /* Enable or disable selection of item. */
8351 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8352 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8353 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8355 /* Handle radio buttons or toggle boxes. */
8356 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8357 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8358 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8366 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8367 that can be reused. */
8370 init_tool_bar_items (Lisp_Object reuse
)
8372 if (VECTORP (reuse
))
8373 tool_bar_items_vector
= reuse
;
8375 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8376 ntool_bar_items
= 0;
8380 /* Append parsed tool bar item properties from
8381 tool_bar_item_properties */
8384 append_tool_bar_item (void)
8386 Lisp_Object
*to
, *from
;
8388 /* Enlarge tool_bar_items_vector if necessary. */
8389 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8390 >= XVECTOR (tool_bar_items_vector
)->size
)
8391 tool_bar_items_vector
8392 = larger_vector (tool_bar_items_vector
,
8393 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8395 /* Append entries from tool_bar_item_properties to the end of
8396 tool_bar_items_vector. */
8397 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8398 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8399 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8400 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8407 /* Read a character using menus based on maps in the array MAPS.
8408 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8409 Return t if we displayed a menu but the user rejected it.
8411 PREV_EVENT is the previous input event, or nil if we are reading
8412 the first event of a key sequence.
8414 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8415 if we used a mouse menu to read the input, or zero otherwise. If
8416 USED_MOUSE_MENU is null, we don't dereference it.
8418 The prompting is done based on the prompt-string of the map
8419 and the strings associated with various map elements.
8421 This can be done with X menus or with menus put in the minibuf.
8422 These are done in different ways, depending on how the input will be read.
8423 Menus using X are done after auto-saving in read-char, getting the input
8424 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8425 and do auto-saving in the inner call of read_char. */
8428 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8429 int *used_mouse_menu
)
8433 if (used_mouse_menu
)
8434 *used_mouse_menu
= 0;
8436 /* Use local over global Menu maps */
8438 if (! menu_prompting
)
8441 /* Optionally disregard all but the global map. */
8442 if (inhibit_local_menu_bar_menus
)
8444 maps
+= (nmaps
- 1);
8449 /* If we got to this point via a mouse click,
8450 use a real menu for mouse selection. */
8451 if (EVENT_HAS_PARAMETERS (prev_event
)
8452 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8453 && !EQ (XCAR (prev_event
), Qtool_bar
))
8455 /* Display the menu and get the selection. */
8456 Lisp_Object
*realmaps
8457 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8461 /* Use the maps that are not nil. */
8462 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8463 if (!NILP (maps
[mapno
]))
8464 realmaps
[nmaps1
++] = maps
[mapno
];
8466 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8471 record_menu_key (XCAR (value
));
8473 /* If we got multiple events, unread all but
8475 There is no way to prevent those unread events
8476 from showing up later in last_nonmenu_event.
8477 So turn symbol and integer events into lists,
8478 to indicate that they came from a mouse menu,
8479 so that when present in last_nonmenu_event
8480 they won't confuse things. */
8481 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8483 record_menu_key (XCAR (tem
));
8484 if (SYMBOLP (XCAR (tem
))
8485 || INTEGERP (XCAR (tem
)))
8486 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8489 /* If we got more than one event, put all but the first
8490 onto this list to be read later.
8491 Return just the first event now. */
8492 Vunread_command_events
8493 = nconc2 (XCDR (value
), Vunread_command_events
);
8494 value
= XCAR (value
);
8496 else if (NILP (value
))
8498 if (used_mouse_menu
)
8499 *used_mouse_menu
= 1;
8502 #endif /* HAVE_MENUS */
8506 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8507 We make this bigger when necessary, and never free it. */
8508 static char *read_char_minibuf_menu_text
;
8509 /* Size of that buffer. */
8510 static int read_char_minibuf_menu_width
;
8513 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8516 register Lisp_Object name
;
8518 /* FIXME: Use the minibuffer's frame width. */
8519 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8522 Lisp_Object rest
, vector
;
8528 if (! menu_prompting
)
8531 /* Get the menu name from the first map that has one (a prompt string). */
8532 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8534 name
= Fkeymap_prompt (maps
[mapno
]);
8539 /* If we don't have any menus, just read a character normally. */
8540 if (!STRINGP (name
))
8543 /* Make sure we have a big enough buffer for the menu text. */
8544 width
= max (width
, SBYTES (name
));
8545 if (read_char_minibuf_menu_text
== 0)
8547 read_char_minibuf_menu_width
= width
+ 4;
8548 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8550 else if (width
+ 4 > read_char_minibuf_menu_width
)
8552 read_char_minibuf_menu_width
= width
+ 4;
8553 read_char_minibuf_menu_text
8554 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8556 menu
= read_char_minibuf_menu_text
;
8558 /* Prompt string always starts with map's prompt, and a space. */
8559 strcpy (menu
, SDATA (name
));
8560 nlength
= SBYTES (name
);
8561 menu
[nlength
++] = ':';
8562 menu
[nlength
++] = ' ';
8565 /* Start prompting at start of first map. */
8569 /* Present the documented bindings, a line at a time. */
8576 Lisp_Object orig_defn_macro
;
8578 /* Loop over elements of map. */
8583 /* If reached end of map, start at beginning of next map. */
8587 /* At end of last map, wrap around to first map if just starting,
8588 or end this line if already have something on it. */
8592 if (notfirst
|| nobindings
) break;
8597 /* Look at the next element of the map. */
8599 elt
= XVECTOR (vector
)->contents
[idx
];
8601 elt
= Fcar_safe (rest
);
8603 if (idx
< 0 && VECTORP (elt
))
8605 /* If we found a dense table in the keymap,
8606 advanced past it, but start scanning its contents. */
8607 rest
= Fcdr_safe (rest
);
8613 /* An ordinary element. */
8614 Lisp_Object event
, tem
;
8618 event
= Fcar_safe (elt
); /* alist */
8619 elt
= Fcdr_safe (elt
);
8623 XSETINT (event
, idx
); /* vector */
8626 /* Ignore the element if it has no prompt string. */
8627 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8629 /* 1 if the char to type matches the string. */
8631 Lisp_Object upcased_event
, downcased_event
;
8632 Lisp_Object desc
= Qnil
;
8634 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8636 upcased_event
= Fupcase (event
);
8637 downcased_event
= Fdowncase (event
);
8638 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8639 || XINT (downcased_event
) == SREF (s
, 0));
8641 desc
= Fsingle_key_description (event
, Qnil
);
8643 #if 0 /* It is redundant to list the equivalent key bindings because
8644 the prefix is what the user has already typed. */
8646 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8648 /* Insert equivalent keybinding. */
8649 s
= concat2 (s
, tem
);
8652 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8653 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8655 /* Insert button prefix. */
8656 Lisp_Object selected
8657 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8658 if (EQ (tem
, QCradio
))
8659 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8661 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8662 s
= concat2 (tem
, s
);
8666 /* If we have room for the prompt string, add it to this line.
8667 If this is the first on the line, always add it. */
8668 if ((SCHARS (s
) + i
+ 2
8669 + (char_matches
? 0 : SCHARS (desc
) + 3))
8675 /* Punctuate between strings. */
8678 strcpy (menu
+ i
, ", ");
8684 /* If the char to type doesn't match the string's
8685 first char, explicitly show what char to type. */
8688 /* Add as much of string as fits. */
8689 thiswidth
= SCHARS (desc
);
8690 if (thiswidth
+ i
> width
)
8691 thiswidth
= width
- i
;
8692 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8694 strcpy (menu
+ i
, " = ");
8698 /* Add as much of string as fits. */
8699 thiswidth
= SCHARS (s
);
8700 if (thiswidth
+ i
> width
)
8701 thiswidth
= width
- i
;
8702 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8708 /* If this element does not fit, end the line now,
8709 and save the element for the next line. */
8710 strcpy (menu
+ i
, "...");
8715 /* Move past this element. */
8716 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8717 /* Handle reaching end of dense table. */
8722 rest
= Fcdr_safe (rest
);
8726 /* Prompt with that and read response. */
8727 message2_nolog (menu
, strlen (menu
),
8728 ! NILP (current_buffer
->enable_multibyte_characters
));
8730 /* Make believe its not a keyboard macro in case the help char
8731 is pressed. Help characters are not recorded because menu prompting
8732 is not used on replay.
8734 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8735 current_kboard
->defining_kbd_macro
= Qnil
;
8737 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8738 while (BUFFERP (obj
));
8739 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8741 if (!INTEGERP (obj
))
8743 else if (XINT (obj
) == -2)
8748 if (! EQ (obj
, menu_prompt_more_char
)
8749 && (!INTEGERP (menu_prompt_more_char
)
8750 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8752 if (!NILP (current_kboard
->defining_kbd_macro
))
8753 store_kbd_macro_char (obj
);
8756 /* Help char - go round again */
8760 /* Reading key sequences. */
8762 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8763 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8764 keymap, or nil otherwise. Return the index of the first keymap in
8765 which KEY has any binding, or NMAPS if no map has a binding.
8767 If KEY is a meta ASCII character, treat it like meta-prefix-char
8768 followed by the corresponding non-meta character. Keymaps in
8769 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8772 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8775 NEXT may be the same array as CURRENT. */
8778 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8781 int i
, first_binding
;
8783 first_binding
= nmaps
;
8784 for (i
= nmaps
- 1; i
>= 0; i
--)
8786 if (! NILP (current
[i
]))
8788 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8789 if (! NILP (defs
[i
]))
8796 /* Given the set of bindings we've found, produce the next set of maps. */
8797 if (first_binding
< nmaps
)
8798 for (i
= 0; i
< nmaps
; i
++)
8799 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8801 return first_binding
;
8804 /* Structure used to keep track of partial application of key remapping
8805 such as Vfunction_key_map and Vkey_translation_map. */
8806 typedef struct keyremap
8808 /* This is the map originally specified for this use. */
8810 /* This is a submap reached by looking up, in PARENT,
8811 the events from START to END. */
8813 /* Positions [START, END) in the key sequence buffer
8814 are the key that we have scanned so far.
8815 Those events are the ones that we will replace
8816 if PAREHT maps them into a key sequence. */
8820 /* Lookup KEY in MAP.
8821 MAP is a keymap mapping keys to key vectors or functions.
8822 If the mapping is a function and DO_FUNCTION is non-zero, then
8823 the function is called with PROMPT as parameter and its return
8824 value is used as the return value of this function (after checking
8825 that it is indeed a vector). */
8828 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8833 next
= access_keymap (map
, key
, 1, 0, 1);
8835 /* Handle symbol with autoload definition. */
8836 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8837 && CONSP (XSYMBOL (next
)->function
)
8838 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8839 do_autoload (XSYMBOL (next
)->function
, next
);
8841 /* Handle a symbol whose function definition is a keymap
8843 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8844 && (ARRAYP (XSYMBOL (next
)->function
)
8845 || KEYMAPP (XSYMBOL (next
)->function
)))
8846 next
= XSYMBOL (next
)->function
;
8848 /* If the keymap gives a function, not an
8849 array, then call the function with one arg and use
8850 its value instead. */
8851 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8856 next
= call1 (next
, prompt
);
8857 /* If the function returned something invalid,
8858 barf--don't ignore it.
8859 (To ignore it safely, we would need to gcpro a bunch of
8860 other variables.) */
8861 if (! (VECTORP (next
) || STRINGP (next
)))
8862 error ("Function %s returns invalid key sequence", tem
);
8867 /* Do one step of the key remapping used for function-key-map and
8868 key-translation-map:
8869 KEYBUF is the buffer holding the input events.
8870 BUFSIZE is its maximum size.
8871 FKEY is a pointer to the keyremap structure to use.
8872 INPUT is the index of the last element in KEYBUF.
8873 DOIT if non-zero says that the remapping can actually take place.
8874 DIFF is used to return the number of keys added/removed by the remapping.
8875 PARENT is the root of the keymap.
8876 PROMPT is the prompt to use if the remapping happens through a function.
8877 The return value is non-zero if the remapping actually took place. */
8880 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8881 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8883 Lisp_Object next
, key
;
8885 key
= keybuf
[fkey
->end
++];
8887 if (KEYMAPP (fkey
->parent
))
8888 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8892 /* If keybuf[fkey->start..fkey->end] is bound in the
8893 map and we're in a position to do the key remapping, replace it with
8894 the binding and restart with fkey->start at the end. */
8895 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8897 int len
= XFASTINT (Flength (next
));
8900 *diff
= len
- (fkey
->end
- fkey
->start
);
8902 if (input
+ *diff
>= bufsize
)
8903 error ("Key sequence too long");
8905 /* Shift the keys that follow fkey->end. */
8907 for (i
= fkey
->end
; i
< input
; i
++)
8908 keybuf
[i
+ *diff
] = keybuf
[i
];
8910 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8911 keybuf
[i
+ *diff
] = keybuf
[i
];
8912 /* Overwrite the old keys with the new ones. */
8913 for (i
= 0; i
< len
; i
++)
8914 keybuf
[fkey
->start
+ i
]
8915 = Faref (next
, make_number (i
));
8917 fkey
->start
= fkey
->end
+= *diff
;
8918 fkey
->map
= fkey
->parent
;
8923 fkey
->map
= get_keymap (next
, 0, 1);
8925 /* If we no longer have a bound suffix, try a new position for
8927 if (!CONSP (fkey
->map
))
8929 fkey
->end
= ++fkey
->start
;
8930 fkey
->map
= fkey
->parent
;
8935 /* Read a sequence of keys that ends with a non prefix character,
8936 storing it in KEYBUF, a buffer of size BUFSIZE.
8938 Return the length of the key sequence stored.
8939 Return -1 if the user rejected a command menu.
8941 Echo starting immediately unless `prompt' is 0.
8943 Where a key sequence ends depends on the currently active keymaps.
8944 These include any minor mode keymaps active in the current buffer,
8945 the current buffer's local map, and the global map.
8947 If a key sequence has no other bindings, we check Vfunction_key_map
8948 to see if some trailing subsequence might be the beginning of a
8949 function key's sequence. If so, we try to read the whole function
8950 key, and substitute its symbolic name into the key sequence.
8952 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8953 `double-' events into similar click events, if that would make them
8954 bound. We try to turn `triple-' events first into `double-' events,
8957 If we get a mouse click in a mode line, vertical divider, or other
8958 non-text area, we treat the click as if it were prefixed by the
8959 symbol denoting that area - `mode-line', `vertical-line', or
8962 If the sequence starts with a mouse click, we read the key sequence
8963 with respect to the buffer clicked on, not the current buffer.
8965 If the user switches frames in the midst of a key sequence, we put
8966 off the switch-frame event until later; the next call to
8967 read_char will return it.
8969 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8970 from the selected window's buffer. */
8973 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8974 int dont_downcase_last
, int can_return_switch_frame
,
8975 int fix_current_buffer
)
8977 Lisp_Object from_string
;
8978 int count
= SPECPDL_INDEX ();
8980 /* How many keys there are in the current key sequence. */
8983 /* The length of the echo buffer when we started reading, and
8984 the length of this_command_keys when we started reading. */
8988 /* The number of keymaps we're scanning right now, and the number of
8989 keymaps we have allocated space for. */
8991 int nmaps_allocated
= 0;
8993 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8994 the current keymaps. */
8995 Lisp_Object
*defs
= NULL
;
8997 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8998 in the current keymaps, or nil where it is not a prefix. */
8999 Lisp_Object
*submaps
= NULL
;
9001 /* The local map to start out with at start of key sequence. */
9002 Lisp_Object orig_local_map
;
9004 /* The map from the `keymap' property to start out with at start of
9006 Lisp_Object orig_keymap
;
9008 /* 1 if we have already considered switching to the local-map property
9009 of the place where a mouse click occurred. */
9010 int localized_local_map
= 0;
9012 /* The index in submaps[] of the first keymap that has a binding for
9013 this key sequence. In other words, the lowest i such that
9014 submaps[i] is non-nil. */
9016 /* Index of the first key that has no binding.
9017 It is useless to try fkey.start larger than that. */
9020 /* If t < mock_input, then KEYBUF[t] should be read as the next
9023 We use this to recover after recognizing a function key. Once we
9024 realize that a suffix of the current key sequence is actually a
9025 function key's escape sequence, we replace the suffix with the
9026 function key's binding from Vfunction_key_map. Now keybuf
9027 contains a new and different key sequence, so the echo area,
9028 this_command_keys, and the submaps and defs arrays are wrong. In
9029 this situation, we set mock_input to t, set t to 0, and jump to
9030 restart_sequence; the loop will read keys from keybuf up until
9031 mock_input, thus rebuilding the state; and then it will resume
9032 reading characters from the keyboard. */
9035 /* If the sequence is unbound in submaps[], then
9036 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9037 and fkey.map is its binding.
9039 These might be > t, indicating that all function key scanning
9040 should hold off until t reaches them. We do this when we've just
9041 recognized a function key, to avoid searching for the function
9042 key's again in Vfunction_key_map. */
9045 /* Likewise, for key_translation_map and input-decode-map. */
9046 keyremap keytran
, indec
;
9048 /* Non-zero if we are trying to map a key by changing an upper-case
9049 letter to lower case, or a shifted function key to an unshifted
9051 int shift_translated
= 0;
9053 /* If we receive a `switch-frame' or `select-window' event in the middle of
9054 a key sequence, we put it off for later.
9055 While we're reading, we keep the event here. */
9056 Lisp_Object delayed_switch_frame
;
9058 /* See the comment below... */
9059 #if defined (GOBBLE_FIRST_EVENT)
9060 Lisp_Object first_event
;
9063 Lisp_Object original_uppercase
;
9064 int original_uppercase_position
= -1;
9066 /* Gets around Microsoft compiler limitations. */
9069 struct buffer
*starting_buffer
;
9071 /* List of events for which a fake prefix key has been generated. */
9072 Lisp_Object fake_prefixed_keys
= Qnil
;
9074 #if defined (GOBBLE_FIRST_EVENT)
9078 struct gcpro gcpro1
;
9080 GCPRO1 (fake_prefixed_keys
);
9081 raw_keybuf_count
= 0;
9083 last_nonmenu_event
= Qnil
;
9085 delayed_switch_frame
= Qnil
;
9090 echo_prompt (prompt
);
9091 else if (cursor_in_echo_area
9092 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9093 && NILP (Fzerop (Vecho_keystrokes
)))
9094 /* This doesn't put in a dash if the echo buffer is empty, so
9095 you don't always see a dash hanging out in the minibuffer. */
9099 /* Record the initial state of the echo area and this_command_keys;
9100 we will need to restore them if we replay a key sequence. */
9102 echo_start
= echo_length ();
9103 keys_start
= this_command_key_count
;
9104 this_single_command_key_start
= keys_start
;
9106 #if defined (GOBBLE_FIRST_EVENT)
9107 /* This doesn't quite work, because some of the things that read_char
9108 does cannot safely be bypassed. It seems too risky to try to make
9111 /* Read the first char of the sequence specially, before setting
9112 up any keymaps, in case a filter runs and switches buffers on us. */
9113 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9115 #endif /* GOBBLE_FIRST_EVENT */
9117 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9118 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9121 /* We jump here when we need to reinitialize fkey and keytran; this
9122 happens if we switch keyboards between rescans. */
9123 replay_entire_sequence
:
9125 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9126 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9127 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9128 indec
.start
= indec
.end
= 0;
9129 fkey
.start
= fkey
.end
= 0;
9130 keytran
.start
= keytran
.end
= 0;
9132 /* We jump here when the key sequence has been thoroughly changed, and
9133 we need to rescan it starting from the beginning. When we jump here,
9134 keybuf[0..mock_input] holds the sequence we should reread. */
9137 starting_buffer
= current_buffer
;
9138 first_unbound
= bufsize
+ 1;
9140 /* Build our list of keymaps.
9141 If we recognize a function key and replace its escape sequence in
9142 keybuf with its symbol, or if the sequence starts with a mouse
9143 click and we need to switch buffers, we jump back here to rebuild
9144 the initial keymaps from the current buffer. */
9147 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9149 if (2 > nmaps_allocated
)
9151 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9152 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9153 nmaps_allocated
= 2;
9155 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9157 else if (!NILP (Voverriding_local_map
))
9159 if (2 > nmaps_allocated
)
9161 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9162 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9163 nmaps_allocated
= 2;
9165 submaps
[nmaps
++] = Voverriding_local_map
;
9173 nminor
= current_minor_maps (0, &maps
);
9174 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9176 if (total
> nmaps_allocated
)
9178 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9179 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9180 nmaps_allocated
= total
;
9183 if (!NILP (orig_keymap
))
9184 submaps
[nmaps
++] = orig_keymap
;
9186 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9190 submaps
[nmaps
++] = orig_local_map
;
9192 submaps
[nmaps
++] = current_global_map
;
9194 /* Find an accurate initial value for first_binding. */
9195 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9196 if (! NILP (submaps
[first_binding
]))
9199 /* Start from the beginning in keybuf. */
9202 /* These are no-ops the first time through, but if we restart, they
9203 revert the echo area and this_command_keys to their original state. */
9204 this_command_key_count
= keys_start
;
9205 if (INTERACTIVE
&& t
< mock_input
)
9206 echo_truncate (echo_start
);
9208 /* If the best binding for the current key sequence is a keymap, or
9209 we may be looking at a function key's escape sequence, keep on
9211 while (first_binding
< nmaps
9212 /* Keep reading as long as there's a prefix binding. */
9213 ? !NILP (submaps
[first_binding
])
9214 /* Don't return in the middle of a possible function key sequence,
9215 if the only bindings we found were via case conversion.
9216 Thus, if ESC O a has a function-key-map translation
9217 and ESC o has a binding, don't return after ESC O,
9218 so that we can translate ESC O plus the next character. */
9219 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9222 int used_mouse_menu
= 0;
9224 /* Where the last real key started. If we need to throw away a
9225 key that has expanded into more than one element of keybuf
9226 (say, a mouse click on the mode line which is being treated
9227 as [mode-line (mouse-...)], then we backtrack to this point
9229 int last_real_key_start
;
9231 /* These variables are analogous to echo_start and keys_start;
9232 while those allow us to restart the entire key sequence,
9233 echo_local_start and keys_local_start allow us to throw away
9235 int echo_local_start
, keys_local_start
, local_first_binding
;
9237 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9238 eassert (indec
.start
<= indec
.end
);
9239 eassert (fkey
.start
<= fkey
.end
);
9240 eassert (keytran
.start
<= keytran
.end
);
9241 /* key-translation-map is applied *after* function-key-map
9242 which is itself applied *after* input-decode-map. */
9243 eassert (fkey
.end
<= indec
.start
);
9244 eassert (keytran
.end
<= fkey
.start
);
9246 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9247 first_unbound
< keytran
.start
)
9248 { /* The prefix upto first_unbound has no binding and has
9249 no translation left to do either, so we know it's unbound.
9250 If we don't stop now, we risk staying here indefinitely
9251 (if the user keeps entering fkey or keytran prefixes
9252 like C-c ESC ESC ESC ESC ...) */
9254 for (i
= first_unbound
+ 1; i
< t
; i
++)
9255 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9256 mock_input
= t
- first_unbound
- 1;
9257 indec
.end
= indec
.start
-= first_unbound
+ 1;
9258 indec
.map
= indec
.parent
;
9259 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9260 fkey
.map
= fkey
.parent
;
9261 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9262 keytran
.map
= keytran
.parent
;
9263 goto replay_sequence
;
9267 error ("Key sequence too long");
9270 echo_local_start
= echo_length ();
9271 keys_local_start
= this_command_key_count
;
9272 local_first_binding
= first_binding
;
9275 /* These are no-ops, unless we throw away a keystroke below and
9276 jumped back up to replay_key; in that case, these restore the
9277 variables to their original state, allowing us to replay the
9279 if (INTERACTIVE
&& t
< mock_input
)
9280 echo_truncate (echo_local_start
);
9281 this_command_key_count
= keys_local_start
;
9282 first_binding
= local_first_binding
;
9284 /* By default, assume each event is "real". */
9285 last_real_key_start
= t
;
9287 /* Does mock_input indicate that we are re-reading a key sequence? */
9291 add_command_key (key
);
9292 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9293 && NILP (Fzerop (Vecho_keystrokes
)))
9297 /* If not, we should actually read a character. */
9301 KBOARD
*interrupted_kboard
= current_kboard
;
9302 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9303 key
= read_char (NILP (prompt
), nmaps
,
9304 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9305 &used_mouse_menu
, NULL
);
9306 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9307 /* When switching to a new tty (with a new keyboard),
9308 read_char returns the new buffer, rather than -2
9309 (Bug#5095). This is because `terminal-init-xterm'
9310 calls read-char, which eats the wrong_kboard_jmpbuf
9311 return. Any better way to fix this? -- cyd */
9312 || (interrupted_kboard
!= current_kboard
))
9317 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9318 if (k
== interrupted_kboard
)
9323 /* Don't touch interrupted_kboard when it's been
9325 delayed_switch_frame
= Qnil
;
9326 goto replay_entire_sequence
;
9329 if (!NILP (delayed_switch_frame
))
9331 interrupted_kboard
->kbd_queue
9332 = Fcons (delayed_switch_frame
,
9333 interrupted_kboard
->kbd_queue
);
9334 delayed_switch_frame
= Qnil
;
9338 interrupted_kboard
->kbd_queue
9339 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9341 /* If the side queue is non-empty, ensure it begins with a
9342 switch-frame, so we'll replay it in the right context. */
9343 if (CONSP (interrupted_kboard
->kbd_queue
)
9344 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9345 !(EVENT_HAS_PARAMETERS (key
)
9346 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9350 XSETFRAME (frame
, interrupted_frame
);
9351 interrupted_kboard
->kbd_queue
9352 = Fcons (make_lispy_switch_frame (frame
),
9353 interrupted_kboard
->kbd_queue
);
9356 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9357 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9358 goto replay_entire_sequence
;
9362 /* read_char returns t when it shows a menu and the user rejects it.
9366 unbind_to (count
, Qnil
);
9371 /* read_char returns -1 at the end of a macro.
9372 Emacs 18 handles this by returning immediately with a
9373 zero, so that's what we'll do. */
9374 if (INTEGERP (key
) && XINT (key
) == -1)
9377 /* The Microsoft C compiler can't handle the goto that
9383 /* If the current buffer has been changed from under us, the
9384 keymap may have changed, so replay the sequence. */
9387 timer_resume_idle ();
9390 /* Reset the current buffer from the selected window
9391 in case something changed the former and not the latter.
9392 This is to be more consistent with the behavior
9393 of the command_loop_1. */
9394 if (fix_current_buffer
)
9396 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9398 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9399 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9402 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9403 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9404 goto replay_sequence
;
9407 /* If we have a quit that was typed in another frame, and
9408 quit_throw_to_read_char switched buffers,
9409 replay to get the right keymap. */
9411 && XINT (key
) == quit_char
9412 && current_buffer
!= starting_buffer
)
9415 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9419 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9420 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9421 goto replay_sequence
;
9426 if (EVENT_HAS_PARAMETERS (key
)
9427 /* Either a `switch-frame' or a `select-window' event. */
9428 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9430 /* If we're at the beginning of a key sequence, and the caller
9431 says it's okay, go ahead and return this event. If we're
9432 in the midst of a key sequence, delay it until the end. */
9433 if (t
> 0 || !can_return_switch_frame
)
9435 delayed_switch_frame
= key
;
9441 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9445 /* Clicks in non-text areas get prefixed by the symbol
9446 in their CHAR-ADDRESS field. For example, a click on
9447 the mode line is prefixed by the symbol `mode-line'.
9449 Furthermore, key sequences beginning with mouse clicks
9450 are read using the keymaps of the buffer clicked on, not
9451 the current buffer. So we may have to switch the buffer
9454 When we turn one event into two events, we must make sure
9455 that neither of the two looks like the original--so that,
9456 if we replay the events, they won't be expanded again.
9457 If not for this, such reexpansion could happen either here
9458 or when user programs play with this-command-keys. */
9459 if (EVENT_HAS_PARAMETERS (key
))
9464 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9465 if (EQ (kind
, Qmouse_click
))
9467 Lisp_Object window
, posn
;
9469 window
= POSN_WINDOW (EVENT_START (key
));
9470 posn
= POSN_POSN (EVENT_START (key
));
9473 || (!NILP (fake_prefixed_keys
)
9474 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9476 /* We're looking a second time at an event for which
9477 we generated a fake prefix key. Set
9478 last_real_key_start appropriately. */
9480 last_real_key_start
= t
- 1;
9483 /* Key sequences beginning with mouse clicks are
9484 read using the keymaps in the buffer clicked on,
9485 not the current buffer. If we're at the
9486 beginning of a key sequence, switch buffers. */
9487 if (last_real_key_start
== 0
9489 && BUFFERP (XWINDOW (window
)->buffer
)
9490 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9492 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9496 /* Arrange to go back to the original buffer once we're
9497 done reading the key sequence. Note that we can't
9498 use save_excursion_{save,restore} here, because they
9499 save point as well as the current buffer; we don't
9500 want to save point, because redisplay may change it,
9501 to accommodate a Fset_window_start or something. We
9502 don't want to do this at the top of the function,
9503 because we may get input from a subprocess which
9504 wants to change the selected window and stuff (say,
9506 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9508 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9510 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9511 orig_local_map
= get_local_map (PT
, current_buffer
,
9513 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9514 goto replay_sequence
;
9517 /* For a mouse click, get the local text-property keymap
9518 of the place clicked on, rather than point. */
9519 if (last_real_key_start
== 0
9520 && CONSP (XCDR (key
))
9521 && ! localized_local_map
)
9523 Lisp_Object map_here
, start
, pos
;
9525 localized_local_map
= 1;
9526 start
= EVENT_START (key
);
9528 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9530 pos
= POSN_BUFFER_POSN (start
);
9532 && XINT (pos
) >= BEGV
9533 && XINT (pos
) <= ZV
)
9535 map_here
= get_local_map (XINT (pos
),
9536 current_buffer
, Qlocal_map
);
9537 if (!EQ (map_here
, orig_local_map
))
9539 orig_local_map
= map_here
;
9540 ++localized_local_map
;
9543 map_here
= get_local_map (XINT (pos
),
9544 current_buffer
, Qkeymap
);
9545 if (!EQ (map_here
, orig_keymap
))
9547 orig_keymap
= map_here
;
9548 ++localized_local_map
;
9551 if (localized_local_map
> 1)
9556 goto replay_sequence
;
9562 /* Expand mode-line and scroll-bar events into two events:
9563 use posn as a fake prefix key. */
9565 && (NILP (fake_prefixed_keys
)
9566 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9568 if (t
+ 1 >= bufsize
)
9569 error ("Key sequence too long");
9572 keybuf
[t
+ 1] = key
;
9575 /* Record that a fake prefix key has been generated
9576 for KEY. Don't modify the event; this would
9577 prevent proper action when the event is pushed
9578 back into unread-command-events. */
9579 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9581 /* If on a mode line string with a local keymap,
9582 reconsider the key sequence with that keymap. */
9583 if (string
= POSN_STRING (EVENT_START (key
)),
9584 (CONSP (string
) && STRINGP (XCAR (string
))))
9586 Lisp_Object pos
, map
, map2
;
9588 pos
= XCDR (string
);
9589 string
= XCAR (string
);
9591 && XINT (pos
) < SCHARS (string
))
9593 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9595 orig_local_map
= map
;
9596 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9599 if (!NILP (map
) || !NILP (map2
))
9600 goto replay_sequence
;
9606 else if (NILP (from_string
)
9607 && (string
= POSN_STRING (EVENT_START (key
)),
9608 (CONSP (string
) && STRINGP (XCAR (string
)))))
9610 /* For a click on a string, i.e. overlay string or a
9611 string displayed via the `display' property,
9612 consider `local-map' and `keymap' properties of
9614 Lisp_Object pos
, map
, map2
;
9616 pos
= XCDR (string
);
9617 string
= XCAR (string
);
9619 && XINT (pos
) < SCHARS (string
))
9621 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9623 orig_local_map
= map
;
9624 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9628 if (!NILP (map
) || !NILP (map2
))
9630 from_string
= string
;
9633 goto replay_sequence
;
9638 else if (CONSP (XCDR (key
))
9639 && CONSP (EVENT_START (key
))
9640 && CONSP (XCDR (EVENT_START (key
))))
9644 posn
= POSN_POSN (EVENT_START (key
));
9645 /* Handle menu-bar events:
9646 insert the dummy prefix event `menu-bar'. */
9647 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9649 if (t
+ 1 >= bufsize
)
9650 error ("Key sequence too long");
9654 /* Zap the position in key, so we know that we've
9655 expanded it, and don't try to do so again. */
9656 POSN_SET_POSN (EVENT_START (key
),
9657 Fcons (posn
, Qnil
));
9660 goto replay_sequence
;
9662 else if (CONSP (posn
))
9664 /* We're looking at the second event of a
9665 sequence which we expanded before. Set
9666 last_real_key_start appropriately. */
9667 if (last_real_key_start
== t
&& t
> 0)
9668 last_real_key_start
= t
- 1;
9673 /* We have finally decided that KEY is something we might want
9675 first_binding
= (follow_key (key
,
9676 nmaps
- first_binding
,
9677 submaps
+ first_binding
,
9678 defs
+ first_binding
,
9679 submaps
+ first_binding
)
9682 /* If KEY wasn't bound, we'll try some fallbacks. */
9683 if (first_binding
< nmaps
)
9684 /* This is needed for the following scenario:
9685 event 0: a down-event that gets dropped by calling replay_key.
9686 event 1: some normal prefix like C-h.
9687 After event 0, first_unbound is 0, after event 1 indec.start,
9688 fkey.start, and keytran.start are all 1, so when we see that
9689 C-h is bound, we need to update first_unbound. */
9690 first_unbound
= max (t
+ 1, first_unbound
);
9695 /* Remember the position to put an upper bound on indec.start. */
9696 first_unbound
= min (t
, first_unbound
);
9698 head
= EVENT_HEAD (key
);
9699 if (help_char_p (head
) && t
> 0)
9701 read_key_sequence_cmd
= Vprefix_help_command
;
9703 last_nonmenu_event
= key
;
9704 /* The Microsoft C compiler can't handle the goto that
9712 Lisp_Object breakdown
;
9715 breakdown
= parse_modifiers (head
);
9716 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9717 /* Attempt to reduce an unbound mouse event to a simpler
9718 event that is bound:
9719 Drags reduce to clicks.
9720 Double-clicks reduce to clicks.
9721 Triple-clicks reduce to double-clicks, then to clicks.
9722 Down-clicks are eliminated.
9723 Double-downs reduce to downs, then are eliminated.
9724 Triple-downs reduce to double-downs, then to downs,
9725 then are eliminated. */
9726 if (modifiers
& (down_modifier
| drag_modifier
9727 | double_modifier
| triple_modifier
))
9729 while (modifiers
& (down_modifier
| drag_modifier
9730 | double_modifier
| triple_modifier
))
9732 Lisp_Object new_head
, new_click
;
9733 if (modifiers
& triple_modifier
)
9734 modifiers
^= (double_modifier
| triple_modifier
);
9735 else if (modifiers
& double_modifier
)
9736 modifiers
&= ~double_modifier
;
9737 else if (modifiers
& drag_modifier
)
9738 modifiers
&= ~drag_modifier
;
9741 /* Dispose of this `down' event by simply jumping
9742 back to replay_key, to get another event.
9744 Note that if this event came from mock input,
9745 then just jumping back to replay_key will just
9746 hand it to us again. So we have to wipe out any
9749 We could delete keybuf[t] and shift everything
9750 after that to the left by one spot, but we'd also
9751 have to fix up any variable that points into
9752 keybuf, and shifting isn't really necessary
9755 Adding prefixes for non-textual mouse clicks
9756 creates two characters of mock input, and both
9757 must be thrown away. If we're only looking at
9758 the prefix now, we can just jump back to
9759 replay_key. On the other hand, if we've already
9760 processed the prefix, and now the actual click
9761 itself is giving us trouble, then we've lost the
9762 state of the keymaps we want to backtrack to, and
9763 we need to replay the whole sequence to rebuild
9766 Beyond that, only function key expansion could
9767 create more than two keys, but that should never
9768 generate mouse events, so it's okay to zero
9769 mock_input in that case too.
9771 FIXME: The above paragraph seems just plain
9772 wrong, if you consider things like
9773 xterm-mouse-mode. -stef
9775 Isn't this just the most wonderful code ever? */
9777 /* If mock_input > t + 1, the above simplification
9778 will actually end up dropping keys on the floor.
9779 This is probably OK for now, but even
9780 if mock_input <= t + 1, we need to adjust indec,
9782 Typical case [header-line down-mouse-N]:
9783 mock_input = 2, t = 1, fkey.end = 1,
9784 last_real_key_start = 0. */
9785 if (indec
.end
> last_real_key_start
)
9787 indec
.end
= indec
.start
9788 = min (last_real_key_start
, indec
.start
);
9789 indec
.map
= indec
.parent
;
9790 if (fkey
.end
> last_real_key_start
)
9792 fkey
.end
= fkey
.start
9793 = min (last_real_key_start
, fkey
.start
);
9794 fkey
.map
= fkey
.parent
;
9795 if (keytran
.end
> last_real_key_start
)
9797 keytran
.end
= keytran
.start
9798 = min (last_real_key_start
, keytran
.start
);
9799 keytran
.map
= keytran
.parent
;
9803 if (t
== last_real_key_start
)
9810 mock_input
= last_real_key_start
;
9811 goto replay_sequence
;
9816 = apply_modifiers (modifiers
, XCAR (breakdown
));
9818 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9820 /* Look for a binding for this new key. follow_key
9821 promises that it didn't munge submaps the
9822 last time we called it, since key was unbound. */
9824 = (follow_key (new_click
,
9825 nmaps
- local_first_binding
,
9826 submaps
+ local_first_binding
,
9827 defs
+ local_first_binding
,
9828 submaps
+ local_first_binding
)
9829 + local_first_binding
);
9831 /* If that click is bound, go for it. */
9832 if (first_binding
< nmaps
)
9837 /* Otherwise, we'll leave key set to the drag event. */
9844 /* Normally, last_nonmenu_event gets the previous key we read.
9845 But when a mouse popup menu is being used,
9846 we don't update last_nonmenu_event; it continues to hold the mouse
9847 event that preceded the first level of menu. */
9848 if (!used_mouse_menu
)
9849 last_nonmenu_event
= key
;
9851 /* Record what part of this_command_keys is the current key sequence. */
9852 this_single_command_key_start
= this_command_key_count
- t
;
9854 /* Look for this sequence in input-decode-map.
9855 Scan from indec.end until we find a bound suffix. */
9856 while (indec
.end
< t
)
9858 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9861 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9862 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9867 mock_input
= diff
+ max (t
, mock_input
);
9868 goto replay_sequence
;
9872 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9873 && indec
.start
>= t
)
9874 /* There is a binding and it's not a prefix.
9875 (and it doesn't have any input-decode-map translation pending).
9876 There is thus no function-key in this sequence.
9877 Moving fkey.start is important in this case to allow keytran.start
9878 to go over the sequence before we return (since we keep the
9879 invariant that keytran.end <= fkey.start). */
9882 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9885 /* If the sequence is unbound, see if we can hang a function key
9886 off the end of it. */
9887 /* Continue scan from fkey.end until we find a bound suffix. */
9888 while (fkey
.end
< indec
.start
)
9890 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9893 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9894 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9895 max (t
, mock_input
),
9896 /* If there's a binding (i.e.
9897 first_binding >= nmaps) we don't want
9898 to apply this function-key-mapping. */
9899 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9904 mock_input
= diff
+ max (t
, mock_input
);
9905 /* Adjust the input-decode-map counters. */
9907 indec
.start
+= diff
;
9909 goto replay_sequence
;
9913 /* Look for this sequence in key-translation-map.
9914 Scan from keytran.end until we find a bound suffix. */
9915 while (keytran
.end
< fkey
.start
)
9917 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9920 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9921 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9926 mock_input
= diff
+ max (t
, mock_input
);
9927 /* Adjust the function-key-map and input-decode-map counters. */
9929 indec
.start
+= diff
;
9933 goto replay_sequence
;
9937 /* If KEY is not defined in any of the keymaps,
9938 and cannot be part of a function key or translation,
9939 and is an upper case letter
9940 use the corresponding lower-case letter instead. */
9941 if (first_binding
>= nmaps
9942 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9944 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9945 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9946 || (XINT (key
) & shift_modifier
)))
9948 Lisp_Object new_key
;
9950 original_uppercase
= key
;
9951 original_uppercase_position
= t
- 1;
9953 if (XINT (key
) & shift_modifier
)
9954 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9956 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9957 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9959 /* We have to do this unconditionally, regardless of whether
9960 the lower-case char is defined in the keymaps, because they
9961 might get translated through function-key-map. */
9962 keybuf
[t
- 1] = new_key
;
9963 mock_input
= max (t
, mock_input
);
9964 shift_translated
= 1;
9966 goto replay_sequence
;
9968 /* If KEY is not defined in any of the keymaps,
9969 and cannot be part of a function key or translation,
9970 and is a shifted function key,
9971 use the corresponding unshifted function key instead. */
9972 if (first_binding
>= nmaps
9973 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9975 Lisp_Object breakdown
= parse_modifiers (key
);
9977 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9979 if (modifiers
& shift_modifier
9980 /* Treat uppercase keys as shifted. */
9982 && (KEY_TO_CHAR (key
)
9983 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9984 && UPPERCASEP (KEY_TO_CHAR (key
))))
9987 = (modifiers
& shift_modifier
9988 ? apply_modifiers (modifiers
& ~shift_modifier
,
9990 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
9992 original_uppercase
= key
;
9993 original_uppercase_position
= t
- 1;
9995 /* We have to do this unconditionally, regardless of whether
9996 the lower-case char is defined in the keymaps, because they
9997 might get translated through function-key-map. */
9998 keybuf
[t
- 1] = new_key
;
9999 mock_input
= max (t
, mock_input
);
10000 /* Reset fkey (and consequently keytran) to apply
10001 function-key-map on the result, so that S-backspace is
10002 correctly mapped to DEL (via backspace). OTOH,
10003 input-decode-map doesn't need to go through it again. */
10004 fkey
.start
= fkey
.end
= 0;
10005 keytran
.start
= keytran
.end
= 0;
10006 shift_translated
= 1;
10008 goto replay_sequence
;
10013 read_key_sequence_cmd
= (first_binding
< nmaps
10014 ? defs
[first_binding
]
10017 unread_switch_frame
= delayed_switch_frame
;
10018 unbind_to (count
, Qnil
);
10020 /* Don't downcase the last character if the caller says don't.
10021 Don't downcase it if the result is undefined, either. */
10022 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10024 && t
- 1 == original_uppercase_position
)
10026 keybuf
[t
- 1] = original_uppercase
;
10027 shift_translated
= 0;
10030 if (shift_translated
)
10031 Vthis_command_keys_shift_translated
= Qt
;
10033 /* Occasionally we fabricate events, perhaps by expanding something
10034 according to function-key-map, or by adding a prefix symbol to a
10035 mouse click in the scroll bar or modeline. In this cases, return
10036 the entire generated key sequence, even if we hit an unbound
10037 prefix or a definition before the end. This means that you will
10038 be able to push back the event properly, and also means that
10039 read-key-sequence will always return a logical unit.
10042 for (; t
< mock_input
; t
++)
10044 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10045 && NILP (Fzerop (Vecho_keystrokes
)))
10046 echo_char (keybuf
[t
]);
10047 add_command_key (keybuf
[t
]);
10054 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10055 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10056 The sequence is sufficient to specify a non-prefix command in the
10057 current local and global maps.
10059 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10060 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10061 as a continuation of the previous key.
10063 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10064 convert the last event to lower case. (Normally any upper case event
10065 is converted to lower case if the original event is undefined and the lower
10066 case equivalent is defined.) A non-nil value is appropriate for reading
10067 a key sequence to be defined.
10069 A C-g typed while in this function is treated like any other character,
10070 and `quit-flag' is not set.
10072 If the key sequence starts with a mouse click, then the sequence is read
10073 using the keymaps of the buffer of the window clicked in, not the buffer
10074 of the selected window as normal.
10076 `read-key-sequence' drops unbound button-down events, since you normally
10077 only care about the click or drag events which follow them. If a drag
10078 or multi-click event is unbound, but the corresponding click event would
10079 be bound, `read-key-sequence' turns the event into a click event at the
10080 drag's starting position. This means that you don't have to distinguish
10081 between click and drag, double, or triple events unless you want to.
10083 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10084 lines separating windows, and scroll bars with imaginary keys
10085 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10087 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10088 function will process a switch-frame event if the user switches frames
10089 before typing anything. If the user switches frames in the middle of a
10090 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10091 is nil, then the event will be put off until after the current key sequence.
10093 `read-key-sequence' checks `function-key-map' for function key
10094 sequences, where they wouldn't conflict with ordinary bindings. See
10095 `function-key-map' for more details.
10097 The optional fifth argument COMMAND-LOOP, if non-nil, means
10098 that this key sequence is being read by something that will
10099 read commands one after another. It should be nil if the caller
10100 will read just one key sequence. */)
10101 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10103 Lisp_Object keybuf
[30];
10105 struct gcpro gcpro1
;
10106 int count
= SPECPDL_INDEX ();
10108 if (!NILP (prompt
))
10109 CHECK_STRING (prompt
);
10112 specbind (Qinput_method_exit_on_first_char
,
10113 (NILP (command_loop
) ? Qt
: Qnil
));
10114 specbind (Qinput_method_use_echo_area
,
10115 (NILP (command_loop
) ? Qt
: Qnil
));
10117 memset (keybuf
, 0, sizeof keybuf
);
10118 GCPRO1 (keybuf
[0]);
10119 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10121 if (NILP (continue_echo
))
10123 this_command_key_count
= 0;
10124 this_command_key_count_reset
= 0;
10125 this_single_command_key_start
= 0;
10128 #ifdef HAVE_WINDOW_SYSTEM
10129 if (display_hourglass_p
)
10130 cancel_hourglass ();
10133 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10134 prompt
, ! NILP (dont_downcase_last
),
10135 ! NILP (can_return_switch_frame
), 0);
10137 #if 0 /* The following is fine for code reading a key sequence and
10138 then proceeding with a lenghty computation, but it's not good
10139 for code reading keys in a loop, like an input method. */
10140 #ifdef HAVE_WINDOW_SYSTEM
10141 if (display_hourglass_p
)
10142 start_hourglass ();
10152 return unbind_to (count
, make_event_array (i
, keybuf
));
10155 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10156 Sread_key_sequence_vector
, 1, 5, 0,
10157 doc
: /* Like `read-key-sequence' but always return a vector. */)
10158 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10160 Lisp_Object keybuf
[30];
10162 struct gcpro gcpro1
;
10163 int count
= SPECPDL_INDEX ();
10165 if (!NILP (prompt
))
10166 CHECK_STRING (prompt
);
10169 specbind (Qinput_method_exit_on_first_char
,
10170 (NILP (command_loop
) ? Qt
: Qnil
));
10171 specbind (Qinput_method_use_echo_area
,
10172 (NILP (command_loop
) ? Qt
: Qnil
));
10174 memset (keybuf
, 0, sizeof keybuf
);
10175 GCPRO1 (keybuf
[0]);
10176 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10178 if (NILP (continue_echo
))
10180 this_command_key_count
= 0;
10181 this_command_key_count_reset
= 0;
10182 this_single_command_key_start
= 0;
10185 #ifdef HAVE_WINDOW_SYSTEM
10186 if (display_hourglass_p
)
10187 cancel_hourglass ();
10190 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10191 prompt
, ! NILP (dont_downcase_last
),
10192 ! NILP (can_return_switch_frame
), 0);
10194 #ifdef HAVE_WINDOW_SYSTEM
10195 if (display_hourglass_p
)
10196 start_hourglass ();
10205 return unbind_to (count
, Fvector (i
, keybuf
));
10208 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10209 doc
: /* Execute CMD as an editor command.
10210 CMD must be a symbol that satisfies the `commandp' predicate.
10211 Optional second arg RECORD-FLAG non-nil
10212 means unconditionally put this command in `command-history'.
10213 Otherwise, that is done only if an arg is read using the minibuffer.
10214 The argument KEYS specifies the value to use instead of (this-command-keys)
10215 when reading the arguments; if it is nil, (this-command-keys) is used.
10216 The argument SPECIAL, if non-nil, means that this command is executing
10217 a special event, so ignore the prefix argument and don't clear it. */)
10218 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10220 register Lisp_Object final
;
10221 register Lisp_Object tem
;
10222 Lisp_Object prefixarg
;
10224 debug_on_next_call
= 0;
10226 if (NILP (special
))
10228 prefixarg
= current_kboard
->Vprefix_arg
;
10229 Vcurrent_prefix_arg
= prefixarg
;
10230 current_kboard
->Vprefix_arg
= Qnil
;
10237 tem
= Fget (cmd
, Qdisabled
);
10238 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10240 tem
= Fsymbol_value (Qdisabled_command_function
);
10242 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10248 final
= Findirect_function (cmd
, Qnil
);
10250 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10252 struct gcpro gcpro1
, gcpro2
;
10254 GCPRO2 (cmd
, prefixarg
);
10255 do_autoload (final
, cmd
);
10262 if (STRINGP (final
) || VECTORP (final
))
10264 /* If requested, place the macro in the command history. For
10265 other sorts of commands, call-interactively takes care of
10267 if (!NILP (record_flag
))
10270 = Fcons (Fcons (Qexecute_kbd_macro
,
10271 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10274 /* Don't keep command history around forever. */
10275 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10277 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10279 XSETCDR (tem
, Qnil
);
10283 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10286 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10287 /* Don't call Fcall_interactively directly because we want to make
10288 sure the backtrace has an entry for `call-interactively'.
10289 For the same reason, pass `cmd' rather than `final'. */
10290 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10297 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10299 doc
: /* Read function name, then read its arguments and call it.
10301 To pass a numeric argument to the command you are invoking with, specify
10302 the numeric argument to this command.
10304 Noninteractively, the argument PREFIXARG is the prefix argument to
10305 give to the command you invoke, if it asks for an argument. */)
10306 (Lisp_Object prefixarg
)
10308 Lisp_Object function
;
10310 int saved_last_point_position
;
10311 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10312 Lisp_Object bindings
, value
;
10313 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10314 #ifdef HAVE_WINDOW_SYSTEM
10315 /* The call to Fcompleting_read wil start and cancel the hourglass,
10316 but if the hourglass was already scheduled, this means that no
10317 hourglass will be shown for the actual M-x command itself.
10318 So we restart it if it is already scheduled. Note that checking
10319 hourglass_shown_p is not enough, normally the hourglass is not shown,
10320 just scheduled to be shown. */
10321 int hstarted
= hourglass_started ();
10324 saved_keys
= Fvector (this_command_key_count
,
10325 XVECTOR (this_command_keys
)->contents
);
10326 saved_last_point_position_buffer
= last_point_position_buffer
;
10327 saved_last_point_position
= last_point_position
;
10329 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10331 if (EQ (prefixarg
, Qminus
))
10332 strcpy (buf
, "- ");
10333 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10334 strcpy (buf
, "C-u ");
10335 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10336 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10337 else if (INTEGERP (prefixarg
))
10338 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10340 /* This isn't strictly correct if execute-extended-command
10341 is bound to anything else. Perhaps it should use
10342 this_command_keys? */
10343 strcat (buf
, "M-x ");
10345 /* Prompt with buf, and then read a string, completing from and
10346 restricting to the set of all defined commands. Don't provide
10347 any initial input. Save the command read on the extended-command
10349 function
= Fcompleting_read (build_string (buf
),
10350 Vobarray
, Qcommandp
,
10351 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10354 #ifdef HAVE_WINDOW_SYSTEM
10355 if (hstarted
) start_hourglass ();
10358 if (STRINGP (function
) && SCHARS (function
) == 0)
10359 error ("No command name given");
10361 /* Set this_command_keys to the concatenation of saved_keys and
10362 function, followed by a RET. */
10367 this_command_key_count
= 0;
10368 this_command_key_count_reset
= 0;
10369 this_single_command_key_start
= 0;
10371 keys
= XVECTOR (saved_keys
)->contents
;
10372 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10373 add_command_key (keys
[i
]);
10375 for (i
= 0; i
< SCHARS (function
); i
++)
10376 add_command_key (Faref (function
, make_number (i
)));
10378 add_command_key (make_number ('\015'));
10381 last_point_position
= saved_last_point_position
;
10382 last_point_position_buffer
= saved_last_point_position_buffer
;
10386 function
= Fintern (function
, Qnil
);
10387 current_kboard
->Vprefix_arg
= prefixarg
;
10388 Vthis_command
= function
;
10389 real_this_command
= function
;
10391 /* If enabled, show which key runs this command. */
10392 if (!NILP (Vsuggest_key_bindings
)
10393 && NILP (Vexecuting_kbd_macro
)
10394 && SYMBOLP (function
))
10395 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10401 GCPRO3 (bindings
, value
, function
);
10402 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10404 /* If the command has a key binding, print it now. */
10405 if (!NILP (bindings
)
10406 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10409 /* But first wait, and skip the message if there is input. */
10410 Lisp_Object waited
;
10412 /* If this command displayed something in the echo area;
10413 wait a few seconds, then display our suggestion message. */
10414 if (NILP (echo_area_buffer
[0]))
10415 waited
= sit_for (make_number (0), 0, 2);
10416 else if (NUMBERP (Vsuggest_key_bindings
))
10417 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10419 waited
= sit_for (make_number (2), 0, 2);
10421 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10423 Lisp_Object binding
;
10425 int message_p
= push_message ();
10426 int count
= SPECPDL_INDEX ();
10428 record_unwind_protect (pop_message_unwind
, Qnil
);
10429 binding
= Fkey_description (bindings
, Qnil
);
10432 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10435 sprintf (newmessage
, "You can run the command `%s' with %s",
10436 SDATA (SYMBOL_NAME (function
)),
10438 message2_nolog (newmessage
,
10439 strlen (newmessage
),
10440 STRING_MULTIBYTE (binding
));
10441 if (NUMBERP (Vsuggest_key_bindings
))
10442 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10444 waited
= sit_for (make_number (2), 0, 2);
10446 if (!NILP (waited
) && message_p
)
10447 restore_message ();
10449 unbind_to (count
, Qnil
);
10453 RETURN_UNGCPRO (value
);
10457 /* Return nonzero if input events are pending. */
10460 detect_input_pending (void)
10462 if (!input_pending
)
10463 get_input_pending (&input_pending
, 0);
10465 return input_pending
;
10468 /* Return nonzero if input events other than mouse movements are
10472 detect_input_pending_ignore_squeezables (void)
10474 if (!input_pending
)
10475 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10477 return input_pending
;
10480 /* Return nonzero if input events are pending, and run any pending timers. */
10483 detect_input_pending_run_timers (int do_display
)
10485 int old_timers_run
= timers_run
;
10487 if (!input_pending
)
10488 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10490 if (old_timers_run
!= timers_run
&& do_display
)
10492 redisplay_preserve_echo_area (8);
10493 /* The following fixes a bug when using lazy-lock with
10494 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10495 from an idle timer function. The symptom of the bug is that
10496 the cursor sometimes doesn't become visible until the next X
10497 event is processed. --gerd. */
10499 Lisp_Object tail
, frame
;
10500 FOR_EACH_FRAME (tail
, frame
)
10501 if (FRAME_RIF (XFRAME (frame
)))
10502 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10506 return input_pending
;
10509 /* This is called in some cases before a possible quit.
10510 It cases the next call to detect_input_pending to recompute input_pending.
10511 So calling this function unnecessarily can't do any harm. */
10514 clear_input_pending (void)
10519 /* Return nonzero if there are pending requeued events.
10520 This isn't used yet. The hope is to make wait_reading_process_output
10521 call it, and return if it runs Lisp code that unreads something.
10522 The problem is, kbd_buffer_get_event needs to be fixed to know what
10523 to do in that case. It isn't trivial. */
10526 requeued_events_pending_p (void)
10528 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10532 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10533 doc
: /* Return t if command input is currently available with no wait.
10534 Actually, the value is nil only if we can be sure that no input is available;
10535 if there is a doubt, the value is t. */)
10538 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10539 || !NILP (Vunread_post_input_method_events
)
10540 || !NILP (Vunread_input_method_events
))
10543 get_input_pending (&input_pending
,
10544 READABLE_EVENTS_DO_TIMERS_NOW
10545 | READABLE_EVENTS_FILTER_EVENTS
);
10546 return input_pending
> 0 ? Qt
: Qnil
;
10549 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10550 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10553 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10556 if (total_keys
< NUM_RECENT_KEYS
)
10557 return Fvector (total_keys
, keys
);
10560 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10561 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10562 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10563 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10564 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10569 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10570 doc
: /* Return the key sequence that invoked this command.
10571 However, if the command has called `read-key-sequence', it returns
10572 the last key sequence that has been read.
10573 The value is a string or a vector.
10575 See also `this-command-keys-vector'. */)
10578 return make_event_array (this_command_key_count
,
10579 XVECTOR (this_command_keys
)->contents
);
10582 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10583 doc
: /* Return the key sequence that invoked this command, as a vector.
10584 However, if the command has called `read-key-sequence', it returns
10585 the last key sequence that has been read.
10587 See also `this-command-keys'. */)
10590 return Fvector (this_command_key_count
,
10591 XVECTOR (this_command_keys
)->contents
);
10594 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10595 Sthis_single_command_keys
, 0, 0, 0,
10596 doc
: /* Return the key sequence that invoked this command.
10597 More generally, it returns the last key sequence read, either by
10598 the command loop or by `read-key-sequence'.
10599 Unlike `this-command-keys', this function's value
10600 does not include prefix arguments.
10601 The value is always a vector. */)
10604 return Fvector (this_command_key_count
10605 - this_single_command_key_start
,
10606 (XVECTOR (this_command_keys
)->contents
10607 + this_single_command_key_start
));
10610 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10611 Sthis_single_command_raw_keys
, 0, 0, 0,
10612 doc
: /* Return the raw events that were read for this command.
10613 More generally, it returns the last key sequence read, either by
10614 the command loop or by `read-key-sequence'.
10615 Unlike `this-single-command-keys', this function's value
10616 shows the events before all translations (except for input methods).
10617 The value is always a vector. */)
10620 return Fvector (raw_keybuf_count
,
10621 (XVECTOR (raw_keybuf
)->contents
));
10624 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10625 Sreset_this_command_lengths
, 0, 0, 0,
10626 doc
: /* Make the unread events replace the last command and echo.
10627 Used in `universal-argument-other-key'.
10629 `universal-argument-other-key' rereads the event just typed.
10630 It then gets translated through `function-key-map'.
10631 The translated event has to replace the real events,
10632 both in the value of (this-command-keys) and in echoing.
10633 To achieve this, `universal-argument-other-key' calls
10634 `reset-this-command-lengths', which discards the record of reading
10635 these events the first time. */)
10638 this_command_key_count
= before_command_key_count
;
10639 if (this_command_key_count
< this_single_command_key_start
)
10640 this_single_command_key_start
= this_command_key_count
;
10642 echo_truncate (before_command_echo_length
);
10644 /* Cause whatever we put into unread-command-events
10645 to echo as if it were being freshly read from the keyboard. */
10646 this_command_key_count_reset
= 1;
10651 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10652 Sclear_this_command_keys
, 0, 1, 0,
10653 doc
: /* Clear out the vector that `this-command-keys' returns.
10654 Also clear the record of the last 100 events, unless optional arg
10655 KEEP-RECORD is non-nil. */)
10656 (Lisp_Object keep_record
)
10660 this_command_key_count
= 0;
10661 this_command_key_count_reset
= 0;
10663 if (NILP (keep_record
))
10665 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10666 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10668 recent_keys_index
= 0;
10673 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10674 doc
: /* Return the current depth in recursive edits. */)
10678 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10682 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10683 "FOpen dribble file: ",
10684 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10685 If FILE is nil, close any open dribble file. */)
10697 file
= Fexpand_file_name (file
, Qnil
);
10698 dribble
= fopen (SDATA (file
), "w");
10700 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10705 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10706 doc
: /* Discard the contents of the terminal input buffer.
10707 Also end any kbd macro being defined. */)
10710 if (!NILP (current_kboard
->defining_kbd_macro
))
10712 /* Discard the last command from the macro. */
10713 Fcancel_kbd_macro_events ();
10717 update_mode_lines
++;
10719 Vunread_command_events
= Qnil
;
10720 unread_command_char
= -1;
10722 discard_tty_input ();
10724 kbd_fetch_ptr
= kbd_store_ptr
;
10730 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10731 doc
: /* Stop Emacs and return to superior process. You can resume later.
10732 If `cannot-suspend' is non-nil, or if the system doesn't support job
10733 control, run a subshell instead.
10735 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10736 to be read as terminal input by Emacs's parent, after suspension.
10738 Before suspending, run the normal hook `suspend-hook'.
10739 After resumption run the normal hook `suspend-resume-hook'.
10741 Some operating systems cannot stop the Emacs process and resume it later.
10742 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'. */)
11063 (Lisp_Object interrupt
)
11065 int new_interrupt_input
;
11067 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11068 #ifdef HAVE_X_WINDOWS
11069 if (x_display_list
!= NULL
)
11071 /* When using X, don't give the user a real choice,
11072 because we haven't implemented the mechanisms to support it. */
11073 new_interrupt_input
= 1;
11076 #endif /* HAVE_X_WINDOWS */
11077 new_interrupt_input
= !NILP (interrupt
);
11078 #else /* not SIGIO */
11079 new_interrupt_input
= 0;
11080 #endif /* not SIGIO */
11082 if (new_interrupt_input
!= interrupt_input
)
11084 #ifdef POLL_FOR_INPUT
11088 /* this causes startup screen to be restored and messes with the mouse */
11089 reset_all_sys_modes ();
11091 interrupt_input
= new_interrupt_input
;
11093 init_all_sys_modes ();
11096 #ifdef POLL_FOR_INPUT
11097 poll_suppress_count
= 1;
11104 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11105 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11106 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11107 C-q in key sequences.
11109 This setting only has an effect on tty terminals and only when
11110 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11112 See also `current-input-mode'. */)
11113 (Lisp_Object flow
, Lisp_Object terminal
)
11115 struct terminal
*t
= get_terminal (terminal
, 1);
11116 struct tty_display_info
*tty
;
11117 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11119 tty
= t
->display_info
.tty
;
11121 if (tty
->flow_control
!= !NILP (flow
))
11124 /* this causes startup screen to be restored and messes with the mouse */
11125 reset_sys_modes (tty
);
11128 tty
->flow_control
= !NILP (flow
);
11131 init_sys_modes (tty
);
11137 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11138 doc
: /* Enable or disable 8-bit input on TERMINAL.
11139 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11140 bit as the Meta modifier.
11142 If META is nil, Emacs will ignore the top bit, on the assumption it is
11145 Otherwise, Emacs will accept and pass through 8-bit input without
11146 specially interpreting the top bit.
11148 This setting only has an effect on tty terminal devices.
11150 Optional parameter TERMINAL specifies the tty terminal device to use.
11151 It may be a terminal object, a frame, or nil for the terminal used by
11152 the currently selected frame.
11154 See also `current-input-mode'. */)
11155 (Lisp_Object meta
, Lisp_Object terminal
)
11157 struct terminal
*t
= get_terminal (terminal
, 1);
11158 struct tty_display_info
*tty
;
11161 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11163 tty
= t
->display_info
.tty
;
11167 else if (EQ (meta
, Qt
))
11172 if (tty
->meta_key
!= new_meta
)
11175 /* this causes startup screen to be restored and messes with the mouse */
11176 reset_sys_modes (tty
);
11179 tty
->meta_key
= new_meta
;
11182 init_sys_modes (tty
);
11188 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11189 doc
: /* Specify character used for quitting.
11190 QUIT must be an ASCII character.
11192 This function only has an effect on the controlling tty of the Emacs
11195 See also `current-input-mode'. */)
11198 struct terminal
*t
= get_named_tty ("/dev/tty");
11199 struct tty_display_info
*tty
;
11200 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11202 tty
= t
->display_info
.tty
;
11204 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11205 error ("QUIT must be an ASCII character");
11208 /* this causes startup screen to be restored and messes with the mouse */
11209 reset_sys_modes (tty
);
11212 /* Don't let this value be out of range. */
11213 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11216 init_sys_modes (tty
);
11222 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11223 doc
: /* Set mode of reading keyboard input.
11224 First arg INTERRUPT non-nil means use input interrupts;
11225 nil means use CBREAK mode.
11226 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11227 (no effect except in CBREAK mode).
11228 Third arg META t means accept 8-bit input (for a Meta key).
11229 META nil means ignore the top bit, on the assumption it is parity.
11230 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11231 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11232 See also `current-input-mode'. */)
11233 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11235 Fset_input_interrupt_mode (interrupt
);
11236 Fset_output_flow_control (flow
, Qnil
);
11237 Fset_input_meta_mode (meta
, Qnil
);
11239 Fset_quit_char (quit
);
11243 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11244 doc
: /* Return information about the way Emacs currently reads keyboard input.
11245 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11246 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11247 nil, Emacs is using CBREAK mode.
11248 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11249 terminal; this does not apply if Emacs uses interrupt-driven input.
11250 META is t if accepting 8-bit input with 8th bit as Meta flag.
11251 META nil means ignoring the top bit, on the assumption it is parity.
11252 META is neither t nor nil if accepting 8-bit input and using
11253 all 8 bits as the character code.
11254 QUIT is the character Emacs currently uses to quit.
11255 The elements of this list correspond to the arguments of
11256 `set-input-mode'. */)
11259 Lisp_Object val
[4];
11260 struct frame
*sf
= XFRAME (selected_frame
);
11262 val
[0] = interrupt_input
? Qt
: Qnil
;
11263 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11265 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11266 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11268 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11275 XSETFASTINT (val
[3], quit_char
);
11277 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11280 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11281 doc
: /* Return position information for pixel coordinates X and Y.
11282 By default, X and Y are relative to text area of the selected window.
11283 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11284 If optional fourth arg WHOLE is non-nil, X is relative to the left
11285 edge of the window.
11287 The return value is similar to a mouse click position:
11288 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11289 IMAGE (DX . DY) (WIDTH . HEIGHT))
11290 The `posn-' functions access elements of such lists. */)
11291 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11296 if (NILP (frame_or_window
))
11297 frame_or_window
= selected_window
;
11299 if (WINDOWP (frame_or_window
))
11303 CHECK_LIVE_WINDOW (frame_or_window
);
11305 w
= XWINDOW (frame_or_window
);
11306 XSETINT (x
, (XINT (x
)
11307 + WINDOW_LEFT_EDGE_X (w
)
11309 ? window_box_left_offset (w
, TEXT_AREA
)
11311 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11312 frame_or_window
= w
->frame
;
11315 CHECK_LIVE_FRAME (frame_or_window
);
11317 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11320 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11321 doc
: /* Return position information for buffer POS in WINDOW.
11322 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11324 Return nil if position is not visible in window. Otherwise,
11325 the return value is similar to that returned by `event-start' for
11326 a mouse click at the upper left corner of the glyph corresponding
11327 to the given buffer position:
11328 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11329 IMAGE (DX . DY) (WIDTH . HEIGHT))
11330 The `posn-' functions access elements of such lists. */)
11331 (Lisp_Object pos
, Lisp_Object window
)
11336 window
= selected_window
;
11338 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11341 Lisp_Object x
= XCAR (tem
);
11342 Lisp_Object y
= XCAR (XCDR (tem
));
11344 /* Point invisible due to hscrolling? */
11347 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11355 * Set up a new kboard object with reasonable initial values.
11358 init_kboard (KBOARD
*kb
)
11360 kb
->Voverriding_terminal_local_map
= Qnil
;
11361 kb
->Vlast_command
= Qnil
;
11362 kb
->Vreal_last_command
= Qnil
;
11363 kb
->Vkeyboard_translate_table
= Qnil
;
11364 kb
->Vlast_repeatable_command
= Qnil
;
11365 kb
->Vprefix_arg
= Qnil
;
11366 kb
->Vlast_prefix_arg
= Qnil
;
11367 kb
->kbd_queue
= Qnil
;
11368 kb
->kbd_queue_has_data
= 0;
11369 kb
->immediate_echo
= 0;
11370 kb
->echo_string
= Qnil
;
11371 kb
->echo_after_prompt
= -1;
11372 kb
->kbd_macro_buffer
= 0;
11373 kb
->kbd_macro_bufsize
= 0;
11374 kb
->defining_kbd_macro
= Qnil
;
11375 kb
->Vlast_kbd_macro
= Qnil
;
11376 kb
->reference_count
= 0;
11377 kb
->Vsystem_key_alist
= Qnil
;
11378 kb
->system_key_syms
= Qnil
;
11379 kb
->Vwindow_system
= Qt
; /* Unset. */
11380 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11381 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11382 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11383 kb
->Vdefault_minibuffer_frame
= Qnil
;
11387 * Destroy the contents of a kboard object, but not the object itself.
11388 * We use this just before deleting it, or if we're going to initialize
11389 * it a second time.
11392 wipe_kboard (KBOARD
*kb
)
11394 xfree (kb
->kbd_macro_buffer
);
11397 /* Free KB and memory referenced from it. */
11400 delete_kboard (KBOARD
*kb
)
11404 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11407 *kbp
= kb
->next_kboard
;
11409 /* Prevent a dangling reference to KB. */
11410 if (kb
== current_kboard
11411 && FRAMEP (selected_frame
)
11412 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11414 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11416 if (current_kboard
== kb
)
11425 init_keyboard (void)
11427 /* This is correct before outermost invocation of the editor loop */
11428 command_loop_level
= -1;
11429 immediate_quit
= 0;
11430 quit_char
= Ctl ('g');
11431 Vunread_command_events
= Qnil
;
11432 unread_command_char
= -1;
11433 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11435 recent_keys_index
= 0;
11436 kbd_fetch_ptr
= kbd_buffer
;
11437 kbd_store_ptr
= kbd_buffer
;
11438 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11439 do_mouse_tracking
= Qnil
;
11442 interrupt_input_blocked
= 0;
11443 interrupt_input_pending
= 0;
11445 pending_signals
= 0;
11448 /* This means that command_loop_1 won't try to select anything the first
11450 internal_last_event_frame
= Qnil
;
11451 Vlast_event_frame
= internal_last_event_frame
;
11453 current_kboard
= initial_kboard
;
11454 /* Re-initialize the keyboard again. */
11455 wipe_kboard (current_kboard
);
11456 init_kboard (current_kboard
);
11457 /* A value of nil for Vwindow_system normally means a tty, but we also use
11458 it for the initial terminal since there is no window system there. */
11459 current_kboard
->Vwindow_system
= Qnil
;
11461 if (!noninteractive
)
11463 /* Before multi-tty support, these handlers used to be installed
11464 only if the current session was a tty session. Now an Emacs
11465 session may have multiple display types, so we always handle
11466 SIGINT. There is special code in interrupt_signal to exit
11467 Emacs on SIGINT when there are no termcap frames on the
11468 controlling terminal. */
11469 signal (SIGINT
, interrupt_signal
);
11470 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11471 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11472 SIGQUIT and we can't tell which one it will give us. */
11473 signal (SIGQUIT
, interrupt_signal
);
11474 #endif /* HAVE_TERMIO */
11476 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11478 if (!noninteractive
)
11479 signal (SIGIO
, input_available_signal
);
11482 /* Use interrupt input by default, if it works and noninterrupt input
11483 has deficiencies. */
11485 #ifdef INTERRUPT_INPUT
11486 interrupt_input
= 1;
11488 interrupt_input
= 0;
11494 if (keyboard_init_hook
)
11495 (*keyboard_init_hook
) ();
11497 #ifdef POLL_FOR_INPUT
11499 poll_suppress_count
= 1;
11504 /* This type's only use is in syms_of_keyboard, to initialize the
11505 event header symbols and put properties on them. */
11506 struct event_head
{
11512 static const struct event_head head_table
[] = {
11513 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11514 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11515 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11516 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11517 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11518 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11519 /* `select-window' should be handled just like `switch-frame'
11520 in read_key_sequence. */
11521 {&Qselect_window
, "select-window", &Qswitch_frame
}
11525 syms_of_keyboard (void)
11527 pending_funcalls
= Qnil
;
11528 staticpro (&pending_funcalls
);
11530 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11531 staticpro (&Vlispy_mouse_stem
);
11534 QCimage
= intern_c_string (":image");
11535 staticpro (&QCimage
);
11537 staticpro (&Qhelp_echo
);
11538 Qhelp_echo
= intern_c_string ("help-echo");
11541 Qrtl
= intern_c_string (":rtl");
11543 staticpro (&item_properties
);
11544 item_properties
= Qnil
;
11546 staticpro (&tool_bar_item_properties
);
11547 tool_bar_item_properties
= Qnil
;
11548 staticpro (&tool_bar_items_vector
);
11549 tool_bar_items_vector
= Qnil
;
11551 staticpro (&real_this_command
);
11552 real_this_command
= Qnil
;
11554 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11555 staticpro (&Qtimer_event_handler
);
11557 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11558 staticpro (&Qdisabled_command_function
);
11560 Qself_insert_command
= intern_c_string ("self-insert-command");
11561 staticpro (&Qself_insert_command
);
11563 Qforward_char
= intern_c_string ("forward-char");
11564 staticpro (&Qforward_char
);
11566 Qbackward_char
= intern_c_string ("backward-char");
11567 staticpro (&Qbackward_char
);
11569 Qdisabled
= intern_c_string ("disabled");
11570 staticpro (&Qdisabled
);
11572 Qundefined
= intern_c_string ("undefined");
11573 staticpro (&Qundefined
);
11575 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11576 staticpro (&Qpre_command_hook
);
11578 Qpost_command_hook
= intern_c_string ("post-command-hook");
11579 staticpro (&Qpost_command_hook
);
11581 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11582 staticpro (&Qdeferred_action_function
);
11584 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11585 staticpro (&Qcommand_hook_internal
);
11587 Qfunction_key
= intern_c_string ("function-key");
11588 staticpro (&Qfunction_key
);
11589 Qmouse_click
= intern_c_string ("mouse-click");
11590 staticpro (&Qmouse_click
);
11591 #if defined (WINDOWSNT)
11592 Qlanguage_change
= intern_c_string ("language-change");
11593 staticpro (&Qlanguage_change
);
11595 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11596 staticpro (&Qdrag_n_drop
);
11598 Qsave_session
= intern_c_string ("save-session");
11599 staticpro (&Qsave_session
);
11602 Qdbus_event
= intern_c_string ("dbus-event");
11603 staticpro (&Qdbus_event
);
11606 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11607 staticpro (&Qconfig_changed_event
);
11609 Qmenu_enable
= intern_c_string ("menu-enable");
11610 staticpro (&Qmenu_enable
);
11611 QCenable
= intern_c_string (":enable");
11612 staticpro (&QCenable
);
11613 QCvisible
= intern_c_string (":visible");
11614 staticpro (&QCvisible
);
11615 QChelp
= intern_c_string (":help");
11616 staticpro (&QChelp
);
11617 QCfilter
= intern_c_string (":filter");
11618 staticpro (&QCfilter
);
11619 QCbutton
= intern_c_string (":button");
11620 staticpro (&QCbutton
);
11621 QCkeys
= intern_c_string (":keys");
11622 staticpro (&QCkeys
);
11623 QCkey_sequence
= intern_c_string (":key-sequence");
11624 staticpro (&QCkey_sequence
);
11625 QCtoggle
= intern_c_string (":toggle");
11626 staticpro (&QCtoggle
);
11627 QCradio
= intern_c_string (":radio");
11628 staticpro (&QCradio
);
11629 QClabel
= intern_c_string (":label");
11630 staticpro (&QClabel
);
11632 Qmode_line
= intern_c_string ("mode-line");
11633 staticpro (&Qmode_line
);
11634 Qvertical_line
= intern_c_string ("vertical-line");
11635 staticpro (&Qvertical_line
);
11636 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11637 staticpro (&Qvertical_scroll_bar
);
11638 Qmenu_bar
= intern_c_string ("menu-bar");
11639 staticpro (&Qmenu_bar
);
11641 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11642 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11643 staticpro (&Qmouse_fixup_help_message
);
11646 Qabove_handle
= intern_c_string ("above-handle");
11647 staticpro (&Qabove_handle
);
11648 Qhandle
= intern_c_string ("handle");
11649 staticpro (&Qhandle
);
11650 Qbelow_handle
= intern_c_string ("below-handle");
11651 staticpro (&Qbelow_handle
);
11652 Qup
= intern_c_string ("up");
11654 Qdown
= intern_c_string ("down");
11655 staticpro (&Qdown
);
11656 Qtop
= intern_c_string ("top");
11658 Qbottom
= intern_c_string ("bottom");
11659 staticpro (&Qbottom
);
11660 Qend_scroll
= intern_c_string ("end-scroll");
11661 staticpro (&Qend_scroll
);
11662 Qratio
= intern_c_string ("ratio");
11663 staticpro (&Qratio
);
11665 Qevent_kind
= intern_c_string ("event-kind");
11666 staticpro (&Qevent_kind
);
11667 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11668 staticpro (&Qevent_symbol_elements
);
11669 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11670 staticpro (&Qevent_symbol_element_mask
);
11671 Qmodifier_cache
= intern_c_string ("modifier-cache");
11672 staticpro (&Qmodifier_cache
);
11674 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11675 staticpro (&Qrecompute_lucid_menubar
);
11676 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11677 staticpro (&Qactivate_menubar_hook
);
11679 Qpolling_period
= intern_c_string ("polling-period");
11680 staticpro (&Qpolling_period
);
11682 Qinput_method_function
= intern_c_string ("input-method-function");
11683 staticpro (&Qinput_method_function
);
11685 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11686 staticpro (&Qinput_method_exit_on_first_char
);
11687 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11688 staticpro (&Qinput_method_use_echo_area
);
11690 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11691 Fset (Qinput_method_use_echo_area
, Qnil
);
11693 last_point_position_buffer
= Qnil
;
11694 last_point_position_window
= Qnil
;
11697 const struct event_head
*p
;
11699 for (p
= head_table
;
11700 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11703 *p
->var
= intern_c_string (p
->name
);
11704 staticpro (p
->var
);
11705 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11706 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11710 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11711 staticpro (&button_down_location
);
11712 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11713 staticpro (&mouse_syms
);
11714 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11715 / sizeof (lispy_wheel_names
[0])),
11717 staticpro (&wheel_syms
);
11721 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11723 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11724 for (i
= 0; i
< len
; i
++)
11725 if (modifier_names
[i
])
11726 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11727 staticpro (&modifier_symbols
);
11730 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11731 staticpro (&recent_keys
);
11733 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11734 staticpro (&this_command_keys
);
11736 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11737 staticpro (&raw_keybuf
);
11739 Qextended_command_history
= intern_c_string ("extended-command-history");
11740 Fset (Qextended_command_history
, Qnil
);
11741 staticpro (&Qextended_command_history
);
11743 accent_key_syms
= Qnil
;
11744 staticpro (&accent_key_syms
);
11746 func_key_syms
= Qnil
;
11747 staticpro (&func_key_syms
);
11749 drag_n_drop_syms
= Qnil
;
11750 staticpro (&drag_n_drop_syms
);
11752 unread_switch_frame
= Qnil
;
11753 staticpro (&unread_switch_frame
);
11755 internal_last_event_frame
= Qnil
;
11756 staticpro (&internal_last_event_frame
);
11758 read_key_sequence_cmd
= Qnil
;
11759 staticpro (&read_key_sequence_cmd
);
11761 menu_bar_one_keymap_changed_items
= Qnil
;
11762 staticpro (&menu_bar_one_keymap_changed_items
);
11764 menu_bar_items_vector
= Qnil
;
11765 staticpro (&menu_bar_items_vector
);
11767 help_form_saved_window_configs
= Qnil
;
11768 staticpro (&help_form_saved_window_configs
);
11770 defsubr (&Scurrent_idle_time
);
11771 defsubr (&Sevent_symbol_parse_modifiers
);
11772 defsubr (&Sevent_convert_list
);
11773 defsubr (&Sread_key_sequence
);
11774 defsubr (&Sread_key_sequence_vector
);
11775 defsubr (&Srecursive_edit
);
11776 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11777 defsubr (&Strack_mouse
);
11779 defsubr (&Sinput_pending_p
);
11780 defsubr (&Scommand_execute
);
11781 defsubr (&Srecent_keys
);
11782 defsubr (&Sthis_command_keys
);
11783 defsubr (&Sthis_command_keys_vector
);
11784 defsubr (&Sthis_single_command_keys
);
11785 defsubr (&Sthis_single_command_raw_keys
);
11786 defsubr (&Sreset_this_command_lengths
);
11787 defsubr (&Sclear_this_command_keys
);
11788 defsubr (&Ssuspend_emacs
);
11789 defsubr (&Sabort_recursive_edit
);
11790 defsubr (&Sexit_recursive_edit
);
11791 defsubr (&Srecursion_depth
);
11792 defsubr (&Stop_level
);
11793 defsubr (&Sdiscard_input
);
11794 defsubr (&Sopen_dribble_file
);
11795 defsubr (&Sset_input_interrupt_mode
);
11796 defsubr (&Sset_output_flow_control
);
11797 defsubr (&Sset_input_meta_mode
);
11798 defsubr (&Sset_quit_char
);
11799 defsubr (&Sset_input_mode
);
11800 defsubr (&Scurrent_input_mode
);
11801 defsubr (&Sexecute_extended_command
);
11802 defsubr (&Sposn_at_point
);
11803 defsubr (&Sposn_at_x_y
);
11805 DEFVAR_LISP ("last-command-event", &last_command_event
,
11806 doc
: /* Last input event that was part of a command. */);
11808 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11809 doc
: /* Last input event in a command, except for mouse menu events.
11810 Mouse menus give back keys that don't look like mouse events;
11811 this variable holds the actual mouse event that led to the menu,
11812 so that you can determine whether the command was run by mouse or not. */);
11814 DEFVAR_LISP ("last-input-event", &last_input_event
,
11815 doc
: /* Last input event. */);
11817 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11818 doc
: /* List of events to be read as the command input.
11819 These events are processed first, before actual keyboard input.
11820 Events read from this list are not normally added to `this-command-keys',
11821 as they will already have been added once as they were read for the first time.
11822 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11823 Vunread_command_events
= Qnil
;
11825 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11826 doc
: /* If not -1, an object to be read as next command input event. */);
11828 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11829 doc
: /* List of events to be processed as input by input methods.
11830 These events are processed before `unread-command-events'
11831 and actual keyboard input, but are not given to `input-method-function'. */);
11832 Vunread_post_input_method_events
= Qnil
;
11834 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11835 doc
: /* List of events to be processed as input by input methods.
11836 These events are processed after `unread-command-events', but
11837 before actual keyboard input.
11838 If there's an active input method, the events are given to
11839 `input-method-function'. */);
11840 Vunread_input_method_events
= Qnil
;
11842 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11843 doc
: /* Meta-prefix character code.
11844 Meta-foo as command input turns into this character followed by foo. */);
11845 XSETINT (meta_prefix_char
, 033);
11847 DEFVAR_KBOARD ("last-command", Vlast_command
,
11848 doc
: /* The last command executed.
11849 Normally a symbol with a function definition, but can be whatever was found
11850 in the keymap, or whatever the variable `this-command' was set to by that
11853 The value `mode-exit' is special; it means that the previous command
11854 read an event that told it to exit, and it did so and unread that event.
11855 In other words, the present command is the event that made the previous
11858 The value `kill-region' is special; it means that the previous command
11859 was a kill command.
11861 `last-command' has a separate binding for each terminal device.
11862 See Info node `(elisp)Multiple Terminals'. */);
11864 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11865 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11867 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11868 doc
: /* Last command that may be repeated.
11869 The last command executed that was not bound to an input event.
11870 This is the command `repeat' will try to repeat. */);
11872 DEFVAR_LISP ("this-command", &Vthis_command
,
11873 doc
: /* The command now being executed.
11874 The command can set this variable; whatever is put here
11875 will be in `last-command' during the following command. */);
11876 Vthis_command
= Qnil
;
11878 DEFVAR_LISP ("this-command-keys-shift-translated",
11879 &Vthis_command_keys_shift_translated
,
11880 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11881 Shift-translation occurs when there is no binding for the key sequence
11882 as entered, but a binding was found by changing an upper-case letter
11883 to lower-case, or a shifted function key to an unshifted one. */);
11884 Vthis_command_keys_shift_translated
= Qnil
;
11886 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11887 doc
: /* The command bound to the current key sequence before remapping.
11888 It equals `this-command' if the original command was not remapped through
11889 any of the active keymaps. Otherwise, the value of `this-command' is the
11890 result of looking up the original command in the active keymaps. */);
11891 Vthis_original_command
= Qnil
;
11893 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11894 doc
: /* *Number of input events between auto-saves.
11895 Zero means disable autosaving due to number of characters typed. */);
11896 auto_save_interval
= 300;
11898 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11899 doc
: /* *Number of seconds idle time before auto-save.
11900 Zero or nil means disable auto-saving due to idleness.
11901 After auto-saving due to this many seconds of idle time,
11902 Emacs also does a garbage collection if that seems to be warranted. */);
11903 XSETFASTINT (Vauto_save_timeout
, 30);
11905 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11906 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11907 The value may be integer or floating point. */);
11908 Vecho_keystrokes
= make_number (1);
11910 DEFVAR_INT ("polling-period", &polling_period
,
11911 doc
: /* *Interval between polling for input during Lisp execution.
11912 The reason for polling is to make C-g work to stop a running program.
11913 Polling is needed only when using X windows and SIGIO does not work.
11914 Polling is automatically disabled in all other cases. */);
11915 polling_period
= 2;
11917 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11918 doc
: /* *Maximum time between mouse clicks to make a double-click.
11919 Measured in milliseconds. The value nil means disable double-click
11920 recognition; t means double-clicks have no time limit and are detected
11921 by position only. */);
11922 Vdouble_click_time
= make_number (500);
11924 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11925 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11926 On window-system frames, value is the number of pixels the mouse may have
11927 moved horizontally or vertically between two clicks to make a double-click.
11928 On non window-system frames, value is interpreted in units of 1/8 characters
11931 This variable is also the threshold for motion of the mouse
11932 to count as a drag. */);
11933 double_click_fuzz
= 3;
11935 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11936 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11937 inhibit_local_menu_bar_menus
= 0;
11939 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11940 doc
: /* Number of complete key sequences read as input so far.
11941 This includes key sequences read from keyboard macros.
11942 The number is effectively the number of interactive command invocations. */);
11943 num_input_keys
= 0;
11945 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11946 doc
: /* Number of input events read from the keyboard so far.
11947 This does not include events generated by keyboard macros. */);
11948 num_nonmacro_input_events
= 0;
11950 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11951 doc
: /* The frame in which the most recently read event occurred.
11952 If the last event came from a keyboard macro, this is set to `macro'. */);
11953 Vlast_event_frame
= Qnil
;
11955 /* This variable is set up in sysdep.c. */
11956 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11957 doc
: /* The ERASE character as set by the user with stty. */);
11959 DEFVAR_LISP ("help-char", &Vhelp_char
,
11960 doc
: /* Character to recognize as meaning Help.
11961 When it is read, do `(eval help-form)', and display result if it's a string.
11962 If the value of `help-form' is nil, this char can be read normally. */);
11963 XSETINT (Vhelp_char
, Ctl ('H'));
11965 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11966 doc
: /* List of input events to recognize as meaning Help.
11967 These work just like the value of `help-char' (see that). */);
11968 Vhelp_event_list
= Qnil
;
11970 DEFVAR_LISP ("help-form", &Vhelp_form
,
11971 doc
: /* Form to execute when character `help-char' is read.
11972 If the form returns a string, that string is displayed.
11973 If `help-form' is nil, the help char is not recognized. */);
11976 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11977 doc
: /* Command to run when `help-char' character follows a prefix key.
11978 This command is used only when there is no actual binding
11979 for that character after that prefix key. */);
11980 Vprefix_help_command
= Qnil
;
11982 DEFVAR_LISP ("top-level", &Vtop_level
,
11983 doc
: /* Form to evaluate when Emacs starts up.
11984 Useful to set before you dump a modified Emacs. */);
11987 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11988 doc
: /* Translate table for local keyboard input, or nil.
11989 If non-nil, the value should be a char-table. Each character read
11990 from the keyboard is looked up in this char-table. If the value found
11991 there is non-nil, then it is used instead of the actual input character.
11993 The value can also be a string or vector, but this is considered obsolete.
11994 If it is a string or vector of length N, character codes N and up are left
11995 untranslated. In a vector, an element which is nil means "no translation".
11997 This is applied to the characters supplied to input methods, not their
11998 output. See also `translation-table-for-input'.
12000 This variable has a separate binding for each terminal.
12001 See Info node `(elisp)Multiple Terminals'. */);
12003 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12004 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12005 \(Even if the operating system has support for stopping a process.\) */);
12006 cannot_suspend
= 0;
12008 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12009 doc
: /* Non-nil means prompt with menus when appropriate.
12010 This is done when reading from a keymap that has a prompt string,
12011 for elements that have prompt strings.
12012 The menu is displayed on the screen
12013 if X menus were enabled at configuration
12014 time and the previous event was a mouse click prefix key.
12015 Otherwise, menu prompting uses the echo area. */);
12016 menu_prompting
= 1;
12018 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12019 doc
: /* Character to see next line of menu prompt.
12020 Type this character while in a menu prompt to rotate around the lines of it. */);
12021 XSETINT (menu_prompt_more_char
, ' ');
12023 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12024 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12025 Emacs applies the modifiers of the character stored here to each keyboard
12026 character it reads. For example, after evaluating the expression
12027 (setq extra-keyboard-modifiers ?\\C-x)
12028 all input characters will have the control modifier applied to them.
12030 Note that the character ?\\C-@, equivalent to the integer zero, does
12031 not count as a control character; rather, it counts as a character
12032 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12033 cancels any modification. */);
12034 extra_keyboard_modifiers
= 0;
12036 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12037 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12038 The command loop sets this to nil before each command,
12039 and tests the value when the command returns.
12040 Buffer modification stores t in this variable. */);
12041 Vdeactivate_mark
= Qnil
;
12042 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12043 staticpro (&Qdeactivate_mark
);
12045 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12046 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12047 Vcommand_hook_internal
= Qnil
;
12049 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12050 doc
: /* Normal hook run before each command is executed.
12051 If an unhandled error happens in running this hook,
12052 the hook value is set to nil, since otherwise the error
12053 might happen repeatedly and make Emacs nonfunctional. */);
12054 Vpre_command_hook
= Qnil
;
12056 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12057 doc
: /* Normal hook run after 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 Vpost_command_hook
= Qnil
;
12064 DEFVAR_LISP ("echo-area-clear-hook", ...,
12065 doc
: /* Normal hook run when clearing the echo area. */);
12067 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12068 staticpro (&Qecho_area_clear_hook
);
12069 Fset (Qecho_area_clear_hook
, Qnil
);
12071 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12072 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12073 Vlucid_menu_bar_dirty_flag
= Qnil
;
12075 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12076 doc
: /* List of menu bar items to move to the end of the menu bar.
12077 The elements of the list are event types that may have menu bar bindings. */);
12078 Vmenu_bar_final_items
= Qnil
;
12080 DEFVAR_KBOARD ("overriding-terminal-local-map",
12081 Voverriding_terminal_local_map
,
12082 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12083 If this variable is non-nil, it is used as a keymap instead of the
12084 buffer's local map, and the minor mode keymaps and text property keymaps.
12085 It also replaces `overriding-local-map'.
12087 This variable is intended to let commands such as `universal-argument'
12088 set up a different keymap for reading the next command.
12090 `overriding-terminal-local-map' has a separate binding for each
12092 See Info node `(elisp)Multiple Terminals'. */);
12094 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12095 doc
: /* Keymap that overrides all other local keymaps.
12096 If this variable is non-nil, it is used as a keymap--replacing the
12097 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12098 Voverriding_local_map
= Qnil
;
12100 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12101 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12102 Otherwise, the menu bar continues to reflect the buffer's local map
12103 and the minor mode maps regardless of `overriding-local-map'. */);
12104 Voverriding_local_map_menu_flag
= Qnil
;
12106 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12107 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12108 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12110 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12111 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12113 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12114 doc
: /* Alist of system-specific X windows key symbols.
12115 Each element should have the form (N . SYMBOL) where N is the
12116 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12117 and SYMBOL is its name.
12119 `system-key-alist' has a separate binding for each terminal device.
12120 See Info node `(elisp)Multiple Terminals'. */);
12122 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12123 doc
: /* Keymap that translates key sequences to key sequences during input.
12124 This is used mainly for mapping key sequences into some preferred
12125 key events (symbols).
12127 The `read-key-sequence' function replaces any subsequence bound by
12128 `local-function-key-map' with its binding. More precisely, when the
12129 active keymaps have no binding for the current key sequence but
12130 `local-function-key-map' binds a suffix of the sequence to a vector or
12131 string, `read-key-sequence' replaces the matching suffix with its
12132 binding, and continues with the new sequence.
12134 If the binding is a function, it is called with one argument (the prompt)
12135 and its return value (a key sequence) is used.
12137 The events that come from bindings in `local-function-key-map' are not
12138 themselves looked up in `local-function-key-map'.
12140 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12141 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12142 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12143 typing `ESC O P x' would return [f1 x].
12145 `local-function-key-map' has a separate binding for each terminal
12146 device. See Info node `(elisp)Multiple Terminals'. If you need to
12147 define a binding on all terminals, change `function-key-map'
12148 instead. Initially, `local-function-key-map' is an empty keymap that
12149 has `function-key-map' as its parent on all terminal devices. */);
12151 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12152 doc
: /* Keymap that decodes input escape sequences.
12153 This is used mainly for mapping ASCII function key sequences into
12154 real Emacs function key events (symbols).
12156 The `read-key-sequence' function replaces any subsequence bound by
12157 `input-decode-map' with its binding. Contrary to `function-key-map',
12158 this map applies its rebinding regardless of the presence of an ordinary
12159 binding. So it is more like `key-translation-map' except that it applies
12160 before `function-key-map' rather than after.
12162 If the binding is a function, it is called with one argument (the prompt)
12163 and its return value (a key sequence) is used.
12165 The events that come from bindings in `input-decode-map' are not
12166 themselves looked up in `input-decode-map'.
12168 This variable is keyboard-local. */);
12170 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12171 doc
: /* The parent keymap of all `local-function-key-map' instances.
12172 Function key definitions that apply to all terminal devices should go
12173 here. If a mapping is defined in both the current
12174 `local-function-key-map' binding and this variable, then the local
12175 definition will take precendence. */);
12176 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12178 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12179 doc
: /* Keymap of key translations that can override keymaps.
12180 This keymap works like `function-key-map', but comes after that,
12181 and its non-prefix bindings override ordinary bindings.
12182 Another difference is that it is global rather than keyboard-local. */);
12183 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12185 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12186 doc
: /* List of deferred actions to be performed at a later time.
12187 The precise format isn't relevant here; we just check whether it is nil. */);
12188 Vdeferred_action_list
= Qnil
;
12190 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12191 doc
: /* Function to call to handle deferred actions, after each command.
12192 This function is called with no arguments after each command
12193 whenever `deferred-action-list' is non-nil. */);
12194 Vdeferred_action_function
= Qnil
;
12196 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12197 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12198 The value can be a length of time to show the message for.
12199 If the value is non-nil and not a number, we wait 2 seconds. */);
12200 Vsuggest_key_bindings
= Qt
;
12202 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12203 doc
: /* List of active absolute time timers in order of increasing time. */);
12204 Vtimer_list
= Qnil
;
12206 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12207 doc
: /* List of active idle-time timers in order of increasing time. */);
12208 Vtimer_idle_list
= Qnil
;
12210 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12211 doc
: /* If non-nil, the function that implements the current input method.
12212 It's called with one argument, a printing character that was just read.
12213 \(That means a character with code 040...0176.)
12214 Typically this function uses `read-event' to read additional events.
12215 When it does so, it should first bind `input-method-function' to nil
12216 so it will not be called recursively.
12218 The function should return a list of zero or more events
12219 to be used as input. If it wants to put back some events
12220 to be reconsidered, separately, by the input method,
12221 it can add them to the beginning of `unread-command-events'.
12223 The input method function can find in `input-method-previous-message'
12224 the previous echo area message.
12226 The input method function should refer to the variables
12227 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12228 for guidance on what to do. */);
12229 Vinput_method_function
= Qnil
;
12231 DEFVAR_LISP ("input-method-previous-message",
12232 &Vinput_method_previous_message
,
12233 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12234 This variable exists because `read-event' clears the echo area
12235 before running the input method. It is nil if there was no message. */);
12236 Vinput_method_previous_message
= Qnil
;
12238 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12239 doc
: /* If non-nil, the function that implements the display of help.
12240 It's called with one argument, the help string to display. */);
12241 Vshow_help_function
= Qnil
;
12243 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12244 doc
: /* If non-nil, suppress point adjustment after executing a command.
12246 After a command is executed, if point is moved into a region that has
12247 special properties (e.g. composition, display), we adjust point to
12248 the boundary of the region. But, when a command sets this variable to
12249 non-nil, we suppress the point adjustment.
12251 This variable is set to nil before reading a command, and is checked
12252 just after executing the command. */);
12253 Vdisable_point_adjustment
= Qnil
;
12255 DEFVAR_LISP ("global-disable-point-adjustment",
12256 &Vglobal_disable_point_adjustment
,
12257 doc
: /* *If non-nil, always suppress point adjustment.
12259 The default value is nil, in which case, point adjustment are
12260 suppressed only after special commands that set
12261 `disable-point-adjustment' (which see) to non-nil. */);
12262 Vglobal_disable_point_adjustment
= Qnil
;
12264 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12265 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12266 If the value is not a number, such messages don't time out. */);
12267 Vminibuffer_message_timeout
= make_number (2);
12269 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12270 doc
: /* If non-nil, any keyboard input throws to this symbol.
12271 The value of that variable is passed to `quit-flag' and later causes a
12272 peculiar kind of quitting. */);
12273 Vthrow_on_input
= Qnil
;
12275 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12276 doc
: /* If non-nil, function to output error messages.
12277 The arguments are the error data, a list of the form
12278 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12279 such as just as `condition-case' would bind its variable to,
12280 the context (a string which normally goes at the start of the message),
12281 and the Lisp function within which the error was signaled. */);
12282 Vcommand_error_function
= Qnil
;
12284 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12285 &Venable_disabled_menus_and_buttons
,
12286 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12288 Help functions bind this to allow help on disabled menu items
12289 and tool-bar buttons. */);
12290 Venable_disabled_menus_and_buttons
= Qnil
;
12292 /* Create the initial keyboard. */
12293 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12294 init_kboard (initial_kboard
);
12295 /* Vwindow_system is left at t for now. */
12296 initial_kboard
->next_kboard
= all_kboards
;
12297 all_kboards
= initial_kboard
;
12301 keys_of_keyboard (void)
12303 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12304 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12305 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12306 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12307 initial_define_key (meta_map
, 'x', "execute-extended-command");
12309 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12310 "handle-delete-frame");
12311 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12312 "ns-put-working-text");
12313 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12314 "ns-unput-working-text");
12315 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12316 current-prefix-arg, as is done in `handle-switch-frame'.
12317 But `handle-switch-frame is not run from the special-map.
12318 Commands from that map are run in a special way that automatically
12319 preserves the prefix-arg. Restoring the prefix arg here is not just
12320 redundant but harmful:
12322 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12323 - after the first prompt, the exit-minibuffer-hook is run which may
12324 iconify a frame and thus push a `iconify-frame' event.
12325 - after running exit-minibuffer-hook, current-prefix-arg is
12326 restored to the non-nil value it had before the prompt.
12327 - we enter the second prompt.
12328 current-prefix-arg is non-nil, prefix-arg is nil.
12329 - before running the first real event, we run the special iconify-frame
12330 event, but we pass the `special' arg to execute-command so
12331 current-prefix-arg and prefix-arg are left untouched.
12332 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12333 - the next key event will have a spuriously non-nil current-prefix-arg. */
12334 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12336 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12338 /* Handling it at such a low-level causes read_key_sequence to get
12339 * confused because it doesn't realize that the current_buffer was
12340 * changed by read_char.
12342 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12343 * "handle-select-window"); */
12344 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12345 "handle-save-session");
12348 /* Define a special event which is raised for dbus callback
12350 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12351 "dbus-handle-event");
12354 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12358 /* Mark the pointers in the kboard objects.
12359 Called by the Fgarbage_collector. */
12361 mark_kboards (void)
12365 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12367 if (kb
->kbd_macro_buffer
)
12368 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12370 mark_object (kb
->Voverriding_terminal_local_map
);
12371 mark_object (kb
->Vlast_command
);
12372 mark_object (kb
->Vreal_last_command
);
12373 mark_object (kb
->Vkeyboard_translate_table
);
12374 mark_object (kb
->Vlast_repeatable_command
);
12375 mark_object (kb
->Vprefix_arg
);
12376 mark_object (kb
->Vlast_prefix_arg
);
12377 mark_object (kb
->kbd_queue
);
12378 mark_object (kb
->defining_kbd_macro
);
12379 mark_object (kb
->Vlast_kbd_macro
);
12380 mark_object (kb
->Vsystem_key_alist
);
12381 mark_object (kb
->system_key_syms
);
12382 mark_object (kb
->Vwindow_system
);
12383 mark_object (kb
->Vinput_decode_map
);
12384 mark_object (kb
->Vlocal_function_key_map
);
12385 mark_object (kb
->Vdefault_minibuffer_frame
);
12386 mark_object (kb
->echo_string
);
12389 struct input_event
*event
;
12390 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12392 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12393 event
= kbd_buffer
;
12394 if (event
->kind
!= SELECTION_REQUEST_EVENT
12395 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12397 mark_object (event
->x
);
12398 mark_object (event
->y
);
12400 mark_object (event
->frame_or_window
);
12401 mark_object (event
->arg
);
12406 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12407 (do not change this comment) */