1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000, 01, 02
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 /* File descriptor to use for input. */
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
101 #define KBD_BUFFER_SIZE 4096
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
123 KBOARD
*initial_kboard
;
124 KBOARD
*current_kboard
;
128 KBOARD the_only_kboard
;
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index
; /* Index for storing next element into recent_keys */
137 int total_keys
; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys
;
146 int this_command_key_count
;
148 /* This vector is used as a buffer to record the events that were actually read
149 by read_key_sequence. */
150 Lisp_Object raw_keybuf
;
151 int raw_keybuf_count
;
153 #define GROW_RAW_KEYBUF \
154 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
156 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
158 new = Fmake_vector (make_number (newsize), Qnil); \
159 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
160 raw_keybuf_count * sizeof (Lisp_Object)); \
164 /* Number of elements of this_command_keys
165 that precede this key sequence. */
166 int this_single_command_key_start
;
168 /* Record values of this_command_key_count and echo_length ()
169 before this command was read. */
170 static int before_command_key_count
;
171 static int before_command_echo_length
;
172 /* Values of before_command_key_count and before_command_echo_length
173 saved by reset-this-command-lengths. */
174 static int before_command_key_count_1
;
175 static int before_command_echo_length_1
;
176 /* Flag set by reset-this-command-lengths,
177 saying to reset the lengths when add_command_key is called. */
178 static int before_command_restore_flag
;
180 extern int minbuf_level
;
182 extern int message_enable_multibyte
;
184 extern struct backtrace
*backtrace_list
;
186 /* If non-nil, the function that implements the display of help.
187 It's called with one argument, the help string to display. */
189 Lisp_Object Vshow_help_function
;
191 /* If a string, the message displayed before displaying a help-echo
194 Lisp_Object Vpre_help_message
;
196 /* Nonzero means do menu prompting. */
198 static int menu_prompting
;
200 /* Character to see next line of menu prompt. */
202 static Lisp_Object menu_prompt_more_char
;
204 /* For longjmp to where kbd input is being done. */
206 static jmp_buf getcjmp
;
208 /* True while doing kbd input. */
209 int waiting_for_input
;
211 /* True while displaying for echoing. Delays C-g throwing. */
215 /* Non-null means we can start echoing at the next input pause even
216 though there is something in the echo area. */
218 static struct kboard
*ok_to_echo_at_next_pause
;
220 /* The kboard last echoing, or null for none. Reset to 0 in
221 cancel_echoing. If non-null, and a current echo area message
222 exists, and echo_message_buffer is eq to the current message
223 buffer, we know that the message comes from echo_kboard. */
225 struct kboard
*echo_kboard
;
227 /* The buffer used for echoing. Set in echo_now, reset in
230 Lisp_Object echo_message_buffer
;
232 /* Nonzero means disregard local maps for the menu bar. */
233 static int inhibit_local_menu_bar_menus
;
235 /* Nonzero means C-g should cause immediate error-signal. */
238 /* The user's ERASE setting. */
239 Lisp_Object Vtty_erase_char
;
241 /* Character to recognize as the help char. */
242 Lisp_Object Vhelp_char
;
244 /* List of other event types to recognize as meaning "help". */
245 Lisp_Object Vhelp_event_list
;
247 /* Form to execute when help char is typed. */
248 Lisp_Object Vhelp_form
;
250 /* Command to run when the help character follows a prefix key. */
251 Lisp_Object Vprefix_help_command
;
253 /* List of items that should move to the end of the menu bar. */
254 Lisp_Object Vmenu_bar_final_items
;
256 /* Non-nil means show the equivalent key-binding for
257 any M-x command that has one.
258 The value can be a length of time to show the message for.
259 If the value is non-nil and not a number, we wait 2 seconds. */
260 Lisp_Object Vsuggest_key_bindings
;
262 /* How long to display an echo-area message when the minibuffer is active.
263 If the value is not a number, such messages don't time out. */
264 Lisp_Object Vminibuffer_message_timeout
;
266 /* Character that causes a quit. Normally C-g.
268 If we are running on an ordinary terminal, this must be an ordinary
269 ASCII char, since we want to make it our interrupt character.
271 If we are not running on an ordinary terminal, it still needs to be
272 an ordinary ASCII char. This character needs to be recognized in
273 the input interrupt handler. At this point, the keystroke is
274 represented as a struct input_event, while the desired quit
275 character is specified as a lispy event. The mapping from struct
276 input_events to lispy events cannot run in an interrupt handler,
277 and the reverse mapping is difficult for anything but ASCII
280 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
284 extern Lisp_Object current_global_map
;
285 extern int minibuf_level
;
287 /* If non-nil, this is a map that overrides all other local maps. */
288 Lisp_Object Voverriding_local_map
;
290 /* If non-nil, Voverriding_local_map applies to the menu bar. */
291 Lisp_Object Voverriding_local_map_menu_flag
;
293 /* Keymap that defines special misc events that should
294 be processed immediately at a low level. */
295 Lisp_Object Vspecial_event_map
;
297 /* Current depth in recursive edits. */
298 int command_loop_level
;
300 /* Total number of times command_loop has read a key sequence. */
301 EMACS_INT num_input_keys
;
303 /* Last input character read as a command. */
304 Lisp_Object last_command_char
;
306 /* Last input character read as a command, not counting menus
307 reached by the mouse. */
308 Lisp_Object last_nonmenu_event
;
310 /* Last input character read for any purpose. */
311 Lisp_Object last_input_char
;
313 /* If not Qnil, a list of objects to be read as subsequent command input. */
314 Lisp_Object Vunread_command_events
;
316 /* If not Qnil, a list of objects to be read as subsequent command input
317 including input method processing. */
318 Lisp_Object Vunread_input_method_events
;
320 /* If not Qnil, a list of objects to be read as subsequent command input
321 but NOT including input method processing. */
322 Lisp_Object Vunread_post_input_method_events
;
324 /* If not -1, an event to be read as subsequent command input. */
325 EMACS_INT unread_command_char
;
327 /* If not Qnil, this is a switch-frame event which we decided to put
328 off until the end of a key sequence. This should be read as the
329 next command input, after any unread_command_events.
331 read_key_sequence uses this to delay switch-frame events until the
332 end of the key sequence; Fread_char uses it to put off switch-frame
333 events until a non-ASCII event is acceptable as input. */
334 Lisp_Object unread_switch_frame
;
336 /* A mask of extra modifier bits to put into every keyboard char. */
337 EMACS_INT extra_keyboard_modifiers
;
339 /* Char to use as prefix when a meta character is typed in.
340 This is bound on entry to minibuffer in case ESC is changed there. */
342 Lisp_Object meta_prefix_char
;
344 /* Last size recorded for a current buffer which is not a minibuffer. */
345 static int last_non_minibuf_size
;
347 /* Number of idle seconds before an auto-save and garbage collection. */
348 static Lisp_Object Vauto_save_timeout
;
350 /* Total number of times read_char has returned. */
351 int num_input_events
;
353 /* Total number of times read_char has returned, outside of macros. */
354 EMACS_INT num_nonmacro_input_events
;
356 /* Auto-save automatically when this many characters have been typed
357 since the last time. */
359 static EMACS_INT auto_save_interval
;
361 /* Value of num_nonmacro_input_events as of last auto save. */
365 /* The command being executed by the command loop.
366 Commands may set this, and the value set will be copied into
367 current_kboard->Vlast_command instead of the actual command. */
368 Lisp_Object Vthis_command
;
370 /* This is like Vthis_command, except that commands never set it. */
371 Lisp_Object real_this_command
;
373 /* If the lookup of the command returns a binding, the original
374 command is stored in this-original-command. It is nil otherwise. */
375 Lisp_Object Vthis_original_command
;
377 /* The value of point when the last command was executed. */
378 int last_point_position
;
380 /* The buffer that was current when the last command was started. */
381 Lisp_Object last_point_position_buffer
;
383 /* The frame in which the last input event occurred, or Qmacro if the
384 last event came from a macro. We use this to determine when to
385 generate switch-frame events. This may be cleared by functions
386 like Fselect_frame, to make sure that a switch-frame event is
387 generated by the next character. */
388 Lisp_Object internal_last_event_frame
;
390 /* A user-visible version of the above, intended to allow users to
391 figure out where the last event came from, if the event doesn't
392 carry that information itself (i.e. if it was a character). */
393 Lisp_Object Vlast_event_frame
;
395 /* The timestamp of the last input event we received from the X server.
396 X Windows wants this for selection ownership. */
397 unsigned long last_event_timestamp
;
399 Lisp_Object Qself_insert_command
;
400 Lisp_Object Qforward_char
;
401 Lisp_Object Qbackward_char
;
402 Lisp_Object Qundefined
;
403 Lisp_Object Qtimer_event_handler
;
405 /* read_key_sequence stores here the command definition of the
406 key sequence that it reads. */
407 Lisp_Object read_key_sequence_cmd
;
409 /* Echo unfinished commands after this many seconds of pause. */
410 Lisp_Object Vecho_keystrokes
;
412 /* Form to evaluate (if non-nil) when Emacs is started. */
413 Lisp_Object Vtop_level
;
415 /* User-supplied string to translate input characters through. */
416 Lisp_Object Vkeyboard_translate_table
;
418 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
419 extern Lisp_Object Vfunction_key_map
;
421 /* Another keymap that maps key sequences into key sequences.
422 This one takes precedence over ordinary definitions. */
423 extern Lisp_Object Vkey_translation_map
;
425 /* If non-nil, this implements the current input method. */
426 Lisp_Object Vinput_method_function
;
427 Lisp_Object Qinput_method_function
;
429 /* When we call Vinput_method_function,
430 this holds the echo area message that was just erased. */
431 Lisp_Object Vinput_method_previous_message
;
433 /* Non-nil means deactivate the mark at end of this command. */
434 Lisp_Object Vdeactivate_mark
;
436 /* Menu bar specified in Lucid Emacs fashion. */
438 Lisp_Object Vlucid_menu_bar_dirty_flag
;
439 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
441 Lisp_Object Qecho_area_clear_hook
;
443 /* Hooks to run before and after each command. */
444 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
445 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
446 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
447 /* Hook run after a command if there's no more input soon. */
448 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
450 /* Delay time in microseconds before running post-command-idle-hook. */
451 EMACS_INT post_command_idle_delay
;
453 /* List of deferred actions to be performed at a later time.
454 The precise format isn't relevant here; we just check whether it is nil. */
455 Lisp_Object Vdeferred_action_list
;
457 /* Function to call to handle deferred actions, when there are any. */
458 Lisp_Object Vdeferred_action_function
;
459 Lisp_Object Qdeferred_action_function
;
461 Lisp_Object Qinput_method_exit_on_first_char
;
462 Lisp_Object Qinput_method_use_echo_area
;
464 /* File in which we write all commands we read. */
467 /* Nonzero if input is available. */
470 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
471 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
475 /* Non-zero means force key bindings update in parse_menu_item. */
477 int update_menu_bindings
;
479 extern char *pending_malloc_warning
;
481 /* Circular buffer for pre-read keyboard input. */
483 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
485 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
487 The interrupt-level event handlers will never enqueue an event on a
488 frame which is not in Vframe_list, and once an event is dequeued,
489 internal_last_event_frame or the event itself points to the frame.
492 But while the event is sitting in the queue, it's completely
493 unprotected. Suppose the user types one command which will run for
494 a while and then delete a frame, and then types another event at
495 the frame that will be deleted, before the command gets around to
496 it. Suppose there are no references to this frame elsewhere in
497 Emacs, and a GC occurs before the second event is dequeued. Now we
498 have an event referring to a freed frame, which will crash Emacs
501 Similar things happen when an event on a scroll bar is enqueued; the
502 window may be deleted while the event is in the queue.
504 So, we use this vector to protect the Lisp_Objects in the event
505 queue. That way, they'll be dequeued as dead frames or windows,
506 but still valid Lisp objects.
508 If kbd_buffer[i].kind != NO_EVENT, then
510 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
511 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
513 static Lisp_Object kbd_buffer_gcpro
;
515 /* Pointer to next available character in kbd_buffer.
516 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
517 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
518 next available char is in kbd_buffer[0]. */
519 static struct input_event
*kbd_fetch_ptr
;
521 /* Pointer to next place to store character in kbd_buffer. This
522 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
523 character should go in kbd_buffer[0]. */
524 static struct input_event
* volatile kbd_store_ptr
;
526 /* The above pair of variables forms a "queue empty" flag. When we
527 enqueue a non-hook event, we increment kbd_store_ptr. When we
528 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
529 there is input available iff the two pointers are not equal.
531 Why not just have a flag set and cleared by the enqueuing and
532 dequeuing functions? Such a flag could be screwed up by interrupts
533 at inopportune times. */
535 /* If this flag is non-nil, we check mouse_moved to see when the
536 mouse moves, and motion events will appear in the input stream.
537 Otherwise, mouse motion is ignored. */
538 Lisp_Object do_mouse_tracking
;
540 /* Symbols to head events. */
541 Lisp_Object Qmouse_movement
;
542 Lisp_Object Qscroll_bar_movement
;
543 Lisp_Object Qswitch_frame
;
544 Lisp_Object Qdelete_frame
;
545 Lisp_Object Qiconify_frame
;
546 Lisp_Object Qmake_frame_visible
;
547 Lisp_Object Qselect_window
;
548 Lisp_Object Qhelp_echo
;
550 /* Symbols to denote kinds of events. */
551 Lisp_Object Qfunction_key
;
552 Lisp_Object Qmouse_click
;
554 Lisp_Object Qmouse_wheel
;
555 Lisp_Object Qlanguage_change
;
557 Lisp_Object Qdrag_n_drop
;
558 Lisp_Object Qsave_session
;
560 /* Lisp_Object Qmouse_movement; - also an event header */
562 /* Properties of event headers. */
563 Lisp_Object Qevent_kind
;
564 Lisp_Object Qevent_symbol_elements
;
566 /* menu item parts */
567 Lisp_Object Qmenu_alias
;
568 Lisp_Object Qmenu_enable
;
569 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
570 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
571 extern Lisp_Object Vdefine_key_rebound_commands
;
572 extern Lisp_Object Qmenu_item
;
574 /* An event header symbol HEAD may have a property named
575 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
576 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
577 mask of modifiers applied to it. If present, this is used to help
578 speed up parse_modifiers. */
579 Lisp_Object Qevent_symbol_element_mask
;
581 /* An unmodified event header BASE may have a property named
582 Qmodifier_cache, which is an alist mapping modifier masks onto
583 modified versions of BASE. If present, this helps speed up
585 Lisp_Object Qmodifier_cache
;
587 /* Symbols to use for parts of windows. */
588 Lisp_Object Qmode_line
;
589 Lisp_Object Qvertical_line
;
590 Lisp_Object Qvertical_scroll_bar
;
591 Lisp_Object Qmenu_bar
;
592 extern Lisp_Object Qleft_margin
, Qright_margin
;
594 Lisp_Object
recursive_edit_unwind (), command_loop ();
595 Lisp_Object
Fthis_command_keys ();
596 Lisp_Object Qextended_command_history
;
597 EMACS_TIME
timer_check ();
599 extern Lisp_Object Vhistory_length
;
601 extern char *x_get_keysym_name ();
603 static void record_menu_key ();
605 Lisp_Object Qpolling_period
;
607 /* List of absolute timers. Appears in order of next scheduled event. */
608 Lisp_Object Vtimer_list
;
610 /* List of idle time timers. Appears in order of next scheduled event. */
611 Lisp_Object Vtimer_idle_list
;
613 /* Incremented whenever a timer is run. */
616 extern Lisp_Object Vprint_level
, Vprint_length
;
618 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
620 EMACS_TIME
*input_available_clear_time
;
622 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
623 Default is 1 if INTERRUPT_INPUT is defined. */
626 /* Nonzero while interrupts are temporarily deferred during redisplay. */
627 int interrupts_deferred
;
629 /* Nonzero means use ^S/^Q for flow control. */
632 /* Allow m- file to inhibit use of FIONREAD. */
633 #ifdef BROKEN_FIONREAD
637 /* We are unable to use interrupts if FIONREAD is not available,
638 so flush SIGIO so we won't try. */
645 /* If we support a window system, turn on the code to poll periodically
646 to detect C-g. It isn't actually used when doing interrupt input. */
647 #ifdef HAVE_WINDOW_SYSTEM
648 #define POLL_FOR_INPUT
651 /* After a command is executed, if point is moved into a region that
652 has specific properties (e.g. composition, display), we adjust
653 point to the boundary of the region. But, if a command sets this
654 variable to non-nil, we suppress this point adjustment. This
655 variable is set to nil before reading a command. */
657 Lisp_Object Vdisable_point_adjustment
;
659 /* If non-nil, always disable point adjustment. */
661 Lisp_Object Vglobal_disable_point_adjustment
;
663 /* The time when Emacs started being idle. */
665 static EMACS_TIME timer_idleness_start_time
;
667 /* After Emacs stops being idle, this saves the last value
668 of timer_idleness_start_time from when it was idle. */
670 static EMACS_TIME timer_last_idleness_start_time
;
673 /* Global variable declarations. */
675 /* Function for init_keyboard to call with no args (if nonzero). */
676 void (*keyboard_init_hook
) ();
678 static int read_avail_input
P_ ((int));
679 static void get_input_pending
P_ ((int *, int));
680 static void get_filtered_input_pending
P_ ((int *, int, int));
681 static int readable_events
P_ ((int));
682 static int readable_filtered_events
P_ ((int, int));
683 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
684 Lisp_Object
, int *));
685 static Lisp_Object
read_char_x_menu_prompt ();
686 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
688 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
690 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
691 enum scroll_bar_part
,
692 Lisp_Object
, Lisp_Object
,
695 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
696 Lisp_Object
, char **,
697 Lisp_Object
*, unsigned));
698 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
699 static int parse_solitary_modifier
P_ ((Lisp_Object
));
700 static int parse_solitary_modifier ();
701 static void save_getcjmp
P_ ((jmp_buf));
702 static void save_getcjmp ();
703 static void restore_getcjmp
P_ ((jmp_buf));
704 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
705 static void clear_event
P_ ((struct input_event
*));
706 static void any_kboard_state
P_ ((void));
708 /* Nonzero means don't try to suspend even if the operating system seems
710 static int cannot_suspend
;
712 /* Install the string STR as the beginning of the string of echoing,
713 so that it serves as a prompt for the next character.
714 Also start echoing. */
720 current_kboard
->echo_string
= str
;
721 current_kboard
->echo_after_prompt
= SCHARS (str
);
725 /* Add C to the echo string, if echoing is going on.
726 C can be a character, which is printed prettily ("M-C-x" and all that
727 jazz), or a symbol, whose name is printed. */
733 if (current_kboard
->immediate_echo
)
735 int size
= KEY_DESCRIPTION_SIZE
+ 100;
736 char *buffer
= (char *) alloca (size
);
738 Lisp_Object echo_string
;
740 echo_string
= current_kboard
->echo_string
;
742 /* If someone has passed us a composite event, use its head symbol. */
747 ptr
= push_key_description (XINT (c
), ptr
, 1);
749 else if (SYMBOLP (c
))
751 Lisp_Object name
= SYMBOL_NAME (c
);
752 int nbytes
= SBYTES (name
);
754 if (size
- (ptr
- buffer
) < nbytes
)
756 int offset
= ptr
- buffer
;
757 size
= max (2 * size
, size
+ nbytes
);
758 buffer
= (char *) alloca (size
);
759 ptr
= buffer
+ offset
;
762 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
763 STRING_MULTIBYTE (name
), 1);
766 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
769 const char *text
= " (Type ? for further options)";
770 int len
= strlen (text
);
772 if (size
- (ptr
- buffer
) < len
)
774 int offset
= ptr
- buffer
;
776 buffer
= (char *) alloca (size
);
777 ptr
= buffer
+ offset
;
780 bcopy (text
, ptr
, len
);
784 /* Replace a dash from echo_dash with a space, otherwise
785 add a space at the end as a separator between keys. */
786 if (STRINGP (echo_string
)
787 && SCHARS (echo_string
) > 0)
789 Lisp_Object last_char
, idx
;
791 idx
= make_number (SCHARS (echo_string
) - 1);
792 last_char
= Faref (echo_string
, idx
);
794 if (XINT (last_char
) == '-')
795 Faset (echo_string
, idx
, make_number (' '));
797 echo_string
= concat2 (echo_string
, build_string (" "));
800 current_kboard
->echo_string
801 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
807 /* Temporarily add a dash to the end of the echo string if it's not
808 empty, so that it serves as a mini-prompt for the very next character. */
813 /* Do nothing if not echoing at all. */
814 if (NILP (current_kboard
->echo_string
))
817 if (!current_kboard
->immediate_echo
818 && SCHARS (current_kboard
->echo_string
) == 0)
821 /* Do nothing if we just printed a prompt. */
822 if (current_kboard
->echo_after_prompt
823 == SCHARS (current_kboard
->echo_string
))
826 /* Put a dash at the end of the buffer temporarily,
827 but make it go away when the next character is added. */
828 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
833 /* Display the current echo string, and begin echoing if not already
839 if (!current_kboard
->immediate_echo
)
842 current_kboard
->immediate_echo
= 1;
844 for (i
= 0; i
< this_command_key_count
; i
++)
847 c
= XVECTOR (this_command_keys
)->contents
[i
];
848 if (! (EVENT_HAS_PARAMETERS (c
)
849 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
856 message3_nolog (current_kboard
->echo_string
,
857 SBYTES (current_kboard
->echo_string
),
858 STRING_MULTIBYTE (current_kboard
->echo_string
));
861 /* Record in what buffer we echoed, and from which kboard. */
862 echo_message_buffer
= echo_area_buffer
[0];
863 echo_kboard
= current_kboard
;
865 if (waiting_for_input
&& !NILP (Vquit_flag
))
866 quit_throw_to_read_char ();
869 /* Turn off echoing, for the start of a new command. */
874 current_kboard
->immediate_echo
= 0;
875 current_kboard
->echo_after_prompt
= -1;
876 current_kboard
->echo_string
= Qnil
;
877 ok_to_echo_at_next_pause
= NULL
;
879 echo_message_buffer
= Qnil
;
882 /* Return the length of the current echo string. */
887 return (STRINGP (current_kboard
->echo_string
)
888 ? SCHARS (current_kboard
->echo_string
)
892 /* Truncate the current echo message to its first LEN chars.
893 This and echo_char get used by read_key_sequence when the user
894 switches frames while entering a key sequence. */
897 echo_truncate (nchars
)
900 if (STRINGP (current_kboard
->echo_string
))
901 current_kboard
->echo_string
902 = Fsubstring (current_kboard
->echo_string
,
903 make_number (0), make_number (nchars
));
904 truncate_echo_area (nchars
);
908 /* Functions for manipulating this_command_keys. */
910 add_command_key (key
)
913 /* If reset-this-command-length was called recently, obey it now.
914 See the doc string of that function for an explanation of why. */
915 if (before_command_restore_flag
)
917 this_command_key_count
= before_command_key_count_1
;
918 if (this_command_key_count
< this_single_command_key_start
)
919 this_single_command_key_start
= this_command_key_count
;
920 echo_truncate (before_command_echo_length_1
);
921 before_command_restore_flag
= 0;
924 if (this_command_key_count
>= ASIZE (this_command_keys
))
925 this_command_keys
= larger_vector (this_command_keys
,
926 2 * ASIZE (this_command_keys
),
929 AREF (this_command_keys
, this_command_key_count
) = key
;
930 ++this_command_key_count
;
937 int count
= SPECPDL_INDEX ();
940 if (command_loop_level
> 0)
942 specbind (Qstandard_output
, Qt
);
943 specbind (Qstandard_input
, Qt
);
946 #ifdef HAVE_X_WINDOWS
947 /* The command loop has started an hourglass timer, so we have to
948 cancel it here, otherwise it will fire because the recursive edit
949 can take some time. Do not check for display_hourglass_p here,
950 because it could already be nil. */
954 /* This function may have been called from a debugger called from
955 within redisplay, for instance by Edebugging a function called
956 from fontification-functions. We want to allow redisplay in
957 the debugging session.
959 The recursive edit is left with a `(throw exit ...)'. The `exit'
960 tag is not caught anywhere in redisplay, i.e. when we leave the
961 recursive edit, the original redisplay leading to the recursive
962 edit will be unwound. The outcome should therefore be safe. */
963 specbind (Qinhibit_redisplay
, Qnil
);
966 val
= command_loop ();
968 Fsignal (Qquit
, Qnil
);
969 /* Handle throw from read_minibuf when using minibuffer
970 while it's active but we're in another window. */
972 Fsignal (Qerror
, Fcons (val
, Qnil
));
974 return unbind_to (count
, Qnil
);
977 /* When an auto-save happens, record the "time", and don't do again soon. */
982 last_auto_save
= num_nonmacro_input_events
;
985 /* Make an auto save happen as soon as possible at command level. */
988 force_auto_save_soon ()
990 last_auto_save
= - auto_save_interval
- 1;
992 record_asynch_buffer_change ();
995 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
996 doc
: /* Invoke the editor command loop recursively.
997 To get out of the recursive edit, a command can do `(throw 'exit nil)';
998 that tells this function to return.
999 Alternately, `(throw 'exit t)' makes this function signal an error.
1000 This function is called by the editor initialization to begin editing. */)
1003 int count
= SPECPDL_INDEX ();
1006 command_loop_level
++;
1007 update_mode_lines
= 1;
1009 if (command_loop_level
1010 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1011 buffer
= Fcurrent_buffer ();
1015 /* If we leave recursive_edit_1 below with a `throw' for instance,
1016 like it is done in the splash screen display, we have to
1017 make sure that we restore single_kboard as command_loop_1
1018 would have done if it were left normally. */
1019 record_unwind_protect (recursive_edit_unwind
,
1020 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1022 recursive_edit_1 ();
1023 return unbind_to (count
, Qnil
);
1027 recursive_edit_unwind (info
)
1030 if (BUFFERP (XCAR (info
)))
1031 Fset_buffer (XCAR (info
));
1033 if (NILP (XCDR (info
)))
1034 any_kboard_state ();
1036 single_kboard_state ();
1038 command_loop_level
--;
1039 update_mode_lines
= 1;
1048 #if 0 /* Theory: if there's anything in Vunread_command_events,
1049 it will right away be read by read_key_sequence,
1050 and then if we do switch KBOARDS, it will go into the side
1051 queue then. So we don't need to do anything special here -- rms. */
1052 if (CONSP (Vunread_command_events
))
1054 current_kboard
->kbd_queue
1055 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1056 current_kboard
->kbd_queue_has_data
= 1;
1058 Vunread_command_events
= Qnil
;
1064 /* Switch to the single-kboard state, making current_kboard
1065 the only KBOARD from which further input is accepted. */
1068 single_kboard_state ()
1075 /* Maintain a stack of kboards, so other parts of Emacs
1076 can switch temporarily to the kboard of a given frame
1077 and then revert to the previous status. */
1082 struct kboard_stack
*next
;
1085 static struct kboard_stack
*kboard_stack
;
1088 push_frame_kboard (f
)
1092 struct kboard_stack
*p
1093 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1095 p
->next
= kboard_stack
;
1096 p
->kboard
= current_kboard
;
1099 current_kboard
= FRAME_KBOARD (f
);
1107 struct kboard_stack
*p
= kboard_stack
;
1108 current_kboard
= p
->kboard
;
1109 kboard_stack
= p
->next
;
1114 /* Handle errors that are not handled at inner levels
1115 by printing an error message and returning to the editor command loop. */
1121 Lisp_Object old_level
, old_length
;
1122 char macroerror
[50];
1124 #ifdef HAVE_X_WINDOWS
1125 if (display_hourglass_p
)
1126 cancel_hourglass ();
1129 if (!NILP (executing_macro
))
1131 if (executing_macro_iterations
== 1)
1132 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1134 sprintf (macroerror
, "After %d kbd macro iterations: ",
1135 executing_macro_iterations
);
1140 Vstandard_output
= Qt
;
1141 Vstandard_input
= Qt
;
1142 Vexecuting_macro
= Qnil
;
1143 executing_macro
= Qnil
;
1144 current_kboard
->Vprefix_arg
= Qnil
;
1145 current_kboard
->Vlast_prefix_arg
= Qnil
;
1148 /* Avoid unquittable loop if data contains a circular list. */
1149 old_level
= Vprint_level
;
1150 old_length
= Vprint_length
;
1151 XSETFASTINT (Vprint_level
, 10);
1152 XSETFASTINT (Vprint_length
, 10);
1153 cmd_error_internal (data
, macroerror
);
1154 Vprint_level
= old_level
;
1155 Vprint_length
= old_length
;
1159 Vinhibit_quit
= Qnil
;
1161 any_kboard_state ();
1164 return make_number (0);
1167 /* Take actions on handling an error. DATA is the data that describes
1170 CONTEXT is a C-string containing ASCII characters only which
1171 describes the context in which the error happened. If we need to
1172 generalize CONTEXT to allow multibyte characters, make it a Lisp
1176 cmd_error_internal (data
, context
)
1181 int kill_emacs_p
= 0;
1182 struct frame
*sf
= SELECTED_FRAME ();
1186 clear_message (1, 0);
1188 /* If the window system or terminal frame hasn't been initialized
1189 yet, or we're not interactive, it's best to dump this message out
1190 to stderr and exit. */
1191 if (!sf
->glyphs_initialized_p
1192 /* This is the case of the frame dumped with Emacs, when we're
1193 running under a window system. */
1194 || (!NILP (Vwindow_system
)
1195 && !inhibit_window_system
1196 && FRAME_TERMCAP_P (sf
))
1199 stream
= Qexternal_debugging_output
;
1205 message_log_maybe_newline ();
1210 /* The immediate context is not interesting for Quits,
1211 since they are asyncronous. */
1212 if (EQ (XCAR (data
), Qquit
))
1213 Vsignaling_function
= Qnil
;
1215 print_error_message (data
, stream
, context
, Vsignaling_function
);
1217 Vsignaling_function
= Qnil
;
1219 /* If the window system or terminal frame hasn't been initialized
1220 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1224 Fkill_emacs (make_number (-1));
1228 Lisp_Object
command_loop_1 ();
1229 Lisp_Object
command_loop_2 ();
1230 Lisp_Object
top_level_1 ();
1232 /* Entry to editor-command-loop.
1233 This level has the catches for exiting/returning to editor command loop.
1234 It returns nil to exit recursive edit, t to abort it. */
1239 if (command_loop_level
> 0 || minibuf_level
> 0)
1242 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1243 executing_macro
= Qnil
;
1249 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1250 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1251 executing_macro
= Qnil
;
1253 /* End of file in -batch run causes exit here. */
1259 /* Here we catch errors in execution of commands within the
1260 editing loop, and reenter the editing loop.
1261 When there is an error, cmd_error runs and returns a non-nil
1262 value to us. A value of nil means that command_loop_1 itself
1263 returned due to end of file (or end of kbd macro). */
1268 register Lisp_Object val
;
1271 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1272 while (!NILP (val
));
1280 return Feval (Vtop_level
);
1286 /* On entry to the outer level, run the startup file */
1287 if (!NILP (Vtop_level
))
1288 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1289 else if (!NILP (Vpurify_flag
))
1290 message ("Bare impure Emacs (standard Lisp code not loaded)");
1292 message ("Bare Emacs (standard Lisp code not loaded)");
1296 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1297 doc
: /* Exit all recursive editing levels. */)
1300 #ifdef HAVE_X_WINDOWS
1301 if (display_hourglass_p
)
1302 cancel_hourglass ();
1304 return Fthrow (Qtop_level
, Qnil
);
1307 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1308 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1311 if (command_loop_level
> 0 || minibuf_level
> 0)
1312 Fthrow (Qexit
, Qnil
);
1314 error ("No recursive edit is in progress");
1318 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1319 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1322 if (command_loop_level
> 0 || minibuf_level
> 0)
1325 error ("No recursive edit is in progress");
1329 /* This is the actual command reading loop,
1330 sans error-handling encapsulation. */
1332 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1334 void safe_run_hooks
P_ ((Lisp_Object
));
1335 static void adjust_point_for_property
P_ ((int));
1343 Lisp_Object keybuf
[30];
1347 struct buffer
*prev_buffer
= NULL
;
1349 int was_locked
= single_kboard
;
1352 current_kboard
->Vprefix_arg
= Qnil
;
1353 current_kboard
->Vlast_prefix_arg
= Qnil
;
1354 Vdeactivate_mark
= Qnil
;
1355 waiting_for_input
= 0;
1359 this_command_key_count
= 0;
1360 this_single_command_key_start
= 0;
1362 if (NILP (Vmemory_full
))
1364 /* Make sure this hook runs after commands that get errors and
1365 throw to top level. */
1366 /* Note that the value cell will never directly contain nil
1367 if the symbol is a local variable. */
1368 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1369 safe_run_hooks (Qpost_command_hook
);
1371 /* If displaying a message, resize the echo area window to fit
1372 that message's size exactly. */
1373 if (!NILP (echo_area_buffer
[0]))
1374 resize_echo_area_exactly ();
1376 if (!NILP (Vdeferred_action_list
))
1377 call0 (Vdeferred_action_function
);
1379 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1381 if (NILP (Vunread_command_events
)
1382 && NILP (Vunread_input_method_events
)
1383 && NILP (Vunread_post_input_method_events
)
1384 && NILP (Vexecuting_macro
)
1385 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1386 safe_run_hooks (Qpost_command_idle_hook
);
1390 Vmemory_full
= Qnil
;
1392 /* Do this after running Vpost_command_hook, for consistency. */
1393 current_kboard
->Vlast_command
= Vthis_command
;
1394 current_kboard
->Vreal_last_command
= real_this_command
;
1398 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1401 /* Make sure the current window's buffer is selected. */
1402 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1403 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1405 /* Display any malloc warning that just came out. Use while because
1406 displaying one warning can cause another. */
1408 while (pending_malloc_warning
)
1409 display_malloc_warning ();
1413 Vdeactivate_mark
= Qnil
;
1415 /* If minibuffer on and echo area in use,
1416 wait a short time and redraw minibuffer. */
1419 && !NILP (echo_area_buffer
[0])
1420 && EQ (minibuf_window
, echo_area_window
)
1421 && NUMBERP (Vminibuffer_message_timeout
))
1423 /* Bind inhibit-quit to t so that C-g gets read in
1424 rather than quitting back to the minibuffer. */
1425 int count
= SPECPDL_INDEX ();
1426 specbind (Qinhibit_quit
, Qt
);
1428 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1429 /* Clear the echo area. */
1431 safe_run_hooks (Qecho_area_clear_hook
);
1433 unbind_to (count
, Qnil
);
1435 /* If a C-g came in before, treat it as input now. */
1436 if (!NILP (Vquit_flag
))
1439 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1444 alloca (0); /* Cause a garbage collection now */
1445 /* Since we can free the most stuff here. */
1446 #endif /* C_ALLOCA */
1449 /* Select the frame that the last event came from. Usually,
1450 switch-frame events will take care of this, but if some lisp
1451 code swallows a switch-frame event, we'll fix things up here.
1452 Is this a good idea? */
1453 if (FRAMEP (internal_last_event_frame
)
1454 && !EQ (internal_last_event_frame
, selected_frame
))
1455 Fselect_frame (internal_last_event_frame
, Qnil
);
1457 /* If it has changed current-menubar from previous value,
1458 really recompute the menubar from the value. */
1459 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1460 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1461 call0 (Qrecompute_lucid_menubar
);
1463 before_command_key_count
= this_command_key_count
;
1464 before_command_echo_length
= echo_length ();
1466 Vthis_command
= Qnil
;
1467 real_this_command
= Qnil
;
1469 /* Read next key sequence; i gets its length. */
1470 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1473 /* A filter may have run while we were reading the input. */
1474 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1476 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1477 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1481 /* Now we have read a key sequence of length I,
1482 or else I is 0 and we found end of file. */
1484 if (i
== 0) /* End of file -- happens only in */
1485 return Qnil
; /* a kbd macro, at the end. */
1486 /* -1 means read_key_sequence got a menu that was rejected.
1487 Just loop around and read another command. */
1491 this_command_key_count
= 0;
1492 this_single_command_key_start
= 0;
1496 last_command_char
= keybuf
[i
- 1];
1498 /* If the previous command tried to force a specific window-start,
1499 forget about that, in case this command moves point far away
1500 from that position. But also throw away beg_unchanged and
1501 end_unchanged information in that case, so that redisplay will
1502 update the whole window properly. */
1503 if (!NILP (XWINDOW (selected_window
)->force_start
))
1506 XWINDOW (selected_window
)->force_start
= Qnil
;
1507 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1508 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1511 cmd
= read_key_sequence_cmd
;
1512 if (!NILP (Vexecuting_macro
))
1514 if (!NILP (Vquit_flag
))
1516 Vexecuting_macro
= Qt
;
1517 QUIT
; /* Make some noise. */
1518 /* Will return since macro now empty. */
1522 /* Do redisplay processing after this command except in special
1523 cases identified below. */
1524 prev_buffer
= current_buffer
;
1525 prev_modiff
= MODIFF
;
1526 last_point_position
= PT
;
1527 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1529 /* By default, we adjust point to a boundary of a region that
1530 has such a property that should be treated intangible
1531 (e.g. composition, display). But, some commands will set
1532 this variable differently. */
1533 Vdisable_point_adjustment
= Qnil
;
1535 /* Process filters and timers may have messed with deactivate-mark.
1536 reset it before we execute the command. */
1537 Vdeactivate_mark
= Qnil
;
1539 /* Remap command through active keymaps */
1540 Vthis_original_command
= cmd
;
1544 if (cmd1
= Fremap_command (cmd
), !NILP (cmd1
))
1548 /* Execute the command. */
1550 Vthis_command
= cmd
;
1551 real_this_command
= cmd
;
1552 /* Note that the value cell will never directly contain nil
1553 if the symbol is a local variable. */
1554 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1555 safe_run_hooks (Qpre_command_hook
);
1557 if (NILP (Vthis_command
))
1559 /* nil means key is undefined. */
1561 current_kboard
->defining_kbd_macro
= Qnil
;
1562 update_mode_lines
= 1;
1563 current_kboard
->Vprefix_arg
= Qnil
;
1567 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1569 /* In case we jump to directly_done. */
1570 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1572 /* Recognize some common commands in common situations and
1573 do them directly. */
1574 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1576 struct Lisp_Char_Table
*dp
1577 = window_display_table (XWINDOW (selected_window
));
1578 lose
= FETCH_CHAR (PT_BYTE
);
1581 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1582 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1583 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1584 && (lose
>= 0x20 && lose
< 0x7f)))
1585 : (lose
>= 0x20 && lose
< 0x7f))
1586 /* To extract the case of continuation on
1587 wide-column characters. */
1588 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1589 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1591 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1593 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1595 && !windows_or_buffers_changed
1596 && EQ (current_buffer
->selective_display
, Qnil
)
1597 && !detect_input_pending ()
1598 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1599 && NILP (Vexecuting_macro
))
1600 direct_output_forward_char (1);
1603 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1605 struct Lisp_Char_Table
*dp
1606 = window_display_table (XWINDOW (selected_window
));
1608 lose
= FETCH_CHAR (PT_BYTE
);
1610 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1611 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1612 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1613 && (lose
>= 0x20 && lose
< 0x7f)))
1614 : (lose
>= 0x20 && lose
< 0x7f))
1615 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1617 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1619 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1621 && !windows_or_buffers_changed
1622 && EQ (current_buffer
->selective_display
, Qnil
)
1623 && !detect_input_pending ()
1624 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1625 && NILP (Vexecuting_macro
))
1626 direct_output_forward_char (-1);
1629 else if (EQ (Vthis_command
, Qself_insert_command
)
1630 /* Try this optimization only on ascii keystrokes. */
1631 && INTEGERP (last_command_char
))
1633 unsigned int c
= XINT (last_command_char
);
1635 if (NILP (Vexecuting_macro
)
1636 && !EQ (minibuf_window
, selected_window
))
1638 if (!nonundocount
|| nonundocount
>= 20)
1646 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1648 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1650 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1652 || MODIFF
<= SAVE_MODIFF
1653 || windows_or_buffers_changed
1654 || !EQ (current_buffer
->selective_display
, Qnil
)
1655 || detect_input_pending ()
1656 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1657 || !NILP (Vexecuting_macro
));
1659 value
= internal_self_insert (c
, 0);
1664 /* VALUE == 1 when AFTER-CHANGE functions are
1665 installed which is the case most of the time
1666 because FONT-LOCK installs one. */
1667 if (!lose
&& !value
)
1668 direct_output_for_insert (c
);
1673 /* Here for a command that isn't executed directly */
1675 #ifdef HAVE_X_WINDOWS
1676 if (display_hourglass_p
1677 && NILP (Vexecuting_macro
))
1682 if (NILP (current_kboard
->Vprefix_arg
))
1684 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1686 #ifdef HAVE_X_WINDOWS
1687 /* Do not check display_hourglass_p here, because
1688 Fcommand_execute could change it, but we should cancel
1689 hourglass cursor anyway.
1690 But don't cancel the hourglass within a macro
1691 just because a command in the macro finishes. */
1692 if (NILP (Vexecuting_macro
))
1693 cancel_hourglass ();
1697 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1699 /* Note that the value cell will never directly contain nil
1700 if the symbol is a local variable. */
1701 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1702 safe_run_hooks (Qpost_command_hook
);
1704 /* If displaying a message, resize the echo area window to fit
1705 that message's size exactly. */
1706 if (!NILP (echo_area_buffer
[0]))
1707 resize_echo_area_exactly ();
1709 if (!NILP (Vdeferred_action_list
))
1710 safe_run_hooks (Qdeferred_action_function
);
1712 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1714 if (NILP (Vunread_command_events
)
1715 && NILP (Vunread_input_method_events
)
1716 && NILP (Vunread_post_input_method_events
)
1717 && NILP (Vexecuting_macro
)
1718 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1719 safe_run_hooks (Qpost_command_idle_hook
);
1722 /* If there is a prefix argument,
1723 1) We don't want Vlast_command to be ``universal-argument''
1724 (that would be dumb), so don't set Vlast_command,
1725 2) we want to leave echoing on so that the prefix will be
1726 echoed as part of this key sequence, so don't call
1728 3) we want to leave this_command_key_count non-zero, so that
1729 read_char will realize that it is re-reading a character, and
1730 not echo it a second time.
1732 If the command didn't actually create a prefix arg,
1733 but is merely a frame event that is transparent to prefix args,
1734 then the above doesn't apply. */
1735 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1737 current_kboard
->Vlast_command
= Vthis_command
;
1738 current_kboard
->Vreal_last_command
= real_this_command
;
1740 this_command_key_count
= 0;
1741 this_single_command_key_start
= 0;
1744 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1746 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1748 /* We could also call `deactivate'mark'. */
1749 if (EQ (Vtransient_mark_mode
, Qlambda
))
1750 Vtransient_mark_mode
= Qnil
;
1753 current_buffer
->mark_active
= Qnil
;
1754 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1757 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1758 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1763 if (current_buffer
== prev_buffer
1764 && last_point_position
!= PT
1765 && NILP (Vdisable_point_adjustment
)
1766 && NILP (Vglobal_disable_point_adjustment
))
1767 adjust_point_for_property (last_point_position
);
1769 /* Install chars successfully executed in kbd macro. */
1771 if (!NILP (current_kboard
->defining_kbd_macro
)
1772 && NILP (current_kboard
->Vprefix_arg
))
1773 finalize_kbd_macro_chars ();
1777 any_kboard_state ();
1782 extern Lisp_Object Qcomposition
, Qdisplay
;
1784 /* Adjust point to a boundary of a region that has such a property
1785 that should be treated intangible. For the moment, we check
1786 `composition' and `display' property. LAST_PT is the last position
1790 adjust_point_for_property (last_pt
)
1795 int check_composition
= 1, check_display
= 1;
1797 while (check_composition
|| check_display
)
1799 if (check_composition
1800 && PT
> BEGV
&& PT
< ZV
1801 && get_property_and_range (PT
, Qcomposition
, &val
, &start
, &end
, Qnil
)
1802 && COMPOSITION_VALID_P (start
, end
, val
)
1803 && start
< PT
&& end
> PT
1804 && (last_pt
<= start
|| last_pt
>= end
))
1812 check_composition
= 0;
1814 && PT
> BEGV
&& PT
< ZV
1815 && get_property_and_range (PT
, Qdisplay
, &val
, &start
, &end
, Qnil
)
1816 && display_prop_intangible_p (val
)
1817 && start
< PT
&& end
> PT
1818 && (last_pt
<= start
|| last_pt
>= end
))
1824 check_composition
= 1;
1830 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1833 safe_run_hooks_1 (hook
)
1836 return call1 (Vrun_hooks
, Vinhibit_quit
);
1839 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1842 safe_run_hooks_error (data
)
1845 return Fset (Vinhibit_quit
, Qnil
);
1848 /* If we get an error while running the hook, cause the hook variable
1849 to be nil. Also inhibit quits, so that C-g won't cause the hook
1850 to mysteriously evaporate. */
1853 safe_run_hooks (hook
)
1856 int count
= SPECPDL_INDEX ();
1857 specbind (Qinhibit_quit
, hook
);
1859 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1861 unbind_to (count
, Qnil
);
1865 /* Number of seconds between polling for input. This is a Lisp
1866 variable that can be bound. */
1868 EMACS_INT polling_period
;
1870 /* Nonzero means polling for input is temporarily suppressed. */
1872 int poll_suppress_count
;
1874 /* Asynchronous timer for polling. */
1876 struct atimer
*poll_timer
;
1879 #ifdef POLL_FOR_INPUT
1881 /* Poll for input, so what we catch a C-g if it comes in. This
1882 function is called from x_make_frame_visible, see comment
1888 if (interrupt_input_blocked
== 0
1889 && !waiting_for_input
)
1890 read_avail_input (0);
1893 /* Timer callback function for poll_timer. TIMER is equal to
1897 poll_for_input (timer
)
1898 struct atimer
*timer
;
1900 if (poll_suppress_count
== 0)
1901 poll_for_input_1 ();
1904 #endif /* POLL_FOR_INPUT */
1906 /* Begin signals to poll for input, if they are appropriate.
1907 This function is called unconditionally from various places. */
1912 #ifdef POLL_FOR_INPUT
1913 if (read_socket_hook
&& !interrupt_input
)
1915 /* Turn alarm handling on unconditionally. It might have
1916 been turned off in process.c. */
1917 turn_on_atimers (1);
1919 /* If poll timer doesn't exist, are we need one with
1920 a different interval, start a new one. */
1921 if (poll_timer
== NULL
1922 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1924 EMACS_TIME interval
;
1927 cancel_atimer (poll_timer
);
1929 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1930 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1931 poll_for_input
, NULL
);
1934 /* Let the timer's callback function poll for input
1935 if this becomes zero. */
1936 --poll_suppress_count
;
1941 /* Nonzero if we are using polling to handle input asynchronously. */
1944 input_polling_used ()
1946 #ifdef POLL_FOR_INPUT
1947 return read_socket_hook
&& !interrupt_input
;
1953 /* Turn off polling. */
1958 #ifdef POLL_FOR_INPUT
1959 if (read_socket_hook
&& !interrupt_input
)
1960 ++poll_suppress_count
;
1964 /* Set the value of poll_suppress_count to COUNT
1965 and start or stop polling accordingly. */
1968 set_poll_suppress_count (count
)
1971 #ifdef POLL_FOR_INPUT
1972 if (count
== 0 && poll_suppress_count
!= 0)
1974 poll_suppress_count
= 1;
1977 else if (count
!= 0 && poll_suppress_count
== 0)
1981 poll_suppress_count
= count
;
1985 /* Bind polling_period to a value at least N.
1986 But don't decrease it. */
1989 bind_polling_period (n
)
1992 #ifdef POLL_FOR_INPUT
1993 int new = polling_period
;
1998 stop_other_atimers (poll_timer
);
2000 specbind (Qpolling_period
, make_number (new));
2001 /* Start a new alarm with the new period. */
2006 /* Apply the control modifier to CHARACTER. */
2012 /* Save the upper bits here. */
2013 int upper
= c
& ~0177;
2017 /* Everything in the columns containing the upper-case letters
2018 denotes a control character. */
2019 if (c
>= 0100 && c
< 0140)
2023 /* Set the shift modifier for a control char
2024 made from a shifted letter. But only for letters! */
2025 if (oc
>= 'A' && oc
<= 'Z')
2026 c
|= shift_modifier
;
2029 /* The lower-case letters denote control characters too. */
2030 else if (c
>= 'a' && c
<= 'z')
2033 /* Include the bits for control and shift
2034 only if the basic ASCII code can't indicate them. */
2038 /* Replace the high bits. */
2039 c
|= (upper
& ~ctrl_modifier
);
2044 /* Display help echo in the echo area.
2046 HELP a string means display that string, HELP nil means clear the
2047 help echo. If HELP is a function, call it with OBJECT and POS as
2048 arguments; the function should return a help string or nil for
2049 none. For all other types of HELP evaluate it to obtain a string.
2051 WINDOW is the window in which the help was generated, if any.
2052 It is nil if not in a window.
2054 If OBJECT is a buffer, POS is the position in the buffer where the
2055 `help-echo' text property was found.
2057 If OBJECT is an overlay, that overlay has a `help-echo' property,
2058 and POS is the position in the overlay's buffer under the mouse.
2060 If OBJECT is a string (an overlay string or a string displayed with
2061 the `display' property). POS is the position in that string under
2064 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2065 echo overwrites a keystroke echo currently displayed in the echo
2068 Note: this function may only be called with HELP nil or a string
2069 from X code running asynchronously. */
2072 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2073 Lisp_Object help
, window
, object
, pos
;
2074 int ok_to_overwrite_keystroke_echo
;
2076 if (!NILP (help
) && !STRINGP (help
))
2078 if (FUNCTIONP (help
))
2080 Lisp_Object args
[4];
2085 help
= safe_call (4, args
);
2088 help
= safe_eval (help
);
2090 if (!STRINGP (help
))
2094 if (STRINGP (help
) || NILP (help
))
2096 if (!NILP (Vshow_help_function
))
2097 call1 (Vshow_help_function
, help
);
2098 else if (/* Don't overwrite minibuffer contents. */
2099 !MINI_WINDOW_P (XWINDOW (selected_window
))
2100 /* Don't overwrite a keystroke echo. */
2101 && (NILP (echo_message_buffer
)
2102 || ok_to_overwrite_keystroke_echo
)
2103 /* Don't overwrite a prompt. */
2104 && !cursor_in_echo_area
)
2108 int count
= SPECPDL_INDEX ();
2110 if (!help_echo_showing_p
)
2111 Vpre_help_message
= current_message ();
2113 specbind (Qmessage_truncate_lines
, Qt
);
2114 message3_nolog (help
, SBYTES (help
),
2115 STRING_MULTIBYTE (help
));
2116 unbind_to (count
, Qnil
);
2118 else if (STRINGP (Vpre_help_message
))
2120 message3_nolog (Vpre_help_message
,
2121 SBYTES (Vpre_help_message
),
2122 STRING_MULTIBYTE (Vpre_help_message
));
2123 Vpre_help_message
= Qnil
;
2129 help_echo_showing_p
= STRINGP (help
);
2135 /* Input of single characters from keyboard */
2137 Lisp_Object
print_help ();
2138 static Lisp_Object
kbd_buffer_get_event ();
2139 static void record_char ();
2142 static jmp_buf wrong_kboard_jmpbuf
;
2145 /* read a character from the keyboard; call the redisplay if needed */
2146 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2147 -1 means do not do redisplay, but do do autosaving.
2150 /* The arguments MAPS and NMAPS are for menu prompting.
2151 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2153 PREV_EVENT is the previous input event, or nil if we are reading
2154 the first event of a key sequence (or not reading a key sequence).
2155 If PREV_EVENT is t, that is a "magic" value that says
2156 not to run input methods, but in other respects to act as if
2157 not reading a key sequence.
2159 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2160 if we used a mouse menu to read the input, or zero otherwise. If
2161 USED_MOUSE_MENU is null, we don't dereference it.
2163 Value is t if we showed a menu and the user rejected it. */
2166 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2170 Lisp_Object prev_event
;
2171 int *used_mouse_menu
;
2173 volatile Lisp_Object c
;
2175 jmp_buf local_getcjmp
;
2177 volatile int key_already_recorded
= 0;
2178 Lisp_Object tem
, save
;
2179 volatile Lisp_Object previous_echo_area_message
;
2180 volatile Lisp_Object also_record
;
2181 volatile int reread
;
2182 struct gcpro gcpro1
, gcpro2
;
2183 EMACS_TIME last_idle_start
;
2187 before_command_key_count
= this_command_key_count
;
2188 before_command_echo_length
= echo_length ();
2190 previous_echo_area_message
= Qnil
;
2192 GCPRO2 (c
, previous_echo_area_message
);
2197 if (CONSP (Vunread_post_input_method_events
))
2199 c
= XCAR (Vunread_post_input_method_events
);
2200 Vunread_post_input_method_events
2201 = XCDR (Vunread_post_input_method_events
);
2203 /* Undo what read_char_x_menu_prompt did when it unread
2204 additional keys returned by Fx_popup_menu. */
2206 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2214 if (unread_command_char
!= -1)
2216 XSETINT (c
, unread_command_char
);
2217 unread_command_char
= -1;
2223 if (CONSP (Vunread_command_events
))
2225 c
= XCAR (Vunread_command_events
);
2226 Vunread_command_events
= XCDR (Vunread_command_events
);
2228 /* Undo what read_char_x_menu_prompt did when it unread
2229 additional keys returned by Fx_popup_menu. */
2231 && EQ (XCDR (c
), Qdisabled
)
2232 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2235 /* If the queued event is something that used the mouse,
2236 set used_mouse_menu accordingly. */
2238 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2239 *used_mouse_menu
= 1;
2242 goto reread_for_input_method
;
2245 if (CONSP (Vunread_input_method_events
))
2247 c
= XCAR (Vunread_input_method_events
);
2248 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2250 /* Undo what read_char_x_menu_prompt did when it unread
2251 additional keys returned by Fx_popup_menu. */
2253 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2257 goto reread_for_input_method
;
2260 /* If there is no function key translated before
2261 reset-this-command-lengths takes effect, forget about it. */
2262 before_command_restore_flag
= 0;
2264 if (!NILP (Vexecuting_macro
))
2266 /* We set this to Qmacro; since that's not a frame, nobody will
2267 try to switch frames on us, and the selected window will
2270 Since this event came from a macro, it would be misleading to
2271 leave internal_last_event_frame set to wherever the last
2272 real event came from. Normally, a switch-frame event selects
2273 internal_last_event_frame after each command is read, but
2274 events read from a macro should never cause a new frame to be
2276 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2278 /* Exit the macro if we are at the end.
2279 Also, some things replace the macro with t
2280 to force an early exit. */
2281 if (EQ (Vexecuting_macro
, Qt
)
2282 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2288 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2289 if (STRINGP (Vexecuting_macro
)
2290 && (XINT (c
) & 0x80))
2291 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2293 executing_macro_index
++;
2298 if (!NILP (unread_switch_frame
))
2300 c
= unread_switch_frame
;
2301 unread_switch_frame
= Qnil
;
2303 /* This event should make it into this_command_keys, and get echoed
2304 again, so we do not set `reread'. */
2308 /* if redisplay was requested */
2309 if (commandflag
>= 0)
2311 /* If there is pending input, process any events which are not
2312 user-visible, such as X selection_request events. */
2314 || detect_input_pending_run_timers (0))
2315 swallow_events (0); /* may clear input_pending */
2317 /* Redisplay if no pending input. */
2318 while (!input_pending
)
2320 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2321 redisplay_preserve_echo_area (5);
2326 /* Normal case: no input arrived during redisplay. */
2329 /* Input arrived and pre-empted redisplay.
2330 Process any events which are not user-visible. */
2332 /* If that cleared input_pending, try again to redisplay. */
2336 /* Message turns off echoing unless more keystrokes turn it on again.
2338 The code in 20.x for the condition was
2340 1. echo_area_glyphs && *echo_area_glyphs
2341 2. && echo_area_glyphs != current_kboard->echobuf
2342 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2344 (1) means there's a current message displayed
2346 (2) means it's not the message from echoing from the current
2349 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2350 is set to a non-null value. This is done in read_char and it is
2351 set to echo_area_glyphs after a call to echo_char. That means
2352 ok_to_echo_at_next_pause is either null or
2353 current_kboard->echobuf with the appropriate current_kboard at
2356 So, condition (3) means in clear text ok_to_echo_at_next_pause
2357 must be either null, or the current message isn't from echoing at
2358 all, or it's from echoing from a different kboard than the
2361 if (/* There currently is something in the echo area. */
2362 !NILP (echo_area_buffer
[0])
2363 && (/* And it's either not from echoing. */
2364 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2365 /* Or it's an echo from a different kboard. */
2366 || echo_kboard
!= current_kboard
2367 /* Or we explicitly allow overwriting whatever there is. */
2368 || ok_to_echo_at_next_pause
== NULL
))
2373 /* Try reading a character via menu prompting in the minibuf.
2374 Try this before the sit-for, because the sit-for
2375 would do the wrong thing if we are supposed to do
2376 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2377 after a mouse event so don't try a minibuf menu. */
2379 if (nmaps
> 0 && INTERACTIVE
2380 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2381 /* Don't bring up a menu if we already have another event. */
2382 && NILP (Vunread_command_events
)
2383 && unread_command_char
< 0
2384 && !detect_input_pending_run_timers (0))
2386 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2389 key_already_recorded
= 1;
2394 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2395 We will do that below, temporarily for short sections of code,
2396 when appropriate. local_getcjmp must be in effect
2397 around any call to sit_for or kbd_buffer_get_event;
2398 it *must not* be in effect when we call redisplay. */
2400 if (_setjmp (local_getcjmp
))
2402 XSETINT (c
, quit_char
);
2403 internal_last_event_frame
= selected_frame
;
2404 Vlast_event_frame
= internal_last_event_frame
;
2405 /* If we report the quit char as an event,
2406 don't do so more than once. */
2407 if (!NILP (Vinhibit_quit
))
2412 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2413 if (kb
!= current_kboard
)
2415 Lisp_Object link
= kb
->kbd_queue
;
2416 /* We shouldn't get here if we were in single-kboard mode! */
2421 while (CONSP (XCDR (link
)))
2423 if (!NILP (XCDR (link
)))
2427 kb
->kbd_queue
= Fcons (c
, Qnil
);
2429 XSETCDR (link
, Fcons (c
, Qnil
));
2430 kb
->kbd_queue_has_data
= 1;
2431 current_kboard
= kb
;
2432 /* This is going to exit from read_char
2433 so we had better get rid of this frame's stuff. */
2435 longjmp (wrong_kboard_jmpbuf
, 1);
2442 timer_start_idle ();
2444 /* If in middle of key sequence and minibuffer not active,
2445 start echoing if enough time elapses. */
2447 if (minibuf_level
== 0
2448 && !current_kboard
->immediate_echo
2449 && this_command_key_count
> 0
2451 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2452 && NILP (Fzerop (Vecho_keystrokes
))
2453 && (/* No message. */
2454 NILP (echo_area_buffer
[0])
2455 /* Or empty message. */
2456 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2457 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2458 /* Or already echoing from same kboard. */
2459 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2460 /* Or not echoing before and echoing allowed. */
2461 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2465 /* After a mouse event, start echoing right away.
2466 This is because we are probably about to display a menu,
2467 and we don't want to delay before doing so. */
2468 if (EVENT_HAS_PARAMETERS (prev_event
))
2473 double duration
= extract_float (Vecho_keystrokes
);
2474 sec
= (int) duration
;
2475 usec
= (duration
- sec
) * 1000000;
2476 save_getcjmp (save_jump
);
2477 restore_getcjmp (local_getcjmp
);
2478 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2479 restore_getcjmp (save_jump
);
2481 && ! CONSP (Vunread_command_events
))
2486 /* Maybe auto save due to number of keystrokes. */
2488 if (commandflag
!= 0
2489 && auto_save_interval
> 0
2490 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2491 && !detect_input_pending_run_timers (0))
2493 Fdo_auto_save (Qnil
, Qnil
);
2494 /* Hooks can actually change some buffers in auto save. */
2498 /* Try reading using an X menu.
2499 This is never confused with reading using the minibuf
2500 because the recursive call of read_char in read_char_minibuf_menu_prompt
2501 does not pass on any keymaps. */
2503 if (nmaps
> 0 && INTERACTIVE
2504 && !NILP (prev_event
)
2505 && EVENT_HAS_PARAMETERS (prev_event
)
2506 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2507 && !EQ (XCAR (prev_event
), Qtool_bar
)
2508 /* Don't bring up a menu if we already have another event. */
2509 && NILP (Vunread_command_events
)
2510 && unread_command_char
< 0)
2512 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2514 /* Now that we have read an event, Emacs is not idle. */
2520 /* Maybe autosave and/or garbage collect due to idleness. */
2522 if (INTERACTIVE
&& NILP (c
))
2524 int delay_level
, buffer_size
;
2526 /* Slow down auto saves logarithmically in size of current buffer,
2527 and garbage collect while we're at it. */
2528 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2529 last_non_minibuf_size
= Z
- BEG
;
2530 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2532 while (buffer_size
> 64)
2533 delay_level
++, buffer_size
-= buffer_size
>> 2;
2534 if (delay_level
< 4) delay_level
= 4;
2535 /* delay_level is 4 for files under around 50k, 7 at 100k,
2536 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2538 /* Auto save if enough time goes by without input. */
2539 if (commandflag
!= 0
2540 && num_nonmacro_input_events
> last_auto_save
2541 && INTEGERP (Vauto_save_timeout
)
2542 && XINT (Vauto_save_timeout
) > 0)
2546 save_getcjmp (save_jump
);
2547 restore_getcjmp (local_getcjmp
);
2548 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2550 restore_getcjmp (save_jump
);
2553 && ! CONSP (Vunread_command_events
))
2555 Fdo_auto_save (Qnil
, Qnil
);
2557 /* If we have auto-saved and there is still no input
2558 available, garbage collect if there has been enough
2559 consing going on to make it worthwhile. */
2560 if (!detect_input_pending_run_timers (0)
2561 && consing_since_gc
> gc_cons_threshold
/ 2)
2562 Fgarbage_collect ();
2569 /* If this has become non-nil here, it has been set by a timer
2570 or sentinel or filter. */
2571 if (CONSP (Vunread_command_events
))
2573 c
= XCAR (Vunread_command_events
);
2574 Vunread_command_events
= XCDR (Vunread_command_events
);
2577 /* Read something from current KBOARD's side queue, if possible. */
2581 if (current_kboard
->kbd_queue_has_data
)
2583 if (!CONSP (current_kboard
->kbd_queue
))
2585 c
= XCAR (current_kboard
->kbd_queue
);
2586 current_kboard
->kbd_queue
2587 = XCDR (current_kboard
->kbd_queue
);
2588 if (NILP (current_kboard
->kbd_queue
))
2589 current_kboard
->kbd_queue_has_data
= 0;
2590 input_pending
= readable_events (0);
2591 if (EVENT_HAS_PARAMETERS (c
)
2592 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2593 internal_last_event_frame
= XCAR (XCDR (c
));
2594 Vlast_event_frame
= internal_last_event_frame
;
2599 /* If current_kboard's side queue is empty check the other kboards.
2600 If one of them has data that we have not yet seen here,
2601 switch to it and process the data waiting for it.
2603 Note: if the events queued up for another kboard
2604 have already been seen here, and therefore are not a complete command,
2605 the kbd_queue_has_data field is 0, so we skip that kboard here.
2606 That's to avoid an infinite loop switching between kboards here. */
2607 if (NILP (c
) && !single_kboard
)
2610 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2611 if (kb
->kbd_queue_has_data
)
2613 current_kboard
= kb
;
2614 /* This is going to exit from read_char
2615 so we had better get rid of this frame's stuff. */
2617 longjmp (wrong_kboard_jmpbuf
, 1);
2626 /* Finally, we read from the main queue,
2627 and if that gives us something we can't use yet, we put it on the
2628 appropriate side queue and try again. */
2634 /* Actually read a character, waiting if necessary. */
2635 save_getcjmp (save_jump
);
2636 restore_getcjmp (local_getcjmp
);
2637 timer_start_idle ();
2638 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2639 restore_getcjmp (save_jump
);
2642 if (! NILP (c
) && (kb
!= current_kboard
))
2644 Lisp_Object link
= kb
->kbd_queue
;
2647 while (CONSP (XCDR (link
)))
2649 if (!NILP (XCDR (link
)))
2653 kb
->kbd_queue
= Fcons (c
, Qnil
);
2655 XSETCDR (link
, Fcons (c
, Qnil
));
2656 kb
->kbd_queue_has_data
= 1;
2660 current_kboard
= kb
;
2661 /* This is going to exit from read_char
2662 so we had better get rid of this frame's stuff. */
2664 longjmp (wrong_kboard_jmpbuf
, 1);
2669 /* Terminate Emacs in batch mode if at eof. */
2670 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2671 Fkill_emacs (make_number (1));
2675 /* Add in any extra modifiers, where appropriate. */
2676 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2677 || ((extra_keyboard_modifiers
& 0177) < ' '
2678 && (extra_keyboard_modifiers
& 0177) != 0))
2679 XSETINT (c
, make_ctrl_char (XINT (c
)));
2681 /* Transfer any other modifier bits directly from
2682 extra_keyboard_modifiers to c. Ignore the actual character code
2683 in the low 16 bits of extra_keyboard_modifiers. */
2684 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2689 /* Record the last idle start time so that we can reset it
2690 should the next event read be a help-echo. */
2691 last_idle_start
= timer_idleness_start_time
;
2697 if (commandflag
>= 0
2698 && !input_pending
&& !detect_input_pending_run_timers (0))
2706 /* Buffer switch events are only for internal wakeups
2707 so don't show them to the user.
2708 Also, don't record a key if we already did. */
2709 if (BUFFERP (c
) || key_already_recorded
)
2712 /* Process special events within read_char
2713 and loop around to read another event. */
2716 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2721 int was_locked
= single_kboard
;
2723 last_input_char
= c
;
2724 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2726 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2727 /* We stopped being idle for this event; undo that. This
2728 prevents automatic window selection (under
2729 mouse_autoselect_window from acting as a real input event, for
2730 example banishing the mouse under mouse-avoidance-mode. */
2731 timer_idleness_start_time
= last_idle_start
;
2733 /* Resume allowing input from any kboard, if that was true before. */
2735 any_kboard_state ();
2740 /* Handle things that only apply to characters. */
2743 /* If kbd_buffer_get_event gave us an EOF, return that. */
2747 if ((STRINGP (Vkeyboard_translate_table
)
2748 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2749 || (VECTORP (Vkeyboard_translate_table
)
2750 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2751 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2752 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2755 d
= Faref (Vkeyboard_translate_table
, c
);
2756 /* nil in keyboard-translate-table means no translation. */
2762 /* If this event is a mouse click in the menu bar,
2763 return just menu-bar for now. Modify the mouse click event
2764 so we won't do this twice, then queue it up. */
2765 if (EVENT_HAS_PARAMETERS (c
)
2767 && CONSP (EVENT_START (c
))
2768 && CONSP (XCDR (EVENT_START (c
))))
2772 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2773 /* Handle menu-bar events:
2774 insert the dummy prefix event `menu-bar'. */
2775 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2777 /* Change menu-bar to (menu-bar) as the event "position". */
2778 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2781 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2786 /* Store these characters into recent_keys, the dribble file if any,
2787 and the keyboard macro being defined, if any. */
2789 if (! NILP (also_record
))
2790 record_char (also_record
);
2792 /* Wipe the echo area.
2793 But first, if we are about to use an input method,
2794 save the echo area contents for it to refer to. */
2796 && ! NILP (Vinput_method_function
)
2797 && (unsigned) XINT (c
) >= ' '
2798 && (unsigned) XINT (c
) != 127
2799 && (unsigned) XINT (c
) < 256)
2801 previous_echo_area_message
= Fcurrent_message ();
2802 Vinput_method_previous_message
= previous_echo_area_message
;
2805 /* Now wipe the echo area, except for help events which do their
2806 own stuff with the echo area. */
2808 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2809 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2811 if (!NILP (echo_area_buffer
[0]))
2812 safe_run_hooks (Qecho_area_clear_hook
);
2813 clear_message (1, 0);
2816 reread_for_input_method
:
2818 /* Pass this to the input method, if appropriate. */
2820 && ! NILP (Vinput_method_function
)
2821 /* Don't run the input method within a key sequence,
2822 after the first event of the key sequence. */
2823 && NILP (prev_event
)
2824 && (unsigned) XINT (c
) >= ' '
2825 && (unsigned) XINT (c
) != 127
2826 && (unsigned) XINT (c
) < 256)
2830 struct gcpro gcpro1
;
2831 int count
= SPECPDL_INDEX ();
2833 /* Save the echo status. */
2834 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2835 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2836 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2838 if (before_command_restore_flag
)
2840 this_command_key_count
= before_command_key_count_1
;
2841 if (this_command_key_count
< this_single_command_key_start
)
2842 this_single_command_key_start
= this_command_key_count
;
2843 echo_truncate (before_command_echo_length_1
);
2844 before_command_restore_flag
= 0;
2847 /* Save the this_command_keys status. */
2848 key_count
= this_command_key_count
;
2851 keys
= Fcopy_sequence (this_command_keys
);
2856 /* Clear out this_command_keys. */
2857 this_command_key_count
= 0;
2859 /* Now wipe the echo area. */
2860 if (!NILP (echo_area_buffer
[0]))
2861 safe_run_hooks (Qecho_area_clear_hook
);
2862 clear_message (1, 0);
2865 /* If we are not reading a key sequence,
2866 never use the echo area. */
2869 specbind (Qinput_method_use_echo_area
, Qt
);
2872 /* Call the input method. */
2873 tem
= call1 (Vinput_method_function
, c
);
2875 tem
= unbind_to (count
, tem
);
2877 /* Restore the saved echoing state
2878 and this_command_keys state. */
2879 this_command_key_count
= key_count
;
2881 this_command_keys
= keys
;
2884 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2885 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2886 if (saved_immediate_echo
)
2891 /* The input method can return no events. */
2894 /* Bring back the previous message, if any. */
2895 if (! NILP (previous_echo_area_message
))
2896 message_with_string ("%s", previous_echo_area_message
, 0);
2899 /* It returned one event or more. */
2901 Vunread_post_input_method_events
2902 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2907 /* Display help if not echoing. */
2908 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2910 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
2911 Lisp_Object help
, object
, position
, window
, tem
;
2913 tem
= Fcdr (XCDR (c
));
2916 window
= Fcar (tem
);
2918 object
= Fcar (tem
);
2920 position
= Fcar (tem
);
2922 show_help_echo (help
, window
, object
, position
, 0);
2924 /* We stopped being idle for this event; undo that. */
2925 timer_idleness_start_time
= last_idle_start
;
2929 if (this_command_key_count
== 0 || ! reread
)
2931 before_command_key_count
= this_command_key_count
;
2932 before_command_echo_length
= echo_length ();
2934 /* Don't echo mouse motion events. */
2935 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2936 && NILP (Fzerop (Vecho_keystrokes
))
2937 && ! (EVENT_HAS_PARAMETERS (c
)
2938 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2941 if (! NILP (also_record
))
2942 echo_char (also_record
);
2943 /* Once we reread a character, echoing can happen
2944 the next time we pause to read a new one. */
2945 ok_to_echo_at_next_pause
= current_kboard
;
2948 /* Record this character as part of the current key. */
2949 add_command_key (c
);
2950 if (! NILP (also_record
))
2951 add_command_key (also_record
);
2954 last_input_char
= c
;
2957 /* Process the help character specially if enabled */
2958 if (!NILP (Vhelp_form
) && help_char_p (c
))
2961 count
= SPECPDL_INDEX ();
2963 record_unwind_protect (Fset_window_configuration
,
2964 Fcurrent_window_configuration (Qnil
));
2966 tem0
= Feval (Vhelp_form
);
2968 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2972 c
= read_char (0, 0, 0, Qnil
, 0);
2973 while (BUFFERP (c
));
2974 /* Remove the help from the frame */
2975 unbind_to (count
, Qnil
);
2978 if (EQ (c
, make_number (040)))
2982 c
= read_char (0, 0, 0, Qnil
, 0);
2983 while (BUFFERP (c
));
2990 /* Record a key that came from a mouse menu.
2991 Record it for echoing, for this-command-keys, and so on. */
2997 /* Wipe the echo area. */
2998 clear_message (1, 0);
3002 before_command_key_count
= this_command_key_count
;
3003 before_command_echo_length
= echo_length ();
3005 /* Don't echo mouse motion events. */
3006 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3007 && NILP (Fzerop (Vecho_keystrokes
)))
3011 /* Once we reread a character, echoing can happen
3012 the next time we pause to read a new one. */
3013 ok_to_echo_at_next_pause
= 0;
3016 /* Record this character as part of the current key. */
3017 add_command_key (c
);
3019 /* Re-reading in the middle of a command */
3020 last_input_char
= c
;
3024 /* Return 1 if should recognize C as "the help character". */
3032 if (EQ (c
, Vhelp_char
))
3034 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3035 if (EQ (c
, XCAR (tail
)))
3040 /* Record the input event C in various ways. */
3048 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3050 /* To avoid filling recent_keys with help-echo and mouse-movement
3051 events, we filter out repeated help-echo events, only store the
3052 first and last in a series of mouse-movement events, and don't
3053 store repeated help-echo events which are only separated by
3054 mouse-movement events. */
3056 Lisp_Object ev1
, ev2
, ev3
;
3059 if ((ix1
= recent_keys_index
- 1) < 0)
3060 ix1
= NUM_RECENT_KEYS
- 1;
3061 ev1
= AREF (recent_keys
, ix1
);
3063 if ((ix2
= ix1
- 1) < 0)
3064 ix2
= NUM_RECENT_KEYS
- 1;
3065 ev2
= AREF (recent_keys
, ix2
);
3067 if ((ix3
= ix2
- 1) < 0)
3068 ix3
= NUM_RECENT_KEYS
- 1;
3069 ev3
= AREF (recent_keys
, ix3
);
3071 if (EQ (XCAR (c
), Qhelp_echo
))
3073 /* Don't record `help-echo' in recent_keys unless it shows some help
3074 message, and a different help than the previously recorded
3076 Lisp_Object help
, last_help
;
3078 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3079 if (!STRINGP (help
))
3081 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3082 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3084 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3085 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3086 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3088 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3089 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3090 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3091 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3094 else if (EQ (XCAR (c
), Qmouse_movement
))
3096 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3097 So additional mouse movement events replace the last element. */
3098 Lisp_Object last_window
, window
;
3100 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3101 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3102 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3103 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3104 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3106 ASET (recent_keys
, ix1
, c
);
3112 store_kbd_macro_char (c
);
3117 ASET (recent_keys
, recent_keys_index
, c
);
3118 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3119 recent_keys_index
= 0;
3121 else if (recorded
< 0)
3123 /* We need to remove one or two events from recent_keys.
3124 To do this, we simply put nil at those events and move the
3125 recent_keys_index backwards over those events. Usually,
3126 users will never see those nil events, as they will be
3127 overwritten by the command keys entered to see recent_keys
3130 while (recorded
++ < 0 && total_keys
> 0)
3132 if (total_keys
< NUM_RECENT_KEYS
)
3134 if (--recent_keys_index
< 0)
3135 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3136 ASET (recent_keys
, recent_keys_index
, Qnil
);
3140 num_nonmacro_input_events
++;
3142 /* Write c to the dribble file. If c is a lispy event, write
3143 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3144 If you, dear reader, have a better idea, you've got the source. :-) */
3149 if (XUINT (c
) < 0x100)
3150 putc (XINT (c
), dribble
);
3152 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3156 Lisp_Object dribblee
;
3158 /* If it's a structured event, take the event header. */
3159 dribblee
= EVENT_HEAD (c
);
3161 if (SYMBOLP (dribblee
))
3163 putc ('<', dribble
);
3164 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3165 SBYTES (SYMBOL_NAME (dribblee
)),
3167 putc ('>', dribble
);
3179 struct buffer
*old
= current_buffer
;
3180 Fprinc (object
, Qnil
);
3181 set_buffer_internal (XBUFFER (Vstandard_output
));
3182 call0 (intern ("help-mode"));
3183 set_buffer_internal (old
);
3187 /* Copy out or in the info on where C-g should throw to.
3188 This is used when running Lisp code from within get_char,
3189 in case get_char is called recursively.
3190 See read_process_output. */
3196 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3200 restore_getcjmp (temp
)
3203 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3208 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3209 of this function. */
3212 tracking_off (old_value
)
3213 Lisp_Object old_value
;
3215 do_mouse_tracking
= old_value
;
3216 if (NILP (old_value
))
3218 /* Redisplay may have been preempted because there was input
3219 available, and it assumes it will be called again after the
3220 input has been processed. If the only input available was
3221 the sort that we have just disabled, then we need to call
3223 if (!readable_events (1))
3225 redisplay_preserve_echo_area (6);
3226 get_input_pending (&input_pending
, 1);
3232 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3233 doc
: /* Evaluate BODY with mouse movement events enabled.
3234 Within a `track-mouse' form, mouse motion generates input events that
3235 you can read with `read-event'.
3236 Normally, mouse motion is ignored.
3237 usage: (track-mouse BODY ...) */)
3241 int count
= SPECPDL_INDEX ();
3244 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3246 do_mouse_tracking
= Qt
;
3248 val
= Fprogn (args
);
3249 return unbind_to (count
, val
);
3252 /* If mouse has moved on some frame, return one of those frames.
3253 Return 0 otherwise. */
3258 Lisp_Object tail
, frame
;
3260 FOR_EACH_FRAME (tail
, frame
)
3262 if (XFRAME (frame
)->mouse_moved
)
3263 return XFRAME (frame
);
3269 #endif /* HAVE_MOUSE */
3271 /* Low level keyboard/mouse input.
3272 kbd_buffer_store_event places events in kbd_buffer, and
3273 kbd_buffer_get_event retrieves them. */
3275 /* Return true iff there are any events in the queue that read-char
3276 would return. If this returns false, a read-char would block. */
3278 readable_filtered_events (do_timers_now
, filter_events
)
3283 timer_check (do_timers_now
);
3285 /* If the buffer contains only FOCUS_IN_EVENT events,
3286 and FILTER_EVENTS is nonzero, report it as empty. */
3287 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3289 int have_live_event
= 1;
3293 struct input_event
*event
;
3295 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3299 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3302 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3304 if (event
== kbd_store_ptr
)
3305 have_live_event
= 0;
3308 if (have_live_event
) return 1;
3312 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3317 if (current_kboard
->kbd_queue_has_data
)
3323 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3324 if (kb
->kbd_queue_has_data
)
3330 /* Return true iff there are any events in the queue that read-char
3331 would return. If this returns false, a read-char would block. */
3333 readable_events (do_timers_now
)
3336 return readable_filtered_events (do_timers_now
, 0);
3339 /* Set this for debugging, to have a way to get out */
3344 event_to_kboard (event
)
3345 struct input_event
*event
;
3348 frame
= event
->frame_or_window
;
3350 frame
= XCAR (frame
);
3351 else if (WINDOWP (frame
))
3352 frame
= WINDOW_FRAME (XWINDOW (frame
));
3354 /* There are still some events that don't set this field.
3355 For now, just ignore the problem.
3356 Also ignore dead frames here. */
3357 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3360 return FRAME_KBOARD (XFRAME (frame
));
3364 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3367 kbd_buffer_store_event (event
)
3368 register struct input_event
*event
;
3370 if (event
->kind
== NO_EVENT
)
3373 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3375 register int c
= event
->code
& 0377;
3377 if (event
->modifiers
& ctrl_modifier
)
3378 c
= make_ctrl_char (c
);
3380 c
|= (event
->modifiers
3381 & (meta_modifier
| alt_modifier
3382 | hyper_modifier
| super_modifier
));
3386 static SIGTYPE interrupt_signal
P_ ((int));
3389 struct input_event
*sp
;
3392 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3393 kb
!= current_kboard
))
3396 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3397 Fcons (make_number (c
), Qnil
));
3398 kb
->kbd_queue_has_data
= 1;
3399 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3401 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3404 if (event_to_kboard (sp
) == kb
)
3406 sp
->kind
= NO_EVENT
;
3407 sp
->frame_or_window
= Qnil
;
3415 /* If this results in a quit_char being returned to Emacs as
3416 input, set Vlast_event_frame properly. If this doesn't
3417 get returned to Emacs as an event, the next event read
3418 will set Vlast_event_frame again, so this is safe to do. */
3422 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3424 focus
= event
->frame_or_window
;
3425 internal_last_event_frame
= focus
;
3426 Vlast_event_frame
= focus
;
3429 last_event_timestamp
= event
->timestamp
;
3430 interrupt_signal (0 /* dummy */);
3434 if (c
&& c
== stop_character
)
3440 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3441 Just ignore the second one. */
3442 else if (event
->kind
== BUFFER_SWITCH_EVENT
3443 && kbd_fetch_ptr
!= kbd_store_ptr
3444 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3447 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3448 kbd_store_ptr
= kbd_buffer
;
3450 /* Don't let the very last slot in the buffer become full,
3451 since that would make the two pointers equal,
3452 and that is indistinguishable from an empty buffer.
3453 Discard the event if it would fill the last slot. */
3454 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3458 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3459 prone to assign individual members for other events, in case
3460 the input_event structure is changed. --2000-07-13, gerd. */
3461 struct input_event
*sp
= kbd_store_ptr
;
3462 sp
->kind
= event
->kind
;
3463 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3465 /* We must not use the ordinary copying code for this case,
3466 since `part' is an enum and copying it might not copy enough
3468 bcopy (event
, (char *) sp
, sizeof (*event
));
3473 sp
->code
= event
->code
;
3474 sp
->part
= event
->part
;
3475 sp
->frame_or_window
= event
->frame_or_window
;
3476 sp
->arg
= event
->arg
;
3477 sp
->modifiers
= event
->modifiers
;
3480 sp
->timestamp
= event
->timestamp
;
3483 *kbd_store_ptr
= *event
;
3486 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3487 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3488 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3494 /* Generate HELP_EVENT input_events in BUFP which has room for
3495 SIZE events. If there's not enough room in BUFP, ignore this
3498 HELP is the help form.
3500 FRAME is the frame on which the help is generated. OBJECT is the
3501 Lisp object where the help was found (a buffer, a string, an
3502 overlay, or nil if neither from a string nor from a buffer. POS is
3503 the position within OBJECT where the help was found.
3505 Value is the number of input_events generated. */
3508 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3509 struct input_event
*bufp
;
3511 Lisp_Object help
, frame
, object
, window
;
3516 bufp
->kind
= HELP_EVENT
;
3517 bufp
->frame_or_window
= frame
;
3519 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3528 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3531 kbd_buffer_store_help_event (frame
, help
)
3532 Lisp_Object frame
, help
;
3534 struct input_event event
;
3536 event
.kind
= HELP_EVENT
;
3537 event
.frame_or_window
= frame
;
3542 kbd_buffer_store_event (&event
);
3546 /* Discard any mouse events in the event buffer by setting them to
3549 discard_mouse_events ()
3551 struct input_event
*sp
;
3552 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3554 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3557 if (sp
->kind
== MOUSE_CLICK_EVENT
3559 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3561 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3563 sp
->kind
= NO_EVENT
;
3569 /* Return non-zero if there are any real events waiting in the event
3570 buffer, not counting `NO_EVENT's.
3572 If DISCARD is non-zero, discard NO_EVENT events at the front of
3573 the input queue, possibly leaving the input queue empty if there
3574 are no real input events. */
3577 kbd_buffer_events_waiting (discard
)
3580 struct input_event
*sp
;
3582 for (sp
= kbd_fetch_ptr
;
3583 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3586 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3593 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3597 /* Clear input event EVENT. */
3601 struct input_event
*event
;
3603 int idx
= 2 * (event
- kbd_buffer
);
3604 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3605 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3606 event
->kind
= NO_EVENT
;
3610 /* Read one event from the event buffer, waiting if necessary.
3611 The value is a Lisp object representing the event.
3612 The value is nil for an event that should be ignored,
3613 or that was handled here.
3614 We always read and discard one event. */
3617 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3619 int *used_mouse_menu
;
3628 *kbp
= current_kboard
;
3632 /* Wait until there is input available. */
3635 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3638 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3642 /* If the quit flag is set, then read_char will return
3643 quit_char, so that counts as "available input." */
3644 if (!NILP (Vquit_flag
))
3645 quit_throw_to_read_char ();
3647 /* One way or another, wait until input is available; then, if
3648 interrupt handlers have not read it, read it now. */
3651 wait_for_kbd_input ();
3653 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3657 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3660 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3664 Lisp_Object minus_one
;
3666 XSETINT (minus_one
, -1);
3667 wait_reading_process_input (0, 0, minus_one
, 1);
3669 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3670 /* Pass 1 for EXPECT since we just waited to have input. */
3671 read_avail_input (1);
3673 #endif /* not VMS */
3676 if (CONSP (Vunread_command_events
))
3679 first
= XCAR (Vunread_command_events
);
3680 Vunread_command_events
= XCDR (Vunread_command_events
);
3681 *kbp
= current_kboard
;
3685 /* At this point, we know that there is a readable event available
3686 somewhere. If the event queue is empty, then there must be a
3687 mouse movement enabled and available. */
3688 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3690 struct input_event
*event
;
3692 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3696 last_event_timestamp
= event
->timestamp
;
3699 *kbp
= event_to_kboard (event
);
3701 *kbp
= current_kboard
; /* Better than returning null ptr? */
3703 *kbp
= &the_only_kboard
;
3708 /* These two kinds of events get special handling
3709 and don't actually appear to the command loop.
3710 We return nil for them. */
3711 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3714 struct input_event copy
;
3716 /* Remove it from the buffer before processing it,
3717 since otherwise swallow_events will see it
3718 and process it again. */
3720 kbd_fetch_ptr
= event
+ 1;
3721 input_pending
= readable_events (0);
3722 x_handle_selection_request (©
);
3724 /* We're getting selection request events, but we don't have
3730 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3733 struct input_event copy
;
3735 /* Remove it from the buffer before processing it. */
3737 kbd_fetch_ptr
= event
+ 1;
3738 input_pending
= readable_events (0);
3739 x_handle_selection_clear (©
);
3741 /* We're getting selection request events, but we don't have
3746 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3747 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3749 /* Make an event (delete-frame (FRAME)). */
3750 obj
= Fcons (event
->frame_or_window
, Qnil
);
3751 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3752 kbd_fetch_ptr
= event
+ 1;
3755 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3756 else if (event
->kind
== ICONIFY_EVENT
)
3758 /* Make an event (iconify-frame (FRAME)). */
3759 obj
= Fcons (event
->frame_or_window
, Qnil
);
3760 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3761 kbd_fetch_ptr
= event
+ 1;
3763 else if (event
->kind
== DEICONIFY_EVENT
)
3765 /* Make an event (make-frame-visible (FRAME)). */
3766 obj
= Fcons (event
->frame_or_window
, Qnil
);
3767 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3768 kbd_fetch_ptr
= event
+ 1;
3771 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3773 /* The value doesn't matter here; only the type is tested. */
3774 XSETBUFFER (obj
, current_buffer
);
3775 kbd_fetch_ptr
= event
+ 1;
3777 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
3778 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3780 kbd_fetch_ptr
= event
+ 1;
3781 input_pending
= readable_events (0);
3782 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3783 x_activate_menubar (XFRAME (event
->frame_or_window
));
3787 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3789 /* Make an event (language-change (FRAME CHARSET LCID)). */
3790 obj
= Fcons (event
->modifiers
, Qnil
);
3791 obj
= Fcons (event
->code
, obj
);
3792 obj
= Fcons (event
->frame_or_window
, obj
);
3793 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3794 kbd_fetch_ptr
= event
+ 1;
3797 else if (event
->kind
== SAVE_SESSION_EVENT
)
3799 obj
= Fcons (Qsave_session
, Qnil
);
3800 kbd_fetch_ptr
= event
+ 1;
3802 /* Just discard these, by returning nil.
3803 With MULTI_KBOARD, these events are used as placeholders
3804 when we need to randomly delete events from the queue.
3805 (They shouldn't otherwise be found in the buffer,
3806 but on some machines it appears they do show up
3807 even without MULTI_KBOARD.) */
3808 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3809 mouse events during a popup-menu call. */
3810 else if (event
->kind
== NO_EVENT
)
3811 kbd_fetch_ptr
= event
+ 1;
3812 else if (event
->kind
== HELP_EVENT
)
3814 Lisp_Object object
, position
, help
, frame
, window
;
3816 frame
= event
->frame_or_window
;
3817 object
= event
->arg
;
3818 position
= make_number (event
->code
);
3821 clear_event (event
);
3823 kbd_fetch_ptr
= event
+ 1;
3824 if (!WINDOWP (window
))
3826 obj
= Fcons (Qhelp_echo
,
3827 list5 (frame
, help
, window
, object
, position
));
3829 else if (event
->kind
== FOCUS_IN_EVENT
)
3831 /* Notification of a FocusIn event. The frame receiving the
3832 focus is in event->frame_or_window. Generate a
3833 switch-frame event if necessary. */
3834 Lisp_Object frame
, focus
;
3836 frame
= event
->frame_or_window
;
3837 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3841 if (!EQ (frame
, internal_last_event_frame
)
3842 && !EQ (frame
, selected_frame
))
3843 obj
= make_lispy_switch_frame (frame
);
3844 internal_last_event_frame
= frame
;
3845 kbd_fetch_ptr
= event
+ 1;
3847 else if (event
->kind
== SELECT_WINDOW_EVENT
)
3849 /* Make an event (select-window (WINDOW)). */
3850 obj
= Fcons (event
->frame_or_window
, Qnil
);
3851 obj
= Fcons (Qselect_window
, Fcons (obj
, Qnil
));
3853 kbd_fetch_ptr
= event
+ 1;
3857 /* If this event is on a different frame, return a switch-frame this
3858 time, and leave the event in the queue for next time. */
3862 frame
= event
->frame_or_window
;
3864 frame
= XCAR (frame
);
3865 else if (WINDOWP (frame
))
3866 frame
= WINDOW_FRAME (XWINDOW (frame
));
3868 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3872 if (! EQ (frame
, internal_last_event_frame
)
3873 && !EQ (frame
, selected_frame
))
3874 obj
= make_lispy_switch_frame (frame
);
3875 internal_last_event_frame
= frame
;
3877 /* If we didn't decide to make a switch-frame event, go ahead
3878 and build a real event from the queue entry. */
3882 obj
= make_lispy_event (event
);
3884 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3885 /* If this was a menu selection, then set the flag to inhibit
3886 writing to last_nonmenu_event. Don't do this if the event
3887 we're returning is (menu-bar), though; that indicates the
3888 beginning of the menu sequence, and we might as well leave
3889 that as the `event with parameters' for this selection. */
3891 && !EQ (event
->frame_or_window
, event
->arg
)
3892 && (event
->kind
== MENU_BAR_EVENT
3893 || event
->kind
== TOOL_BAR_EVENT
))
3894 *used_mouse_menu
= 1;
3897 /* Wipe out this event, to catch bugs. */
3898 clear_event (event
);
3899 kbd_fetch_ptr
= event
+ 1;
3904 /* Try generating a mouse motion event. */
3905 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3907 FRAME_PTR f
= some_mouse_moved ();
3908 Lisp_Object bar_window
;
3909 enum scroll_bar_part part
;
3913 *kbp
= current_kboard
;
3914 /* Note that this uses F to determine which display to look at.
3915 If there is no valid info, it does not store anything
3916 so x remains nil. */
3918 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3922 /* Decide if we should generate a switch-frame event. Don't
3923 generate switch-frame events for motion outside of all Emacs
3929 frame
= FRAME_FOCUS_FRAME (f
);
3931 XSETFRAME (frame
, f
);
3933 if (! EQ (frame
, internal_last_event_frame
)
3934 && !EQ (frame
, selected_frame
))
3935 obj
= make_lispy_switch_frame (frame
);
3936 internal_last_event_frame
= frame
;
3939 /* If we didn't decide to make a switch-frame event, go ahead and
3940 return a mouse-motion event. */
3941 if (!NILP (x
) && NILP (obj
))
3942 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3944 #endif /* HAVE_MOUSE */
3946 /* We were promised by the above while loop that there was
3947 something for us to read! */
3950 input_pending
= readable_events (0);
3952 Vlast_event_frame
= internal_last_event_frame
;
3957 /* Process any events that are not user-visible,
3958 then return, without reading any user-visible events. */
3961 swallow_events (do_display
)
3966 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3968 struct input_event
*event
;
3970 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3974 last_event_timestamp
= event
->timestamp
;
3976 /* These two kinds of events get special handling
3977 and don't actually appear to the command loop. */
3978 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3981 struct input_event copy
;
3983 /* Remove it from the buffer before processing it,
3984 since otherwise swallow_events called recursively could see it
3985 and process it again. */
3987 kbd_fetch_ptr
= event
+ 1;
3988 input_pending
= readable_events (0);
3989 x_handle_selection_request (©
);
3991 /* We're getting selection request events, but we don't have
3997 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4000 struct input_event copy
;
4002 /* Remove it from the buffer before processing it, */
4005 kbd_fetch_ptr
= event
+ 1;
4006 input_pending
= readable_events (0);
4007 x_handle_selection_clear (©
);
4009 /* We're getting selection request events, but we don't have
4018 old_timers_run
= timers_run
;
4019 get_input_pending (&input_pending
, 1);
4021 if (timers_run
!= old_timers_run
&& do_display
)
4022 redisplay_preserve_echo_area (7);
4025 /* Record the start of when Emacs is idle,
4026 for the sake of running idle-time timers. */
4033 /* If we are already in the idle state, do nothing. */
4034 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4037 EMACS_GET_TIME (timer_idleness_start_time
);
4039 timer_last_idleness_start_time
= timer_idleness_start_time
;
4041 /* Mark all idle-time timers as once again candidates for running. */
4042 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4046 timer
= XCAR (timers
);
4048 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4050 XVECTOR (timer
)->contents
[0] = Qnil
;
4054 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4059 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4062 /* This is only for debugging. */
4063 struct input_event last_timer_event
;
4065 /* Check whether a timer has fired. To prevent larger problems we simply
4066 disregard elements that are not proper timers. Do not make a circular
4067 timer list for the time being.
4069 Returns the number of seconds to wait until the next timer fires. If a
4070 timer is triggering now, return zero seconds.
4071 If no timer is active, return -1 seconds.
4073 If a timer is ripe, we run it, with quitting turned off.
4075 DO_IT_NOW is now ignored. It used to mean that we should
4076 run the timer directly instead of queueing a timer-event.
4077 Now we always run timers directly. */
4080 timer_check (do_it_now
)
4083 EMACS_TIME nexttime
;
4084 EMACS_TIME now
, idleness_now
;
4085 Lisp_Object timers
, idle_timers
, chosen_timer
;
4086 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4088 EMACS_SET_SECS (nexttime
, -1);
4089 EMACS_SET_USECS (nexttime
, -1);
4091 /* Always consider the ordinary timers. */
4092 timers
= Vtimer_list
;
4093 /* Consider the idle timers only if Emacs is idle. */
4094 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4095 idle_timers
= Vtimer_idle_list
;
4098 chosen_timer
= Qnil
;
4099 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4101 if (CONSP (timers
) || CONSP (idle_timers
))
4103 EMACS_GET_TIME (now
);
4104 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4105 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4108 while (CONSP (timers
) || CONSP (idle_timers
))
4110 Lisp_Object
*vector
;
4111 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4112 EMACS_TIME timer_time
, idle_timer_time
;
4113 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4115 /* Skip past invalid timers and timers already handled. */
4118 timer
= XCAR (timers
);
4119 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4121 timers
= XCDR (timers
);
4124 vector
= XVECTOR (timer
)->contents
;
4126 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4127 || !INTEGERP (vector
[3])
4128 || ! NILP (vector
[0]))
4130 timers
= XCDR (timers
);
4134 if (!NILP (idle_timers
))
4136 timer
= XCAR (idle_timers
);
4137 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4139 idle_timers
= XCDR (idle_timers
);
4142 vector
= XVECTOR (timer
)->contents
;
4144 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4145 || !INTEGERP (vector
[3])
4146 || ! NILP (vector
[0]))
4148 idle_timers
= XCDR (idle_timers
);
4153 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4154 based on the next ordinary timer.
4155 TIMER_DIFFERENCE is the distance in time from NOW to when
4156 this timer becomes ripe (negative if it's already ripe). */
4159 timer
= XCAR (timers
);
4160 vector
= XVECTOR (timer
)->contents
;
4161 EMACS_SET_SECS (timer_time
,
4162 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4163 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4164 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4167 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4168 based on the next idle timer. */
4169 if (!NILP (idle_timers
))
4171 idle_timer
= XCAR (idle_timers
);
4172 vector
= XVECTOR (idle_timer
)->contents
;
4173 EMACS_SET_SECS (idle_timer_time
,
4174 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4175 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4176 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4179 /* Decide which timer is the next timer,
4180 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4181 Also step down the list where we found that timer. */
4183 if (! NILP (timers
) && ! NILP (idle_timers
))
4186 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4187 if (EMACS_TIME_NEG_P (temp
))
4189 chosen_timer
= timer
;
4190 timers
= XCDR (timers
);
4191 difference
= timer_difference
;
4195 chosen_timer
= idle_timer
;
4196 idle_timers
= XCDR (idle_timers
);
4197 difference
= idle_timer_difference
;
4200 else if (! NILP (timers
))
4202 chosen_timer
= timer
;
4203 timers
= XCDR (timers
);
4204 difference
= timer_difference
;
4208 chosen_timer
= idle_timer
;
4209 idle_timers
= XCDR (idle_timers
);
4210 difference
= idle_timer_difference
;
4212 vector
= XVECTOR (chosen_timer
)->contents
;
4214 /* If timer is ripe, run it if it hasn't been run. */
4215 if (EMACS_TIME_NEG_P (difference
)
4216 || (EMACS_SECS (difference
) == 0
4217 && EMACS_USECS (difference
) == 0))
4219 if (NILP (vector
[0]))
4221 int was_locked
= single_kboard
;
4222 int count
= SPECPDL_INDEX ();
4223 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4225 /* Mark the timer as triggered to prevent problems if the lisp
4226 code fails to reschedule it right. */
4229 specbind (Qinhibit_quit
, Qt
);
4231 call1 (Qtimer_event_handler
, chosen_timer
);
4232 Vdeactivate_mark
= old_deactivate_mark
;
4234 unbind_to (count
, Qnil
);
4236 /* Resume allowing input from any kboard, if that was true before. */
4238 any_kboard_state ();
4240 /* Since we have handled the event,
4241 we don't need to tell the caller to wake up and do it. */
4245 /* When we encounter a timer that is still waiting,
4246 return the amount of time to wait before it is ripe. */
4253 /* No timers are pending in the future. */
4254 /* Return 0 if we generated an event, and -1 if not. */
4259 /* Caches for modify_event_symbol. */
4260 static Lisp_Object accent_key_syms
;
4261 static Lisp_Object func_key_syms
;
4262 static Lisp_Object mouse_syms
;
4264 static Lisp_Object mouse_wheel_syms
;
4266 static Lisp_Object drag_n_drop_syms
;
4268 /* This is a list of keysym codes for special "accent" characters.
4269 It parallels lispy_accent_keys. */
4271 static int lispy_accent_codes
[] =
4273 #ifdef XK_dead_circumflex
4278 #ifdef XK_dead_grave
4283 #ifdef XK_dead_tilde
4288 #ifdef XK_dead_diaeresis
4293 #ifdef XK_dead_macron
4298 #ifdef XK_dead_degree
4303 #ifdef XK_dead_acute
4308 #ifdef XK_dead_cedilla
4313 #ifdef XK_dead_breve
4318 #ifdef XK_dead_ogonek
4323 #ifdef XK_dead_caron
4328 #ifdef XK_dead_doubleacute
4329 XK_dead_doubleacute
,
4333 #ifdef XK_dead_abovedot
4340 /* This is a list of Lisp names for special "accent" characters.
4341 It parallels lispy_accent_codes. */
4343 static char *lispy_accent_keys
[] =
4361 #define FUNCTION_KEY_OFFSET 0x0
4363 char *lispy_function_keys
[] =
4367 0, /* VK_LBUTTON 0x01 */
4368 0, /* VK_RBUTTON 0x02 */
4369 "cancel", /* VK_CANCEL 0x03 */
4370 0, /* VK_MBUTTON 0x04 */
4372 0, 0, 0, /* 0x05 .. 0x07 */
4374 "backspace", /* VK_BACK 0x08 */
4375 "tab", /* VK_TAB 0x09 */
4377 0, 0, /* 0x0A .. 0x0B */
4379 "clear", /* VK_CLEAR 0x0C */
4380 "return", /* VK_RETURN 0x0D */
4382 0, 0, /* 0x0E .. 0x0F */
4384 0, /* VK_SHIFT 0x10 */
4385 0, /* VK_CONTROL 0x11 */
4386 0, /* VK_MENU 0x12 */
4387 "pause", /* VK_PAUSE 0x13 */
4388 "capslock", /* VK_CAPITAL 0x14 */
4390 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4392 "escape", /* VK_ESCAPE 0x1B */
4394 0, 0, 0, 0, /* 0x1C .. 0x1F */
4396 0, /* VK_SPACE 0x20 */
4397 "prior", /* VK_PRIOR 0x21 */
4398 "next", /* VK_NEXT 0x22 */
4399 "end", /* VK_END 0x23 */
4400 "home", /* VK_HOME 0x24 */
4401 "left", /* VK_LEFT 0x25 */
4402 "up", /* VK_UP 0x26 */
4403 "right", /* VK_RIGHT 0x27 */
4404 "down", /* VK_DOWN 0x28 */
4405 "select", /* VK_SELECT 0x29 */
4406 "print", /* VK_PRINT 0x2A */
4407 "execute", /* VK_EXECUTE 0x2B */
4408 "snapshot", /* VK_SNAPSHOT 0x2C */
4409 "insert", /* VK_INSERT 0x2D */
4410 "delete", /* VK_DELETE 0x2E */
4411 "help", /* VK_HELP 0x2F */
4413 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4415 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4417 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4419 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4421 0, 0, 0, 0, 0, 0, 0, 0, 0,
4422 0, 0, 0, 0, 0, 0, 0, 0, 0,
4423 0, 0, 0, 0, 0, 0, 0, 0,
4425 "lwindow", /* VK_LWIN 0x5B */
4426 "rwindow", /* VK_RWIN 0x5C */
4427 "apps", /* VK_APPS 0x5D */
4429 0, 0, /* 0x5E .. 0x5F */
4431 "kp-0", /* VK_NUMPAD0 0x60 */
4432 "kp-1", /* VK_NUMPAD1 0x61 */
4433 "kp-2", /* VK_NUMPAD2 0x62 */
4434 "kp-3", /* VK_NUMPAD3 0x63 */
4435 "kp-4", /* VK_NUMPAD4 0x64 */
4436 "kp-5", /* VK_NUMPAD5 0x65 */
4437 "kp-6", /* VK_NUMPAD6 0x66 */
4438 "kp-7", /* VK_NUMPAD7 0x67 */
4439 "kp-8", /* VK_NUMPAD8 0x68 */
4440 "kp-9", /* VK_NUMPAD9 0x69 */
4441 "kp-multiply", /* VK_MULTIPLY 0x6A */
4442 "kp-add", /* VK_ADD 0x6B */
4443 "kp-separator", /* VK_SEPARATOR 0x6C */
4444 "kp-subtract", /* VK_SUBTRACT 0x6D */
4445 "kp-decimal", /* VK_DECIMAL 0x6E */
4446 "kp-divide", /* VK_DIVIDE 0x6F */
4447 "f1", /* VK_F1 0x70 */
4448 "f2", /* VK_F2 0x71 */
4449 "f3", /* VK_F3 0x72 */
4450 "f4", /* VK_F4 0x73 */
4451 "f5", /* VK_F5 0x74 */
4452 "f6", /* VK_F6 0x75 */
4453 "f7", /* VK_F7 0x76 */
4454 "f8", /* VK_F8 0x77 */
4455 "f9", /* VK_F9 0x78 */
4456 "f10", /* VK_F10 0x79 */
4457 "f11", /* VK_F11 0x7A */
4458 "f12", /* VK_F12 0x7B */
4459 "f13", /* VK_F13 0x7C */
4460 "f14", /* VK_F14 0x7D */
4461 "f15", /* VK_F15 0x7E */
4462 "f16", /* VK_F16 0x7F */
4463 "f17", /* VK_F17 0x80 */
4464 "f18", /* VK_F18 0x81 */
4465 "f19", /* VK_F19 0x82 */
4466 "f20", /* VK_F20 0x83 */
4467 "f21", /* VK_F21 0x84 */
4468 "f22", /* VK_F22 0x85 */
4469 "f23", /* VK_F23 0x86 */
4470 "f24", /* VK_F24 0x87 */
4472 0, 0, 0, 0, /* 0x88 .. 0x8B */
4473 0, 0, 0, 0, /* 0x8C .. 0x8F */
4475 "kp-numlock", /* VK_NUMLOCK 0x90 */
4476 "scroll", /* VK_SCROLL 0x91 */
4478 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4479 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4480 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4481 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4482 "kp-end", /* VK_NUMPAD_END 0x96 */
4483 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4484 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4485 "kp-up", /* VK_NUMPAD_UP 0x99 */
4486 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4487 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4488 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4489 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4491 0, 0, /* 0x9E .. 0x9F */
4494 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4495 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4496 * No other API or message will distinguish left and right keys this way.
4500 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4501 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4502 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4503 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4504 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4510 "attn", /* VK_ATTN 0xF6 */
4511 "crsel", /* VK_CRSEL 0xF7 */
4512 "exsel", /* VK_EXSEL 0xF8 */
4513 "ereof", /* VK_EREOF 0xF9 */
4514 "play", /* VK_PLAY 0xFA */
4515 "zoom", /* VK_ZOOM 0xFB */
4516 "noname", /* VK_NONAME 0xFC */
4517 "pa1", /* VK_PA1 0xFD */
4518 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4522 #else /* not HAVE_NTGUI */
4525 static char *lispy_kana_keys
[] =
4527 /* X Keysym value */
4528 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4529 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4530 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4531 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4532 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4533 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4534 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4535 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4536 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4537 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4538 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4539 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4540 "kana-i", "kana-u", "kana-e", "kana-o",
4541 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4542 "prolongedsound", "kana-A", "kana-I", "kana-U",
4543 "kana-E", "kana-O", "kana-KA", "kana-KI",
4544 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4545 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4546 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4547 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4548 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4549 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4550 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4551 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4552 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4553 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4554 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4555 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4557 #endif /* XK_kana_A */
4559 #define FUNCTION_KEY_OFFSET 0xff00
4561 /* You'll notice that this table is arranged to be conveniently
4562 indexed by X Windows keysym values. */
4563 static char *lispy_function_keys
[] =
4565 /* X Keysym value */
4567 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4568 "backspace", "tab", "linefeed", "clear",
4570 0, 0, 0, "pause", /* 0xff10...1f */
4571 0, 0, 0, 0, 0, 0, 0, "escape",
4573 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4574 "romaji", "hiragana", "katakana", "hiragana-katakana",
4575 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4576 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4577 "eisu-toggle", /* 0xff30...3f */
4578 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4579 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4581 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4582 "down", "prior", "next", "end",
4583 "begin", 0, 0, 0, 0, 0, 0, 0,
4584 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4595 "break", /* 0xff6b */
4598 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4599 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4600 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4601 0, 0, 0, 0, 0, 0, 0, 0,
4602 "kp-tab", /* 0xff89 */
4604 "kp-enter", /* 0xff8d */
4606 "kp-f1", /* 0xff91 */
4610 "kp-home", /* 0xff95 */
4615 "kp-prior", /* kp-page-up */
4616 "kp-next", /* kp-page-down */
4622 0, 0, 0, 0, 0, 0, 0, 0, 0,
4623 "kp-multiply", /* 0xffaa */
4628 "kp-divide", /* 0xffaf */
4629 "kp-0", /* 0xffb0 */
4630 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4633 "kp-equal", /* 0xffbd */
4634 "f1", /* 0xffbe */ /* IsFunctionKey */
4636 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4637 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4638 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4639 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4640 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4641 0, 0, 0, 0, 0, 0, 0, 0,
4642 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4643 0, 0, 0, 0, 0, 0, 0, "delete"
4646 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4647 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4649 static char *iso_lispy_function_keys
[] =
4651 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4652 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4653 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4654 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4655 "iso-lefttab", /* 0xfe20 */
4656 "iso-move-line-up", "iso-move-line-down",
4657 "iso-partial-line-up", "iso-partial-line-down",
4658 "iso-partial-space-left", "iso-partial-space-right",
4659 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4660 "iso-release-margin-left", "iso-release-margin-right",
4661 "iso-release-both-margins",
4662 "iso-fast-cursor-left", "iso-fast-cursor-right",
4663 "iso-fast-cursor-up", "iso-fast-cursor-down",
4664 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4665 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4668 #endif /* not HAVE_NTGUI */
4670 Lisp_Object Vlispy_mouse_stem
;
4673 /* mouse-wheel events are generated by the wheel on devices such as
4674 the MS Intellimouse. The wheel sits in between the left and right
4675 mouse buttons, and is typically used to scroll or zoom the window
4676 underneath the pointer. mouse-wheel events specify the object on
4677 which they operate, and a delta corresponding to the amount and
4678 direction that the wheel is rotated. Clicking the mouse-wheel
4679 generates a mouse-2 event. */
4680 static char *lispy_mouse_wheel_names
[] =
4685 #endif /* WINDOWSNT */
4687 /* drag-n-drop events are generated when a set of selected files are
4688 dragged from another application and dropped onto an Emacs window. */
4689 static char *lispy_drag_n_drop_names
[] =
4694 /* Scroll bar parts. */
4695 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4696 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4697 Lisp_Object Qtop
, Qratio
;
4699 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4700 Lisp_Object
*scroll_bar_parts
[] = {
4701 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4702 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4705 /* User signal events. */
4706 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4708 Lisp_Object
*lispy_user_signals
[] =
4710 &Qusr1_signal
, &Qusr2_signal
4714 /* A vector, indexed by button number, giving the down-going location
4715 of currently depressed buttons, both scroll bar and non-scroll bar.
4717 The elements have the form
4718 (BUTTON-NUMBER MODIFIER-MASK . REST)
4719 where REST is the cdr of a position as it would be reported in the event.
4721 The make_lispy_event function stores positions here to tell the
4722 difference between click and drag events, and to store the starting
4723 location to be included in drag events. */
4725 static Lisp_Object button_down_location
;
4727 /* Information about the most recent up-going button event: Which
4728 button, what location, and what time. */
4730 static int last_mouse_button
;
4731 static int last_mouse_x
;
4732 static int last_mouse_y
;
4733 static unsigned long button_down_time
;
4735 /* The maximum time between clicks to make a double-click, or Qnil to
4736 disable double-click detection, or Qt for no time limit. */
4738 Lisp_Object Vdouble_click_time
;
4740 /* Maximum number of pixels the mouse may be moved between clicks
4741 to make a double-click. */
4743 EMACS_INT double_click_fuzz
;
4745 /* The number of clicks in this multiple-click. */
4747 int double_click_count
;
4749 /* Given a struct input_event, build the lisp event which represents
4750 it. If EVENT is 0, build a mouse movement event from the mouse
4751 movement buffer, which should have a movement event in it.
4753 Note that events must be passed to this function in the order they
4754 are received; this function stores the location of button presses
4755 in order to build drag events when the button is released. */
4758 make_lispy_event (event
)
4759 struct input_event
*event
;
4763 switch (SWITCH_ENUM_CAST (event
->kind
))
4765 /* A simple keystroke. */
4766 case ASCII_KEYSTROKE_EVENT
:
4768 Lisp_Object lispy_c
;
4769 int c
= event
->code
& 0377;
4770 /* Turn ASCII characters into control characters
4772 if (event
->modifiers
& ctrl_modifier
)
4773 c
= make_ctrl_char (c
);
4775 /* Add in the other modifier bits. We took care of ctrl_modifier
4776 just above, and the shift key was taken care of by the X code,
4777 and applied to control characters by make_ctrl_char. */
4778 c
|= (event
->modifiers
4779 & (meta_modifier
| alt_modifier
4780 | hyper_modifier
| super_modifier
));
4781 /* Distinguish Shift-SPC from SPC. */
4782 if ((event
->code
& 0377) == 040
4783 && event
->modifiers
& shift_modifier
)
4784 c
|= shift_modifier
;
4785 button_down_time
= 0;
4786 XSETFASTINT (lispy_c
, c
);
4790 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4792 Lisp_Object lispy_c
;
4794 XSETFASTINT (lispy_c
, event
->code
);
4798 /* A function key. The symbol may need to have modifier prefixes
4800 case NON_ASCII_KEYSTROKE_EVENT
:
4801 button_down_time
= 0;
4803 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4804 if (event
->code
== lispy_accent_codes
[i
])
4805 return modify_event_symbol (i
,
4807 Qfunction_key
, Qnil
,
4808 lispy_accent_keys
, &accent_key_syms
,
4809 (sizeof (lispy_accent_keys
)
4810 / sizeof (lispy_accent_keys
[0])));
4813 if (event
->code
>= 0x400 && event
->code
< 0x500)
4814 return modify_event_symbol (event
->code
- 0x400,
4815 event
->modifiers
& ~shift_modifier
,
4816 Qfunction_key
, Qnil
,
4817 lispy_kana_keys
, &func_key_syms
,
4818 (sizeof (lispy_kana_keys
)
4819 / sizeof (lispy_kana_keys
[0])));
4820 #endif /* XK_kana_A */
4822 #ifdef ISO_FUNCTION_KEY_OFFSET
4823 if (event
->code
< FUNCTION_KEY_OFFSET
4824 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4825 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4827 Qfunction_key
, Qnil
,
4828 iso_lispy_function_keys
, &func_key_syms
,
4829 (sizeof (iso_lispy_function_keys
)
4830 / sizeof (iso_lispy_function_keys
[0])));
4833 /* Handle system-specific or unknown keysyms. */
4834 if (event
->code
& (1 << 28)
4835 || event
->code
- FUNCTION_KEY_OFFSET
< 0
4836 || (event
->code
- FUNCTION_KEY_OFFSET
4837 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
4838 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
4840 /* We need to use an alist rather than a vector as the cache
4841 since we can't make a vector long enuf. */
4842 if (NILP (current_kboard
->system_key_syms
))
4843 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4844 return modify_event_symbol (event
->code
,
4847 current_kboard
->Vsystem_key_alist
,
4848 0, ¤t_kboard
->system_key_syms
,
4852 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4854 Qfunction_key
, Qnil
,
4855 lispy_function_keys
, &func_key_syms
,
4856 (sizeof (lispy_function_keys
)
4857 / sizeof (lispy_function_keys
[0])));
4860 /* A mouse click. Figure out where it is, decide whether it's
4861 a press, click or drag, and build the appropriate structure. */
4862 case MOUSE_CLICK_EVENT
:
4863 #ifndef USE_TOOLKIT_SCROLL_BARS
4864 case SCROLL_BAR_CLICK_EVENT
:
4867 int button
= event
->code
;
4869 Lisp_Object position
;
4870 Lisp_Object
*start_pos_ptr
;
4871 Lisp_Object start_pos
;
4876 /* Build the position as appropriate for this mouse click. */
4877 if (event
->kind
== MOUSE_CLICK_EVENT
)
4880 struct frame
*f
= XFRAME (event
->frame_or_window
);
4882 Lisp_Object string_info
= Qnil
;
4885 /* Ignore mouse events that were made on frame that
4886 have been deleted. */
4887 if (! FRAME_LIVE_P (f
))
4890 /* EVENT->x and EVENT->y are frame-relative pixel
4891 coordinates at this place. Under old redisplay, COLUMN
4892 and ROW are set to frame relative glyph coordinates
4893 which are then used to determine whether this click is
4894 in a menu (non-toolkit version). */
4895 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4896 &column
, &row
, NULL
, 1);
4898 #ifndef USE_X_TOOLKIT
4899 /* In the non-toolkit version, clicks on the menu bar
4900 are ordinary button events in the event buffer.
4901 Distinguish them, and invoke the menu.
4903 (In the toolkit version, the toolkit handles the menu bar
4904 and Emacs doesn't know about it until after the user
4905 makes a selection.) */
4906 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4907 && (event
->modifiers
& down_modifier
))
4909 Lisp_Object items
, item
;
4914 /* Activate the menu bar on the down event. If the
4915 up event comes in before the menu code can deal with it,
4917 if (! (event
->modifiers
& down_modifier
))
4921 /* Find the menu bar item under `column'. */
4923 items
= FRAME_MENU_BAR_ITEMS (f
);
4924 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4926 Lisp_Object pos
, string
;
4927 string
= AREF (items
, i
+ 1);
4928 pos
= AREF (items
, i
+ 3);
4931 if (column
>= XINT (pos
)
4932 && column
< XINT (pos
) + SCHARS (string
))
4934 item
= AREF (items
, i
);
4939 /* ELisp manual 2.4b says (x y) are window relative but
4940 code says they are frame-relative. */
4942 = Fcons (event
->frame_or_window
,
4944 Fcons (Fcons (event
->x
, event
->y
),
4945 Fcons (make_number (event
->timestamp
),
4948 return Fcons (item
, Fcons (position
, Qnil
));
4950 #endif /* not USE_X_TOOLKIT */
4952 /* Set `window' to the window under frame pixel coordinates
4953 event->x/event->y. */
4954 window
= window_from_coordinates (f
, XINT (event
->x
),
4955 XINT (event
->y
), &part
, 0);
4957 if (!WINDOWP (window
))
4959 window
= event
->frame_or_window
;
4964 /* It's a click in window window at frame coordinates
4965 event->x/ event->y. */
4966 struct window
*w
= XWINDOW (window
);
4968 /* Get window relative coordinates. Original code
4969 `rounded' this to glyph boundaries. */
4970 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4971 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4973 /* Set event coordinates to window-relative coordinates
4974 for constructing the Lisp event below. */
4975 XSETINT (event
->x
, wx
);
4976 XSETINT (event
->y
, wy
);
4978 if (part
== 1 || part
== 3)
4980 /* Mode line or header line. Look for a string under
4981 the mouse that may have a `local-map' property. */
4985 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
4986 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
4987 if (STRINGP (string
))
4988 string_info
= Fcons (string
, make_number (charpos
));
4991 posn
= Qvertical_line
;
4992 else if (part
== 6 || part
== 7)
4995 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
4997 posn
= (part
== 6) ? Qleft_margin
: Qright_margin
;
4998 if (STRINGP (object
))
4999 string_info
= Fcons (object
, make_number (charpos
));
5004 struct display_pos p
;
5005 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5006 posn
= make_number (CHARPOS (p
.pos
));
5007 if (STRINGP (object
))
5010 make_number (CHARPOS (p
.string_pos
)));
5017 Fcons (Fcons (event
->x
, event
->y
),
5018 Fcons (make_number (event
->timestamp
),
5021 : Fcons (string_info
, Qnil
))))));
5023 #ifndef USE_TOOLKIT_SCROLL_BARS
5026 /* It's a scrollbar click. */
5027 Lisp_Object portion_whole
;
5030 window
= event
->frame_or_window
;
5031 portion_whole
= Fcons (event
->x
, event
->y
);
5032 part
= *scroll_bar_parts
[(int) event
->part
];
5036 Fcons (Qvertical_scroll_bar
,
5037 Fcons (portion_whole
,
5038 Fcons (make_number (event
->timestamp
),
5039 Fcons (part
, Qnil
)))));
5041 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5043 if (button
>= ASIZE (button_down_location
))
5045 button_down_location
= larger_vector (button_down_location
,
5047 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5050 start_pos_ptr
= &AREF (button_down_location
, button
);
5051 start_pos
= *start_pos_ptr
;
5052 *start_pos_ptr
= Qnil
;
5055 /* On window-system frames, use the value of
5056 double-click-fuzz as is. On other frames, interpret it
5057 as a multiple of 1/8 characters. */
5061 if (WINDOWP (event
->frame_or_window
))
5062 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5063 else if (FRAMEP (event
->frame_or_window
))
5064 f
= XFRAME (event
->frame_or_window
);
5068 if (FRAME_WINDOW_P (f
))
5069 fuzz
= double_click_fuzz
;
5071 fuzz
= double_click_fuzz
/ 8;
5073 is_double
= (button
== last_mouse_button
5074 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5075 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5076 && button_down_time
!= 0
5077 && (EQ (Vdouble_click_time
, Qt
)
5078 || (INTEGERP (Vdouble_click_time
)
5079 && ((int)(event
->timestamp
- button_down_time
)
5080 < XINT (Vdouble_click_time
)))));
5083 last_mouse_button
= button
;
5084 last_mouse_x
= XINT (event
->x
);
5085 last_mouse_y
= XINT (event
->y
);
5087 /* If this is a button press, squirrel away the location, so
5088 we can decide later whether it was a click or a drag. */
5089 if (event
->modifiers
& down_modifier
)
5093 double_click_count
++;
5094 event
->modifiers
|= ((double_click_count
> 2)
5099 double_click_count
= 1;
5100 button_down_time
= event
->timestamp
;
5101 *start_pos_ptr
= Fcopy_alist (position
);
5104 /* Now we're releasing a button - check the co-ordinates to
5105 see if this was a click or a drag. */
5106 else if (event
->modifiers
& up_modifier
)
5108 /* If we did not see a down before this up, ignore the up.
5109 Probably this happened because the down event chose a
5110 menu item. It would be an annoyance to treat the
5111 release of the button that chose the menu item as a
5114 if (!CONSP (start_pos
))
5117 event
->modifiers
&= ~up_modifier
;
5118 #if 0 /* Formerly we treated an up with no down as a click event. */
5119 if (!CONSP (start_pos
))
5120 event
->modifiers
|= click_modifier
;
5125 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5127 /* The third element of every position
5128 should be the (x,y) pair. */
5129 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5131 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5133 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5134 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5137 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5138 && ydiff
< double_click_fuzz
5139 && ydiff
> - double_click_fuzz
)
5140 /* Mouse hasn't moved (much). */
5141 event
->modifiers
|= click_modifier
;
5144 button_down_time
= 0;
5145 event
->modifiers
|= drag_modifier
;
5148 /* Don't check is_double; treat this as multiple
5149 if the down-event was multiple. */
5150 if (double_click_count
> 1)
5151 event
->modifiers
|= ((double_click_count
> 2)
5157 /* Every mouse event should either have the down_modifier or
5158 the up_modifier set. */
5162 /* Get the symbol we should use for the mouse click. */
5165 head
= modify_event_symbol (button
,
5167 Qmouse_click
, Vlispy_mouse_stem
,
5170 XVECTOR (mouse_syms
)->size
);
5171 if (event
->modifiers
& drag_modifier
)
5176 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5179 Fcons (make_number (double_click_count
),
5188 #ifdef USE_TOOLKIT_SCROLL_BARS
5190 /* We don't have down and up events if using toolkit scroll bars,
5191 so make this always a click event. Store in the `part' of
5192 the Lisp event a symbol which maps to the following actions:
5194 `above_handle' page up
5195 `below_handle' page down
5199 `bottom' bottom of buffer
5200 `handle' thumb has been dragged.
5201 `end-scroll' end of interaction with scroll bar
5203 The incoming input_event contains in its `part' member an
5204 index of type `enum scroll_bar_part' which we can use as an
5205 index in scroll_bar_parts to get the appropriate symbol. */
5207 case SCROLL_BAR_CLICK_EVENT
:
5209 Lisp_Object position
, head
, window
, portion_whole
, part
;
5211 window
= event
->frame_or_window
;
5212 portion_whole
= Fcons (event
->x
, event
->y
);
5213 part
= *scroll_bar_parts
[(int) event
->part
];
5217 Fcons (Qvertical_scroll_bar
,
5218 Fcons (portion_whole
,
5219 Fcons (make_number (event
->timestamp
),
5220 Fcons (part
, Qnil
)))));
5222 /* Always treat scroll bar events as clicks. */
5223 event
->modifiers
|= click_modifier
;
5224 event
->modifiers
&= ~up_modifier
;
5226 /* Get the symbol we should use for the mouse click. */
5227 head
= modify_event_symbol (event
->code
,
5232 XVECTOR (mouse_syms
)->size
);
5233 return Fcons (head
, Fcons (position
, Qnil
));
5236 #endif /* USE_TOOLKIT_SCROLL_BARS */
5239 case W32_SCROLL_BAR_CLICK_EVENT
:
5241 int button
= event
->code
;
5243 Lisp_Object position
;
5244 Lisp_Object
*start_pos_ptr
;
5245 Lisp_Object start_pos
;
5249 Lisp_Object portion_whole
;
5252 window
= event
->frame_or_window
;
5253 portion_whole
= Fcons (event
->x
, event
->y
);
5254 part
= *scroll_bar_parts
[(int) event
->part
];
5258 Fcons (Qvertical_scroll_bar
,
5259 Fcons (portion_whole
,
5260 Fcons (make_number (event
->timestamp
),
5261 Fcons (part
, Qnil
)))));
5264 /* Always treat W32 scroll bar events as clicks. */
5265 event
->modifiers
|= click_modifier
;
5268 /* Get the symbol we should use for the mouse click. */
5271 head
= modify_event_symbol (button
,
5276 XVECTOR (mouse_syms
)->size
);
5282 case MOUSE_WHEEL_EVENT
:
5285 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5288 Lisp_Object head
, position
;
5291 /* Ignore mouse events that were made on frame that
5292 have been deleted. */
5293 if (! FRAME_LIVE_P (f
))
5295 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5296 &column
, &row
, NULL
, 1);
5297 window
= window_from_coordinates (f
, XINT (event
->x
),
5298 XINT (event
->y
), &part
, 0);
5300 if (!WINDOWP (window
))
5302 window
= event
->frame_or_window
;
5307 int pixcolumn
, pixrow
;
5308 column
-= XINT (XWINDOW (window
)->left
);
5309 row
-= XINT (XWINDOW (window
)->top
);
5310 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5311 &pixcolumn
, &pixrow
);
5312 XSETINT (event
->x
, pixcolumn
);
5313 XSETINT (event
->y
, pixrow
);
5318 posn
= Qvertical_line
;
5320 posn
= Qheader_line
;
5324 struct display_pos p
;
5325 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5327 posn
= make_number (CHARPOS (p
.pos
));
5332 Lisp_Object head
, position
;
5337 Fcons (Fcons (event
->x
, event
->y
),
5338 Fcons (make_number (event
->timestamp
),
5341 head
= modify_event_symbol (0, event
->modifiers
,
5343 lispy_mouse_wheel_names
,
5344 &mouse_wheel_syms
, 1);
5347 /* Insert 1 here so event-click-count works. */
5348 Fcons (make_number (1),
5349 Fcons (make_number (event
->code
),
5353 #endif /* WINDOWSNT */
5355 case DRAG_N_DROP_EVENT
:
5363 /* The frame_or_window field should be a cons of the frame in
5364 which the event occurred and a list of the filenames
5366 if (! CONSP (event
->frame_or_window
))
5369 f
= XFRAME (XCAR (event
->frame_or_window
));
5370 files
= XCDR (event
->frame_or_window
);
5372 /* Ignore mouse events that were made on frames that
5373 have been deleted. */
5374 if (! FRAME_LIVE_P (f
))
5377 window
= window_from_coordinates (f
, XINT (event
->x
),
5378 XINT (event
->y
), &part
, 0);
5380 if (!WINDOWP (window
))
5382 window
= XCAR (event
->frame_or_window
);
5387 /* It's an event in window `window' at frame coordinates
5388 event->x/ event->y. */
5389 struct window
*w
= XWINDOW (window
);
5391 /* Get window relative coordinates. */
5392 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5393 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5395 /* Set event coordinates to window-relative coordinates
5396 for constructing the Lisp event below. */
5397 XSETINT (event
->x
, wx
);
5398 XSETINT (event
->y
, wy
);
5403 posn
= Qvertical_line
;
5405 posn
= Qheader_line
;
5409 struct display_pos p
;
5410 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5411 posn
= make_number (CHARPOS (p
.pos
));
5416 Lisp_Object head
, position
;
5421 Fcons (Fcons (event
->x
, event
->y
),
5422 Fcons (make_number (event
->timestamp
),
5425 head
= modify_event_symbol (0, event
->modifiers
,
5427 lispy_drag_n_drop_names
,
5428 &drag_n_drop_syms
, 1);
5435 #endif /* HAVE_MOUSE */
5437 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
5438 case MENU_BAR_EVENT
:
5439 if (EQ (event
->arg
, event
->frame_or_window
))
5440 /* This is the prefix key. We translate this to
5441 `(menu_bar)' because the code in keyboard.c for menu
5442 events, which we use, relies on this. */
5443 return Fcons (Qmenu_bar
, Qnil
);
5447 case TOOL_BAR_EVENT
:
5448 if (EQ (event
->arg
, event
->frame_or_window
))
5449 /* This is the prefix key. We translate this to
5450 `(tool_bar)' because the code in keyboard.c for tool bar
5451 events, which we use, relies on this. */
5452 return Fcons (Qtool_bar
, Qnil
);
5453 else if (SYMBOLP (event
->arg
))
5454 return apply_modifiers (event
->modifiers
, event
->arg
);
5457 case USER_SIGNAL_EVENT
:
5458 /* A user signal. */
5459 return *lispy_user_signals
[event
->code
];
5461 case SAVE_SESSION_EVENT
:
5462 return Qsave_session
;
5464 /* The 'kind' field of the event is something we don't recognize. */
5473 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5475 Lisp_Object bar_window
;
5476 enum scroll_bar_part part
;
5480 /* Is it a scroll bar movement? */
5481 if (frame
&& ! NILP (bar_window
))
5483 Lisp_Object part_sym
;
5485 part_sym
= *scroll_bar_parts
[(int) part
];
5486 return Fcons (Qscroll_bar_movement
,
5487 (Fcons (Fcons (bar_window
,
5488 Fcons (Qvertical_scroll_bar
,
5489 Fcons (Fcons (x
, y
),
5490 Fcons (make_number (time
),
5496 /* Or is it an ordinary mouse movement? */
5504 /* It's in a frame; which window on that frame? */
5505 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5509 if (WINDOWP (window
))
5511 struct window
*w
= XWINDOW (window
);
5514 /* Get window relative coordinates. */
5515 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5516 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5523 posn
= Qvertical_line
;
5525 posn
= Qheader_line
;
5529 struct display_pos p
;
5530 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5531 posn
= make_number (CHARPOS (p
.pos
));
5534 else if (frame
!= 0)
5536 XSETFRAME (window
, frame
);
5547 return Fcons (Qmouse_movement
,
5548 Fcons (Fcons (window
,
5550 Fcons (Fcons (x
, y
),
5551 Fcons (make_number (time
),
5557 #endif /* HAVE_MOUSE */
5559 /* Construct a switch frame event. */
5561 make_lispy_switch_frame (frame
)
5564 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5567 /* Manipulating modifiers. */
5569 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5571 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5572 SYMBOL's name of the end of the modifiers; the string from this
5573 position is the unmodified symbol name.
5575 This doesn't use any caches. */
5578 parse_modifiers_uncached (symbol
, modifier_end
)
5586 CHECK_SYMBOL (symbol
);
5589 name
= SYMBOL_NAME (symbol
);
5591 for (i
= 0; i
+2 <= SBYTES (name
); )
5593 int this_mod_end
= 0;
5596 /* See if the name continues with a modifier word.
5597 Check that the word appears, but don't check what follows it.
5598 Set this_mod and this_mod_end to record what we find. */
5600 switch (SREF (name
, i
))
5602 #define SINGLE_LETTER_MOD(BIT) \
5603 (this_mod_end = i + 1, this_mod = BIT)
5606 SINGLE_LETTER_MOD (alt_modifier
);
5610 SINGLE_LETTER_MOD (ctrl_modifier
);
5614 SINGLE_LETTER_MOD (hyper_modifier
);
5618 SINGLE_LETTER_MOD (meta_modifier
);
5622 SINGLE_LETTER_MOD (shift_modifier
);
5626 SINGLE_LETTER_MOD (super_modifier
);
5629 #undef SINGLE_LETTER_MOD
5632 /* If we found no modifier, stop looking for them. */
5633 if (this_mod_end
== 0)
5636 /* Check there is a dash after the modifier, so that it
5637 really is a modifier. */
5638 if (this_mod_end
>= SBYTES (name
)
5639 || SREF (name
, this_mod_end
) != '-')
5642 /* This modifier is real; look for another. */
5643 modifiers
|= this_mod
;
5644 i
= this_mod_end
+ 1;
5647 /* Should we include the `click' modifier? */
5648 if (! (modifiers
& (down_modifier
| drag_modifier
5649 | double_modifier
| triple_modifier
))
5650 && i
+ 7 == SBYTES (name
)
5651 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5652 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5653 modifiers
|= click_modifier
;
5661 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5662 prepended to the string BASE[0..BASE_LEN-1].
5663 This doesn't use any caches. */
5665 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5668 int base_len
, base_len_byte
;
5670 /* Since BASE could contain nulls, we can't use intern here; we have
5671 to use Fintern, which expects a genuine Lisp_String, and keeps a
5674 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5680 /* Only the event queue may use the `up' modifier; it should always
5681 be turned into a click or drag event before presented to lisp code. */
5682 if (modifiers
& up_modifier
)
5685 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5686 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5687 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5688 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5689 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5690 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5691 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5692 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5693 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5694 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5695 /* The click modifier is denoted by the absence of other modifiers. */
5699 mod_len
= p
- new_mods
;
5703 Lisp_Object new_name
;
5705 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5706 mod_len
+ base_len_byte
);
5707 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5708 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5710 return Fintern (new_name
, Qnil
);
5715 static char *modifier_names
[] =
5717 "up", "down", "drag", "click", "double", "triple", 0, 0,
5718 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5719 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5721 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5723 static Lisp_Object modifier_symbols
;
5725 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5727 lispy_modifier_list (modifiers
)
5730 Lisp_Object modifier_list
;
5733 modifier_list
= Qnil
;
5734 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5735 if (modifiers
& (1<<i
))
5736 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5739 return modifier_list
;
5743 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5744 where UNMODIFIED is the unmodified form of SYMBOL,
5745 MASK is the set of modifiers present in SYMBOL's name.
5746 This is similar to parse_modifiers_uncached, but uses the cache in
5747 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5748 Qevent_symbol_elements property. */
5751 parse_modifiers (symbol
)
5754 Lisp_Object elements
;
5756 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5757 if (CONSP (elements
))
5762 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5763 Lisp_Object unmodified
;
5766 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
5767 SBYTES (SYMBOL_NAME (symbol
)) - end
),
5770 if (modifiers
& ~VALMASK
)
5772 XSETFASTINT (mask
, modifiers
);
5773 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5775 /* Cache the parsing results on SYMBOL. */
5776 Fput (symbol
, Qevent_symbol_element_mask
,
5778 Fput (symbol
, Qevent_symbol_elements
,
5779 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5781 /* Since we know that SYMBOL is modifiers applied to unmodified,
5782 it would be nice to put that in unmodified's cache.
5783 But we can't, since we're not sure that parse_modifiers is
5790 /* Apply the modifiers MODIFIERS to the symbol BASE.
5791 BASE must be unmodified.
5793 This is like apply_modifiers_uncached, but uses BASE's
5794 Qmodifier_cache property, if present. It also builds
5795 Qevent_symbol_elements properties, since it has that info anyway.
5797 apply_modifiers copies the value of BASE's Qevent_kind property to
5798 the modified symbol. */
5800 apply_modifiers (modifiers
, base
)
5804 Lisp_Object cache
, index
, entry
, new_symbol
;
5806 /* Mask out upper bits. We don't know where this value's been. */
5807 modifiers
&= VALMASK
;
5809 /* The click modifier never figures into cache indices. */
5810 cache
= Fget (base
, Qmodifier_cache
);
5811 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5812 entry
= assq_no_quit (index
, cache
);
5815 new_symbol
= XCDR (entry
);
5818 /* We have to create the symbol ourselves. */
5819 new_symbol
= apply_modifiers_uncached (modifiers
,
5820 SDATA (SYMBOL_NAME (base
)),
5821 SCHARS (SYMBOL_NAME (base
)),
5822 SBYTES (SYMBOL_NAME (base
)));
5824 /* Add the new symbol to the base's cache. */
5825 entry
= Fcons (index
, new_symbol
);
5826 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5828 /* We have the parsing info now for free, so add it to the caches. */
5829 XSETFASTINT (index
, modifiers
);
5830 Fput (new_symbol
, Qevent_symbol_element_mask
,
5831 Fcons (base
, Fcons (index
, Qnil
)));
5832 Fput (new_symbol
, Qevent_symbol_elements
,
5833 Fcons (base
, lispy_modifier_list (modifiers
)));
5836 /* Make sure this symbol is of the same kind as BASE.
5838 You'd think we could just set this once and for all when we
5839 intern the symbol above, but reorder_modifiers may call us when
5840 BASE's property isn't set right; we can't assume that just
5841 because it has a Qmodifier_cache property it must have its
5842 Qevent_kind set right as well. */
5843 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5847 kind
= Fget (base
, Qevent_kind
);
5849 Fput (new_symbol
, Qevent_kind
, kind
);
5856 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5857 return a symbol with the modifiers placed in the canonical order.
5858 Canonical order is alphabetical, except for down and drag, which
5859 always come last. The 'click' modifier is never written out.
5861 Fdefine_key calls this to make sure that (for example) C-M-foo
5862 and M-C-foo end up being equivalent in the keymap. */
5865 reorder_modifiers (symbol
)
5868 /* It's hopefully okay to write the code this way, since everything
5869 will soon be in caches, and no consing will be done at all. */
5872 parsed
= parse_modifiers (symbol
);
5873 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5878 /* For handling events, we often want to produce a symbol whose name
5879 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5880 to some base, like the name of a function key or mouse button.
5881 modify_event_symbol produces symbols of this sort.
5883 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5884 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5887 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5888 into symbol names, or a string specifying a name stem used to
5889 construct a symbol name or the form `STEM-N', where N is the decimal
5890 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5891 non-nil; otherwise NAME_TABLE is used.
5893 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5894 persist between calls to modify_event_symbol that it can use to
5895 store a cache of the symbols it's generated for this NAME_TABLE
5896 before. The object stored there may be a vector or an alist.
5898 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5900 MODIFIERS is a set of modifier bits (as given in struct input_events)
5901 whose prefixes should be applied to the symbol name.
5903 SYMBOL_KIND is the value to be placed in the event_kind property of
5904 the returned symbol.
5906 The symbols we create are supposed to have an
5907 `event-symbol-elements' property, which lists the modifiers present
5908 in the symbol's name. */
5911 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5912 name_table
, symbol_table
, table_size
)
5915 Lisp_Object symbol_kind
;
5916 Lisp_Object name_alist_or_stem
;
5918 Lisp_Object
*symbol_table
;
5919 unsigned int table_size
;
5922 Lisp_Object symbol_int
;
5924 /* Get rid of the "vendor-specific" bit here. */
5925 XSETINT (symbol_int
, symbol_num
& 0xffffff);
5927 /* Is this a request for a valid symbol? */
5928 if (symbol_num
< 0 || symbol_num
>= table_size
)
5931 if (CONSP (*symbol_table
))
5932 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
5934 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5935 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5936 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5937 we've never used that symbol before. */
5940 if (! VECTORP (*symbol_table
)
5941 || XVECTOR (*symbol_table
)->size
!= table_size
)
5945 XSETFASTINT (size
, table_size
);
5946 *symbol_table
= Fmake_vector (size
, Qnil
);
5949 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5952 /* Have we already used this symbol before? */
5955 /* No; let's create it. */
5956 if (CONSP (name_alist_or_stem
))
5957 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
5958 else if (STRINGP (name_alist_or_stem
))
5960 int len
= SBYTES (name_alist_or_stem
);
5961 char *buf
= (char *) alloca (len
+ 50);
5962 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
5963 XINT (symbol_int
) + 1);
5964 value
= intern (buf
);
5966 else if (name_table
!= 0 && name_table
[symbol_num
])
5967 value
= intern (name_table
[symbol_num
]);
5969 #ifdef HAVE_WINDOW_SYSTEM
5972 char *name
= x_get_keysym_name (symbol_num
);
5974 value
= intern (name
);
5981 sprintf (buf
, "key-%d", symbol_num
);
5982 value
= intern (buf
);
5985 if (CONSP (*symbol_table
))
5986 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5988 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5990 /* Fill in the cache entries for this symbol; this also
5991 builds the Qevent_symbol_elements property, which the user
5993 apply_modifiers (modifiers
& click_modifier
, value
);
5994 Fput (value
, Qevent_kind
, symbol_kind
);
5997 /* Apply modifiers to that symbol. */
5998 return apply_modifiers (modifiers
, value
);
6001 /* Convert a list that represents an event type,
6002 such as (ctrl meta backspace), into the usual representation of that
6003 event type as a number or a symbol. */
6005 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6006 doc
: /* Convert the event description list EVENT-DESC to an event type.
6007 EVENT-DESC should contain one base event type (a character or symbol)
6008 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6009 drag, down, double or triple). The base must be last.
6010 The return value is an event type (a character or symbol) which
6011 has the same base event type and all the specified modifiers. */)
6013 Lisp_Object event_desc
;
6021 while (CONSP (rest
))
6029 /* Given a symbol, see if it is a modifier name. */
6030 if (SYMBOLP (elt
) && CONSP (rest
))
6031 this = parse_solitary_modifier (elt
);
6035 else if (!NILP (base
))
6036 error ("Two bases given in one event");
6042 /* Let the symbol A refer to the character A. */
6043 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6044 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6046 if (INTEGERP (base
))
6048 /* Turn (shift a) into A. */
6049 if ((modifiers
& shift_modifier
) != 0
6050 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6052 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6053 modifiers
&= ~shift_modifier
;
6056 /* Turn (control a) into C-a. */
6057 if (modifiers
& ctrl_modifier
)
6058 return make_number ((modifiers
& ~ctrl_modifier
)
6059 | make_ctrl_char (XINT (base
)));
6061 return make_number (modifiers
| XINT (base
));
6063 else if (SYMBOLP (base
))
6064 return apply_modifiers (modifiers
, base
);
6067 error ("Invalid base event");
6072 /* Try to recognize SYMBOL as a modifier name.
6073 Return the modifier flag bit, or 0 if not recognized. */
6076 parse_solitary_modifier (symbol
)
6079 Lisp_Object name
= SYMBOL_NAME (symbol
);
6081 switch (SREF (name
, 0))
6083 #define SINGLE_LETTER_MOD(BIT) \
6084 if (SBYTES (name) == 1) \
6087 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6088 if (LEN == SBYTES (name) \
6089 && ! strncmp (SDATA (name), NAME, LEN)) \
6093 SINGLE_LETTER_MOD (alt_modifier
);
6097 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6101 SINGLE_LETTER_MOD (ctrl_modifier
);
6105 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6106 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6110 SINGLE_LETTER_MOD (hyper_modifier
);
6114 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6118 SINGLE_LETTER_MOD (meta_modifier
);
6122 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6126 SINGLE_LETTER_MOD (shift_modifier
);
6130 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6131 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6132 SINGLE_LETTER_MOD (super_modifier
);
6136 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6137 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6138 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6142 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6145 #undef SINGLE_LETTER_MOD
6146 #undef MULTI_LETTER_MOD
6152 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6153 Such a list is not valid as an event,
6154 but it can be a Lucid-style event type list. */
6157 lucid_event_type_list_p (object
)
6162 if (! CONSP (object
))
6165 if (EQ (XCAR (object
), Qhelp_echo
)
6166 || EQ (XCAR (object
), Qvertical_line
)
6167 || EQ (XCAR (object
), Qmode_line
)
6168 || EQ (XCAR (object
), Qheader_line
))
6171 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6175 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6182 /* Store into *addr a value nonzero if terminal input chars are available.
6183 Serves the purpose of ioctl (0, FIONREAD, addr)
6184 but works even if FIONREAD does not exist.
6185 (In fact, this may actually read some input.)
6187 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6188 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6191 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6196 /* First of all, have we already counted some input? */
6197 *addr
= (!NILP (Vquit_flag
)
6198 || readable_filtered_events (do_timers_now
, filter_events
));
6200 /* If input is being read as it arrives, and we have none, there is none. */
6201 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6204 /* Try to read some input and see how much we get. */
6206 *addr
= (!NILP (Vquit_flag
)
6207 || readable_filtered_events (do_timers_now
, filter_events
));
6210 /* Store into *addr a value nonzero if terminal input chars are available.
6211 Serves the purpose of ioctl (0, FIONREAD, addr)
6212 but works even if FIONREAD does not exist.
6213 (In fact, this may actually read some input.)
6215 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6218 get_input_pending (addr
, do_timers_now
)
6222 get_filtered_input_pending (addr
, do_timers_now
, 0);
6225 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6228 gobble_input (expected
)
6233 if (interrupt_input
)
6236 mask
= sigblock (sigmask (SIGIO
));
6237 read_avail_input (expected
);
6241 #ifdef POLL_FOR_INPUT
6242 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6245 mask
= sigblock (sigmask (SIGALRM
));
6246 read_avail_input (expected
);
6252 read_avail_input (expected
);
6256 /* Put a BUFFER_SWITCH_EVENT in the buffer
6257 so that read_key_sequence will notice the new current buffer. */
6260 record_asynch_buffer_change ()
6262 struct input_event event
;
6265 event
.kind
= BUFFER_SWITCH_EVENT
;
6266 event
.frame_or_window
= Qnil
;
6270 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6271 The purpose of the event is to make read_key_sequence look up the
6272 keymaps again. If we aren't in read_key_sequence, we don't need one,
6273 and the event could cause trouble by messing up (input-pending-p). */
6274 tem
= Fwaiting_for_user_input_p ();
6278 /* We never need these events if we have no asynchronous subprocesses. */
6282 /* Make sure no interrupt happens while storing the event. */
6284 if (interrupt_input
)
6287 mask
= sigblock (sigmask (SIGIO
));
6288 kbd_buffer_store_event (&event
);
6295 kbd_buffer_store_event (&event
);
6302 /* Read any terminal input already buffered up by the system
6303 into the kbd_buffer, but do not wait.
6305 EXPECTED should be nonzero if the caller knows there is some input.
6307 Except on VMS, all input is read by this function.
6308 If interrupt_input is nonzero, this function MUST be called
6309 only when SIGIO is blocked.
6311 Returns the number of keyboard chars read, or -1 meaning
6312 this is a bad time to try to read input. */
6315 read_avail_input (expected
)
6318 struct input_event buf
[KBD_BUFFER_SIZE
];
6322 if (read_socket_hook
)
6323 /* No need for FIONREAD or fcntl; just say don't wait. */
6324 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6327 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6328 the kbd_buffer can really hold. That may prevent loss
6329 of characters on some systems when input is stuffed at us. */
6330 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6333 /* Determine how many characters we should *try* to read. */
6336 #else /* not WINDOWSNT */
6338 n_to_read
= dos_keysns ();
6341 #else /* not MSDOS */
6343 /* Find out how much input is available. */
6344 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6345 /* Formerly simply reported no input, but that sometimes led to
6346 a failure of Emacs to terminate.
6347 SIGHUP seems appropriate if we can't reach the terminal. */
6348 /* ??? Is it really right to send the signal just to this process
6349 rather than to the whole process group?
6350 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6351 kill (getpid (), SIGHUP
);
6354 if (n_to_read
> sizeof cbuf
)
6355 n_to_read
= sizeof cbuf
;
6356 #else /* no FIONREAD */
6357 #if defined (USG) || defined (DGUX)
6358 /* Read some input if available, but don't wait. */
6359 n_to_read
= sizeof cbuf
;
6360 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6365 #endif /* not MSDOS */
6366 #endif /* not WINDOWSNT */
6368 /* Now read; for one reason or another, this will not block.
6369 NREAD is set to the number of chars read. */
6373 cbuf
[0] = dos_keyread ();
6376 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6378 /* POSIX infers that processes which are not in the session leader's
6379 process group won't get SIGHUP's at logout time. BSDI adheres to
6380 this part standard and returns -1 from read (0) with errno==EIO
6381 when the control tty is taken away.
6382 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6383 if (nread
== -1 && errno
== EIO
)
6385 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6386 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6387 This looks incorrect, but it isn't, because _BSD causes
6388 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6389 and that causes a value other than 0 when there is no input. */
6395 /* We used to retry the read if it was interrupted.
6396 But this does the wrong thing when O_NDELAY causes
6397 an EAGAIN error. Does anybody know of a situation
6398 where a retry is actually needed? */
6400 nread
< 0 && (errno
== EAGAIN
6414 #if defined (USG) || defined (DGUX)
6415 fcntl (input_fd
, F_SETFL
, 0);
6416 #endif /* USG or DGUX */
6417 #endif /* no FIONREAD */
6418 for (i
= 0; i
< nread
; i
++)
6420 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6421 buf
[i
].modifiers
= 0;
6422 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6423 buf
[i
].modifiers
= meta_modifier
;
6427 buf
[i
].code
= cbuf
[i
];
6428 buf
[i
].frame_or_window
= selected_frame
;
6433 /* Scan the chars for C-g and store them in kbd_buffer. */
6434 for (i
= 0; i
< nread
; i
++)
6436 kbd_buffer_store_event (&buf
[i
]);
6437 /* Don't look at input that follows a C-g too closely.
6438 This reduces lossage due to autorepeat on C-g. */
6439 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6440 && buf
[i
].code
== quit_char
)
6446 #endif /* not VMS */
6448 #ifdef SIGIO /* for entire page */
6449 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6452 input_available_signal (signo
)
6455 /* Must preserve main program's value of errno. */
6456 int old_errno
= errno
;
6458 extern int select_alarmed
;
6461 #if defined (USG) && !defined (POSIX_SIGNALS)
6462 /* USG systems forget handlers when they are used;
6463 must reestablish each time */
6464 signal (signo
, input_available_signal
);
6471 if (input_available_clear_time
)
6472 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6477 nread
= read_avail_input (1);
6478 /* -1 means it's not ok to read the input now.
6479 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6480 0 means there was no keyboard input available. */
6485 select_alarmed
= 1; /* Force the select emulator back to life */
6496 /* Send ourselves a SIGIO.
6498 This function exists so that the UNBLOCK_INPUT macro in
6499 blockinput.h can have some way to take care of input we put off
6500 dealing with, without assuming that every file which uses
6501 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6503 reinvoke_input_signal ()
6506 kill (getpid (), SIGIO
);
6512 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6513 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6515 /* These variables hold the vector under construction within
6516 menu_bar_items and its subroutines, and the current index
6517 for storing into that vector. */
6518 static Lisp_Object menu_bar_items_vector
;
6519 static int menu_bar_items_index
;
6521 /* Return a vector of menu items for a menu bar, appropriate
6522 to the current buffer. Each item has three elements in the vector:
6525 OLD is an old vector we can optionally reuse, or nil. */
6528 menu_bar_items (old
)
6531 /* The number of keymaps we're scanning right now, and the number of
6532 keymaps we have allocated space for. */
6535 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6536 in the current keymaps, or nil where it is not a prefix. */
6539 Lisp_Object def
, tail
;
6548 struct gcpro gcpro1
;
6550 /* In order to build the menus, we need to call the keymap
6551 accessors. They all call QUIT. But this function is called
6552 during redisplay, during which a quit is fatal. So inhibit
6553 quitting while building the menus.
6554 We do this instead of specbind because (1) errors will clear it anyway
6555 and (2) this avoids risk of specpdl overflow. */
6556 oquit
= Vinhibit_quit
;
6560 menu_bar_items_vector
= old
;
6562 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6563 menu_bar_items_index
= 0;
6565 GCPRO1 (menu_bar_items_vector
);
6567 /* Build our list of keymaps.
6568 If we recognize a function key and replace its escape sequence in
6569 keybuf with its symbol, or if the sequence starts with a mouse
6570 click and we need to switch buffers, we jump back here to rebuild
6571 the initial keymaps from the current buffer. */
6575 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6576 if (!NILP (Voverriding_local_map_menu_flag
))
6578 /* Yes, use them (if non-nil) as well as the global map. */
6579 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6581 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6582 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6583 if (!NILP (Voverriding_local_map
))
6584 maps
[nmaps
++] = Voverriding_local_map
;
6588 /* No, so use major and minor mode keymaps and keymap property.
6589 Note that menu-bar bindings in the local-map and keymap
6590 properties may not work reliable, as they are only
6591 recognized when the menu-bar (or mode-line) is updated,
6592 which does not normally happen after every command. */
6595 nminor
= current_minor_maps (NULL
, &tmaps
);
6596 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6598 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6599 maps
[nmaps
++] = tem
;
6600 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6602 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6604 maps
[nmaps
++] = current_global_map
;
6607 /* Look up in each map the dummy prefix key `menu-bar'. */
6611 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6612 if (!NILP (maps
[mapno
]))
6614 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6617 menu_bar_one_keymap (def
);
6620 /* Move to the end those items that should be at the end. */
6622 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6625 int end
= menu_bar_items_index
;
6627 for (i
= 0; i
< end
; i
+= 4)
6628 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6630 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6631 /* Move the item at index I to the end,
6632 shifting all the others forward. */
6633 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6634 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6635 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6636 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6638 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6639 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6640 (end
- i
- 4) * sizeof (Lisp_Object
));
6641 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6642 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6643 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6644 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6649 /* Add nil, nil, nil, nil at the end. */
6650 i
= menu_bar_items_index
;
6651 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6654 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6655 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6656 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6657 menu_bar_items_vector
= tem
;
6659 /* Add this item. */
6660 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6661 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6662 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6663 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6664 menu_bar_items_index
= i
;
6666 Vinhibit_quit
= oquit
;
6668 return menu_bar_items_vector
;
6671 /* Scan one map KEYMAP, accumulating any menu items it defines
6672 in menu_bar_items_vector. */
6674 static Lisp_Object menu_bar_one_keymap_changed_items
;
6677 menu_bar_one_keymap (keymap
)
6680 Lisp_Object tail
, item
;
6682 menu_bar_one_keymap_changed_items
= Qnil
;
6684 /* Loop over all keymap entries that have menu strings. */
6685 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6689 menu_bar_item (XCAR (item
), XCDR (item
));
6690 else if (VECTORP (item
))
6692 /* Loop over the char values represented in the vector. */
6693 int len
= XVECTOR (item
)->size
;
6695 for (c
= 0; c
< len
; c
++)
6697 Lisp_Object character
;
6698 XSETFASTINT (character
, c
);
6699 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6705 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6706 If there's already an item for KEY, add this DEF to it. */
6708 Lisp_Object item_properties
;
6711 menu_bar_item (key
, item
)
6712 Lisp_Object key
, item
;
6714 struct gcpro gcpro1
;
6718 if (EQ (item
, Qundefined
))
6720 /* If a map has an explicit `undefined' as definition,
6721 discard any previously made menu bar item. */
6723 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6724 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6726 if (menu_bar_items_index
> i
+ 4)
6727 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6728 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6729 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6730 menu_bar_items_index
-= 4;
6734 /* If this keymap has already contributed to this KEY,
6735 don't contribute to it a second time. */
6736 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6737 if (!NILP (tem
) || NILP (item
))
6740 menu_bar_one_keymap_changed_items
6741 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6743 /* We add to menu_bar_one_keymap_changed_items before doing the
6744 parse_menu_item, so that if it turns out it wasn't a menu item,
6745 it still correctly hides any further menu item. */
6747 i
= parse_menu_item (item
, 0, 1);
6752 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6754 /* Find any existing item for this KEY. */
6755 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6756 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6759 /* If we did not find this KEY, add it at the end. */
6760 if (i
== menu_bar_items_index
)
6762 /* If vector is too small, get a bigger one. */
6763 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6766 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6767 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6768 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6769 menu_bar_items_vector
= tem
;
6772 /* Add this item. */
6773 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6774 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6775 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6776 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6777 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6778 menu_bar_items_index
= i
;
6780 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6784 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6785 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6789 /* This is used as the handler when calling menu_item_eval_property. */
6791 menu_item_eval_property_1 (arg
)
6794 /* If we got a quit from within the menu computation,
6795 quit all the way out of it. This takes care of C-] in the debugger. */
6796 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6797 Fsignal (Qquit
, Qnil
);
6802 /* Evaluate an expression and return the result (or nil if something
6803 went wrong). Used to evaluate dynamic parts of menu items. */
6805 menu_item_eval_property (sexpr
)
6808 int count
= SPECPDL_INDEX ();
6810 specbind (Qinhibit_redisplay
, Qt
);
6811 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6812 menu_item_eval_property_1
);
6813 return unbind_to (count
, val
);
6816 /* This function parses a menu item and leaves the result in the
6817 vector item_properties.
6818 ITEM is a key binding, a possible menu item.
6819 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6820 evaluate dynamic expressions in the menu item.
6821 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6823 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6824 parse_menu_item returns true if the item is a menu item and false
6828 parse_menu_item (item
, notreal
, inmenubar
)
6830 int notreal
, inmenubar
;
6832 Lisp_Object def
, tem
, item_string
, start
;
6833 Lisp_Object cachelist
;
6835 Lisp_Object keyhint
;
6846 /* Create item_properties vector if necessary. */
6847 if (NILP (item_properties
))
6849 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6851 /* Initialize optional entries. */
6852 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6853 AREF (item_properties
, i
) = Qnil
;
6854 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
6856 /* Save the item here to protect it from GC. */
6857 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
6859 item_string
= XCAR (item
);
6863 if (STRINGP (item_string
))
6865 /* Old format menu item. */
6866 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6868 /* Maybe help string. */
6869 if (CONSP (item
) && STRINGP (XCAR (item
)))
6871 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6876 /* Maybe key binding cache. */
6877 if (CONSP (item
) && CONSP (XCAR (item
))
6878 && (NILP (XCAR (XCAR (item
)))
6879 || VECTORP (XCAR (XCAR (item
)))))
6881 cachelist
= XCAR (item
);
6885 /* This is the real definition--the function to run. */
6886 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
6888 /* Get enable property, if any. */
6891 tem
= Fget (item
, Qmenu_enable
);
6893 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6896 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6898 /* New format menu item. */
6899 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
6900 start
= XCDR (item
);
6903 /* We have a real binding. */
6904 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
6906 item
= XCDR (start
);
6907 /* Is there a cache list with key equivalences. */
6908 if (CONSP (item
) && CONSP (XCAR (item
)))
6910 cachelist
= XCAR (item
);
6914 /* Parse properties. */
6915 while (CONSP (item
) && CONSP (XCDR (item
)))
6920 if (EQ (tem
, QCenable
))
6921 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
6922 else if (EQ (tem
, QCvisible
) && !notreal
)
6924 /* If got a visible property and that evaluates to nil
6925 then ignore this item. */
6926 tem
= menu_item_eval_property (XCAR (item
));
6930 else if (EQ (tem
, QChelp
))
6931 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6932 else if (EQ (tem
, QCfilter
))
6934 else if (EQ (tem
, QCkey_sequence
))
6937 if (NILP (cachelist
)
6938 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
6939 /* Be GC protected. Set keyhint to item instead of tem. */
6942 else if (EQ (tem
, QCkeys
))
6945 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
6946 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6948 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
6953 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6955 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6957 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
6964 else if (inmenubar
|| !NILP (start
))
6968 return 0; /* not a menu item */
6970 /* If item string is not a string, evaluate it to get string.
6971 If we don't get a string, skip this item. */
6972 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
6973 if (!(STRINGP (item_string
) || notreal
))
6975 item_string
= menu_item_eval_property (item_string
);
6976 if (!STRINGP (item_string
))
6978 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6981 /* If got a filter apply it on definition. */
6982 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6985 def
= menu_item_eval_property (list2 (XCAR (filter
),
6986 list2 (Qquote
, def
)));
6988 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
6991 /* Enable or disable selection of item. */
6992 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
6998 tem
= menu_item_eval_property (tem
);
6999 if (inmenubar
&& NILP (tem
))
7000 return 0; /* Ignore disabled items in menu bar. */
7001 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7004 /* If we got no definition, this item is just unselectable text which
7005 is OK in a submenu but not in the menubar. */
7007 return (inmenubar
? 0 : 1);
7009 /* See if this is a separate pane or a submenu. */
7010 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7011 tem
= get_keymap (def
, 0, 1);
7012 /* For a subkeymap, just record its details and exit. */
7015 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7016 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7020 /* At the top level in the menu bar, do likewise for commands also.
7021 The menu bar does not display equivalent key bindings anyway.
7022 ITEM_PROPERTY_DEF is already set up properly. */
7026 /* This is a command. See if there is an equivalent key binding. */
7027 if (NILP (cachelist
))
7029 /* We have to create a cachelist. */
7030 CHECK_IMPURE (start
);
7031 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7032 cachelist
= XCAR (XCDR (start
));
7034 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7035 if (!NILP (keyhint
))
7037 XSETCAR (cachelist
, XCAR (keyhint
));
7040 else if (STRINGP (tem
))
7042 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7043 XSETCAR (cachelist
, Qt
);
7047 tem
= XCAR (cachelist
);
7054 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7056 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7059 def
= XCAR (prefix
);
7060 prefix
= XCDR (prefix
);
7063 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7065 if (!update_menu_bindings
)
7067 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7069 if (newcache
/* Always check first time. */
7070 /* Should we check everything when precomputing key
7072 /* If something had no key binding before, don't recheck it
7073 because that is too slow--except if we have a list of
7074 rebound commands in Vdefine_key_rebound_commands, do
7075 recheck any command that appears in that list. */
7076 || (CONSP (Vdefine_key_rebound_commands
)
7077 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7080 /* We had a saved key. Is it still bound to the command? */
7083 /* If the command is an alias for another
7084 (such as lmenu.el set it up), check if the
7085 original command matches the cached command. */
7086 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7087 chkcache
= 1; /* Need to recompute key binding. */
7091 /* Recompute equivalent key binding. If the command is an alias
7092 for another (such as lmenu.el set it up), see if the original
7093 command name has equivalent keys. Otherwise look up the
7094 specified command itself. We don't try both, because that
7095 makes lmenu menus slow. */
7097 && SYMBOLP (XSYMBOL (def
)->function
)
7098 && ! NILP (Fget (def
, Qmenu_alias
)))
7099 def
= XSYMBOL (def
)->function
;
7100 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7101 XSETCAR (cachelist
, tem
);
7104 XSETCDR (cachelist
, Qnil
);
7108 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7110 tem
= XCAR (cachelist
);
7114 newcache
= chkcache
;
7117 tem
= Fkey_description (tem
);
7120 if (STRINGP (XCAR (prefix
)))
7121 tem
= concat2 (XCAR (prefix
), tem
);
7122 if (STRINGP (XCDR (prefix
)))
7123 tem
= concat2 (tem
, XCDR (prefix
));
7125 XSETCDR (cachelist
, tem
);
7129 tem
= XCDR (cachelist
);
7130 if (newcache
&& !NILP (tem
))
7132 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7133 XSETCDR (cachelist
, tem
);
7136 /* If we only want to precompute equivalent key bindings, stop here. */
7140 /* If we have an equivalent key binding, use that. */
7141 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7143 /* Include this when menu help is implemented.
7144 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7145 if (!(NILP (tem) || STRINGP (tem)))
7147 tem = menu_item_eval_property (tem);
7150 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7154 /* Handle radio buttons or toggle boxes. */
7155 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7157 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7158 = menu_item_eval_property (tem
);
7165 /***********************************************************************
7167 ***********************************************************************/
7169 /* A vector holding tool bar items while they are parsed in function
7170 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7173 static Lisp_Object tool_bar_items_vector
;
7175 /* A vector holding the result of parse_tool_bar_item. Layout is like
7176 the one for a single item in tool_bar_items_vector. */
7178 static Lisp_Object tool_bar_item_properties
;
7180 /* Next free index in tool_bar_items_vector. */
7182 static int ntool_bar_items
;
7184 /* The symbols `tool-bar', and `:image'. */
7186 extern Lisp_Object Qtool_bar
;
7187 Lisp_Object QCimage
;
7189 /* Function prototypes. */
7191 static void init_tool_bar_items
P_ ((Lisp_Object
));
7192 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7193 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7194 static void append_tool_bar_item
P_ ((void));
7197 /* Return a vector of tool bar items for keymaps currently in effect.
7198 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7199 tool bar items found. */
7202 tool_bar_items (reuse
, nitems
)
7213 /* In order to build the menus, we need to call the keymap
7214 accessors. They all call QUIT. But this function is called
7215 during redisplay, during which a quit is fatal. So inhibit
7216 quitting while building the menus. We do this instead of
7217 specbind because (1) errors will clear it anyway and (2) this
7218 avoids risk of specpdl overflow. */
7219 oquit
= Vinhibit_quit
;
7222 /* Initialize tool_bar_items_vector and protect it from GC. */
7223 init_tool_bar_items (reuse
);
7225 /* Build list of keymaps in maps. Set nmaps to the number of maps
7228 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7229 if (!NILP (Voverriding_local_map_menu_flag
))
7231 /* Yes, use them (if non-nil) as well as the global map. */
7232 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7234 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7235 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7236 if (!NILP (Voverriding_local_map
))
7237 maps
[nmaps
++] = Voverriding_local_map
;
7241 /* No, so use major and minor mode keymaps and keymap property.
7242 Note that tool-bar bindings in the local-map and keymap
7243 properties may not work reliable, as they are only
7244 recognized when the tool-bar (or mode-line) is updated,
7245 which does not normally happen after every command. */
7248 nminor
= current_minor_maps (NULL
, &tmaps
);
7249 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7251 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7252 maps
[nmaps
++] = tem
;
7253 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7255 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7258 /* Add global keymap at the end. */
7259 maps
[nmaps
++] = current_global_map
;
7261 /* Process maps in reverse order and look up in each map the prefix
7263 for (i
= nmaps
- 1; i
>= 0; --i
)
7264 if (!NILP (maps
[i
]))
7268 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7273 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7274 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7276 Lisp_Object keydef
= XCAR (tail
);
7278 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7283 Vinhibit_quit
= oquit
;
7284 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7285 return tool_bar_items_vector
;
7289 /* Process the definition of KEY which is DEF. */
7292 process_tool_bar_item (key
, def
)
7293 Lisp_Object key
, def
;
7296 extern Lisp_Object Qundefined
;
7297 struct gcpro gcpro1
, gcpro2
;
7299 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7303 if (EQ (def
, Qundefined
))
7305 /* If a map has an explicit `undefined' as definition,
7306 discard any previously made item. */
7307 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7309 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7311 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7313 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7314 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7315 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7316 * sizeof (Lisp_Object
)));
7317 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7322 else if (parse_tool_bar_item (key
, def
))
7323 /* Append a new tool bar item to tool_bar_items_vector. Accept
7324 more than one definition for the same key. */
7325 append_tool_bar_item ();
7331 /* Parse a tool bar item specification ITEM for key KEY and return the
7332 result in tool_bar_item_properties. Value is zero if ITEM is
7335 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7337 CAPTION is the caption of the item, If it's not a string, it is
7338 evaluated to get a string.
7340 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7341 as binding are currently ignored.
7343 The following properties are recognized:
7347 FORM is evaluated and specifies whether the tool bar item is
7348 enabled or disabled.
7352 FORM is evaluated and specifies whether the tool bar item is visible.
7354 - `:filter FUNCTION'
7356 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7357 result is stored as the new binding.
7359 - `:button (TYPE SELECTED)'
7361 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7362 and specifies whether the button is selected (pressed) or not.
7366 IMAGES is either a single image specification or a vector of four
7367 image specifications. See enum tool_bar_item_images.
7369 - `:help HELP-STRING'.
7371 Gives a help string to display for the tool bar item. */
7374 parse_tool_bar_item (key
, item
)
7375 Lisp_Object key
, item
;
7377 /* Access slot with index IDX of vector tool_bar_item_properties. */
7378 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7380 Lisp_Object filter
= Qnil
;
7381 Lisp_Object caption
;
7384 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7385 Rule out items that aren't lists, don't start with
7386 `menu-item' or whose rest following `tool-bar-item' is not a
7389 || !EQ (XCAR (item
), Qmenu_item
)
7390 || (item
= XCDR (item
),
7394 /* Create tool_bar_item_properties vector if necessary. Reset it to
7396 if (VECTORP (tool_bar_item_properties
))
7398 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7402 tool_bar_item_properties
7403 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7406 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7407 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7409 /* Get the caption of the item. If the caption is not a string,
7410 evaluate it to get a string. If we don't get a string, skip this
7412 caption
= XCAR (item
);
7413 if (!STRINGP (caption
))
7415 caption
= menu_item_eval_property (caption
);
7416 if (!STRINGP (caption
))
7419 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7421 /* Give up if rest following the caption is not a list. */
7426 /* Store the binding. */
7427 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7430 /* Ignore cached key binding, if any. */
7431 if (CONSP (item
) && CONSP (XCAR (item
)))
7434 /* Process the rest of the properties. */
7435 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7437 Lisp_Object key
, value
;
7440 value
= XCAR (XCDR (item
));
7442 if (EQ (key
, QCenable
))
7443 /* `:enable FORM'. */
7444 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7445 else if (EQ (key
, QCvisible
))
7447 /* `:visible FORM'. If got a visible property and that
7448 evaluates to nil then ignore this item. */
7449 if (NILP (menu_item_eval_property (value
)))
7452 else if (EQ (key
, QChelp
))
7453 /* `:help HELP-STRING'. */
7454 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7455 else if (EQ (key
, QCfilter
))
7456 /* ':filter FORM'. */
7458 else if (EQ (key
, QCbutton
) && CONSP (value
))
7460 /* `:button (TYPE . SELECTED)'. */
7461 Lisp_Object type
, selected
;
7463 type
= XCAR (value
);
7464 selected
= XCDR (value
);
7465 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7467 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7468 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7471 else if (EQ (key
, QCimage
)
7473 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7474 /* Value is either a single image specification or a vector
7475 of 4 such specifications for the different button states. */
7476 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7479 /* If got a filter apply it on binding. */
7481 PROP (TOOL_BAR_ITEM_BINDING
)
7482 = menu_item_eval_property (list2 (filter
,
7484 PROP (TOOL_BAR_ITEM_BINDING
))));
7486 /* See if the binding is a keymap. Give up if it is. */
7487 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7490 /* Enable or disable selection of item. */
7491 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7492 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7493 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7495 /* Handle radio buttons or toggle boxes. */
7496 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7497 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7498 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7506 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7507 that can be reused. */
7510 init_tool_bar_items (reuse
)
7513 if (VECTORP (reuse
))
7514 tool_bar_items_vector
= reuse
;
7516 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7517 ntool_bar_items
= 0;
7521 /* Append parsed tool bar item properties from
7522 tool_bar_item_properties */
7525 append_tool_bar_item ()
7527 Lisp_Object
*to
, *from
;
7529 /* Enlarge tool_bar_items_vector if necessary. */
7530 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7531 >= XVECTOR (tool_bar_items_vector
)->size
)
7533 Lisp_Object new_vector
;
7534 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7536 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7537 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7538 XVECTOR (new_vector
)->contents
,
7539 old_size
* sizeof (Lisp_Object
));
7540 tool_bar_items_vector
= new_vector
;
7543 /* Append entries from tool_bar_item_properties to the end of
7544 tool_bar_items_vector. */
7545 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7546 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7547 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7548 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7555 /* Read a character using menus based on maps in the array MAPS.
7556 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7557 Return t if we displayed a menu but the user rejected it.
7559 PREV_EVENT is the previous input event, or nil if we are reading
7560 the first event of a key sequence.
7562 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7563 if we used a mouse menu to read the input, or zero otherwise. If
7564 USED_MOUSE_MENU is null, we don't dereference it.
7566 The prompting is done based on the prompt-string of the map
7567 and the strings associated with various map elements.
7569 This can be done with X menus or with menus put in the minibuf.
7570 These are done in different ways, depending on how the input will be read.
7571 Menus using X are done after auto-saving in read-char, getting the input
7572 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7573 and do auto-saving in the inner call of read_char. */
7576 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7579 Lisp_Object prev_event
;
7580 int *used_mouse_menu
;
7583 register Lisp_Object name
;
7585 if (used_mouse_menu
)
7586 *used_mouse_menu
= 0;
7588 /* Use local over global Menu maps */
7590 if (! menu_prompting
)
7593 /* Optionally disregard all but the global map. */
7594 if (inhibit_local_menu_bar_menus
)
7596 maps
+= (nmaps
- 1);
7600 /* Get the menu name from the first map that has one (a prompt string). */
7601 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7603 name
= Fkeymap_prompt (maps
[mapno
]);
7608 /* If we don't have any menus, just read a character normally. */
7609 if (!STRINGP (name
))
7613 /* If we got to this point via a mouse click,
7614 use a real menu for mouse selection. */
7615 if (EVENT_HAS_PARAMETERS (prev_event
)
7616 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7617 && !EQ (XCAR (prev_event
), Qtool_bar
))
7619 /* Display the menu and get the selection. */
7620 Lisp_Object
*realmaps
7621 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7625 /* Use the maps that are not nil. */
7626 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7627 if (!NILP (maps
[mapno
]))
7628 realmaps
[nmaps1
++] = maps
[mapno
];
7630 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7635 record_menu_key (XCAR (value
));
7637 /* If we got multiple events, unread all but
7639 There is no way to prevent those unread events
7640 from showing up later in last_nonmenu_event.
7641 So turn symbol and integer events into lists,
7642 to indicate that they came from a mouse menu,
7643 so that when present in last_nonmenu_event
7644 they won't confuse things. */
7645 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7647 record_menu_key (XCAR (tem
));
7648 if (SYMBOLP (XCAR (tem
))
7649 || INTEGERP (XCAR (tem
)))
7650 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7653 /* If we got more than one event, put all but the first
7654 onto this list to be read later.
7655 Return just the first event now. */
7656 Vunread_command_events
7657 = nconc2 (XCDR (value
), Vunread_command_events
);
7658 value
= XCAR (value
);
7660 else if (NILP (value
))
7662 if (used_mouse_menu
)
7663 *used_mouse_menu
= 1;
7666 #endif /* HAVE_MENUS */
7670 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7671 We make this bigger when necessary, and never free it. */
7672 static char *read_char_minibuf_menu_text
;
7673 /* Size of that buffer. */
7674 static int read_char_minibuf_menu_width
;
7677 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7683 register Lisp_Object name
;
7685 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7688 Lisp_Object rest
, vector
;
7694 if (! menu_prompting
)
7697 /* Make sure we have a big enough buffer for the menu text. */
7698 if (read_char_minibuf_menu_text
== 0)
7700 read_char_minibuf_menu_width
= width
+ 4;
7701 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7703 else if (width
+ 4 > read_char_minibuf_menu_width
)
7705 read_char_minibuf_menu_width
= width
+ 4;
7706 read_char_minibuf_menu_text
7707 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7709 menu
= read_char_minibuf_menu_text
;
7711 /* Get the menu name from the first map that has one (a prompt string). */
7712 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7714 name
= Fkeymap_prompt (maps
[mapno
]);
7719 /* If we don't have any menus, just read a character normally. */
7720 if (!STRINGP (name
))
7723 /* Prompt string always starts with map's prompt, and a space. */
7724 strcpy (menu
, SDATA (name
));
7725 nlength
= SBYTES (name
);
7726 menu
[nlength
++] = ':';
7727 menu
[nlength
++] = ' ';
7730 /* Start prompting at start of first map. */
7734 /* Present the documented bindings, a line at a time. */
7741 Lisp_Object orig_defn_macro
;
7743 /* Loop over elements of map. */
7748 /* If reached end of map, start at beginning of next map. */
7752 /* At end of last map, wrap around to first map if just starting,
7753 or end this line if already have something on it. */
7757 if (notfirst
|| nobindings
) break;
7762 /* Look at the next element of the map. */
7764 elt
= XVECTOR (vector
)->contents
[idx
];
7766 elt
= Fcar_safe (rest
);
7768 if (idx
< 0 && VECTORP (elt
))
7770 /* If we found a dense table in the keymap,
7771 advanced past it, but start scanning its contents. */
7772 rest
= Fcdr_safe (rest
);
7778 /* An ordinary element. */
7779 Lisp_Object event
, tem
;
7783 event
= Fcar_safe (elt
); /* alist */
7784 elt
= Fcdr_safe (elt
);
7788 XSETINT (event
, idx
); /* vector */
7791 /* Ignore the element if it has no prompt string. */
7792 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7794 /* 1 if the char to type matches the string. */
7796 Lisp_Object upcased_event
, downcased_event
;
7797 Lisp_Object desc
= Qnil
;
7799 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7801 upcased_event
= Fupcase (event
);
7802 downcased_event
= Fdowncase (event
);
7803 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
7804 || XINT (downcased_event
) == SREF (s
, 0));
7806 desc
= Fsingle_key_description (event
, Qnil
);
7808 #if 0 /* It is redundant to list the equivalent key bindings because
7809 the prefix is what the user has already typed. */
7811 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7813 /* Insert equivalent keybinding. */
7814 s
= concat2 (s
, tem
);
7817 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7818 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7820 /* Insert button prefix. */
7821 Lisp_Object selected
7822 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7823 if (EQ (tem
, QCradio
))
7824 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7826 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7827 s
= concat2 (tem
, s
);
7831 /* If we have room for the prompt string, add it to this line.
7832 If this is the first on the line, always add it. */
7833 if ((SCHARS (s
) + i
+ 2
7834 + (char_matches
? 0 : SCHARS (desc
) + 3))
7840 /* Punctuate between strings. */
7843 strcpy (menu
+ i
, ", ");
7849 /* If the char to type doesn't match the string's
7850 first char, explicitly show what char to type. */
7853 /* Add as much of string as fits. */
7854 thiswidth
= SCHARS (desc
);
7855 if (thiswidth
+ i
> width
)
7856 thiswidth
= width
- i
;
7857 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
7859 strcpy (menu
+ i
, " = ");
7863 /* Add as much of string as fits. */
7864 thiswidth
= SCHARS (s
);
7865 if (thiswidth
+ i
> width
)
7866 thiswidth
= width
- i
;
7867 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
7873 /* If this element does not fit, end the line now,
7874 and save the element for the next line. */
7875 strcpy (menu
+ i
, "...");
7880 /* Move past this element. */
7881 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7882 /* Handle reaching end of dense table. */
7887 rest
= Fcdr_safe (rest
);
7891 /* Prompt with that and read response. */
7892 message2_nolog (menu
, strlen (menu
),
7893 ! NILP (current_buffer
->enable_multibyte_characters
));
7895 /* Make believe its not a keyboard macro in case the help char
7896 is pressed. Help characters are not recorded because menu prompting
7897 is not used on replay.
7899 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7900 current_kboard
->defining_kbd_macro
= Qnil
;
7902 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
7903 while (BUFFERP (obj
));
7904 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7906 if (!INTEGERP (obj
))
7911 if (! EQ (obj
, menu_prompt_more_char
)
7912 && (!INTEGERP (menu_prompt_more_char
)
7913 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
7915 if (!NILP (current_kboard
->defining_kbd_macro
))
7916 store_kbd_macro_char (obj
);
7919 /* Help char - go round again */
7923 /* Reading key sequences. */
7925 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7926 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7927 keymap, or nil otherwise. Return the index of the first keymap in
7928 which KEY has any binding, or NMAPS if no map has a binding.
7930 If KEY is a meta ASCII character, treat it like meta-prefix-char
7931 followed by the corresponding non-meta character. Keymaps in
7932 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7935 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7938 NEXT may be the same array as CURRENT. */
7941 follow_key (key
, nmaps
, current
, defs
, next
)
7943 Lisp_Object
*current
, *defs
, *next
;
7946 int i
, first_binding
;
7949 first_binding
= nmaps
;
7950 for (i
= nmaps
- 1; i
>= 0; i
--)
7952 if (! NILP (current
[i
]))
7960 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
7961 if (! NILP (defs
[i
]))
7968 /* Given the set of bindings we've found, produce the next set of maps. */
7969 if (first_binding
< nmaps
)
7970 for (i
= 0; i
< nmaps
; i
++)
7971 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
7973 return first_binding
;
7976 /* Read a sequence of keys that ends with a non prefix character,
7977 storing it in KEYBUF, a buffer of size BUFSIZE.
7979 Return the length of the key sequence stored.
7980 Return -1 if the user rejected a command menu.
7982 Echo starting immediately unless `prompt' is 0.
7984 Where a key sequence ends depends on the currently active keymaps.
7985 These include any minor mode keymaps active in the current buffer,
7986 the current buffer's local map, and the global map.
7988 If a key sequence has no other bindings, we check Vfunction_key_map
7989 to see if some trailing subsequence might be the beginning of a
7990 function key's sequence. If so, we try to read the whole function
7991 key, and substitute its symbolic name into the key sequence.
7993 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7994 `double-' events into similar click events, if that would make them
7995 bound. We try to turn `triple-' events first into `double-' events,
7998 If we get a mouse click in a mode line, vertical divider, or other
7999 non-text area, we treat the click as if it were prefixed by the
8000 symbol denoting that area - `mode-line', `vertical-line', or
8003 If the sequence starts with a mouse click, we read the key sequence
8004 with respect to the buffer clicked on, not the current buffer.
8006 If the user switches frames in the midst of a key sequence, we put
8007 off the switch-frame event until later; the next call to
8008 read_char will return it.
8010 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8011 from the selected window's buffer. */
8014 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8015 can_return_switch_frame
, fix_current_buffer
)
8016 Lisp_Object
*keybuf
;
8019 int dont_downcase_last
;
8020 int can_return_switch_frame
;
8021 int fix_current_buffer
;
8023 volatile Lisp_Object from_string
;
8024 volatile int count
= SPECPDL_INDEX ();
8026 /* How many keys there are in the current key sequence. */
8029 /* The length of the echo buffer when we started reading, and
8030 the length of this_command_keys when we started reading. */
8031 volatile int echo_start
;
8032 volatile int keys_start
;
8034 /* The number of keymaps we're scanning right now, and the number of
8035 keymaps we have allocated space for. */
8037 volatile int nmaps_allocated
= 0;
8039 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8040 the current keymaps. */
8041 Lisp_Object
*volatile defs
= NULL
;
8043 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8044 in the current keymaps, or nil where it is not a prefix. */
8045 Lisp_Object
*volatile submaps
= NULL
;
8047 /* The local map to start out with at start of key sequence. */
8048 volatile Lisp_Object orig_local_map
;
8050 /* The map from the `keymap' property to start out with at start of
8052 volatile Lisp_Object orig_keymap
;
8054 /* 1 if we have already considered switching to the local-map property
8055 of the place where a mouse click occurred. */
8056 volatile int localized_local_map
= 0;
8058 /* The index in defs[] of the first keymap that has a binding for
8059 this key sequence. In other words, the lowest i such that
8060 defs[i] is non-nil. */
8061 volatile int first_binding
;
8062 /* Index of the first key that has no binding.
8063 It is useless to try fkey_start larger than that. */
8064 volatile int first_unbound
;
8066 /* If t < mock_input, then KEYBUF[t] should be read as the next
8069 We use this to recover after recognizing a function key. Once we
8070 realize that a suffix of the current key sequence is actually a
8071 function key's escape sequence, we replace the suffix with the
8072 function key's binding from Vfunction_key_map. Now keybuf
8073 contains a new and different key sequence, so the echo area,
8074 this_command_keys, and the submaps and defs arrays are wrong. In
8075 this situation, we set mock_input to t, set t to 0, and jump to
8076 restart_sequence; the loop will read keys from keybuf up until
8077 mock_input, thus rebuilding the state; and then it will resume
8078 reading characters from the keyboard. */
8079 volatile int mock_input
= 0;
8081 /* If the sequence is unbound in submaps[], then
8082 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
8083 and fkey_map is its binding.
8085 These might be > t, indicating that all function key scanning
8086 should hold off until t reaches them. We do this when we've just
8087 recognized a function key, to avoid searching for the function
8088 key's again in Vfunction_key_map. */
8089 volatile int fkey_start
= 0, fkey_end
= 0;
8090 volatile Lisp_Object fkey_map
;
8092 /* Likewise, for key_translation_map. */
8093 volatile int keytran_start
= 0, keytran_end
= 0;
8094 volatile Lisp_Object keytran_map
;
8096 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8097 we put it off for later. While we're reading, we keep the event here. */
8098 volatile Lisp_Object delayed_switch_frame
;
8100 /* See the comment below... */
8101 #if defined (GOBBLE_FIRST_EVENT)
8102 Lisp_Object first_event
;
8105 volatile Lisp_Object original_uppercase
;
8106 volatile int original_uppercase_position
= -1;
8108 /* Gets around Microsoft compiler limitations. */
8111 struct buffer
*starting_buffer
;
8113 /* List of events for which a fake prefix key has been generated. */
8114 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8116 #if defined (GOBBLE_FIRST_EVENT)
8120 struct gcpro gcpro1
;
8122 GCPRO1 (fake_prefixed_keys
);
8123 raw_keybuf_count
= 0;
8125 last_nonmenu_event
= Qnil
;
8127 delayed_switch_frame
= Qnil
;
8128 fkey_map
= Vfunction_key_map
;
8129 keytran_map
= Vkey_translation_map
;
8131 /* If there is no function-key-map, turn off function key scanning. */
8132 if (!KEYMAPP (Vfunction_key_map
))
8133 fkey_start
= fkey_end
= bufsize
+ 1;
8135 /* If there is no key-translation-map, turn off scanning. */
8136 if (!KEYMAPP (Vkey_translation_map
))
8137 keytran_start
= keytran_end
= bufsize
+ 1;
8142 echo_prompt (prompt
);
8143 else if (cursor_in_echo_area
8144 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8145 && NILP (Fzerop (Vecho_keystrokes
)))
8146 /* This doesn't put in a dash if the echo buffer is empty, so
8147 you don't always see a dash hanging out in the minibuffer. */
8151 /* Record the initial state of the echo area and this_command_keys;
8152 we will need to restore them if we replay a key sequence. */
8154 echo_start
= echo_length ();
8155 keys_start
= this_command_key_count
;
8156 this_single_command_key_start
= keys_start
;
8158 #if defined (GOBBLE_FIRST_EVENT)
8159 /* This doesn't quite work, because some of the things that read_char
8160 does cannot safely be bypassed. It seems too risky to try to make
8163 /* Read the first char of the sequence specially, before setting
8164 up any keymaps, in case a filter runs and switches buffers on us. */
8165 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8167 #endif /* GOBBLE_FIRST_EVENT */
8169 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8170 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8173 /* We jump here when the key sequence has been thoroughly changed, and
8174 we need to rescan it starting from the beginning. When we jump here,
8175 keybuf[0..mock_input] holds the sequence we should reread. */
8178 starting_buffer
= current_buffer
;
8179 first_unbound
= bufsize
+ 1;
8181 /* Build our list of keymaps.
8182 If we recognize a function key and replace its escape sequence in
8183 keybuf with its symbol, or if the sequence starts with a mouse
8184 click and we need to switch buffers, we jump back here to rebuild
8185 the initial keymaps from the current buffer. */
8188 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8189 || !NILP (Voverriding_local_map
))
8191 if (3 > nmaps_allocated
)
8193 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8194 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8195 nmaps_allocated
= 3;
8197 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8198 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8199 if (!NILP (Voverriding_local_map
))
8200 submaps
[nmaps
++] = Voverriding_local_map
;
8208 nminor
= current_minor_maps (0, &maps
);
8209 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8211 if (total
> nmaps_allocated
)
8213 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8214 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8215 nmaps_allocated
= total
;
8218 if (!NILP (orig_keymap
))
8219 submaps
[nmaps
++] = orig_keymap
;
8221 bcopy (maps
, (void *) (submaps
+ nmaps
),
8222 nminor
* sizeof (submaps
[0]));
8226 submaps
[nmaps
++] = orig_local_map
;
8228 submaps
[nmaps
++] = current_global_map
;
8230 /* Find an accurate initial value for first_binding. */
8231 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8232 if (! NILP (submaps
[first_binding
]))
8235 /* Start from the beginning in keybuf. */
8238 /* These are no-ops the first time through, but if we restart, they
8239 revert the echo area and this_command_keys to their original state. */
8240 this_command_key_count
= keys_start
;
8241 if (INTERACTIVE
&& t
< mock_input
)
8242 echo_truncate (echo_start
);
8244 /* If the best binding for the current key sequence is a keymap, or
8245 we may be looking at a function key's escape sequence, keep on
8247 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
8248 || (first_binding
>= nmaps
&& fkey_start
< t
)
8249 || (first_binding
>= nmaps
&& keytran_start
< t
)
8250 /* Don't return in the middle of a possible function key sequence,
8251 if the only bindings we found were via case conversion.
8252 Thus, if ESC O a has a function-key-map translation
8253 and ESC o has a binding, don't return after ESC O,
8254 so that we can translate ESC O plus the next character. */
8258 int used_mouse_menu
= 0;
8260 /* Where the last real key started. If we need to throw away a
8261 key that has expanded into more than one element of keybuf
8262 (say, a mouse click on the mode line which is being treated
8263 as [mode-line (mouse-...)], then we backtrack to this point
8265 volatile int last_real_key_start
;
8267 /* These variables are analogous to echo_start and keys_start;
8268 while those allow us to restart the entire key sequence,
8269 echo_local_start and keys_local_start allow us to throw away
8271 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8273 /* key-translation-map is applied *after* function-key-map. */
8274 eassert (keytran_end
<= fkey_start
);
8276 if (first_unbound
< fkey_start
&& first_unbound
< keytran_start
)
8277 { /* The prefix upto first_unbound has no binding and has
8278 no translation left to do either, so we know it's unbound.
8279 If we don't stop now, we risk staying here indefinitely
8280 (if the user keeps entering fkey or keytran prefixes
8281 like C-c ESC ESC ESC ESC ...) */
8283 for (i
= first_unbound
+ 1; i
< t
; i
++)
8284 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8285 mock_input
= t
- first_unbound
- 1;
8286 fkey_end
= fkey_start
-= first_unbound
+ 1;
8287 fkey_map
= Vfunction_key_map
;
8288 keytran_end
= keytran_start
-= first_unbound
+ 1;
8289 keytran_map
= Vkey_translation_map
;
8290 goto replay_sequence
;
8294 error ("Key sequence too long");
8297 echo_local_start
= echo_length ();
8298 keys_local_start
= this_command_key_count
;
8299 local_first_binding
= first_binding
;
8302 /* These are no-ops, unless we throw away a keystroke below and
8303 jumped back up to replay_key; in that case, these restore the
8304 variables to their original state, allowing us to replay the
8306 if (INTERACTIVE
&& t
< mock_input
)
8307 echo_truncate (echo_local_start
);
8308 this_command_key_count
= keys_local_start
;
8309 first_binding
= local_first_binding
;
8311 /* By default, assume each event is "real". */
8312 last_real_key_start
= t
;
8314 /* Does mock_input indicate that we are re-reading a key sequence? */
8318 add_command_key (key
);
8319 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8320 && NILP (Fzerop (Vecho_keystrokes
)))
8324 /* If not, we should actually read a character. */
8329 KBOARD
*interrupted_kboard
= current_kboard
;
8330 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8331 if (setjmp (wrong_kboard_jmpbuf
))
8333 if (!NILP (delayed_switch_frame
))
8335 interrupted_kboard
->kbd_queue
8336 = Fcons (delayed_switch_frame
,
8337 interrupted_kboard
->kbd_queue
);
8338 delayed_switch_frame
= Qnil
;
8341 interrupted_kboard
->kbd_queue
8342 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8344 /* If the side queue is non-empty, ensure it begins with a
8345 switch-frame, so we'll replay it in the right context. */
8346 if (CONSP (interrupted_kboard
->kbd_queue
)
8347 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8348 !(EVENT_HAS_PARAMETERS (key
)
8349 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8353 XSETFRAME (frame
, interrupted_frame
);
8354 interrupted_kboard
->kbd_queue
8355 = Fcons (make_lispy_switch_frame (frame
),
8356 interrupted_kboard
->kbd_queue
);
8359 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8360 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8361 goto replay_sequence
;
8364 key
= read_char (NILP (prompt
), nmaps
,
8365 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8369 /* read_char returns t when it shows a menu and the user rejects it.
8373 unbind_to (count
, Qnil
);
8378 /* read_char returns -1 at the end of a macro.
8379 Emacs 18 handles this by returning immediately with a
8380 zero, so that's what we'll do. */
8381 if (INTEGERP (key
) && XINT (key
) == -1)
8384 /* The Microsoft C compiler can't handle the goto that
8390 /* If the current buffer has been changed from under us, the
8391 keymap may have changed, so replay the sequence. */
8394 EMACS_TIME initial_idleness_start_time
;
8395 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8396 EMACS_SECS (timer_last_idleness_start_time
),
8397 EMACS_USECS (timer_last_idleness_start_time
));
8399 /* Resume idle state, using the same start-time as before. */
8400 timer_start_idle ();
8401 timer_idleness_start_time
= initial_idleness_start_time
;
8404 /* Reset the current buffer from the selected window
8405 in case something changed the former and not the latter.
8406 This is to be more consistent with the behavior
8407 of the command_loop_1. */
8408 if (fix_current_buffer
)
8410 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8412 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8413 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8416 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8417 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8418 goto replay_sequence
;
8421 /* If we have a quit that was typed in another frame, and
8422 quit_throw_to_read_char switched buffers,
8423 replay to get the right keymap. */
8425 && XINT (key
) == quit_char
8426 && current_buffer
!= starting_buffer
)
8429 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8433 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8434 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8435 goto replay_sequence
;
8440 if (EVENT_HAS_PARAMETERS (key
)
8441 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8443 /* If we're at the beginning of a key sequence, and the caller
8444 says it's okay, go ahead and return this event. If we're
8445 in the midst of a key sequence, delay it until the end. */
8446 if (t
> 0 || !can_return_switch_frame
)
8448 delayed_switch_frame
= key
;
8454 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8457 /* Clicks in non-text areas get prefixed by the symbol
8458 in their CHAR-ADDRESS field. For example, a click on
8459 the mode line is prefixed by the symbol `mode-line'.
8461 Furthermore, key sequences beginning with mouse clicks
8462 are read using the keymaps of the buffer clicked on, not
8463 the current buffer. So we may have to switch the buffer
8466 When we turn one event into two events, we must make sure
8467 that neither of the two looks like the original--so that,
8468 if we replay the events, they won't be expanded again.
8469 If not for this, such reexpansion could happen either here
8470 or when user programs play with this-command-keys. */
8471 if (EVENT_HAS_PARAMETERS (key
))
8475 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8476 if (EQ (kind
, Qmouse_click
))
8478 Lisp_Object window
, posn
;
8480 window
= POSN_WINDOW (EVENT_START (key
));
8481 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8484 || (!NILP (fake_prefixed_keys
)
8485 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8487 /* We're looking a second time at an event for which
8488 we generated a fake prefix key. Set
8489 last_real_key_start appropriately. */
8491 last_real_key_start
= t
- 1;
8494 /* Key sequences beginning with mouse clicks are
8495 read using the keymaps in the buffer clicked on,
8496 not the current buffer. If we're at the
8497 beginning of a key sequence, switch buffers. */
8498 if (last_real_key_start
== 0
8500 && BUFFERP (XWINDOW (window
)->buffer
)
8501 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8503 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8507 /* Arrange to go back to the original buffer once we're
8508 done reading the key sequence. Note that we can't
8509 use save_excursion_{save,restore} here, because they
8510 save point as well as the current buffer; we don't
8511 want to save point, because redisplay may change it,
8512 to accommodate a Fset_window_start or something. We
8513 don't want to do this at the top of the function,
8514 because we may get input from a subprocess which
8515 wants to change the selected window and stuff (say,
8517 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8519 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8521 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8522 orig_local_map
= get_local_map (PT
, current_buffer
,
8524 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8525 goto replay_sequence
;
8528 /* For a mouse click, get the local text-property keymap
8529 of the place clicked on, rather than point. */
8530 if (last_real_key_start
== 0
8531 && CONSP (XCDR (key
))
8532 && ! localized_local_map
)
8534 Lisp_Object map_here
, start
, pos
;
8536 localized_local_map
= 1;
8537 start
= EVENT_START (key
);
8539 if (CONSP (start
) && CONSP (XCDR (start
)))
8541 pos
= POSN_BUFFER_POSN (start
);
8543 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8545 map_here
= get_local_map (XINT (pos
),
8546 current_buffer
, Qlocal_map
);
8547 if (!EQ (map_here
, orig_local_map
))
8549 orig_local_map
= map_here
;
8553 goto replay_sequence
;
8555 map_here
= get_local_map (XINT (pos
),
8556 current_buffer
, Qkeymap
);
8557 if (!EQ (map_here
, orig_keymap
))
8559 orig_keymap
= map_here
;
8563 goto replay_sequence
;
8569 /* Expand mode-line and scroll-bar events into two events:
8570 use posn as a fake prefix key. */
8572 && (NILP (fake_prefixed_keys
)
8573 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8575 if (t
+ 1 >= bufsize
)
8576 error ("Key sequence too long");
8579 keybuf
[t
+ 1] = key
;
8582 /* Record that a fake prefix key has been generated
8583 for KEY. Don't modify the event; this would
8584 prevent proper action when the event is pushed
8585 back into unread-command-events. */
8586 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8588 /* If on a mode line string with a local keymap,
8589 reconsider the key sequence with that keymap. */
8590 if (CONSP (POSN_STRING (EVENT_START (key
))))
8592 Lisp_Object string
, pos
, map
, map2
;
8594 string
= POSN_STRING (EVENT_START (key
));
8595 pos
= XCDR (string
);
8596 string
= XCAR (string
);
8598 && XINT (pos
) < SCHARS (string
))
8600 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8602 orig_local_map
= map
;
8603 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8606 if (!NILP (map
) || !NILP (map2
))
8607 goto replay_sequence
;
8613 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8614 && NILP (from_string
))
8616 /* For a click on a string, i.e. overlay string or a
8617 string displayed via the `display' property,
8618 consider `local-map' and `keymap' properties of
8620 Lisp_Object string
, pos
, map
, map2
;
8622 string
= POSN_STRING (EVENT_START (key
));
8623 pos
= XCDR (string
);
8624 string
= XCAR (string
);
8626 && XINT (pos
) < SCHARS (string
))
8628 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8630 orig_local_map
= map
;
8631 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8635 if (!NILP (map
) || !NILP (map2
))
8637 from_string
= string
;
8638 goto replay_sequence
;
8643 else if (CONSP (XCDR (key
))
8644 && CONSP (EVENT_START (key
))
8645 && CONSP (XCDR (EVENT_START (key
))))
8649 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8650 /* Handle menu-bar events:
8651 insert the dummy prefix event `menu-bar'. */
8652 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8654 if (t
+ 1 >= bufsize
)
8655 error ("Key sequence too long");
8659 /* Zap the position in key, so we know that we've
8660 expanded it, and don't try to do so again. */
8661 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8662 Fcons (posn
, Qnil
));
8665 goto replay_sequence
;
8667 else if (CONSP (posn
))
8669 /* We're looking at the second event of a
8670 sequence which we expanded before. Set
8671 last_real_key_start appropriately. */
8672 if (last_real_key_start
== t
&& t
> 0)
8673 last_real_key_start
= t
- 1;
8678 /* We have finally decided that KEY is something we might want
8680 first_binding
= (follow_key (key
,
8681 nmaps
- first_binding
,
8682 submaps
+ first_binding
,
8683 defs
+ first_binding
,
8684 submaps
+ first_binding
)
8687 /* If KEY wasn't bound, we'll try some fallbacks. */
8688 if (first_binding
< nmaps
)
8689 /* This is needed for the following scenario:
8690 event 0: a down-event that gets dropped by calling replay_key.
8691 event 1: some normal prefix like C-h.
8692 After event 0, first_unbound is 0, after event 1 fkey_start
8693 and keytran_start are both 1, so when we see that C-h is bound,
8694 we need to update first_unbound. */
8695 first_unbound
= max (t
+ 1, first_unbound
);
8700 /* Remember the position to put an upper bound on fkey_start. */
8701 first_unbound
= min (t
, first_unbound
);
8703 head
= EVENT_HEAD (key
);
8704 if (help_char_p (head
) && t
> 0)
8706 read_key_sequence_cmd
= Vprefix_help_command
;
8708 last_nonmenu_event
= key
;
8709 /* The Microsoft C compiler can't handle the goto that
8717 Lisp_Object breakdown
;
8720 breakdown
= parse_modifiers (head
);
8721 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8722 /* Attempt to reduce an unbound mouse event to a simpler
8723 event that is bound:
8724 Drags reduce to clicks.
8725 Double-clicks reduce to clicks.
8726 Triple-clicks reduce to double-clicks, then to clicks.
8727 Down-clicks are eliminated.
8728 Double-downs reduce to downs, then are eliminated.
8729 Triple-downs reduce to double-downs, then to downs,
8730 then are eliminated. */
8731 if (modifiers
& (down_modifier
| drag_modifier
8732 | double_modifier
| triple_modifier
))
8734 while (modifiers
& (down_modifier
| drag_modifier
8735 | double_modifier
| triple_modifier
))
8737 Lisp_Object new_head
, new_click
;
8738 if (modifiers
& triple_modifier
)
8739 modifiers
^= (double_modifier
| triple_modifier
);
8740 else if (modifiers
& double_modifier
)
8741 modifiers
&= ~double_modifier
;
8742 else if (modifiers
& drag_modifier
)
8743 modifiers
&= ~drag_modifier
;
8746 /* Dispose of this `down' event by simply jumping
8747 back to replay_key, to get another event.
8749 Note that if this event came from mock input,
8750 then just jumping back to replay_key will just
8751 hand it to us again. So we have to wipe out any
8754 We could delete keybuf[t] and shift everything
8755 after that to the left by one spot, but we'd also
8756 have to fix up any variable that points into
8757 keybuf, and shifting isn't really necessary
8760 Adding prefixes for non-textual mouse clicks
8761 creates two characters of mock input, and both
8762 must be thrown away. If we're only looking at
8763 the prefix now, we can just jump back to
8764 replay_key. On the other hand, if we've already
8765 processed the prefix, and now the actual click
8766 itself is giving us trouble, then we've lost the
8767 state of the keymaps we want to backtrack to, and
8768 we need to replay the whole sequence to rebuild
8771 Beyond that, only function key expansion could
8772 create more than two keys, but that should never
8773 generate mouse events, so it's okay to zero
8774 mock_input in that case too.
8776 FIXME: The above paragraph seems just plain
8777 wrong, if you consider things like
8778 xterm-mouse-mode. -stef
8780 Isn't this just the most wonderful code ever? */
8781 if (t
== last_real_key_start
)
8788 mock_input
= last_real_key_start
;
8789 goto replay_sequence
;
8794 = apply_modifiers (modifiers
, XCAR (breakdown
));
8796 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8798 /* Look for a binding for this new key. follow_key
8799 promises that it didn't munge submaps the
8800 last time we called it, since key was unbound. */
8802 = (follow_key (new_click
,
8803 nmaps
- local_first_binding
,
8804 submaps
+ local_first_binding
,
8805 defs
+ local_first_binding
,
8806 submaps
+ local_first_binding
)
8807 + local_first_binding
);
8809 /* If that click is bound, go for it. */
8810 if (first_binding
< nmaps
)
8815 /* Otherwise, we'll leave key set to the drag event. */
8822 /* Normally, last_nonmenu_event gets the previous key we read.
8823 But when a mouse popup menu is being used,
8824 we don't update last_nonmenu_event; it continues to hold the mouse
8825 event that preceded the first level of menu. */
8826 if (!used_mouse_menu
)
8827 last_nonmenu_event
= key
;
8829 /* Record what part of this_command_keys is the current key sequence. */
8830 this_single_command_key_start
= this_command_key_count
- t
;
8832 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
8833 /* There is a binding and it's not a prefix.
8834 There is thus no function-key in this sequence.
8835 Moving fkey.start is important in this case to allow keytran.start
8836 to go over the sequence before we return (since we keep the
8837 invariant that keytran.end <= fkey.start). */
8840 (fkey_start
= fkey_end
= t
, fkey_map
= Vfunction_key_map
);
8843 /* If the sequence is unbound, see if we can hang a function key
8844 off the end of it. */
8846 Lisp_Object fkey_next
;
8848 /* Continue scan from fkey_end until we find a bound suffix.
8849 If we fail, increment fkey_start and start over from there. */
8850 while (fkey_end
< t
)
8854 key
= keybuf
[fkey_end
++];
8855 fkey_next
= access_keymap (fkey_map
, key
, 1, 0, 1);
8857 /* Handle symbol with autoload definition. */
8858 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8859 && CONSP (XSYMBOL (fkey_next
)->function
)
8860 && EQ (XCAR (XSYMBOL (fkey_next
)->function
), Qautoload
))
8861 do_autoload (XSYMBOL (fkey_next
)->function
,
8864 /* Handle a symbol whose function definition is a keymap
8866 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8867 && (!NILP (Farrayp (XSYMBOL (fkey_next
)->function
))
8868 || KEYMAPP (XSYMBOL (fkey_next
)->function
)))
8869 fkey_next
= XSYMBOL (fkey_next
)->function
;
8871 #if 0 /* I didn't turn this on, because it might cause trouble
8872 for the mapping of return into C-m and tab into C-i. */
8873 /* Optionally don't map function keys into other things.
8874 This enables the user to redefine kp- keys easily. */
8875 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8879 /* If the function key map gives a function, not an
8880 array, then call the function with no args and use
8881 its value instead. */
8882 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8883 /* If there's a binding (i.e. first_binding >= nmaps)
8884 we don't want to apply this function-key-mapping. */
8885 && fkey_end
== t
&& first_binding
>= nmaps
)
8887 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8891 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8892 fkey_next
= call1 (fkey_next
, prompt
);
8894 /* If the function returned something invalid,
8895 barf--don't ignore it.
8896 (To ignore it safely, we would need to gcpro a bunch of
8897 other variables.) */
8898 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
8899 error ("Function in key-translation-map returns invalid key sequence");
8902 /* If keybuf[fkey_start..fkey_end] is bound in the
8903 function key map and it's a suffix of the current
8904 sequence (i.e. fkey_end == t), replace it with
8905 the binding and restart with fkey_start at the end. */
8906 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
8907 /* If there's a binding (i.e. first_binding >= nmaps)
8908 we don't want to apply this function-key-mapping. */
8909 && fkey_end
== t
&& first_binding
>= nmaps
)
8911 int len
= XFASTINT (Flength (fkey_next
));
8913 t
= fkey_start
+ len
;
8915 error ("Key sequence too long");
8917 if (VECTORP (fkey_next
))
8918 bcopy (XVECTOR (fkey_next
)->contents
,
8919 keybuf
+ fkey_start
,
8920 (t
- fkey_start
) * sizeof (keybuf
[0]));
8921 else if (STRINGP (fkey_next
))
8925 for (i
= 0; i
< len
; i
++)
8926 XSETFASTINT (keybuf
[fkey_start
+ i
],
8927 SREF (fkey_next
, i
));
8931 fkey_start
= fkey_end
= t
;
8932 fkey_map
= Vfunction_key_map
;
8934 /* Do pass the results through key-translation-map.
8935 But don't retranslate what key-translation-map
8936 has already translated. */
8937 keytran_end
= keytran_start
;
8938 keytran_map
= Vkey_translation_map
;
8940 goto replay_sequence
;
8943 fkey_map
= get_keymap (fkey_next
, 0, 1);
8945 /* If we no longer have a bound suffix, try a new positions for
8947 if (!CONSP (fkey_map
))
8949 fkey_end
= ++fkey_start
;
8950 fkey_map
= Vfunction_key_map
;
8955 /* Look for this sequence in key-translation-map. */
8957 Lisp_Object keytran_next
;
8959 /* Scan from keytran_end until we find a bound suffix. */
8960 while (keytran_end
< fkey_start
)
8964 key
= keybuf
[keytran_end
++];
8966 = access_keymap (keytran_map
, key
, 1, 0, 1);
8968 /* Handle symbol with autoload definition. */
8969 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8970 && CONSP (XSYMBOL (keytran_next
)->function
)
8971 && EQ (XCAR (XSYMBOL (keytran_next
)->function
), Qautoload
))
8972 do_autoload (XSYMBOL (keytran_next
)->function
,
8975 /* Handle a symbol whose function definition is a keymap
8977 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8978 && (!NILP (Farrayp (XSYMBOL (keytran_next
)->function
))
8979 || KEYMAPP (XSYMBOL (keytran_next
)->function
)))
8980 keytran_next
= XSYMBOL (keytran_next
)->function
;
8982 /* If the key translation map gives a function, not an
8983 array, then call the function with one arg and use
8984 its value instead. */
8985 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
)))
8987 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8991 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8992 keytran_next
= call1 (keytran_next
, prompt
);
8994 /* If the function returned something invalid,
8995 barf--don't ignore it.
8996 (To ignore it safely, we would need to gcpro a bunch of
8997 other variables.) */
8998 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8999 error ("Function in key-translation-map returns invalid key sequence");
9002 /* If keybuf[keytran_start..keytran_end] is bound in the
9003 key translation map and it's a suffix of the current
9004 sequence (i.e. keytran_end == t), replace it with
9005 the binding and restart with keytran_start at the end. */
9006 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
)))
9008 int len
= XFASTINT (Flength (keytran_next
));
9009 int i
, diff
= len
- (keytran_end
- keytran_start
);
9011 mock_input
= max (t
, mock_input
);
9012 if (mock_input
+ diff
>= bufsize
)
9013 error ("Key sequence too long");
9015 /* Shift the keys that are after keytran_end. */
9017 for (i
= keytran_end
; i
< mock_input
; i
++)
9018 keybuf
[i
+ diff
] = keybuf
[i
];
9020 for (i
= mock_input
- 1; i
>= keytran_end
; i
--)
9021 keybuf
[i
+ diff
] = keybuf
[i
];
9022 /* Replace the keys between keytran_start and keytran_end
9023 with those from keytran_next. */
9024 for (i
= 0; i
< len
; i
++)
9025 keybuf
[keytran_start
+ i
]
9026 = Faref (keytran_next
, make_number (i
));
9029 keytran_start
= keytran_end
+= diff
;
9030 keytran_map
= Vkey_translation_map
;
9032 /* Adjust the function-key-map counters. */
9036 goto replay_sequence
;
9039 keytran_map
= get_keymap (keytran_next
, 0, 1);
9041 /* If we no longer have a bound suffix, try a new positions for
9043 if (!CONSP (keytran_map
))
9045 keytran_end
= ++keytran_start
;
9046 keytran_map
= Vkey_translation_map
;
9051 /* If KEY is not defined in any of the keymaps,
9052 and cannot be part of a function key or translation,
9053 and is an upper case letter
9054 use the corresponding lower-case letter instead. */
9055 if (first_binding
>= nmaps
9056 && fkey_start
>= t
&& keytran_start
>= t
9058 && ((((XINT (key
) & 0x3ffff)
9059 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9060 && UPPERCASEP (XINT (key
) & 0x3ffff))
9061 || (XINT (key
) & shift_modifier
)))
9063 Lisp_Object new_key
;
9065 original_uppercase
= key
;
9066 original_uppercase_position
= t
- 1;
9068 if (XINT (key
) & shift_modifier
)
9069 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9071 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9072 | (XINT (key
) & ~0x3ffff)));
9074 /* We have to do this unconditionally, regardless of whether
9075 the lower-case char is defined in the keymaps, because they
9076 might get translated through function-key-map. */
9077 keybuf
[t
- 1] = new_key
;
9078 mock_input
= max (t
, mock_input
);
9080 goto replay_sequence
;
9082 /* If KEY is not defined in any of the keymaps,
9083 and cannot be part of a function key or translation,
9084 and is a shifted function key,
9085 use the corresponding unshifted function key instead. */
9086 if (first_binding
>= nmaps
9087 && fkey_start
>= t
&& keytran_start
>= t
9090 Lisp_Object breakdown
;
9093 breakdown
= parse_modifiers (key
);
9094 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9095 if (modifiers
& shift_modifier
)
9097 Lisp_Object new_key
;
9099 original_uppercase
= key
;
9100 original_uppercase_position
= t
- 1;
9102 modifiers
&= ~shift_modifier
;
9103 new_key
= apply_modifiers (modifiers
,
9106 keybuf
[t
- 1] = new_key
;
9107 mock_input
= max (t
, mock_input
);
9109 goto replay_sequence
;
9115 read_key_sequence_cmd
= (first_binding
< nmaps
9116 ? defs
[first_binding
]
9119 unread_switch_frame
= delayed_switch_frame
;
9120 unbind_to (count
, Qnil
);
9122 /* Don't downcase the last character if the caller says don't.
9123 Don't downcase it if the result is undefined, either. */
9124 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9125 && t
- 1 == original_uppercase_position
)
9126 keybuf
[t
- 1] = original_uppercase
;
9128 /* Occasionally we fabricate events, perhaps by expanding something
9129 according to function-key-map, or by adding a prefix symbol to a
9130 mouse click in the scroll bar or modeline. In this cases, return
9131 the entire generated key sequence, even if we hit an unbound
9132 prefix or a definition before the end. This means that you will
9133 be able to push back the event properly, and also means that
9134 read-key-sequence will always return a logical unit.
9137 for (; t
< mock_input
; t
++)
9139 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9140 && NILP (Fzerop (Vecho_keystrokes
)))
9141 echo_char (keybuf
[t
]);
9142 add_command_key (keybuf
[t
]);
9151 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9152 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9153 The sequence is sufficient to specify a non-prefix command in the
9154 current local and global maps.
9156 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9157 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9158 as a continuation of the previous key.
9160 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9161 convert the last event to lower case. (Normally any upper case event
9162 is converted to lower case if the original event is undefined and the lower
9163 case equivalent is defined.) A non-nil value is appropriate for reading
9164 a key sequence to be defined.
9166 A C-g typed while in this function is treated like any other character,
9167 and `quit-flag' is not set.
9169 If the key sequence starts with a mouse click, then the sequence is read
9170 using the keymaps of the buffer of the window clicked in, not the buffer
9171 of the selected window as normal.
9173 `read-key-sequence' drops unbound button-down events, since you normally
9174 only care about the click or drag events which follow them. If a drag
9175 or multi-click event is unbound, but the corresponding click event would
9176 be bound, `read-key-sequence' turns the event into a click event at the
9177 drag's starting position. This means that you don't have to distinguish
9178 between click and drag, double, or triple events unless you want to.
9180 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9181 lines separating windows, and scroll bars with imaginary keys
9182 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9184 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9185 function will process a switch-frame event if the user switches frames
9186 before typing anything. If the user switches frames in the middle of a
9187 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9188 is nil, then the event will be put off until after the current key sequence.
9190 `read-key-sequence' checks `function-key-map' for function key
9191 sequences, where they wouldn't conflict with ordinary bindings. See
9192 `function-key-map' for more details.
9194 The optional fifth argument COMMAND-LOOP, if non-nil, means
9195 that this key sequence is being read by something that will
9196 read commands one after another. It should be nil if the caller
9197 will read just one key sequence. */)
9198 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9200 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9201 Lisp_Object can_return_switch_frame
, command_loop
;
9203 Lisp_Object keybuf
[30];
9205 struct gcpro gcpro1
;
9206 int count
= SPECPDL_INDEX ();
9209 CHECK_STRING (prompt
);
9212 specbind (Qinput_method_exit_on_first_char
,
9213 (NILP (command_loop
) ? Qt
: Qnil
));
9214 specbind (Qinput_method_use_echo_area
,
9215 (NILP (command_loop
) ? Qt
: Qnil
));
9217 bzero (keybuf
, sizeof keybuf
);
9219 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9221 if (NILP (continue_echo
))
9223 this_command_key_count
= 0;
9224 this_single_command_key_start
= 0;
9227 #ifdef HAVE_X_WINDOWS
9228 if (display_hourglass_p
)
9229 cancel_hourglass ();
9232 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9233 prompt
, ! NILP (dont_downcase_last
),
9234 ! NILP (can_return_switch_frame
), 0);
9236 #if 0 /* The following is fine for code reading a key sequence and
9237 then proceeding with a lenghty computation, but it's not good
9238 for code reading keys in a loop, like an input method. */
9239 #ifdef HAVE_X_WINDOWS
9240 if (display_hourglass_p
)
9251 return unbind_to (count
, make_event_array (i
, keybuf
));
9254 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9255 Sread_key_sequence_vector
, 1, 5, 0,
9256 doc
: /* Like `read-key-sequence' but always return a vector. */)
9257 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9259 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9260 Lisp_Object can_return_switch_frame
, command_loop
;
9262 Lisp_Object keybuf
[30];
9264 struct gcpro gcpro1
;
9265 int count
= SPECPDL_INDEX ();
9268 CHECK_STRING (prompt
);
9271 specbind (Qinput_method_exit_on_first_char
,
9272 (NILP (command_loop
) ? Qt
: Qnil
));
9273 specbind (Qinput_method_use_echo_area
,
9274 (NILP (command_loop
) ? Qt
: Qnil
));
9276 bzero (keybuf
, sizeof keybuf
);
9278 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9280 if (NILP (continue_echo
))
9282 this_command_key_count
= 0;
9283 this_single_command_key_start
= 0;
9286 #ifdef HAVE_X_WINDOWS
9287 if (display_hourglass_p
)
9288 cancel_hourglass ();
9291 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9292 prompt
, ! NILP (dont_downcase_last
),
9293 ! NILP (can_return_switch_frame
), 0);
9295 #ifdef HAVE_X_WINDOWS
9296 if (display_hourglass_p
)
9306 return unbind_to (count
, Fvector (i
, keybuf
));
9309 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9310 doc
: /* Execute CMD as an editor command.
9311 CMD must be a symbol that satisfies the `commandp' predicate.
9312 Optional second arg RECORD-FLAG non-nil
9313 means unconditionally put this command in `command-history'.
9314 Otherwise, that is done only if an arg is read using the minibuffer.
9315 The argument KEYS specifies the value to use instead of (this-command-keys)
9316 when reading the arguments; if it is nil, (this-command-keys) is used.
9317 The argument SPECIAL, if non-nil, means that this command is executing
9318 a special event, so ignore the prefix argument and don't clear it. */)
9319 (cmd
, record_flag
, keys
, special
)
9320 Lisp_Object cmd
, record_flag
, keys
, special
;
9322 register Lisp_Object final
;
9323 register Lisp_Object tem
;
9324 Lisp_Object prefixarg
;
9325 struct backtrace backtrace
;
9326 extern int debug_on_next_call
;
9328 debug_on_next_call
= 0;
9332 prefixarg
= current_kboard
->Vprefix_arg
;
9333 Vcurrent_prefix_arg
= prefixarg
;
9334 current_kboard
->Vprefix_arg
= Qnil
;
9341 tem
= Fget (cmd
, Qdisabled
);
9342 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9344 tem
= Fsymbol_value (Qdisabled_command_hook
);
9346 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9352 final
= Findirect_function (cmd
);
9354 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9356 struct gcpro gcpro1
, gcpro2
;
9358 GCPRO2 (cmd
, prefixarg
);
9359 do_autoload (final
, cmd
);
9366 if (STRINGP (final
) || VECTORP (final
))
9368 /* If requested, place the macro in the command history. For
9369 other sorts of commands, call-interactively takes care of
9371 if (!NILP (record_flag
))
9374 = Fcons (Fcons (Qexecute_kbd_macro
,
9375 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9378 /* Don't keep command history around forever. */
9379 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9381 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9383 XSETCDR (tem
, Qnil
);
9387 return Fexecute_kbd_macro (final
, prefixarg
);
9390 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9392 backtrace
.next
= backtrace_list
;
9393 backtrace_list
= &backtrace
;
9394 backtrace
.function
= &Qcall_interactively
;
9395 backtrace
.args
= &cmd
;
9396 backtrace
.nargs
= 1;
9397 backtrace
.evalargs
= 0;
9399 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9401 backtrace_list
= backtrace
.next
;
9409 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9411 doc
: /* Read function name, then read its arguments and call it. */)
9413 Lisp_Object prefixarg
;
9415 Lisp_Object function
;
9417 int saved_last_point_position
;
9418 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9419 Lisp_Object bindings
, value
;
9420 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9422 saved_keys
= Fvector (this_command_key_count
,
9423 XVECTOR (this_command_keys
)->contents
);
9424 saved_last_point_position_buffer
= last_point_position_buffer
;
9425 saved_last_point_position
= last_point_position
;
9427 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9429 if (EQ (prefixarg
, Qminus
))
9431 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9432 strcpy (buf
, "C-u ");
9433 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9435 if (sizeof (int) == sizeof (EMACS_INT
))
9436 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9437 else if (sizeof (long) == sizeof (EMACS_INT
))
9438 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9442 else if (INTEGERP (prefixarg
))
9444 if (sizeof (int) == sizeof (EMACS_INT
))
9445 sprintf (buf
, "%d ", XINT (prefixarg
));
9446 else if (sizeof (long) == sizeof (EMACS_INT
))
9447 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9452 /* This isn't strictly correct if execute-extended-command
9453 is bound to anything else. Perhaps it should use
9454 this_command_keys? */
9455 strcat (buf
, "M-x ");
9457 /* Prompt with buf, and then read a string, completing from and
9458 restricting to the set of all defined commands. Don't provide
9459 any initial input. Save the command read on the extended-command
9461 function
= Fcompleting_read (build_string (buf
),
9462 Vobarray
, Qcommandp
,
9463 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9466 if (STRINGP (function
) && SCHARS (function
) == 0)
9467 error ("No command name given");
9469 /* Set this_command_keys to the concatenation of saved_keys and
9470 function, followed by a RET. */
9475 this_command_key_count
= 0;
9476 this_single_command_key_start
= 0;
9478 keys
= XVECTOR (saved_keys
)->contents
;
9479 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9480 add_command_key (keys
[i
]);
9482 for (i
= 0; i
< SCHARS (function
); i
++)
9483 add_command_key (Faref (function
, make_number (i
)));
9485 add_command_key (make_number ('\015'));
9488 last_point_position
= saved_last_point_position
;
9489 last_point_position_buffer
= saved_last_point_position_buffer
;
9493 function
= Fintern (function
, Qnil
);
9494 current_kboard
->Vprefix_arg
= prefixarg
;
9495 Vthis_command
= function
;
9496 real_this_command
= function
;
9498 /* If enabled, show which key runs this command. */
9499 if (!NILP (Vsuggest_key_bindings
)
9500 && NILP (Vexecuting_macro
)
9501 && SYMBOLP (function
))
9502 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9508 GCPRO2 (bindings
, value
);
9509 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9511 /* If the command has a key binding, print it now. */
9512 if (!NILP (bindings
)
9513 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9516 /* But first wait, and skip the message if there is input. */
9518 if (!NILP (echo_area_buffer
[0]))
9519 /* This command displayed something in the echo area;
9520 so wait a few seconds, then display our suggestion message. */
9521 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9522 ? XINT (Vsuggest_key_bindings
) : 2);
9524 /* This command left the echo area empty,
9525 so display our message immediately. */
9528 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9529 && ! CONSP (Vunread_command_events
))
9531 Lisp_Object binding
;
9533 int message_p
= push_message ();
9534 int count
= SPECPDL_INDEX ();
9536 record_unwind_protect (push_message_unwind
, Qnil
);
9537 binding
= Fkey_description (bindings
);
9540 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9543 sprintf (newmessage
, "You can run the command `%s' with %s",
9544 SDATA (SYMBOL_NAME (function
)),
9546 message2_nolog (newmessage
,
9547 strlen (newmessage
),
9548 STRING_MULTIBYTE (binding
));
9549 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9550 ? Vsuggest_key_bindings
: make_number (2)),
9555 unbind_to (count
, Qnil
);
9559 RETURN_UNGCPRO (value
);
9563 /* Return nonzero if input events are pending. */
9566 detect_input_pending ()
9569 get_input_pending (&input_pending
, 0);
9571 return input_pending
;
9574 /* Return nonzero if input events are pending, and run any pending timers. */
9577 detect_input_pending_run_timers (do_display
)
9580 int old_timers_run
= timers_run
;
9583 get_input_pending (&input_pending
, 1);
9585 if (old_timers_run
!= timers_run
&& do_display
)
9587 redisplay_preserve_echo_area (8);
9588 /* The following fixes a bug when using lazy-lock with
9589 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9590 from an idle timer function. The symptom of the bug is that
9591 the cursor sometimes doesn't become visible until the next X
9592 event is processed. --gerd. */
9594 rif
->flush_display (NULL
);
9597 return input_pending
;
9600 /* This is called in some cases before a possible quit.
9601 It cases the next call to detect_input_pending to recompute input_pending.
9602 So calling this function unnecessarily can't do any harm. */
9605 clear_input_pending ()
9610 /* Return nonzero if there are pending requeued events.
9611 This isn't used yet. The hope is to make wait_reading_process_input
9612 call it, and return if it runs Lisp code that unreads something.
9613 The problem is, kbd_buffer_get_event needs to be fixed to know what
9614 to do in that case. It isn't trivial. */
9617 requeued_events_pending_p ()
9619 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9623 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9624 doc
: /* Return t if command input is currently available with no wait.
9625 Actually, the value is nil only if we can be sure that no input is available;
9626 if there is a doubt, the value is t. */)
9629 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9632 get_filtered_input_pending (&input_pending
, 1, 1);
9633 return input_pending
> 0 ? Qt
: Qnil
;
9636 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9637 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9640 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9643 if (total_keys
< NUM_RECENT_KEYS
)
9644 return Fvector (total_keys
, keys
);
9647 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9648 bcopy (keys
+ recent_keys_index
,
9649 XVECTOR (val
)->contents
,
9650 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9652 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9653 recent_keys_index
* sizeof (Lisp_Object
));
9658 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9659 doc
: /* Return the key sequence that invoked this command.
9660 However, if the command has called `read-key-sequence', it returns
9661 the last key sequence that has been read.
9662 The value is a string or a vector. */)
9665 return make_event_array (this_command_key_count
,
9666 XVECTOR (this_command_keys
)->contents
);
9669 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9670 doc
: /* Return the key sequence that invoked this command, as a vector.
9671 However, if the command has called `read-key-sequence', it returns
9672 the last key sequence that has been read. */)
9675 return Fvector (this_command_key_count
,
9676 XVECTOR (this_command_keys
)->contents
);
9679 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9680 Sthis_single_command_keys
, 0, 0, 0,
9681 doc
: /* Return the key sequence that invoked this command.
9682 More generally, it returns the last key sequence read, either by
9683 the command loop or by `read-key-sequence'.
9684 Unlike `this-command-keys', this function's value
9685 does not include prefix arguments.
9686 The value is always a vector. */)
9689 return Fvector (this_command_key_count
9690 - this_single_command_key_start
,
9691 (XVECTOR (this_command_keys
)->contents
9692 + this_single_command_key_start
));
9695 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9696 Sthis_single_command_raw_keys
, 0, 0, 0,
9697 doc
: /* Return the raw events that were read for this command.
9698 More generally, it returns the last key sequence read, either by
9699 the command loop or by `read-key-sequence'.
9700 Unlike `this-single-command-keys', this function's value
9701 shows the events before all translations (except for input methods).
9702 The value is always a vector. */)
9705 return Fvector (raw_keybuf_count
,
9706 (XVECTOR (raw_keybuf
)->contents
));
9709 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9710 Sreset_this_command_lengths
, 0, 0, 0,
9711 doc
: /* Used for complicated reasons in `universal-argument-other-key'.
9713 `universal-argument-other-key' rereads the event just typed.
9714 It then gets translated through `function-key-map'.
9715 The translated event gets included in the echo area and in
9716 the value of `this-command-keys' in addition to the raw original event.
9719 Calling this function directs the translated event to replace
9720 the original event, so that only one version of the event actually
9721 appears in the echo area and in the value of `this-command-keys'. */)
9724 before_command_restore_flag
= 1;
9725 before_command_key_count_1
= before_command_key_count
;
9726 before_command_echo_length_1
= before_command_echo_length
;
9730 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9731 Sclear_this_command_keys
, 0, 0, 0,
9732 doc
: /* Clear out the vector that `this-command-keys' returns.
9733 Also clear the record of the last 100 events. */)
9738 this_command_key_count
= 0;
9740 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9741 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9743 recent_keys_index
= 0;
9747 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9748 doc
: /* Return the current depth in recursive edits. */)
9752 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9756 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9757 "FOpen dribble file: ",
9758 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9759 If FILE is nil, close any open dribble file. */)
9770 file
= Fexpand_file_name (file
, Qnil
);
9771 dribble
= fopen (SDATA (file
), "w");
9773 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9778 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9779 doc
: /* Discard the contents of the terminal input buffer.
9780 Also cancel any kbd macro being defined. */)
9783 current_kboard
->defining_kbd_macro
= Qnil
;
9784 update_mode_lines
++;
9786 Vunread_command_events
= Qnil
;
9787 unread_command_char
= -1;
9789 discard_tty_input ();
9791 kbd_fetch_ptr
= kbd_store_ptr
;
9792 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9798 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9799 doc
: /* Stop Emacs and return to superior process. You can resume later.
9800 If `cannot-suspend' is non-nil, or if the system doesn't support job
9801 control, run a subshell instead.
9803 If optional arg STUFFSTRING is non-nil, its characters are stuffed
9804 to be read as terminal input by Emacs's parent, after suspension.
9806 Before suspending, run the normal hook `suspend-hook'.
9807 After resumption run the normal hook `suspend-resume-hook'.
9809 Some operating systems cannot stop the Emacs process and resume it later.
9810 On such systems, Emacs starts a subshell instead of suspending. */)
9812 Lisp_Object stuffstring
;
9814 int count
= SPECPDL_INDEX ();
9815 int old_height
, old_width
;
9817 struct gcpro gcpro1
;
9819 if (!NILP (stuffstring
))
9820 CHECK_STRING (stuffstring
);
9822 /* Run the functions in suspend-hook. */
9823 if (!NILP (Vrun_hooks
))
9824 call1 (Vrun_hooks
, intern ("suspend-hook"));
9826 GCPRO1 (stuffstring
);
9827 get_frame_size (&old_width
, &old_height
);
9829 /* sys_suspend can get an error if it tries to fork a subshell
9830 and the system resources aren't available for that. */
9831 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9833 stuff_buffered_input (stuffstring
);
9838 unbind_to (count
, Qnil
);
9840 /* Check if terminal/window size has changed.
9841 Note that this is not useful when we are running directly
9842 with a window system; but suspend should be disabled in that case. */
9843 get_frame_size (&width
, &height
);
9844 if (width
!= old_width
|| height
!= old_height
)
9845 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9847 /* Run suspend-resume-hook. */
9848 if (!NILP (Vrun_hooks
))
9849 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9855 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9856 Then in any case stuff anything Emacs has read ahead and not used. */
9859 stuff_buffered_input (stuffstring
)
9860 Lisp_Object stuffstring
;
9862 /* stuff_char works only in BSD, versions 4.2 and up. */
9865 register unsigned char *p
;
9867 if (STRINGP (stuffstring
))
9871 p
= SDATA (stuffstring
);
9872 count
= SBYTES (stuffstring
);
9878 /* Anything we have read ahead, put back for the shell to read. */
9879 /* ?? What should this do when we have multiple keyboards??
9880 Should we ignore anything that was typed in at the "wrong" kboard? */
9881 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9885 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9886 kbd_fetch_ptr
= kbd_buffer
;
9887 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
9888 stuff_char (kbd_fetch_ptr
->code
);
9890 kbd_fetch_ptr
->kind
= NO_EVENT
;
9891 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
9892 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
9893 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
9898 #endif /* BSD_SYSTEM and not BSD4_1 */
9902 set_waiting_for_input (time_to_clear
)
9903 EMACS_TIME
*time_to_clear
;
9905 input_available_clear_time
= time_to_clear
;
9907 /* Tell interrupt_signal to throw back to read_char, */
9908 waiting_for_input
= 1;
9910 /* If interrupt_signal was called before and buffered a C-g,
9911 make it run again now, to avoid timing error. */
9912 if (!NILP (Vquit_flag
))
9913 quit_throw_to_read_char ();
9917 clear_waiting_for_input ()
9919 /* Tell interrupt_signal not to throw back to read_char, */
9920 waiting_for_input
= 0;
9921 input_available_clear_time
= 0;
9924 /* This routine is called at interrupt level in response to C-g.
9926 If interrupt_input, this is the handler for SIGINT. Otherwise, it
9927 is called from kbd_buffer_store_event, in handling SIGIO or
9930 If `waiting_for_input' is non zero, then unless `echoing' is
9931 nonzero, immediately throw back to read_char.
9933 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
9934 eval to throw, when it gets a chance. If quit-flag is already
9935 non-nil, it stops the job right away. */
9938 interrupt_signal (signalnum
) /* If we don't have an argument, */
9939 int signalnum
; /* some compilers complain in signal calls. */
9942 /* Must preserve main program's value of errno. */
9943 int old_errno
= errno
;
9944 struct frame
*sf
= SELECTED_FRAME ();
9946 #if defined (USG) && !defined (POSIX_SIGNALS)
9947 if (!read_socket_hook
&& NILP (Vwindow_system
))
9949 /* USG systems forget handlers when they are used;
9950 must reestablish each time */
9951 signal (SIGINT
, interrupt_signal
);
9952 signal (SIGQUIT
, interrupt_signal
);
9958 if (!NILP (Vquit_flag
)
9959 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
9961 /* If SIGINT isn't blocked, don't let us be interrupted by
9962 another SIGINT, it might be harmful due to non-reentrancy
9963 in I/O functions. */
9964 sigblock (sigmask (SIGINT
));
9969 #ifdef SIGTSTP /* Support possible in later USG versions */
9971 * On systems which can suspend the current process and return to the original
9972 * shell, this command causes the user to end up back at the shell.
9973 * The "Auto-save" and "Abort" questions are not asked until
9974 * the user elects to return to emacs, at which point he can save the current
9975 * job and either dump core or continue.
9980 if (sys_suspend () == -1)
9982 printf ("Not running as a subprocess;\n");
9983 printf ("you can continue or abort.\n");
9986 /* Perhaps should really fork an inferior shell?
9987 But that would not provide any way to get back
9988 to the original shell, ever. */
9989 printf ("No support for stopping a process on this operating system;\n");
9990 printf ("you can continue or abort.\n");
9991 #endif /* not VMS */
9992 #endif /* not SIGTSTP */
9994 /* We must remain inside the screen area when the internal terminal
9995 is used. Note that [Enter] is not echoed by dos. */
9998 /* It doesn't work to autosave while GC is in progress;
9999 the code used for auto-saving doesn't cope with the mark bit. */
10000 if (!gc_in_progress
)
10002 printf ("Auto-save? (y or n) ");
10004 if (((c
= getchar ()) & ~040) == 'Y')
10006 Fdo_auto_save (Qt
, Qnil
);
10008 printf ("\r\nAuto-save done");
10009 #else /* not MSDOS */
10010 printf ("Auto-save done\n");
10011 #endif /* not MSDOS */
10013 while (c
!= '\n') c
= getchar ();
10017 /* During GC, it must be safe to reenable quitting again. */
10018 Vinhibit_quit
= Qnil
;
10021 #endif /* not MSDOS */
10022 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10023 printf ("but will instead do a real quit after garbage collection ends\r\n");
10028 printf ("\r\nAbort? (y or n) ");
10029 #else /* not MSDOS */
10031 printf ("Abort (and enter debugger)? (y or n) ");
10032 #else /* not VMS */
10033 printf ("Abort (and dump core)? (y or n) ");
10034 #endif /* not VMS */
10035 #endif /* not MSDOS */
10037 if (((c
= getchar ()) & ~040) == 'Y')
10039 while (c
!= '\n') c
= getchar ();
10041 printf ("\r\nContinuing...\r\n");
10042 #else /* not MSDOS */
10043 printf ("Continuing...\n");
10044 #endif /* not MSDOS */
10051 /* If executing a function that wants to be interrupted out of
10052 and the user has not deferred quitting by binding `inhibit-quit'
10053 then quit right away. */
10054 if (immediate_quit
&& NILP (Vinhibit_quit
))
10056 struct gl_state_s saved
;
10057 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10059 immediate_quit
= 0;
10062 GCPRO4 (saved
.object
, saved
.global_code
,
10063 saved
.current_syntax_table
, saved
.old_prop
);
10064 Fsignal (Qquit
, Qnil
);
10069 /* Else request quit when it's safe */
10073 if (waiting_for_input
&& !echoing
)
10074 quit_throw_to_read_char ();
10079 /* Handle a C-g by making read_char return C-g. */
10082 quit_throw_to_read_char ()
10085 /* Prevent another signal from doing this before we finish. */
10086 clear_waiting_for_input ();
10089 Vunread_command_events
= Qnil
;
10090 unread_command_char
= -1;
10092 #if 0 /* Currently, sit_for is called from read_char without turning
10093 off polling. And that can call set_waiting_for_input.
10094 It seems to be harmless. */
10095 #ifdef POLL_FOR_INPUT
10096 /* May be > 1 if in recursive minibuffer. */
10097 if (poll_suppress_count
== 0)
10101 if (FRAMEP (internal_last_event_frame
)
10102 && !EQ (internal_last_event_frame
, selected_frame
))
10103 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10106 _longjmp (getcjmp
, 1);
10109 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10110 doc
: /* Set mode of reading keyboard input.
10111 First arg INTERRUPT non-nil means use input interrupts;
10112 nil means use CBREAK mode.
10113 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10114 (no effect except in CBREAK mode).
10115 Third arg META t means accept 8-bit input (for a Meta key).
10116 META nil means ignore the top bit, on the assumption it is parity.
10117 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10118 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10119 See also `current-input-mode'. */)
10120 (interrupt
, flow
, meta
, quit
)
10121 Lisp_Object interrupt
, flow
, meta
, quit
;
10124 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10125 error ("set-input-mode: QUIT must be an ASCII character");
10127 #ifdef POLL_FOR_INPUT
10132 /* this causes startup screen to be restored and messes with the mouse */
10133 reset_sys_modes ();
10137 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10138 if (read_socket_hook
)
10140 /* When using X, don't give the user a real choice,
10141 because we haven't implemented the mechanisms to support it. */
10142 #ifdef NO_SOCK_SIGIO
10143 interrupt_input
= 0;
10144 #else /* not NO_SOCK_SIGIO */
10145 interrupt_input
= 1;
10146 #endif /* NO_SOCK_SIGIO */
10149 interrupt_input
= !NILP (interrupt
);
10150 #else /* not SIGIO */
10151 interrupt_input
= 0;
10152 #endif /* not SIGIO */
10154 /* Our VMS input only works by interrupts, as of now. */
10156 interrupt_input
= 1;
10159 flow_control
= !NILP (flow
);
10162 else if (EQ (meta
, Qt
))
10167 /* Don't let this value be out of range. */
10168 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10174 #ifdef POLL_FOR_INPUT
10175 poll_suppress_count
= 1;
10181 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10182 doc
: /* Return information about the way Emacs currently reads keyboard input.
10183 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10184 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10185 nil, Emacs is using CBREAK mode.
10186 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10187 terminal; this does not apply if Emacs uses interrupt-driven input.
10188 META is t if accepting 8-bit input with 8th bit as Meta flag.
10189 META nil means ignoring the top bit, on the assumption it is parity.
10190 META is neither t nor nil if accepting 8-bit input and using
10191 all 8 bits as the character code.
10192 QUIT is the character Emacs currently uses to quit.
10193 The elements of this list correspond to the arguments of
10194 `set-input-mode'. */)
10197 Lisp_Object val
[4];
10199 val
[0] = interrupt_input
? Qt
: Qnil
;
10200 val
[1] = flow_control
? Qt
: Qnil
;
10201 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10202 XSETFASTINT (val
[3], quit_char
);
10204 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10209 * Set up a new kboard object with reasonable initial values.
10215 kb
->Voverriding_terminal_local_map
= Qnil
;
10216 kb
->Vlast_command
= Qnil
;
10217 kb
->Vreal_last_command
= Qnil
;
10218 kb
->Vprefix_arg
= Qnil
;
10219 kb
->Vlast_prefix_arg
= Qnil
;
10220 kb
->kbd_queue
= Qnil
;
10221 kb
->kbd_queue_has_data
= 0;
10222 kb
->immediate_echo
= 0;
10223 kb
->echo_string
= Qnil
;
10224 kb
->echo_after_prompt
= -1;
10225 kb
->kbd_macro_buffer
= 0;
10226 kb
->kbd_macro_bufsize
= 0;
10227 kb
->defining_kbd_macro
= Qnil
;
10228 kb
->Vlast_kbd_macro
= Qnil
;
10229 kb
->reference_count
= 0;
10230 kb
->Vsystem_key_alist
= Qnil
;
10231 kb
->system_key_syms
= Qnil
;
10232 kb
->Vdefault_minibuffer_frame
= Qnil
;
10236 * Destroy the contents of a kboard object, but not the object itself.
10237 * We use this just before deleting it, or if we're going to initialize
10238 * it a second time.
10244 if (kb
->kbd_macro_buffer
)
10245 xfree (kb
->kbd_macro_buffer
);
10248 #ifdef MULTI_KBOARD
10250 /* Free KB and memory referenced from it. */
10258 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10261 *kbp
= kb
->next_kboard
;
10263 /* Prevent a dangling reference to KB. */
10264 if (kb
== current_kboard
10265 && FRAMEP (selected_frame
)
10266 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10268 current_kboard
= XFRAME (selected_frame
)->kboard
;
10269 if (current_kboard
== kb
)
10277 #endif /* MULTI_KBOARD */
10282 /* This is correct before outermost invocation of the editor loop */
10283 command_loop_level
= -1;
10284 immediate_quit
= 0;
10285 quit_char
= Ctl ('g');
10286 Vunread_command_events
= Qnil
;
10287 unread_command_char
= -1;
10288 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10290 recent_keys_index
= 0;
10291 kbd_fetch_ptr
= kbd_buffer
;
10292 kbd_store_ptr
= kbd_buffer
;
10293 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10295 do_mouse_tracking
= Qnil
;
10299 /* This means that command_loop_1 won't try to select anything the first
10301 internal_last_event_frame
= Qnil
;
10302 Vlast_event_frame
= internal_last_event_frame
;
10304 #ifdef MULTI_KBOARD
10305 current_kboard
= initial_kboard
;
10307 wipe_kboard (current_kboard
);
10308 init_kboard (current_kboard
);
10310 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10312 signal (SIGINT
, interrupt_signal
);
10313 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10314 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10315 SIGQUIT and we can't tell which one it will give us. */
10316 signal (SIGQUIT
, interrupt_signal
);
10317 #endif /* HAVE_TERMIO */
10319 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10321 if (!noninteractive
)
10322 signal (SIGIO
, input_available_signal
);
10325 /* Use interrupt input by default, if it works and noninterrupt input
10326 has deficiencies. */
10328 #ifdef INTERRUPT_INPUT
10329 interrupt_input
= 1;
10331 interrupt_input
= 0;
10334 /* Our VMS input only works by interrupts, as of now. */
10336 interrupt_input
= 1;
10342 if (keyboard_init_hook
)
10343 (*keyboard_init_hook
) ();
10345 #ifdef POLL_FOR_INPUT
10346 poll_suppress_count
= 1;
10351 /* This type's only use is in syms_of_keyboard, to initialize the
10352 event header symbols and put properties on them. */
10353 struct event_head
{
10359 struct event_head head_table
[] = {
10360 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10361 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10362 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10363 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10364 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10365 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10366 {&Qselect_window
, "select-window", &Qselect_window
}
10370 syms_of_keyboard ()
10372 Vpre_help_message
= Qnil
;
10373 staticpro (&Vpre_help_message
);
10375 Vlispy_mouse_stem
= build_string ("mouse");
10376 staticpro (&Vlispy_mouse_stem
);
10379 QCimage
= intern (":image");
10380 staticpro (&QCimage
);
10382 staticpro (&Qhelp_echo
);
10383 Qhelp_echo
= intern ("help-echo");
10385 staticpro (&item_properties
);
10386 item_properties
= Qnil
;
10388 staticpro (&tool_bar_item_properties
);
10389 tool_bar_item_properties
= Qnil
;
10390 staticpro (&tool_bar_items_vector
);
10391 tool_bar_items_vector
= Qnil
;
10393 staticpro (&real_this_command
);
10394 real_this_command
= Qnil
;
10396 Qtimer_event_handler
= intern ("timer-event-handler");
10397 staticpro (&Qtimer_event_handler
);
10399 Qdisabled_command_hook
= intern ("disabled-command-hook");
10400 staticpro (&Qdisabled_command_hook
);
10402 Qself_insert_command
= intern ("self-insert-command");
10403 staticpro (&Qself_insert_command
);
10405 Qforward_char
= intern ("forward-char");
10406 staticpro (&Qforward_char
);
10408 Qbackward_char
= intern ("backward-char");
10409 staticpro (&Qbackward_char
);
10411 Qdisabled
= intern ("disabled");
10412 staticpro (&Qdisabled
);
10414 Qundefined
= intern ("undefined");
10415 staticpro (&Qundefined
);
10417 Qpre_command_hook
= intern ("pre-command-hook");
10418 staticpro (&Qpre_command_hook
);
10420 Qpost_command_hook
= intern ("post-command-hook");
10421 staticpro (&Qpost_command_hook
);
10423 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10424 staticpro (&Qpost_command_idle_hook
);
10426 Qdeferred_action_function
= intern ("deferred-action-function");
10427 staticpro (&Qdeferred_action_function
);
10429 Qcommand_hook_internal
= intern ("command-hook-internal");
10430 staticpro (&Qcommand_hook_internal
);
10432 Qfunction_key
= intern ("function-key");
10433 staticpro (&Qfunction_key
);
10434 Qmouse_click
= intern ("mouse-click");
10435 staticpro (&Qmouse_click
);
10437 Qmouse_wheel
= intern ("mouse-wheel");
10438 staticpro (&Qmouse_wheel
);
10439 Qlanguage_change
= intern ("language-change");
10440 staticpro (&Qlanguage_change
);
10442 Qdrag_n_drop
= intern ("drag-n-drop");
10443 staticpro (&Qdrag_n_drop
);
10445 Qsave_session
= intern ("save-session");
10446 staticpro(&Qsave_session
);
10448 Qusr1_signal
= intern ("usr1-signal");
10449 staticpro (&Qusr1_signal
);
10450 Qusr2_signal
= intern ("usr2-signal");
10451 staticpro (&Qusr2_signal
);
10453 Qmenu_enable
= intern ("menu-enable");
10454 staticpro (&Qmenu_enable
);
10455 Qmenu_alias
= intern ("menu-alias");
10456 staticpro (&Qmenu_alias
);
10457 QCenable
= intern (":enable");
10458 staticpro (&QCenable
);
10459 QCvisible
= intern (":visible");
10460 staticpro (&QCvisible
);
10461 QChelp
= intern (":help");
10462 staticpro (&QChelp
);
10463 QCfilter
= intern (":filter");
10464 staticpro (&QCfilter
);
10465 QCbutton
= intern (":button");
10466 staticpro (&QCbutton
);
10467 QCkeys
= intern (":keys");
10468 staticpro (&QCkeys
);
10469 QCkey_sequence
= intern (":key-sequence");
10470 staticpro (&QCkey_sequence
);
10471 QCtoggle
= intern (":toggle");
10472 staticpro (&QCtoggle
);
10473 QCradio
= intern (":radio");
10474 staticpro (&QCradio
);
10476 Qmode_line
= intern ("mode-line");
10477 staticpro (&Qmode_line
);
10478 Qvertical_line
= intern ("vertical-line");
10479 staticpro (&Qvertical_line
);
10480 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10481 staticpro (&Qvertical_scroll_bar
);
10482 Qmenu_bar
= intern ("menu-bar");
10483 staticpro (&Qmenu_bar
);
10485 Qabove_handle
= intern ("above-handle");
10486 staticpro (&Qabove_handle
);
10487 Qhandle
= intern ("handle");
10488 staticpro (&Qhandle
);
10489 Qbelow_handle
= intern ("below-handle");
10490 staticpro (&Qbelow_handle
);
10491 Qup
= intern ("up");
10493 Qdown
= intern ("down");
10494 staticpro (&Qdown
);
10495 Qtop
= intern ("top");
10497 Qbottom
= intern ("bottom");
10498 staticpro (&Qbottom
);
10499 Qend_scroll
= intern ("end-scroll");
10500 staticpro (&Qend_scroll
);
10501 Qratio
= intern ("ratio");
10502 staticpro (&Qratio
);
10504 Qevent_kind
= intern ("event-kind");
10505 staticpro (&Qevent_kind
);
10506 Qevent_symbol_elements
= intern ("event-symbol-elements");
10507 staticpro (&Qevent_symbol_elements
);
10508 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10509 staticpro (&Qevent_symbol_element_mask
);
10510 Qmodifier_cache
= intern ("modifier-cache");
10511 staticpro (&Qmodifier_cache
);
10513 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10514 staticpro (&Qrecompute_lucid_menubar
);
10515 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10516 staticpro (&Qactivate_menubar_hook
);
10518 Qpolling_period
= intern ("polling-period");
10519 staticpro (&Qpolling_period
);
10521 Qinput_method_function
= intern ("input-method-function");
10522 staticpro (&Qinput_method_function
);
10524 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10525 staticpro (&Qinput_method_exit_on_first_char
);
10526 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10527 staticpro (&Qinput_method_use_echo_area
);
10529 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10530 Fset (Qinput_method_use_echo_area
, Qnil
);
10532 last_point_position_buffer
= Qnil
;
10535 struct event_head
*p
;
10537 for (p
= head_table
;
10538 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10541 *p
->var
= intern (p
->name
);
10542 staticpro (p
->var
);
10543 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10544 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10548 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10549 staticpro (&button_down_location
);
10550 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10551 staticpro (&mouse_syms
);
10555 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10557 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10558 for (i
= 0; i
< len
; i
++)
10559 if (modifier_names
[i
])
10560 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10561 staticpro (&modifier_symbols
);
10564 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10565 staticpro (&recent_keys
);
10567 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10568 staticpro (&this_command_keys
);
10570 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10571 staticpro (&raw_keybuf
);
10573 Qextended_command_history
= intern ("extended-command-history");
10574 Fset (Qextended_command_history
, Qnil
);
10575 staticpro (&Qextended_command_history
);
10577 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10578 staticpro (&kbd_buffer_gcpro
);
10580 accent_key_syms
= Qnil
;
10581 staticpro (&accent_key_syms
);
10583 func_key_syms
= Qnil
;
10584 staticpro (&func_key_syms
);
10587 mouse_wheel_syms
= Qnil
;
10588 staticpro (&mouse_wheel_syms
);
10590 drag_n_drop_syms
= Qnil
;
10591 staticpro (&drag_n_drop_syms
);
10594 unread_switch_frame
= Qnil
;
10595 staticpro (&unread_switch_frame
);
10597 internal_last_event_frame
= Qnil
;
10598 staticpro (&internal_last_event_frame
);
10600 read_key_sequence_cmd
= Qnil
;
10601 staticpro (&read_key_sequence_cmd
);
10603 menu_bar_one_keymap_changed_items
= Qnil
;
10604 staticpro (&menu_bar_one_keymap_changed_items
);
10606 defsubr (&Sevent_convert_list
);
10607 defsubr (&Sread_key_sequence
);
10608 defsubr (&Sread_key_sequence_vector
);
10609 defsubr (&Srecursive_edit
);
10611 defsubr (&Strack_mouse
);
10613 defsubr (&Sinput_pending_p
);
10614 defsubr (&Scommand_execute
);
10615 defsubr (&Srecent_keys
);
10616 defsubr (&Sthis_command_keys
);
10617 defsubr (&Sthis_command_keys_vector
);
10618 defsubr (&Sthis_single_command_keys
);
10619 defsubr (&Sthis_single_command_raw_keys
);
10620 defsubr (&Sreset_this_command_lengths
);
10621 defsubr (&Sclear_this_command_keys
);
10622 defsubr (&Ssuspend_emacs
);
10623 defsubr (&Sabort_recursive_edit
);
10624 defsubr (&Sexit_recursive_edit
);
10625 defsubr (&Srecursion_depth
);
10626 defsubr (&Stop_level
);
10627 defsubr (&Sdiscard_input
);
10628 defsubr (&Sopen_dribble_file
);
10629 defsubr (&Sset_input_mode
);
10630 defsubr (&Scurrent_input_mode
);
10631 defsubr (&Sexecute_extended_command
);
10633 DEFVAR_LISP ("last-command-char", &last_command_char
,
10634 doc
: /* Last input event that was part of a command. */);
10636 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10637 doc
: /* Last input event that was part of a command. */);
10639 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10640 doc
: /* Last input event in a command, except for mouse menu events.
10641 Mouse menus give back keys that don't look like mouse events;
10642 this variable holds the actual mouse event that led to the menu,
10643 so that you can determine whether the command was run by mouse or not. */);
10645 DEFVAR_LISP ("last-input-char", &last_input_char
,
10646 doc
: /* Last input event. */);
10648 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10649 doc
: /* Last input event. */);
10651 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10652 doc
: /* List of events to be read as the command input.
10653 These events are processed first, before actual keyboard input. */);
10654 Vunread_command_events
= Qnil
;
10656 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10657 doc
: /* If not -1, an object to be read as next command input event. */);
10659 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10660 doc
: /* List of events to be processed as input by input methods.
10661 These events are processed after `unread-command-events', but
10662 before actual keyboard input. */);
10663 Vunread_post_input_method_events
= Qnil
;
10665 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10666 doc
: /* List of events to be processed as input by input methods.
10667 These events are processed after `unread-command-events', but
10668 before actual keyboard input. */);
10669 Vunread_input_method_events
= Qnil
;
10671 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10672 doc
: /* Meta-prefix character code.
10673 Meta-foo as command input turns into this character followed by foo. */);
10674 XSETINT (meta_prefix_char
, 033);
10676 DEFVAR_KBOARD ("last-command", Vlast_command
,
10677 doc
: /* The last command executed.
10678 Normally a symbol with a function definition, but can be whatever was found
10679 in the keymap, or whatever the variable `this-command' was set to by that
10682 The value `mode-exit' is special; it means that the previous command
10683 read an event that told it to exit, and it did so and unread that event.
10684 In other words, the present command is the event that made the previous
10687 The value `kill-region' is special; it means that the previous command
10688 was a kill command. */);
10690 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10691 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10693 DEFVAR_LISP ("this-command", &Vthis_command
,
10694 doc
: /* The command now being executed.
10695 The command can set this variable; whatever is put here
10696 will be in `last-command' during the following command. */);
10697 Vthis_command
= Qnil
;
10699 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10700 doc
: /* If non-nil, the original command bound to the current key sequence.
10701 The value of `this-command' is the result of looking up the original
10702 command in the active keymaps. */);
10703 Vthis_original_command
= Qnil
;
10705 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10706 doc
: /* *Number of input events between auto-saves.
10707 Zero means disable autosaving due to number of characters typed. */);
10708 auto_save_interval
= 300;
10710 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10711 doc
: /* *Number of seconds idle time before auto-save.
10712 Zero or nil means disable auto-saving due to idleness.
10713 After auto-saving due to this many seconds of idle time,
10714 Emacs also does a garbage collection if that seems to be warranted. */);
10715 XSETFASTINT (Vauto_save_timeout
, 30);
10717 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10718 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10719 The value may be integer or floating point. */);
10720 Vecho_keystrokes
= make_number (1);
10722 DEFVAR_INT ("polling-period", &polling_period
,
10723 doc
: /* *Interval between polling for input during Lisp execution.
10724 The reason for polling is to make C-g work to stop a running program.
10725 Polling is needed only when using X windows and SIGIO does not work.
10726 Polling is automatically disabled in all other cases. */);
10727 polling_period
= 2;
10729 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10730 doc
: /* *Maximum time between mouse clicks to make a double-click.
10731 Measured in milliseconds. nil means disable double-click recognition;
10732 t means double-clicks have no time limit and are detected
10733 by position only. */);
10734 Vdouble_click_time
= make_number (500);
10736 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10737 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10738 On window-system frames, value is the number of pixels the mouse may have
10739 moved horizontally or vertically between two clicks to make a double-click.
10740 On non window-system frames, value is interpreted in units of 1/8 characters
10743 This variable is also the threshold for motion of the mouse
10744 to count as a drag. */);
10745 double_click_fuzz
= 3;
10747 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10748 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10749 inhibit_local_menu_bar_menus
= 0;
10751 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10752 doc
: /* Number of complete key sequences read as input so far.
10753 This includes key sequences read from keyboard macros.
10754 The number is effectively the number of interactive command invocations. */);
10755 num_input_keys
= 0;
10757 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10758 doc
: /* Number of input events read from the keyboard so far.
10759 This does not include events generated by keyboard macros. */);
10760 num_nonmacro_input_events
= 0;
10762 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10763 doc
: /* The frame in which the most recently read event occurred.
10764 If the last event came from a keyboard macro, this is set to `macro'. */);
10765 Vlast_event_frame
= Qnil
;
10767 /* This variable is set up in sysdep.c. */
10768 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10769 doc
: /* The ERASE character as set by the user with stty. */);
10771 DEFVAR_LISP ("help-char", &Vhelp_char
,
10772 doc
: /* Character to recognize as meaning Help.
10773 When it is read, do `(eval help-form)', and display result if it's a string.
10774 If the value of `help-form' is nil, this char can be read normally. */);
10775 XSETINT (Vhelp_char
, Ctl ('H'));
10777 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10778 doc
: /* List of input events to recognize as meaning Help.
10779 These work just like the value of `help-char' (see that). */);
10780 Vhelp_event_list
= Qnil
;
10782 DEFVAR_LISP ("help-form", &Vhelp_form
,
10783 doc
: /* Form to execute when character `help-char' is read.
10784 If the form returns a string, that string is displayed.
10785 If `help-form' is nil, the help char is not recognized. */);
10788 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10789 doc
: /* Command to run when `help-char' character follows a prefix key.
10790 This command is used only when there is no actual binding
10791 for that character after that prefix key. */);
10792 Vprefix_help_command
= Qnil
;
10794 DEFVAR_LISP ("top-level", &Vtop_level
,
10795 doc
: /* Form to evaluate when Emacs starts up.
10796 Useful to set before you dump a modified Emacs. */);
10799 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10800 doc
: /* Translate table for keyboard input, or nil.
10801 Each character is looked up in this string and the contents used instead.
10802 The value may be a string, a vector, or a char-table.
10803 If it is a string or vector of length N,
10804 character codes N and up are untranslated.
10805 In a vector or a char-table, an element which is nil means "no translation". */);
10806 Vkeyboard_translate_table
= Qnil
;
10808 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10809 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
10810 \(Even if the operating system has support for stopping a process.\) */);
10811 cannot_suspend
= 0;
10813 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10814 doc
: /* Non-nil means prompt with menus when appropriate.
10815 This is done when reading from a keymap that has a prompt string,
10816 for elements that have prompt strings.
10817 The menu is displayed on the screen
10818 if X menus were enabled at configuration
10819 time and the previous event was a mouse click prefix key.
10820 Otherwise, menu prompting uses the echo area. */);
10821 menu_prompting
= 1;
10823 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10824 doc
: /* Character to see next line of menu prompt.
10825 Type this character while in a menu prompt to rotate around the lines of it. */);
10826 XSETINT (menu_prompt_more_char
, ' ');
10828 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10829 doc
: /* A mask of additional modifier keys to use with every keyboard character.
10830 Emacs applies the modifiers of the character stored here to each keyboard
10831 character it reads. For example, after evaluating the expression
10832 (setq extra-keyboard-modifiers ?\\C-x)
10833 all input characters will have the control modifier applied to them.
10835 Note that the character ?\\C-@, equivalent to the integer zero, does
10836 not count as a control character; rather, it counts as a character
10837 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
10838 cancels any modification. */);
10839 extra_keyboard_modifiers
= 0;
10841 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10842 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
10843 The command loop sets this to nil before each command,
10844 and tests the value when the command returns.
10845 Buffer modification stores t in this variable. */);
10846 Vdeactivate_mark
= Qnil
;
10848 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10849 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
10850 Vcommand_hook_internal
= Qnil
;
10852 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10853 doc
: /* Normal hook run before each command is executed.
10854 If an unhandled error happens in running this hook,
10855 the hook value is set to nil, since otherwise the error
10856 might happen repeatedly and make Emacs nonfunctional. */);
10857 Vpre_command_hook
= Qnil
;
10859 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10860 doc
: /* Normal hook run after each command is executed.
10861 If an unhandled error happens in running this hook,
10862 the hook value is set to nil, since otherwise the error
10863 might happen repeatedly and make Emacs nonfunctional. */);
10864 Vpost_command_hook
= Qnil
;
10866 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10867 doc
: /* Normal hook run after each command is executed, if idle.
10868 Errors running the hook are caught and ignored. */);
10869 Vpost_command_idle_hook
= Qnil
;
10871 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10872 doc
: /* Delay time before running `post-command-idle-hook'.
10873 This is measured in microseconds. */);
10874 post_command_idle_delay
= 100000;
10877 DEFVAR_LISP ("echo-area-clear-hook", ...,
10878 doc
: /* Normal hook run when clearing the echo area. */);
10880 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10881 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
10883 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10884 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
10885 Vlucid_menu_bar_dirty_flag
= Qnil
;
10887 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10888 doc
: /* List of menu bar items to move to the end of the menu bar.
10889 The elements of the list are event types that may have menu bar bindings. */);
10890 Vmenu_bar_final_items
= Qnil
;
10892 DEFVAR_KBOARD ("overriding-terminal-local-map",
10893 Voverriding_terminal_local_map
,
10894 doc
: /* Per-terminal keymap that overrides all other local keymaps.
10895 If this variable is non-nil, it is used as a keymap instead of the
10896 buffer's local map, and the minor mode keymaps and text property keymaps.
10897 This variable is intended to let commands such as `universal-argument'
10898 set up a different keymap for reading the next command. */);
10900 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
10901 doc
: /* Keymap that overrides all other local keymaps.
10902 If this variable is non-nil, it is used as a keymap instead of the
10903 buffer's local map, and the minor mode keymaps and text property keymaps. */);
10904 Voverriding_local_map
= Qnil
;
10906 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
10907 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
10908 Otherwise, the menu bar continues to reflect the buffer's local map
10909 and the minor mode maps regardless of `overriding-local-map'. */);
10910 Voverriding_local_map_menu_flag
= Qnil
;
10912 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
10913 doc
: /* Keymap defining bindings for special events to execute at low level. */);
10914 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
10916 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
10917 doc
: /* *Non-nil means generate motion events for mouse motion. */);
10919 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
10920 doc
: /* Alist of system-specific X windows key symbols.
10921 Each element should have the form (N . SYMBOL) where N is the
10922 numeric keysym code (sans the \"system-specific\" bit 1<<28)
10923 and SYMBOL is its name. */);
10925 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
10926 doc
: /* List of deferred actions to be performed at a later time.
10927 The precise format isn't relevant here; we just check whether it is nil. */);
10928 Vdeferred_action_list
= Qnil
;
10930 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
10931 doc
: /* Function to call to handle deferred actions, after each command.
10932 This function is called with no arguments after each command
10933 whenever `deferred-action-list' is non-nil. */);
10934 Vdeferred_action_function
= Qnil
;
10936 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
10937 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
10938 The value can be a length of time to show the message for.
10939 If the value is non-nil and not a number, we wait 2 seconds. */);
10940 Vsuggest_key_bindings
= Qt
;
10942 DEFVAR_LISP ("timer-list", &Vtimer_list
,
10943 doc
: /* List of active absolute time timers in order of increasing time. */);
10944 Vtimer_list
= Qnil
;
10946 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
10947 doc
: /* List of active idle-time timers in order of increasing time. */);
10948 Vtimer_idle_list
= Qnil
;
10950 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
10951 doc
: /* If non-nil, the function that implements the current input method.
10952 It's called with one argument, a printing character that was just read.
10953 \(That means a character with code 040...0176.)
10954 Typically this function uses `read-event' to read additional events.
10955 When it does so, it should first bind `input-method-function' to nil
10956 so it will not be called recursively.
10958 The function should return a list of zero or more events
10959 to be used as input. If it wants to put back some events
10960 to be reconsidered, separately, by the input method,
10961 it can add them to the beginning of `unread-command-events'.
10963 The input method function can find in `input-method-previous-method'
10964 the previous echo area message.
10966 The input method function should refer to the variables
10967 `input-method-use-echo-area' and `input-method-exit-on-first-char'
10968 for guidance on what to do. */);
10969 Vinput_method_function
= Qnil
;
10971 DEFVAR_LISP ("input-method-previous-message",
10972 &Vinput_method_previous_message
,
10973 doc
: /* When `input-method-function' is called, hold the previous echo area message.
10974 This variable exists because `read-event' clears the echo area
10975 before running the input method. It is nil if there was no message. */);
10976 Vinput_method_previous_message
= Qnil
;
10978 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
10979 doc
: /* If non-nil, the function that implements the display of help.
10980 It's called with one argument, the help string to display. */);
10981 Vshow_help_function
= Qnil
;
10983 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
10984 doc
: /* If non-nil, suppress point adjustment after executing a command.
10986 After a command is executed, if point is moved into a region that has
10987 special properties (e.g. composition, display), we adjust point to
10988 the boundary of the region. But, several special commands sets this
10989 variable to non-nil, then we suppress the point adjustment.
10991 This variable is set to nil before reading a command, and is checked
10992 just after executing the command. */);
10993 Vdisable_point_adjustment
= Qnil
;
10995 DEFVAR_LISP ("global-disable-point-adjustment",
10996 &Vglobal_disable_point_adjustment
,
10997 doc
: /* *If non-nil, always suppress point adjustment.
10999 The default value is nil, in which case, point adjustment are
11000 suppressed only after special commands that set
11001 `disable-point-adjustment' (which see) to non-nil. */);
11002 Vglobal_disable_point_adjustment
= Qnil
;
11004 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11005 doc
: /* Non-nil means updating menu bindings is allowed.
11006 A value of nil means menu bindings should not be updated.
11007 Used during Emacs' startup. */);
11008 update_menu_bindings
= 1;
11010 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11011 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11012 If the value is not a number, such messages don't time out. */);
11013 Vminibuffer_message_timeout
= make_number (2);
11017 keys_of_keyboard ()
11019 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11020 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11021 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11022 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11023 initial_define_key (meta_map
, 'x', "execute-extended-command");
11025 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11026 "handle-delete-frame");
11027 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11029 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11031 initial_define_lispy_key (Vspecial_event_map
, "select-window",
11032 "handle-select-window");
11033 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11034 "handle-save-session");