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 struct Lisp_String
*name
= XSTRING (SYMBOL_NAME (c
));
752 int nbytes
= STRING_BYTES (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 (name
->data
, ptr
, nbytes
,
763 name
->size_byte
>= 0, 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 SMBP (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_ptr
- specpdl
;
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_ptr
- specpdl
;
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 if (!NILP (executing_macro
))
1126 if (executing_macro_iterations
== 1)
1127 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1129 sprintf (macroerror
, "After %d kbd macro iterations: ",
1130 executing_macro_iterations
);
1135 Vstandard_output
= Qt
;
1136 Vstandard_input
= Qt
;
1137 Vexecuting_macro
= Qnil
;
1138 executing_macro
= Qnil
;
1139 current_kboard
->Vprefix_arg
= Qnil
;
1140 current_kboard
->Vlast_prefix_arg
= Qnil
;
1143 /* Avoid unquittable loop if data contains a circular list. */
1144 old_level
= Vprint_level
;
1145 old_length
= Vprint_length
;
1146 XSETFASTINT (Vprint_level
, 10);
1147 XSETFASTINT (Vprint_length
, 10);
1148 cmd_error_internal (data
, macroerror
);
1149 Vprint_level
= old_level
;
1150 Vprint_length
= old_length
;
1154 Vinhibit_quit
= Qnil
;
1156 any_kboard_state ();
1159 return make_number (0);
1162 /* Take actions on handling an error. DATA is the data that describes
1165 CONTEXT is a C-string containing ASCII characters only which
1166 describes the context in which the error happened. If we need to
1167 generalize CONTEXT to allow multibyte characters, make it a Lisp
1171 cmd_error_internal (data
, context
)
1176 int kill_emacs_p
= 0;
1177 struct frame
*sf
= SELECTED_FRAME ();
1181 clear_message (1, 0);
1183 /* If the window system or terminal frame hasn't been initialized
1184 yet, or we're not interactive, it's best to dump this message out
1185 to stderr and exit. */
1186 if (!sf
->glyphs_initialized_p
1187 /* This is the case of the frame dumped with Emacs, when we're
1188 running under a window system. */
1189 || (!NILP (Vwindow_system
)
1190 && !inhibit_window_system
1191 && FRAME_TERMCAP_P (sf
))
1194 stream
= Qexternal_debugging_output
;
1205 write_string_1 (context
, -1, stream
);
1207 print_error_message (data
, stream
);
1209 /* If the window system or terminal frame hasn't been initialized
1210 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1214 Fkill_emacs (make_number (-1));
1218 Lisp_Object
command_loop_1 ();
1219 Lisp_Object
command_loop_2 ();
1220 Lisp_Object
top_level_1 ();
1222 /* Entry to editor-command-loop.
1223 This level has the catches for exiting/returning to editor command loop.
1224 It returns nil to exit recursive edit, t to abort it. */
1229 if (command_loop_level
> 0 || minibuf_level
> 0)
1232 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1233 executing_macro
= Qnil
;
1239 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1240 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1241 executing_macro
= Qnil
;
1243 /* End of file in -batch run causes exit here. */
1249 /* Here we catch errors in execution of commands within the
1250 editing loop, and reenter the editing loop.
1251 When there is an error, cmd_error runs and returns a non-nil
1252 value to us. A value of nil means that command_loop_1 itself
1253 returned due to end of file (or end of kbd macro). */
1258 register Lisp_Object val
;
1261 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1262 while (!NILP (val
));
1270 return Feval (Vtop_level
);
1276 /* On entry to the outer level, run the startup file */
1277 if (!NILP (Vtop_level
))
1278 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1279 else if (!NILP (Vpurify_flag
))
1280 message ("Bare impure Emacs (standard Lisp code not loaded)");
1282 message ("Bare Emacs (standard Lisp code not loaded)");
1286 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1287 doc
: /* Exit all recursive editing levels. */)
1290 #ifdef HAVE_X_WINDOWS
1291 if (display_hourglass_p
)
1292 cancel_hourglass ();
1294 return Fthrow (Qtop_level
, Qnil
);
1297 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1298 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1301 if (command_loop_level
> 0 || minibuf_level
> 0)
1302 Fthrow (Qexit
, Qnil
);
1304 error ("No recursive edit is in progress");
1308 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1309 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1312 if (command_loop_level
> 0 || minibuf_level
> 0)
1315 error ("No recursive edit is in progress");
1319 /* This is the actual command reading loop,
1320 sans error-handling encapsulation. */
1322 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1324 void safe_run_hooks
P_ ((Lisp_Object
));
1325 static void adjust_point_for_property
P_ ((int));
1333 Lisp_Object keybuf
[30];
1337 struct buffer
*prev_buffer
= NULL
;
1339 int was_locked
= single_kboard
;
1342 current_kboard
->Vprefix_arg
= Qnil
;
1343 current_kboard
->Vlast_prefix_arg
= Qnil
;
1344 Vdeactivate_mark
= Qnil
;
1345 waiting_for_input
= 0;
1349 this_command_key_count
= 0;
1350 this_single_command_key_start
= 0;
1352 /* Make sure this hook runs after commands that get errors and
1353 throw to top level. */
1354 /* Note that the value cell will never directly contain nil
1355 if the symbol is a local variable. */
1356 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1357 safe_run_hooks (Qpost_command_hook
);
1359 /* If displaying a message, resize the echo area window to fit
1360 that message's size exactly. */
1361 if (!NILP (echo_area_buffer
[0]))
1362 resize_echo_area_exactly ();
1364 if (!NILP (Vdeferred_action_list
))
1365 call0 (Vdeferred_action_function
);
1367 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1369 if (NILP (Vunread_command_events
)
1370 && NILP (Vunread_input_method_events
)
1371 && NILP (Vunread_post_input_method_events
)
1372 && NILP (Vexecuting_macro
)
1373 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1374 safe_run_hooks (Qpost_command_idle_hook
);
1377 /* Do this after running Vpost_command_hook, for consistency. */
1378 current_kboard
->Vlast_command
= Vthis_command
;
1379 current_kboard
->Vreal_last_command
= real_this_command
;
1383 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1386 /* Make sure the current window's buffer is selected. */
1387 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1388 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1390 /* Display any malloc warning that just came out. Use while because
1391 displaying one warning can cause another. */
1393 while (pending_malloc_warning
)
1394 display_malloc_warning ();
1398 Vdeactivate_mark
= Qnil
;
1400 /* If minibuffer on and echo area in use,
1401 wait a short time and redraw minibuffer. */
1404 && !NILP (echo_area_buffer
[0])
1405 && EQ (minibuf_window
, echo_area_window
)
1406 && NUMBERP (Vminibuffer_message_timeout
))
1408 /* Bind inhibit-quit to t so that C-g gets read in
1409 rather than quitting back to the minibuffer. */
1410 int count
= specpdl_ptr
- specpdl
;
1411 specbind (Qinhibit_quit
, Qt
);
1413 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1414 /* Clear the echo area. */
1416 safe_run_hooks (Qecho_area_clear_hook
);
1418 unbind_to (count
, Qnil
);
1420 /* If a C-g came in before, treat it as input now. */
1421 if (!NILP (Vquit_flag
))
1424 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1429 alloca (0); /* Cause a garbage collection now */
1430 /* Since we can free the most stuff here. */
1431 #endif /* C_ALLOCA */
1434 /* Select the frame that the last event came from. Usually,
1435 switch-frame events will take care of this, but if some lisp
1436 code swallows a switch-frame event, we'll fix things up here.
1437 Is this a good idea? */
1438 if (FRAMEP (internal_last_event_frame
)
1439 && !EQ (internal_last_event_frame
, selected_frame
))
1440 Fselect_frame (internal_last_event_frame
, Qnil
);
1442 /* If it has changed current-menubar from previous value,
1443 really recompute the menubar from the value. */
1444 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1445 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1446 call0 (Qrecompute_lucid_menubar
);
1448 before_command_key_count
= this_command_key_count
;
1449 before_command_echo_length
= echo_length ();
1451 Vthis_command
= Qnil
;
1452 real_this_command
= Qnil
;
1454 /* Read next key sequence; i gets its length. */
1455 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1458 /* A filter may have run while we were reading the input. */
1459 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1461 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1462 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1466 /* Now we have read a key sequence of length I,
1467 or else I is 0 and we found end of file. */
1469 if (i
== 0) /* End of file -- happens only in */
1470 return Qnil
; /* a kbd macro, at the end. */
1471 /* -1 means read_key_sequence got a menu that was rejected.
1472 Just loop around and read another command. */
1476 this_command_key_count
= 0;
1477 this_single_command_key_start
= 0;
1481 last_command_char
= keybuf
[i
- 1];
1483 /* If the previous command tried to force a specific window-start,
1484 forget about that, in case this command moves point far away
1485 from that position. But also throw away beg_unchanged and
1486 end_unchanged information in that case, so that redisplay will
1487 update the whole window properly. */
1488 if (!NILP (XWINDOW (selected_window
)->force_start
))
1491 XWINDOW (selected_window
)->force_start
= Qnil
;
1492 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1493 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1496 cmd
= read_key_sequence_cmd
;
1497 if (!NILP (Vexecuting_macro
))
1499 if (!NILP (Vquit_flag
))
1501 Vexecuting_macro
= Qt
;
1502 QUIT
; /* Make some noise. */
1503 /* Will return since macro now empty. */
1507 /* Do redisplay processing after this command except in special
1508 cases identified below. */
1509 prev_buffer
= current_buffer
;
1510 prev_modiff
= MODIFF
;
1511 last_point_position
= PT
;
1512 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1514 /* By default, we adjust point to a boundary of a region that
1515 has such a property that should be treated intangible
1516 (e.g. composition, display). But, some commands will set
1517 this variable differently. */
1518 Vdisable_point_adjustment
= Qnil
;
1520 /* Process filters and timers may have messed with deactivate-mark.
1521 reset it before we execute the command. */
1522 Vdeactivate_mark
= Qnil
;
1524 /* Remap command through active keymaps */
1525 Vthis_original_command
= cmd
;
1529 if (cmd1
= Fremap_command (cmd
), !NILP (cmd1
))
1533 /* Execute the command. */
1535 Vthis_command
= cmd
;
1536 real_this_command
= cmd
;
1537 /* Note that the value cell will never directly contain nil
1538 if the symbol is a local variable. */
1539 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1540 safe_run_hooks (Qpre_command_hook
);
1542 if (NILP (Vthis_command
))
1544 /* nil means key is undefined. */
1546 current_kboard
->defining_kbd_macro
= Qnil
;
1547 update_mode_lines
= 1;
1548 current_kboard
->Vprefix_arg
= Qnil
;
1552 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1554 /* In case we jump to directly_done. */
1555 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1557 /* Recognize some common commands in common situations and
1558 do them directly. */
1559 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1561 struct Lisp_Char_Table
*dp
1562 = window_display_table (XWINDOW (selected_window
));
1563 lose
= FETCH_CHAR (PT_BYTE
);
1566 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1567 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1568 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1569 && (lose
>= 0x20 && lose
< 0x7f)))
1570 : (lose
>= 0x20 && lose
< 0x7f))
1571 /* To extract the case of continuation on
1572 wide-column characters. */
1573 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1574 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1576 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1578 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1580 && !windows_or_buffers_changed
1581 && EQ (current_buffer
->selective_display
, Qnil
)
1582 && !detect_input_pending ()
1583 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1584 && NILP (Vexecuting_macro
))
1585 direct_output_forward_char (1);
1588 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1590 struct Lisp_Char_Table
*dp
1591 = window_display_table (XWINDOW (selected_window
));
1593 lose
= FETCH_CHAR (PT_BYTE
);
1595 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1596 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1597 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1598 && (lose
>= 0x20 && lose
< 0x7f)))
1599 : (lose
>= 0x20 && lose
< 0x7f))
1600 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1602 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1604 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1606 && !windows_or_buffers_changed
1607 && EQ (current_buffer
->selective_display
, Qnil
)
1608 && !detect_input_pending ()
1609 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1610 && NILP (Vexecuting_macro
))
1611 direct_output_forward_char (-1);
1614 else if (EQ (Vthis_command
, Qself_insert_command
)
1615 /* Try this optimization only on ascii keystrokes. */
1616 && INTEGERP (last_command_char
))
1618 unsigned int c
= XINT (last_command_char
);
1620 if (NILP (Vexecuting_macro
)
1621 && !EQ (minibuf_window
, selected_window
))
1623 if (!nonundocount
|| nonundocount
>= 20)
1631 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1633 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1635 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1637 || MODIFF
<= SAVE_MODIFF
1638 || windows_or_buffers_changed
1639 || !EQ (current_buffer
->selective_display
, Qnil
)
1640 || detect_input_pending ()
1641 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1642 || !NILP (Vexecuting_macro
));
1644 value
= internal_self_insert (c
, 0);
1649 /* VALUE == 1 when AFTER-CHANGE functions are
1650 installed which is the case most of the time
1651 because FONT-LOCK installs one. */
1652 if (!lose
&& !value
)
1653 direct_output_for_insert (c
);
1658 /* Here for a command that isn't executed directly */
1660 #ifdef HAVE_X_WINDOWS
1661 if (display_hourglass_p
1662 && NILP (Vexecuting_macro
))
1667 if (NILP (current_kboard
->Vprefix_arg
))
1669 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1671 #ifdef HAVE_X_WINDOWS
1672 /* Do not check display_hourglass_p here, because
1673 Fcommand_execute could change it, but we should cancel
1674 hourglass cursor anyway.
1675 But don't cancel the hourglass within a macro
1676 just because a command in the macro finishes. */
1677 if (NILP (Vexecuting_macro
))
1678 cancel_hourglass ();
1682 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1684 /* Note that the value cell will never directly contain nil
1685 if the symbol is a local variable. */
1686 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1687 safe_run_hooks (Qpost_command_hook
);
1689 /* If displaying a message, resize the echo area window to fit
1690 that message's size exactly. */
1691 if (!NILP (echo_area_buffer
[0]))
1692 resize_echo_area_exactly ();
1694 if (!NILP (Vdeferred_action_list
))
1695 safe_run_hooks (Qdeferred_action_function
);
1697 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1699 if (NILP (Vunread_command_events
)
1700 && NILP (Vunread_input_method_events
)
1701 && NILP (Vunread_post_input_method_events
)
1702 && NILP (Vexecuting_macro
)
1703 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1704 safe_run_hooks (Qpost_command_idle_hook
);
1707 /* If there is a prefix argument,
1708 1) We don't want Vlast_command to be ``universal-argument''
1709 (that would be dumb), so don't set Vlast_command,
1710 2) we want to leave echoing on so that the prefix will be
1711 echoed as part of this key sequence, so don't call
1713 3) we want to leave this_command_key_count non-zero, so that
1714 read_char will realize that it is re-reading a character, and
1715 not echo it a second time.
1717 If the command didn't actually create a prefix arg,
1718 but is merely a frame event that is transparent to prefix args,
1719 then the above doesn't apply. */
1720 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1722 current_kboard
->Vlast_command
= Vthis_command
;
1723 current_kboard
->Vreal_last_command
= real_this_command
;
1725 this_command_key_count
= 0;
1726 this_single_command_key_start
= 0;
1729 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1731 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1733 /* We could also call `deactivate'mark'. */
1734 if (EQ (Vtransient_mark_mode
, Qlambda
))
1735 Vtransient_mark_mode
= Qnil
;
1738 current_buffer
->mark_active
= Qnil
;
1739 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1742 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1743 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1748 if (current_buffer
== prev_buffer
1749 && last_point_position
!= PT
1750 && NILP (Vdisable_point_adjustment
)
1751 && NILP (Vglobal_disable_point_adjustment
))
1752 adjust_point_for_property (last_point_position
);
1754 /* Install chars successfully executed in kbd macro. */
1756 if (!NILP (current_kboard
->defining_kbd_macro
)
1757 && NILP (current_kboard
->Vprefix_arg
))
1758 finalize_kbd_macro_chars ();
1762 any_kboard_state ();
1767 extern Lisp_Object Qcomposition
, Qdisplay
;
1769 /* Adjust point to a boundary of a region that has such a property
1770 that should be treated intangible. For the moment, we check
1771 `composition' and `display' property. LAST_PT is the last position
1775 adjust_point_for_property (last_pt
)
1780 int check_composition
= 1, check_display
= 1;
1782 while (check_composition
|| check_display
)
1784 if (check_composition
1785 && PT
> BEGV
&& PT
< ZV
1786 && get_property_and_range (PT
, Qcomposition
, &val
, &start
, &end
, Qnil
)
1787 && COMPOSITION_VALID_P (start
, end
, val
)
1788 && start
< PT
&& end
> PT
1789 && (last_pt
<= start
|| last_pt
>= end
))
1797 check_composition
= 0;
1799 && PT
> BEGV
&& PT
< ZV
1800 && get_property_and_range (PT
, Qdisplay
, &val
, &start
, &end
, Qnil
)
1801 && display_prop_intangible_p (val
)
1802 && start
< PT
&& end
> PT
1803 && (last_pt
<= start
|| last_pt
>= end
))
1809 check_composition
= 1;
1815 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1818 safe_run_hooks_1 (hook
)
1821 return call1 (Vrun_hooks
, Vinhibit_quit
);
1824 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1827 safe_run_hooks_error (data
)
1830 return Fset (Vinhibit_quit
, Qnil
);
1833 /* If we get an error while running the hook, cause the hook variable
1834 to be nil. Also inhibit quits, so that C-g won't cause the hook
1835 to mysteriously evaporate. */
1838 safe_run_hooks (hook
)
1841 int count
= specpdl_ptr
- specpdl
;
1842 specbind (Qinhibit_quit
, hook
);
1844 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1846 unbind_to (count
, Qnil
);
1850 /* Number of seconds between polling for input. This is a Lisp
1851 variable that can be bound. */
1853 EMACS_INT polling_period
;
1855 /* Nonzero means polling for input is temporarily suppressed. */
1857 int poll_suppress_count
;
1859 /* Asynchronous timer for polling. */
1861 struct atimer
*poll_timer
;
1864 #ifdef POLL_FOR_INPUT
1866 /* Poll for input, so what we catch a C-g if it comes in. This
1867 function is called from x_make_frame_visible, see comment
1873 if (interrupt_input_blocked
== 0
1874 && !waiting_for_input
)
1875 read_avail_input (0);
1878 /* Timer callback function for poll_timer. TIMER is equal to
1882 poll_for_input (timer
)
1883 struct atimer
*timer
;
1885 if (poll_suppress_count
== 0)
1886 poll_for_input_1 ();
1889 #endif /* POLL_FOR_INPUT */
1891 /* Begin signals to poll for input, if they are appropriate.
1892 This function is called unconditionally from various places. */
1897 #ifdef POLL_FOR_INPUT
1898 if (read_socket_hook
&& !interrupt_input
)
1900 /* Turn alarm handling on unconditionally. It might have
1901 been turned off in process.c. */
1902 turn_on_atimers (1);
1904 /* If poll timer doesn't exist, are we need one with
1905 a different interval, start a new one. */
1906 if (poll_timer
== NULL
1907 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1909 EMACS_TIME interval
;
1912 cancel_atimer (poll_timer
);
1914 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1915 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1916 poll_for_input
, NULL
);
1919 /* Let the timer's callback function poll for input
1920 if this becomes zero. */
1921 --poll_suppress_count
;
1926 /* Nonzero if we are using polling to handle input asynchronously. */
1929 input_polling_used ()
1931 #ifdef POLL_FOR_INPUT
1932 return read_socket_hook
&& !interrupt_input
;
1938 /* Turn off polling. */
1943 #ifdef POLL_FOR_INPUT
1944 if (read_socket_hook
&& !interrupt_input
)
1945 ++poll_suppress_count
;
1949 /* Set the value of poll_suppress_count to COUNT
1950 and start or stop polling accordingly. */
1953 set_poll_suppress_count (count
)
1956 #ifdef POLL_FOR_INPUT
1957 if (count
== 0 && poll_suppress_count
!= 0)
1959 poll_suppress_count
= 1;
1962 else if (count
!= 0 && poll_suppress_count
== 0)
1966 poll_suppress_count
= count
;
1970 /* Bind polling_period to a value at least N.
1971 But don't decrease it. */
1974 bind_polling_period (n
)
1977 #ifdef POLL_FOR_INPUT
1978 int new = polling_period
;
1983 stop_other_atimers (poll_timer
);
1985 specbind (Qpolling_period
, make_number (new));
1986 /* Start a new alarm with the new period. */
1991 /* Apply the control modifier to CHARACTER. */
1997 /* Save the upper bits here. */
1998 int upper
= c
& ~0177;
2002 /* Everything in the columns containing the upper-case letters
2003 denotes a control character. */
2004 if (c
>= 0100 && c
< 0140)
2008 /* Set the shift modifier for a control char
2009 made from a shifted letter. But only for letters! */
2010 if (oc
>= 'A' && oc
<= 'Z')
2011 c
|= shift_modifier
;
2014 /* The lower-case letters denote control characters too. */
2015 else if (c
>= 'a' && c
<= 'z')
2018 /* Include the bits for control and shift
2019 only if the basic ASCII code can't indicate them. */
2023 /* Replace the high bits. */
2024 c
|= (upper
& ~ctrl_modifier
);
2029 /* Display help echo in the echo area.
2031 HELP a string means display that string, HELP nil means clear the
2032 help echo. If HELP is a function, call it with OBJECT and POS as
2033 arguments; the function should return a help string or nil for
2034 none. For all other types of HELP evaluate it to obtain a string.
2036 WINDOW is the window in which the help was generated, if any.
2037 It is nil if not in a window.
2039 If OBJECT is a buffer, POS is the position in the buffer where the
2040 `help-echo' text property was found.
2042 If OBJECT is an overlay, that overlay has a `help-echo' property,
2043 and POS is the position in the overlay's buffer under the mouse.
2045 If OBJECT is a string (an overlay string or a string displayed with
2046 the `display' property). POS is the position in that string under
2049 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2050 echo overwrites a keystroke echo currently displayed in the echo
2053 Note: this function may only be called with HELP nil or a string
2054 from X code running asynchronously. */
2057 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2058 Lisp_Object help
, window
, object
, pos
;
2059 int ok_to_overwrite_keystroke_echo
;
2061 if (!NILP (help
) && !STRINGP (help
))
2063 if (FUNCTIONP (help
))
2065 Lisp_Object args
[4];
2070 help
= safe_call (4, args
);
2073 help
= safe_eval (help
);
2075 if (!STRINGP (help
))
2079 if (STRINGP (help
) || NILP (help
))
2081 if (!NILP (Vshow_help_function
))
2082 call1 (Vshow_help_function
, help
);
2083 else if (/* Don't overwrite minibuffer contents. */
2084 !MINI_WINDOW_P (XWINDOW (selected_window
))
2085 /* Don't overwrite a keystroke echo. */
2086 && (NILP (echo_message_buffer
)
2087 || ok_to_overwrite_keystroke_echo
)
2088 /* Don't overwrite a prompt. */
2089 && !cursor_in_echo_area
)
2093 int count
= BINDING_STACK_SIZE ();
2095 if (!help_echo_showing_p
)
2096 Vpre_help_message
= current_message ();
2098 specbind (Qmessage_truncate_lines
, Qt
);
2099 message3_nolog (help
, STRING_BYTES (XSTRING (help
)),
2100 STRING_MULTIBYTE (help
));
2101 unbind_to (count
, Qnil
);
2103 else if (STRINGP (Vpre_help_message
))
2105 message3_nolog (Vpre_help_message
,
2106 STRING_BYTES (XSTRING (Vpre_help_message
)),
2107 STRING_MULTIBYTE (Vpre_help_message
));
2108 Vpre_help_message
= Qnil
;
2114 help_echo_showing_p
= STRINGP (help
);
2120 /* Input of single characters from keyboard */
2122 Lisp_Object
print_help ();
2123 static Lisp_Object
kbd_buffer_get_event ();
2124 static void record_char ();
2127 static jmp_buf wrong_kboard_jmpbuf
;
2130 /* read a character from the keyboard; call the redisplay if needed */
2131 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2132 -1 means do not do redisplay, but do do autosaving.
2135 /* The arguments MAPS and NMAPS are for menu prompting.
2136 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2138 PREV_EVENT is the previous input event, or nil if we are reading
2139 the first event of a key sequence (or not reading a key sequence).
2140 If PREV_EVENT is t, that is a "magic" value that says
2141 not to run input methods, but in other respects to act as if
2142 not reading a key sequence.
2144 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2145 if we used a mouse menu to read the input, or zero otherwise. If
2146 USED_MOUSE_MENU is null, we don't dereference it.
2148 Value is t if we showed a menu and the user rejected it. */
2151 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2155 Lisp_Object prev_event
;
2156 int *used_mouse_menu
;
2158 volatile Lisp_Object c
;
2160 jmp_buf local_getcjmp
;
2162 volatile int key_already_recorded
= 0;
2163 Lisp_Object tem
, save
;
2164 volatile Lisp_Object previous_echo_area_message
;
2165 volatile Lisp_Object also_record
;
2166 volatile int reread
;
2167 struct gcpro gcpro1
, gcpro2
;
2168 EMACS_TIME last_idle_start
;
2172 before_command_key_count
= this_command_key_count
;
2173 before_command_echo_length
= echo_length ();
2175 previous_echo_area_message
= Qnil
;
2177 GCPRO2 (c
, previous_echo_area_message
);
2182 if (CONSP (Vunread_post_input_method_events
))
2184 c
= XCAR (Vunread_post_input_method_events
);
2185 Vunread_post_input_method_events
2186 = XCDR (Vunread_post_input_method_events
);
2188 /* Undo what read_char_x_menu_prompt did when it unread
2189 additional keys returned by Fx_popup_menu. */
2191 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2199 if (unread_command_char
!= -1)
2201 XSETINT (c
, unread_command_char
);
2202 unread_command_char
= -1;
2208 if (CONSP (Vunread_command_events
))
2210 c
= XCAR (Vunread_command_events
);
2211 Vunread_command_events
= XCDR (Vunread_command_events
);
2213 /* Undo what read_char_x_menu_prompt did when it unread
2214 additional keys returned by Fx_popup_menu. */
2216 && EQ (XCDR (c
), Qdisabled
)
2217 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2220 /* If the queued event is something that used the mouse,
2221 set used_mouse_menu accordingly. */
2223 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2224 *used_mouse_menu
= 1;
2227 goto reread_for_input_method
;
2230 if (CONSP (Vunread_input_method_events
))
2232 c
= XCAR (Vunread_input_method_events
);
2233 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2235 /* Undo what read_char_x_menu_prompt did when it unread
2236 additional keys returned by Fx_popup_menu. */
2238 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2242 goto reread_for_input_method
;
2245 /* If there is no function key translated before
2246 reset-this-command-lengths takes effect, forget about it. */
2247 before_command_restore_flag
= 0;
2249 if (!NILP (Vexecuting_macro
))
2251 /* We set this to Qmacro; since that's not a frame, nobody will
2252 try to switch frames on us, and the selected window will
2255 Since this event came from a macro, it would be misleading to
2256 leave internal_last_event_frame set to wherever the last
2257 real event came from. Normally, a switch-frame event selects
2258 internal_last_event_frame after each command is read, but
2259 events read from a macro should never cause a new frame to be
2261 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2263 /* Exit the macro if we are at the end.
2264 Also, some things replace the macro with t
2265 to force an early exit. */
2266 if (EQ (Vexecuting_macro
, Qt
)
2267 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2273 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2274 if (STRINGP (Vexecuting_macro
)
2275 && (XINT (c
) & 0x80))
2276 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2278 executing_macro_index
++;
2283 if (!NILP (unread_switch_frame
))
2285 c
= unread_switch_frame
;
2286 unread_switch_frame
= Qnil
;
2288 /* This event should make it into this_command_keys, and get echoed
2289 again, so we do not set `reread'. */
2293 /* if redisplay was requested */
2294 if (commandflag
>= 0)
2296 /* If there is pending input, process any events which are not
2297 user-visible, such as X selection_request events. */
2299 || detect_input_pending_run_timers (0))
2300 swallow_events (0); /* may clear input_pending */
2302 /* Redisplay if no pending input. */
2303 while (!input_pending
)
2305 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2306 redisplay_preserve_echo_area (5);
2311 /* Normal case: no input arrived during redisplay. */
2314 /* Input arrived and pre-empted redisplay.
2315 Process any events which are not user-visible. */
2317 /* If that cleared input_pending, try again to redisplay. */
2321 /* Message turns off echoing unless more keystrokes turn it on again.
2323 The code in 20.x for the condition was
2325 1. echo_area_glyphs && *echo_area_glyphs
2326 2. && echo_area_glyphs != current_kboard->echobuf
2327 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2329 (1) means there's a current message displayed
2331 (2) means it's not the message from echoing from the current
2334 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2335 is set to a non-null value. This is done in read_char and it is
2336 set to echo_area_glyphs after a call to echo_char. That means
2337 ok_to_echo_at_next_pause is either null or
2338 current_kboard->echobuf with the appropriate current_kboard at
2341 So, condition (3) means in clear text ok_to_echo_at_next_pause
2342 must be either null, or the current message isn't from echoing at
2343 all, or it's from echoing from a different kboard than the
2346 if (/* There currently is something in the echo area. */
2347 !NILP (echo_area_buffer
[0])
2348 && (/* And it's either not from echoing. */
2349 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2350 /* Or it's an echo from a different kboard. */
2351 || echo_kboard
!= current_kboard
2352 /* Or we explicitly allow overwriting whatever there is. */
2353 || ok_to_echo_at_next_pause
== NULL
))
2358 /* Try reading a character via menu prompting in the minibuf.
2359 Try this before the sit-for, because the sit-for
2360 would do the wrong thing if we are supposed to do
2361 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2362 after a mouse event so don't try a minibuf menu. */
2364 if (nmaps
> 0 && INTERACTIVE
2365 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2366 /* Don't bring up a menu if we already have another event. */
2367 && NILP (Vunread_command_events
)
2368 && unread_command_char
< 0
2369 && !detect_input_pending_run_timers (0))
2371 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2374 key_already_recorded
= 1;
2379 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2380 We will do that below, temporarily for short sections of code,
2381 when appropriate. local_getcjmp must be in effect
2382 around any call to sit_for or kbd_buffer_get_event;
2383 it *must not* be in effect when we call redisplay. */
2385 if (_setjmp (local_getcjmp
))
2387 XSETINT (c
, quit_char
);
2388 internal_last_event_frame
= selected_frame
;
2389 Vlast_event_frame
= internal_last_event_frame
;
2390 /* If we report the quit char as an event,
2391 don't do so more than once. */
2392 if (!NILP (Vinhibit_quit
))
2397 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2398 if (kb
!= current_kboard
)
2400 Lisp_Object link
= kb
->kbd_queue
;
2401 /* We shouldn't get here if we were in single-kboard mode! */
2406 while (CONSP (XCDR (link
)))
2408 if (!NILP (XCDR (link
)))
2412 kb
->kbd_queue
= Fcons (c
, Qnil
);
2414 XSETCDR (link
, Fcons (c
, Qnil
));
2415 kb
->kbd_queue_has_data
= 1;
2416 current_kboard
= kb
;
2417 /* This is going to exit from read_char
2418 so we had better get rid of this frame's stuff. */
2420 longjmp (wrong_kboard_jmpbuf
, 1);
2427 timer_start_idle ();
2429 /* If in middle of key sequence and minibuffer not active,
2430 start echoing if enough time elapses. */
2432 if (minibuf_level
== 0
2433 && !current_kboard
->immediate_echo
2434 && this_command_key_count
> 0
2436 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2437 && NILP (Fzerop (Vecho_keystrokes
))
2438 && (/* No message. */
2439 NILP (echo_area_buffer
[0])
2440 /* Or empty message. */
2441 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2442 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2443 /* Or already echoing from same kboard. */
2444 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2445 /* Or not echoing before and echoing allowed. */
2446 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2450 /* After a mouse event, start echoing right away.
2451 This is because we are probably about to display a menu,
2452 and we don't want to delay before doing so. */
2453 if (EVENT_HAS_PARAMETERS (prev_event
))
2458 double duration
= extract_float (Vecho_keystrokes
);
2459 sec
= (int) duration
;
2460 usec
= (duration
- sec
) * 1000000;
2461 save_getcjmp (save_jump
);
2462 restore_getcjmp (local_getcjmp
);
2463 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2464 restore_getcjmp (save_jump
);
2466 && ! CONSP (Vunread_command_events
))
2471 /* Maybe auto save due to number of keystrokes. */
2473 if (commandflag
!= 0
2474 && auto_save_interval
> 0
2475 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2476 && !detect_input_pending_run_timers (0))
2478 Fdo_auto_save (Qnil
, Qnil
);
2479 /* Hooks can actually change some buffers in auto save. */
2483 /* Try reading using an X menu.
2484 This is never confused with reading using the minibuf
2485 because the recursive call of read_char in read_char_minibuf_menu_prompt
2486 does not pass on any keymaps. */
2488 if (nmaps
> 0 && INTERACTIVE
2489 && !NILP (prev_event
)
2490 && EVENT_HAS_PARAMETERS (prev_event
)
2491 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2492 && !EQ (XCAR (prev_event
), Qtool_bar
)
2493 /* Don't bring up a menu if we already have another event. */
2494 && NILP (Vunread_command_events
)
2495 && unread_command_char
< 0)
2497 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2499 /* Now that we have read an event, Emacs is not idle. */
2505 /* Maybe autosave and/or garbage collect due to idleness. */
2507 if (INTERACTIVE
&& NILP (c
))
2509 int delay_level
, buffer_size
;
2511 /* Slow down auto saves logarithmically in size of current buffer,
2512 and garbage collect while we're at it. */
2513 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2514 last_non_minibuf_size
= Z
- BEG
;
2515 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2517 while (buffer_size
> 64)
2518 delay_level
++, buffer_size
-= buffer_size
>> 2;
2519 if (delay_level
< 4) delay_level
= 4;
2520 /* delay_level is 4 for files under around 50k, 7 at 100k,
2521 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2523 /* Auto save if enough time goes by without input. */
2524 if (commandflag
!= 0
2525 && num_nonmacro_input_events
> last_auto_save
2526 && INTEGERP (Vauto_save_timeout
)
2527 && XINT (Vauto_save_timeout
) > 0)
2531 save_getcjmp (save_jump
);
2532 restore_getcjmp (local_getcjmp
);
2533 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2535 restore_getcjmp (save_jump
);
2538 && ! CONSP (Vunread_command_events
))
2540 Fdo_auto_save (Qnil
, Qnil
);
2542 /* If we have auto-saved and there is still no input
2543 available, garbage collect if there has been enough
2544 consing going on to make it worthwhile. */
2545 if (!detect_input_pending_run_timers (0)
2546 && consing_since_gc
> gc_cons_threshold
/ 2)
2547 Fgarbage_collect ();
2554 /* If this has become non-nil here, it has been set by a timer
2555 or sentinel or filter. */
2556 if (CONSP (Vunread_command_events
))
2558 c
= XCAR (Vunread_command_events
);
2559 Vunread_command_events
= XCDR (Vunread_command_events
);
2562 /* Read something from current KBOARD's side queue, if possible. */
2566 if (current_kboard
->kbd_queue_has_data
)
2568 if (!CONSP (current_kboard
->kbd_queue
))
2570 c
= XCAR (current_kboard
->kbd_queue
);
2571 current_kboard
->kbd_queue
2572 = XCDR (current_kboard
->kbd_queue
);
2573 if (NILP (current_kboard
->kbd_queue
))
2574 current_kboard
->kbd_queue_has_data
= 0;
2575 input_pending
= readable_events (0);
2576 if (EVENT_HAS_PARAMETERS (c
)
2577 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2578 internal_last_event_frame
= XCAR (XCDR (c
));
2579 Vlast_event_frame
= internal_last_event_frame
;
2584 /* If current_kboard's side queue is empty check the other kboards.
2585 If one of them has data that we have not yet seen here,
2586 switch to it and process the data waiting for it.
2588 Note: if the events queued up for another kboard
2589 have already been seen here, and therefore are not a complete command,
2590 the kbd_queue_has_data field is 0, so we skip that kboard here.
2591 That's to avoid an infinite loop switching between kboards here. */
2592 if (NILP (c
) && !single_kboard
)
2595 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2596 if (kb
->kbd_queue_has_data
)
2598 current_kboard
= kb
;
2599 /* This is going to exit from read_char
2600 so we had better get rid of this frame's stuff. */
2602 longjmp (wrong_kboard_jmpbuf
, 1);
2611 /* Finally, we read from the main queue,
2612 and if that gives us something we can't use yet, we put it on the
2613 appropriate side queue and try again. */
2619 /* Actually read a character, waiting if necessary. */
2620 save_getcjmp (save_jump
);
2621 restore_getcjmp (local_getcjmp
);
2622 timer_start_idle ();
2623 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2624 restore_getcjmp (save_jump
);
2627 if (! NILP (c
) && (kb
!= current_kboard
))
2629 Lisp_Object link
= kb
->kbd_queue
;
2632 while (CONSP (XCDR (link
)))
2634 if (!NILP (XCDR (link
)))
2638 kb
->kbd_queue
= Fcons (c
, Qnil
);
2640 XSETCDR (link
, Fcons (c
, Qnil
));
2641 kb
->kbd_queue_has_data
= 1;
2645 current_kboard
= kb
;
2646 /* This is going to exit from read_char
2647 so we had better get rid of this frame's stuff. */
2649 longjmp (wrong_kboard_jmpbuf
, 1);
2654 /* Terminate Emacs in batch mode if at eof. */
2655 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2656 Fkill_emacs (make_number (1));
2660 /* Add in any extra modifiers, where appropriate. */
2661 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2662 || ((extra_keyboard_modifiers
& 0177) < ' '
2663 && (extra_keyboard_modifiers
& 0177) != 0))
2664 XSETINT (c
, make_ctrl_char (XINT (c
)));
2666 /* Transfer any other modifier bits directly from
2667 extra_keyboard_modifiers to c. Ignore the actual character code
2668 in the low 16 bits of extra_keyboard_modifiers. */
2669 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2674 /* Record the last idle start time so that we can reset it
2675 should the next event read be a help-echo. */
2676 last_idle_start
= timer_idleness_start_time
;
2682 if (commandflag
>= 0
2683 && !input_pending
&& !detect_input_pending_run_timers (0))
2691 /* Buffer switch events are only for internal wakeups
2692 so don't show them to the user.
2693 Also, don't record a key if we already did. */
2694 if (BUFFERP (c
) || key_already_recorded
)
2697 /* Process special events within read_char
2698 and loop around to read another event. */
2701 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2706 int was_locked
= single_kboard
;
2708 last_input_char
= c
;
2709 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2711 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2712 /* We stopped being idle for this event; undo that. This
2713 prevents automatic window selection (under
2714 mouse_autoselect_window from acting as a real input event, for
2715 example banishing the mouse under mouse-avoidance-mode. */
2716 timer_idleness_start_time
= last_idle_start
;
2718 /* Resume allowing input from any kboard, if that was true before. */
2720 any_kboard_state ();
2725 /* Handle things that only apply to characters. */
2728 /* If kbd_buffer_get_event gave us an EOF, return that. */
2732 if ((STRINGP (Vkeyboard_translate_table
)
2733 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2734 || (VECTORP (Vkeyboard_translate_table
)
2735 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2736 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2737 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2740 d
= Faref (Vkeyboard_translate_table
, c
);
2741 /* nil in keyboard-translate-table means no translation. */
2747 /* If this event is a mouse click in the menu bar,
2748 return just menu-bar for now. Modify the mouse click event
2749 so we won't do this twice, then queue it up. */
2750 if (EVENT_HAS_PARAMETERS (c
)
2752 && CONSP (EVENT_START (c
))
2753 && CONSP (XCDR (EVENT_START (c
))))
2757 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2758 /* Handle menu-bar events:
2759 insert the dummy prefix event `menu-bar'. */
2760 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2762 /* Change menu-bar to (menu-bar) as the event "position". */
2763 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2766 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2771 /* Store these characters into recent_keys, the dribble file if any,
2772 and the keyboard macro being defined, if any. */
2774 if (! NILP (also_record
))
2775 record_char (also_record
);
2777 /* Wipe the echo area.
2778 But first, if we are about to use an input method,
2779 save the echo area contents for it to refer to. */
2781 && ! NILP (Vinput_method_function
)
2782 && (unsigned) XINT (c
) >= ' '
2783 && (unsigned) XINT (c
) != 127
2784 && (unsigned) XINT (c
) < 256)
2786 previous_echo_area_message
= Fcurrent_message ();
2787 Vinput_method_previous_message
= previous_echo_area_message
;
2790 /* Now wipe the echo area, except for help events which do their
2791 own stuff with the echo area. */
2793 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2794 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2796 if (!NILP (echo_area_buffer
[0]))
2797 safe_run_hooks (Qecho_area_clear_hook
);
2798 clear_message (1, 0);
2801 reread_for_input_method
:
2803 /* Pass this to the input method, if appropriate. */
2805 && ! NILP (Vinput_method_function
)
2806 /* Don't run the input method within a key sequence,
2807 after the first event of the key sequence. */
2808 && NILP (prev_event
)
2809 && (unsigned) XINT (c
) >= ' '
2810 && (unsigned) XINT (c
) != 127
2811 && (unsigned) XINT (c
) < 256)
2815 struct gcpro gcpro1
;
2816 int count
= specpdl_ptr
- specpdl
;
2818 /* Save the echo status. */
2819 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2820 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2821 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2823 if (before_command_restore_flag
)
2825 this_command_key_count
= before_command_key_count_1
;
2826 if (this_command_key_count
< this_single_command_key_start
)
2827 this_single_command_key_start
= this_command_key_count
;
2828 echo_truncate (before_command_echo_length_1
);
2829 before_command_restore_flag
= 0;
2832 /* Save the this_command_keys status. */
2833 key_count
= this_command_key_count
;
2836 keys
= Fcopy_sequence (this_command_keys
);
2841 /* Clear out this_command_keys. */
2842 this_command_key_count
= 0;
2844 /* Now wipe the echo area. */
2845 if (!NILP (echo_area_buffer
[0]))
2846 safe_run_hooks (Qecho_area_clear_hook
);
2847 clear_message (1, 0);
2850 /* If we are not reading a key sequence,
2851 never use the echo area. */
2854 specbind (Qinput_method_use_echo_area
, Qt
);
2857 /* Call the input method. */
2858 tem
= call1 (Vinput_method_function
, c
);
2860 tem
= unbind_to (count
, tem
);
2862 /* Restore the saved echoing state
2863 and this_command_keys state. */
2864 this_command_key_count
= key_count
;
2866 this_command_keys
= keys
;
2869 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2870 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2871 if (saved_immediate_echo
)
2876 /* The input method can return no events. */
2879 /* Bring back the previous message, if any. */
2880 if (! NILP (previous_echo_area_message
))
2881 message_with_string ("%s", previous_echo_area_message
, 0);
2884 /* It returned one event or more. */
2886 Vunread_post_input_method_events
2887 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2892 /* Display help if not echoing. */
2893 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2895 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
2896 Lisp_Object help
, object
, position
, window
, tem
;
2898 tem
= Fcdr (XCDR (c
));
2901 window
= Fcar (tem
);
2903 object
= Fcar (tem
);
2905 position
= Fcar (tem
);
2907 show_help_echo (help
, window
, object
, position
, 0);
2909 /* We stopped being idle for this event; undo that. */
2910 timer_idleness_start_time
= last_idle_start
;
2914 if (this_command_key_count
== 0 || ! reread
)
2916 before_command_key_count
= this_command_key_count
;
2917 before_command_echo_length
= echo_length ();
2919 /* Don't echo mouse motion events. */
2920 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2921 && NILP (Fzerop (Vecho_keystrokes
))
2922 && ! (EVENT_HAS_PARAMETERS (c
)
2923 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2926 if (! NILP (also_record
))
2927 echo_char (also_record
);
2928 /* Once we reread a character, echoing can happen
2929 the next time we pause to read a new one. */
2930 ok_to_echo_at_next_pause
= current_kboard
;
2933 /* Record this character as part of the current key. */
2934 add_command_key (c
);
2935 if (! NILP (also_record
))
2936 add_command_key (also_record
);
2939 last_input_char
= c
;
2942 /* Process the help character specially if enabled */
2943 if (!NILP (Vhelp_form
) && help_char_p (c
))
2946 count
= specpdl_ptr
- specpdl
;
2948 record_unwind_protect (Fset_window_configuration
,
2949 Fcurrent_window_configuration (Qnil
));
2951 tem0
= Feval (Vhelp_form
);
2953 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2957 c
= read_char (0, 0, 0, Qnil
, 0);
2958 while (BUFFERP (c
));
2959 /* Remove the help from the frame */
2960 unbind_to (count
, Qnil
);
2963 if (EQ (c
, make_number (040)))
2967 c
= read_char (0, 0, 0, Qnil
, 0);
2968 while (BUFFERP (c
));
2975 /* Record a key that came from a mouse menu.
2976 Record it for echoing, for this-command-keys, and so on. */
2982 /* Wipe the echo area. */
2983 clear_message (1, 0);
2987 before_command_key_count
= this_command_key_count
;
2988 before_command_echo_length
= echo_length ();
2990 /* Don't echo mouse motion events. */
2991 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2992 && NILP (Fzerop (Vecho_keystrokes
)))
2996 /* Once we reread a character, echoing can happen
2997 the next time we pause to read a new one. */
2998 ok_to_echo_at_next_pause
= 0;
3001 /* Record this character as part of the current key. */
3002 add_command_key (c
);
3004 /* Re-reading in the middle of a command */
3005 last_input_char
= c
;
3009 /* Return 1 if should recognize C as "the help character". */
3017 if (EQ (c
, Vhelp_char
))
3019 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3020 if (EQ (c
, XCAR (tail
)))
3025 /* Record the input event C in various ways. */
3033 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3035 /* To avoid filling recent_keys with help-echo and mouse-movement
3036 events, we filter out repeated help-echo events, only store the
3037 first and last in a series of mouse-movement events, and don't
3038 store repeated help-echo events which are only separated by
3039 mouse-movement events. */
3041 Lisp_Object ev1
, ev2
, ev3
;
3044 if ((ix1
= recent_keys_index
- 1) < 0)
3045 ix1
= NUM_RECENT_KEYS
- 1;
3046 ev1
= AREF (recent_keys
, ix1
);
3048 if ((ix2
= ix1
- 1) < 0)
3049 ix2
= NUM_RECENT_KEYS
- 1;
3050 ev2
= AREF (recent_keys
, ix2
);
3052 if ((ix3
= ix2
- 1) < 0)
3053 ix3
= NUM_RECENT_KEYS
- 1;
3054 ev3
= AREF (recent_keys
, ix3
);
3056 if (EQ (XCAR (c
), Qhelp_echo
))
3058 /* Don't record `help-echo' in recent_keys unless it shows some help
3059 message, and a different help than the previously recorded
3061 Lisp_Object help
, last_help
;
3063 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3064 if (!STRINGP (help
))
3066 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3067 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3069 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3070 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3071 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3073 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3074 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3075 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3076 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3079 else if (EQ (XCAR (c
), Qmouse_movement
))
3081 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3082 So additional mouse movement events replace the last element. */
3083 Lisp_Object last_window
, window
;
3085 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3086 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3087 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3088 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3089 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3091 ASET (recent_keys
, ix1
, c
);
3097 store_kbd_macro_char (c
);
3102 ASET (recent_keys
, recent_keys_index
, c
);
3103 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3104 recent_keys_index
= 0;
3106 else if (recorded
< 0)
3108 /* We need to remove one or two events from recent_keys.
3109 To do this, we simply put nil at those events and move the
3110 recent_keys_index backwards over those events. Usually,
3111 users will never see those nil events, as they will be
3112 overwritten by the command keys entered to see recent_keys
3115 while (recorded
++ < 0 && total_keys
> 0)
3117 if (total_keys
< NUM_RECENT_KEYS
)
3119 if (--recent_keys_index
< 0)
3120 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3121 ASET (recent_keys
, recent_keys_index
, Qnil
);
3125 num_nonmacro_input_events
++;
3127 /* Write c to the dribble file. If c is a lispy event, write
3128 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3129 If you, dear reader, have a better idea, you've got the source. :-) */
3134 if (XUINT (c
) < 0x100)
3135 putc (XINT (c
), dribble
);
3137 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3141 Lisp_Object dribblee
;
3143 /* If it's a structured event, take the event header. */
3144 dribblee
= EVENT_HEAD (c
);
3146 if (SYMBOLP (dribblee
))
3148 putc ('<', dribble
);
3149 fwrite (XSTRING (SYMBOL_NAME (dribblee
))->data
, sizeof (char),
3150 STRING_BYTES (XSTRING (SYMBOL_NAME (dribblee
))),
3152 putc ('>', dribble
);
3164 struct buffer
*old
= current_buffer
;
3165 Fprinc (object
, Qnil
);
3166 set_buffer_internal (XBUFFER (Vstandard_output
));
3167 call0 (intern ("help-mode"));
3168 set_buffer_internal (old
);
3172 /* Copy out or in the info on where C-g should throw to.
3173 This is used when running Lisp code from within get_char,
3174 in case get_char is called recursively.
3175 See read_process_output. */
3181 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3185 restore_getcjmp (temp
)
3188 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3193 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3194 of this function. */
3197 tracking_off (old_value
)
3198 Lisp_Object old_value
;
3200 do_mouse_tracking
= old_value
;
3201 if (NILP (old_value
))
3203 /* Redisplay may have been preempted because there was input
3204 available, and it assumes it will be called again after the
3205 input has been processed. If the only input available was
3206 the sort that we have just disabled, then we need to call
3208 if (!readable_events (1))
3210 redisplay_preserve_echo_area (6);
3211 get_input_pending (&input_pending
, 1);
3217 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3218 doc
: /* Evaluate BODY with mouse movement events enabled.
3219 Within a `track-mouse' form, mouse motion generates input events that
3220 you can read with `read-event'.
3221 Normally, mouse motion is ignored.
3222 usage: (track-mouse BODY ...) */)
3226 int count
= specpdl_ptr
- specpdl
;
3229 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3231 do_mouse_tracking
= Qt
;
3233 val
= Fprogn (args
);
3234 return unbind_to (count
, val
);
3237 /* If mouse has moved on some frame, return one of those frames.
3238 Return 0 otherwise. */
3243 Lisp_Object tail
, frame
;
3245 FOR_EACH_FRAME (tail
, frame
)
3247 if (XFRAME (frame
)->mouse_moved
)
3248 return XFRAME (frame
);
3254 #endif /* HAVE_MOUSE */
3256 /* Low level keyboard/mouse input.
3257 kbd_buffer_store_event places events in kbd_buffer, and
3258 kbd_buffer_get_event retrieves them. */
3260 /* Return true iff there are any events in the queue that read-char
3261 would return. If this returns false, a read-char would block. */
3263 readable_filtered_events (do_timers_now
, filter_events
)
3268 timer_check (do_timers_now
);
3270 /* If the buffer contains only FOCUS_IN_EVENT events,
3271 and FILTER_EVENTS is nonzero, report it as empty. */
3272 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3274 int have_live_event
= 1;
3278 struct input_event
*event
;
3280 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3284 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3287 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3289 if (event
== kbd_store_ptr
)
3290 have_live_event
= 0;
3293 if (have_live_event
) return 1;
3297 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3302 if (current_kboard
->kbd_queue_has_data
)
3308 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3309 if (kb
->kbd_queue_has_data
)
3315 /* Return true iff there are any events in the queue that read-char
3316 would return. If this returns false, a read-char would block. */
3318 readable_events (do_timers_now
)
3321 return readable_filtered_events (do_timers_now
, 0);
3324 /* Set this for debugging, to have a way to get out */
3329 event_to_kboard (event
)
3330 struct input_event
*event
;
3333 frame
= event
->frame_or_window
;
3335 frame
= XCAR (frame
);
3336 else if (WINDOWP (frame
))
3337 frame
= WINDOW_FRAME (XWINDOW (frame
));
3339 /* There are still some events that don't set this field.
3340 For now, just ignore the problem.
3341 Also ignore dead frames here. */
3342 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3345 return FRAME_KBOARD (XFRAME (frame
));
3349 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3352 kbd_buffer_store_event (event
)
3353 register struct input_event
*event
;
3355 if (event
->kind
== NO_EVENT
)
3358 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3360 register int c
= event
->code
& 0377;
3362 if (event
->modifiers
& ctrl_modifier
)
3363 c
= make_ctrl_char (c
);
3365 c
|= (event
->modifiers
3366 & (meta_modifier
| alt_modifier
3367 | hyper_modifier
| super_modifier
));
3371 static SIGTYPE interrupt_signal
P_ ((int));
3374 struct input_event
*sp
;
3377 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3378 kb
!= current_kboard
))
3381 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3382 Fcons (make_number (c
), Qnil
));
3383 kb
->kbd_queue_has_data
= 1;
3384 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3386 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3389 if (event_to_kboard (sp
) == kb
)
3391 sp
->kind
= NO_EVENT
;
3392 sp
->frame_or_window
= Qnil
;
3400 /* If this results in a quit_char being returned to Emacs as
3401 input, set Vlast_event_frame properly. If this doesn't
3402 get returned to Emacs as an event, the next event read
3403 will set Vlast_event_frame again, so this is safe to do. */
3407 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3409 focus
= event
->frame_or_window
;
3410 internal_last_event_frame
= focus
;
3411 Vlast_event_frame
= focus
;
3414 last_event_timestamp
= event
->timestamp
;
3415 interrupt_signal (0 /* dummy */);
3419 if (c
&& c
== stop_character
)
3425 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3426 Just ignore the second one. */
3427 else if (event
->kind
== BUFFER_SWITCH_EVENT
3428 && kbd_fetch_ptr
!= kbd_store_ptr
3429 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3432 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3433 kbd_store_ptr
= kbd_buffer
;
3435 /* Don't let the very last slot in the buffer become full,
3436 since that would make the two pointers equal,
3437 and that is indistinguishable from an empty buffer.
3438 Discard the event if it would fill the last slot. */
3439 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3443 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3444 prone to assign individual members for other events, in case
3445 the input_event structure is changed. --2000-07-13, gerd. */
3446 struct input_event
*sp
= kbd_store_ptr
;
3447 sp
->kind
= event
->kind
;
3448 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3450 /* We must not use the ordinary copying code for this case,
3451 since `part' is an enum and copying it might not copy enough
3453 bcopy (event
, (char *) sp
, sizeof (*event
));
3458 sp
->code
= event
->code
;
3459 sp
->part
= event
->part
;
3460 sp
->frame_or_window
= event
->frame_or_window
;
3461 sp
->arg
= event
->arg
;
3462 sp
->modifiers
= event
->modifiers
;
3465 sp
->timestamp
= event
->timestamp
;
3468 *kbd_store_ptr
= *event
;
3471 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3472 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3473 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3479 /* Generate HELP_EVENT input_events in BUFP which has room for
3480 SIZE events. If there's not enough room in BUFP, ignore this
3483 HELP is the help form.
3485 FRAME is the frame on which the help is generated. OBJECT is the
3486 Lisp object where the help was found (a buffer, a string, an
3487 overlay, or nil if neither from a string nor from a buffer. POS is
3488 the position within OBJECT where the help was found.
3490 Value is the number of input_events generated. */
3493 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3494 struct input_event
*bufp
;
3496 Lisp_Object help
, frame
, object
, window
;
3501 bufp
->kind
= HELP_EVENT
;
3502 bufp
->frame_or_window
= frame
;
3504 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3513 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3516 kbd_buffer_store_help_event (frame
, help
)
3517 Lisp_Object frame
, help
;
3519 struct input_event event
;
3521 event
.kind
= HELP_EVENT
;
3522 event
.frame_or_window
= frame
;
3527 kbd_buffer_store_event (&event
);
3531 /* Discard any mouse events in the event buffer by setting them to
3534 discard_mouse_events ()
3536 struct input_event
*sp
;
3537 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3539 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3542 if (sp
->kind
== MOUSE_CLICK_EVENT
3544 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3546 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3548 sp
->kind
= NO_EVENT
;
3554 /* Return non-zero if there are any real events waiting in the event
3555 buffer, not counting `NO_EVENT's.
3557 If DISCARD is non-zero, discard NO_EVENT events at the front of
3558 the input queue, possibly leaving the input queue empty if there
3559 are no real input events. */
3562 kbd_buffer_events_waiting (discard
)
3565 struct input_event
*sp
;
3567 for (sp
= kbd_fetch_ptr
;
3568 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3571 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3578 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3582 /* Clear input event EVENT. */
3586 struct input_event
*event
;
3588 int idx
= 2 * (event
- kbd_buffer
);
3589 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3590 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3591 event
->kind
= NO_EVENT
;
3595 /* Read one event from the event buffer, waiting if necessary.
3596 The value is a Lisp object representing the event.
3597 The value is nil for an event that should be ignored,
3598 or that was handled here.
3599 We always read and discard one event. */
3602 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3604 int *used_mouse_menu
;
3613 *kbp
= current_kboard
;
3617 /* Wait until there is input available. */
3620 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3623 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3627 /* If the quit flag is set, then read_char will return
3628 quit_char, so that counts as "available input." */
3629 if (!NILP (Vquit_flag
))
3630 quit_throw_to_read_char ();
3632 /* One way or another, wait until input is available; then, if
3633 interrupt handlers have not read it, read it now. */
3636 wait_for_kbd_input ();
3638 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3642 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3645 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3649 Lisp_Object minus_one
;
3651 XSETINT (minus_one
, -1);
3652 wait_reading_process_input (0, 0, minus_one
, 1);
3654 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3655 /* Pass 1 for EXPECT since we just waited to have input. */
3656 read_avail_input (1);
3658 #endif /* not VMS */
3661 if (CONSP (Vunread_command_events
))
3664 first
= XCAR (Vunread_command_events
);
3665 Vunread_command_events
= XCDR (Vunread_command_events
);
3666 *kbp
= current_kboard
;
3670 /* At this point, we know that there is a readable event available
3671 somewhere. If the event queue is empty, then there must be a
3672 mouse movement enabled and available. */
3673 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3675 struct input_event
*event
;
3677 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3681 last_event_timestamp
= event
->timestamp
;
3684 *kbp
= event_to_kboard (event
);
3686 *kbp
= current_kboard
; /* Better than returning null ptr? */
3688 *kbp
= &the_only_kboard
;
3693 /* These two kinds of events get special handling
3694 and don't actually appear to the command loop.
3695 We return nil for them. */
3696 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3699 struct input_event copy
;
3701 /* Remove it from the buffer before processing it,
3702 since otherwise swallow_events will see it
3703 and process it again. */
3705 kbd_fetch_ptr
= event
+ 1;
3706 input_pending
= readable_events (0);
3707 x_handle_selection_request (©
);
3709 /* We're getting selection request events, but we don't have
3715 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3718 struct input_event copy
;
3720 /* Remove it from the buffer before processing it. */
3722 kbd_fetch_ptr
= event
+ 1;
3723 input_pending
= readable_events (0);
3724 x_handle_selection_clear (©
);
3726 /* We're getting selection request events, but we don't have
3731 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3732 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3734 /* Make an event (delete-frame (FRAME)). */
3735 obj
= Fcons (event
->frame_or_window
, Qnil
);
3736 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3737 kbd_fetch_ptr
= event
+ 1;
3740 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3741 else if (event
->kind
== ICONIFY_EVENT
)
3743 /* Make an event (iconify-frame (FRAME)). */
3744 obj
= Fcons (event
->frame_or_window
, Qnil
);
3745 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3746 kbd_fetch_ptr
= event
+ 1;
3748 else if (event
->kind
== DEICONIFY_EVENT
)
3750 /* Make an event (make-frame-visible (FRAME)). */
3751 obj
= Fcons (event
->frame_or_window
, Qnil
);
3752 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3753 kbd_fetch_ptr
= event
+ 1;
3756 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3758 /* The value doesn't matter here; only the type is tested. */
3759 XSETBUFFER (obj
, current_buffer
);
3760 kbd_fetch_ptr
= event
+ 1;
3762 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
3763 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3765 kbd_fetch_ptr
= event
+ 1;
3766 input_pending
= readable_events (0);
3767 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3768 x_activate_menubar (XFRAME (event
->frame_or_window
));
3772 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3774 /* Make an event (language-change (FRAME CHARSET LCID)). */
3775 obj
= Fcons (event
->modifiers
, Qnil
);
3776 obj
= Fcons (event
->code
, obj
);
3777 obj
= Fcons (event
->frame_or_window
, obj
);
3778 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3779 kbd_fetch_ptr
= event
+ 1;
3782 else if (event
->kind
== SAVE_SESSION_EVENT
)
3784 obj
= Fcons (Qsave_session
, Qnil
);
3785 kbd_fetch_ptr
= event
+ 1;
3787 /* Just discard these, by returning nil.
3788 With MULTI_KBOARD, these events are used as placeholders
3789 when we need to randomly delete events from the queue.
3790 (They shouldn't otherwise be found in the buffer,
3791 but on some machines it appears they do show up
3792 even without MULTI_KBOARD.) */
3793 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3794 mouse events during a popup-menu call. */
3795 else if (event
->kind
== NO_EVENT
)
3796 kbd_fetch_ptr
= event
+ 1;
3797 else if (event
->kind
== HELP_EVENT
)
3799 Lisp_Object object
, position
, help
, frame
, window
;
3801 frame
= event
->frame_or_window
;
3802 object
= event
->arg
;
3803 position
= make_number (event
->code
);
3806 clear_event (event
);
3808 kbd_fetch_ptr
= event
+ 1;
3809 if (!WINDOWP (window
))
3811 obj
= Fcons (Qhelp_echo
,
3812 list5 (frame
, help
, window
, object
, position
));
3814 else if (event
->kind
== FOCUS_IN_EVENT
)
3816 /* Notification of a FocusIn event. The frame receiving the
3817 focus is in event->frame_or_window. Generate a
3818 switch-frame event if necessary. */
3819 Lisp_Object frame
, focus
;
3821 frame
= event
->frame_or_window
;
3822 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3826 if (!EQ (frame
, internal_last_event_frame
)
3827 && !EQ (frame
, selected_frame
))
3828 obj
= make_lispy_switch_frame (frame
);
3829 internal_last_event_frame
= frame
;
3830 kbd_fetch_ptr
= event
+ 1;
3832 else if (event
->kind
== SELECT_WINDOW_EVENT
)
3834 /* Make an event (select-window (WINDOW)). */
3835 obj
= Fcons (event
->frame_or_window
, Qnil
);
3836 obj
= Fcons (Qselect_window
, Fcons (obj
, Qnil
));
3838 kbd_fetch_ptr
= event
+ 1;
3842 /* If this event is on a different frame, return a switch-frame this
3843 time, and leave the event in the queue for next time. */
3847 frame
= event
->frame_or_window
;
3849 frame
= XCAR (frame
);
3850 else if (WINDOWP (frame
))
3851 frame
= WINDOW_FRAME (XWINDOW (frame
));
3853 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3857 if (! EQ (frame
, internal_last_event_frame
)
3858 && !EQ (frame
, selected_frame
))
3859 obj
= make_lispy_switch_frame (frame
);
3860 internal_last_event_frame
= frame
;
3862 /* If we didn't decide to make a switch-frame event, go ahead
3863 and build a real event from the queue entry. */
3867 obj
= make_lispy_event (event
);
3869 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3870 /* If this was a menu selection, then set the flag to inhibit
3871 writing to last_nonmenu_event. Don't do this if the event
3872 we're returning is (menu-bar), though; that indicates the
3873 beginning of the menu sequence, and we might as well leave
3874 that as the `event with parameters' for this selection. */
3876 && !EQ (event
->frame_or_window
, event
->arg
)
3877 && (event
->kind
== MENU_BAR_EVENT
3878 || event
->kind
== TOOL_BAR_EVENT
))
3879 *used_mouse_menu
= 1;
3882 /* Wipe out this event, to catch bugs. */
3883 clear_event (event
);
3884 kbd_fetch_ptr
= event
+ 1;
3889 /* Try generating a mouse motion event. */
3890 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3892 FRAME_PTR f
= some_mouse_moved ();
3893 Lisp_Object bar_window
;
3894 enum scroll_bar_part part
;
3898 *kbp
= current_kboard
;
3899 /* Note that this uses F to determine which display to look at.
3900 If there is no valid info, it does not store anything
3901 so x remains nil. */
3903 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3907 /* Decide if we should generate a switch-frame event. Don't
3908 generate switch-frame events for motion outside of all Emacs
3914 frame
= FRAME_FOCUS_FRAME (f
);
3916 XSETFRAME (frame
, f
);
3918 if (! EQ (frame
, internal_last_event_frame
)
3919 && !EQ (frame
, selected_frame
))
3920 obj
= make_lispy_switch_frame (frame
);
3921 internal_last_event_frame
= frame
;
3924 /* If we didn't decide to make a switch-frame event, go ahead and
3925 return a mouse-motion event. */
3926 if (!NILP (x
) && NILP (obj
))
3927 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3929 #endif /* HAVE_MOUSE */
3931 /* We were promised by the above while loop that there was
3932 something for us to read! */
3935 input_pending
= readable_events (0);
3937 Vlast_event_frame
= internal_last_event_frame
;
3942 /* Process any events that are not user-visible,
3943 then return, without reading any user-visible events. */
3946 swallow_events (do_display
)
3951 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3953 struct input_event
*event
;
3955 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3959 last_event_timestamp
= event
->timestamp
;
3961 /* These two kinds of events get special handling
3962 and don't actually appear to the command loop. */
3963 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3966 struct input_event copy
;
3968 /* Remove it from the buffer before processing it,
3969 since otherwise swallow_events called recursively could see it
3970 and process it again. */
3972 kbd_fetch_ptr
= event
+ 1;
3973 input_pending
= readable_events (0);
3974 x_handle_selection_request (©
);
3976 /* We're getting selection request events, but we don't have
3982 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3985 struct input_event copy
;
3987 /* Remove it from the buffer before processing it, */
3990 kbd_fetch_ptr
= event
+ 1;
3991 input_pending
= readable_events (0);
3992 x_handle_selection_clear (©
);
3994 /* We're getting selection request events, but we don't have
4003 old_timers_run
= timers_run
;
4004 get_input_pending (&input_pending
, 1);
4006 if (timers_run
!= old_timers_run
&& do_display
)
4007 redisplay_preserve_echo_area (7);
4010 /* Record the start of when Emacs is idle,
4011 for the sake of running idle-time timers. */
4018 /* If we are already in the idle state, do nothing. */
4019 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4022 EMACS_GET_TIME (timer_idleness_start_time
);
4024 timer_last_idleness_start_time
= timer_idleness_start_time
;
4026 /* Mark all idle-time timers as once again candidates for running. */
4027 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4031 timer
= XCAR (timers
);
4033 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4035 XVECTOR (timer
)->contents
[0] = Qnil
;
4039 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4044 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4047 /* This is only for debugging. */
4048 struct input_event last_timer_event
;
4050 /* Check whether a timer has fired. To prevent larger problems we simply
4051 disregard elements that are not proper timers. Do not make a circular
4052 timer list for the time being.
4054 Returns the number of seconds to wait until the next timer fires. If a
4055 timer is triggering now, return zero seconds.
4056 If no timer is active, return -1 seconds.
4058 If a timer is ripe, we run it, with quitting turned off.
4060 DO_IT_NOW is now ignored. It used to mean that we should
4061 run the timer directly instead of queueing a timer-event.
4062 Now we always run timers directly. */
4065 timer_check (do_it_now
)
4068 EMACS_TIME nexttime
;
4069 EMACS_TIME now
, idleness_now
;
4070 Lisp_Object timers
, idle_timers
, chosen_timer
;
4071 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4073 EMACS_SET_SECS (nexttime
, -1);
4074 EMACS_SET_USECS (nexttime
, -1);
4076 /* Always consider the ordinary timers. */
4077 timers
= Vtimer_list
;
4078 /* Consider the idle timers only if Emacs is idle. */
4079 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4080 idle_timers
= Vtimer_idle_list
;
4083 chosen_timer
= Qnil
;
4084 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4086 if (CONSP (timers
) || CONSP (idle_timers
))
4088 EMACS_GET_TIME (now
);
4089 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4090 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4093 while (CONSP (timers
) || CONSP (idle_timers
))
4095 Lisp_Object
*vector
;
4096 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4097 EMACS_TIME timer_time
, idle_timer_time
;
4098 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4100 /* Skip past invalid timers and timers already handled. */
4103 timer
= XCAR (timers
);
4104 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4106 timers
= XCDR (timers
);
4109 vector
= XVECTOR (timer
)->contents
;
4111 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4112 || !INTEGERP (vector
[3])
4113 || ! NILP (vector
[0]))
4115 timers
= XCDR (timers
);
4119 if (!NILP (idle_timers
))
4121 timer
= XCAR (idle_timers
);
4122 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4124 idle_timers
= XCDR (idle_timers
);
4127 vector
= XVECTOR (timer
)->contents
;
4129 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4130 || !INTEGERP (vector
[3])
4131 || ! NILP (vector
[0]))
4133 idle_timers
= XCDR (idle_timers
);
4138 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4139 based on the next ordinary timer.
4140 TIMER_DIFFERENCE is the distance in time from NOW to when
4141 this timer becomes ripe (negative if it's already ripe). */
4144 timer
= XCAR (timers
);
4145 vector
= XVECTOR (timer
)->contents
;
4146 EMACS_SET_SECS (timer_time
,
4147 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4148 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4149 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4152 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4153 based on the next idle timer. */
4154 if (!NILP (idle_timers
))
4156 idle_timer
= XCAR (idle_timers
);
4157 vector
= XVECTOR (idle_timer
)->contents
;
4158 EMACS_SET_SECS (idle_timer_time
,
4159 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4160 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4161 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4164 /* Decide which timer is the next timer,
4165 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4166 Also step down the list where we found that timer. */
4168 if (! NILP (timers
) && ! NILP (idle_timers
))
4171 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4172 if (EMACS_TIME_NEG_P (temp
))
4174 chosen_timer
= timer
;
4175 timers
= XCDR (timers
);
4176 difference
= timer_difference
;
4180 chosen_timer
= idle_timer
;
4181 idle_timers
= XCDR (idle_timers
);
4182 difference
= idle_timer_difference
;
4185 else if (! NILP (timers
))
4187 chosen_timer
= timer
;
4188 timers
= XCDR (timers
);
4189 difference
= timer_difference
;
4193 chosen_timer
= idle_timer
;
4194 idle_timers
= XCDR (idle_timers
);
4195 difference
= idle_timer_difference
;
4197 vector
= XVECTOR (chosen_timer
)->contents
;
4199 /* If timer is ripe, run it if it hasn't been run. */
4200 if (EMACS_TIME_NEG_P (difference
)
4201 || (EMACS_SECS (difference
) == 0
4202 && EMACS_USECS (difference
) == 0))
4204 if (NILP (vector
[0]))
4206 int was_locked
= single_kboard
;
4207 int count
= BINDING_STACK_SIZE ();
4208 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4210 /* Mark the timer as triggered to prevent problems if the lisp
4211 code fails to reschedule it right. */
4214 specbind (Qinhibit_quit
, Qt
);
4216 call1 (Qtimer_event_handler
, chosen_timer
);
4217 Vdeactivate_mark
= old_deactivate_mark
;
4219 unbind_to (count
, Qnil
);
4221 /* Resume allowing input from any kboard, if that was true before. */
4223 any_kboard_state ();
4225 /* Since we have handled the event,
4226 we don't need to tell the caller to wake up and do it. */
4230 /* When we encounter a timer that is still waiting,
4231 return the amount of time to wait before it is ripe. */
4238 /* No timers are pending in the future. */
4239 /* Return 0 if we generated an event, and -1 if not. */
4244 /* Caches for modify_event_symbol. */
4245 static Lisp_Object accent_key_syms
;
4246 static Lisp_Object func_key_syms
;
4247 static Lisp_Object mouse_syms
;
4249 static Lisp_Object mouse_wheel_syms
;
4251 static Lisp_Object drag_n_drop_syms
;
4253 /* This is a list of keysym codes for special "accent" characters.
4254 It parallels lispy_accent_keys. */
4256 static int lispy_accent_codes
[] =
4258 #ifdef XK_dead_circumflex
4263 #ifdef XK_dead_grave
4268 #ifdef XK_dead_tilde
4273 #ifdef XK_dead_diaeresis
4278 #ifdef XK_dead_macron
4283 #ifdef XK_dead_degree
4288 #ifdef XK_dead_acute
4293 #ifdef XK_dead_cedilla
4298 #ifdef XK_dead_breve
4303 #ifdef XK_dead_ogonek
4308 #ifdef XK_dead_caron
4313 #ifdef XK_dead_doubleacute
4314 XK_dead_doubleacute
,
4318 #ifdef XK_dead_abovedot
4325 /* This is a list of Lisp names for special "accent" characters.
4326 It parallels lispy_accent_codes. */
4328 static char *lispy_accent_keys
[] =
4346 #define FUNCTION_KEY_OFFSET 0x0
4348 char *lispy_function_keys
[] =
4352 0, /* VK_LBUTTON 0x01 */
4353 0, /* VK_RBUTTON 0x02 */
4354 "cancel", /* VK_CANCEL 0x03 */
4355 0, /* VK_MBUTTON 0x04 */
4357 0, 0, 0, /* 0x05 .. 0x07 */
4359 "backspace", /* VK_BACK 0x08 */
4360 "tab", /* VK_TAB 0x09 */
4362 0, 0, /* 0x0A .. 0x0B */
4364 "clear", /* VK_CLEAR 0x0C */
4365 "return", /* VK_RETURN 0x0D */
4367 0, 0, /* 0x0E .. 0x0F */
4369 0, /* VK_SHIFT 0x10 */
4370 0, /* VK_CONTROL 0x11 */
4371 0, /* VK_MENU 0x12 */
4372 "pause", /* VK_PAUSE 0x13 */
4373 "capslock", /* VK_CAPITAL 0x14 */
4375 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4377 "escape", /* VK_ESCAPE 0x1B */
4379 0, 0, 0, 0, /* 0x1C .. 0x1F */
4381 0, /* VK_SPACE 0x20 */
4382 "prior", /* VK_PRIOR 0x21 */
4383 "next", /* VK_NEXT 0x22 */
4384 "end", /* VK_END 0x23 */
4385 "home", /* VK_HOME 0x24 */
4386 "left", /* VK_LEFT 0x25 */
4387 "up", /* VK_UP 0x26 */
4388 "right", /* VK_RIGHT 0x27 */
4389 "down", /* VK_DOWN 0x28 */
4390 "select", /* VK_SELECT 0x29 */
4391 "print", /* VK_PRINT 0x2A */
4392 "execute", /* VK_EXECUTE 0x2B */
4393 "snapshot", /* VK_SNAPSHOT 0x2C */
4394 "insert", /* VK_INSERT 0x2D */
4395 "delete", /* VK_DELETE 0x2E */
4396 "help", /* VK_HELP 0x2F */
4398 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4400 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4402 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4404 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4406 0, 0, 0, 0, 0, 0, 0, 0, 0,
4407 0, 0, 0, 0, 0, 0, 0, 0, 0,
4408 0, 0, 0, 0, 0, 0, 0, 0,
4410 "lwindow", /* VK_LWIN 0x5B */
4411 "rwindow", /* VK_RWIN 0x5C */
4412 "apps", /* VK_APPS 0x5D */
4414 0, 0, /* 0x5E .. 0x5F */
4416 "kp-0", /* VK_NUMPAD0 0x60 */
4417 "kp-1", /* VK_NUMPAD1 0x61 */
4418 "kp-2", /* VK_NUMPAD2 0x62 */
4419 "kp-3", /* VK_NUMPAD3 0x63 */
4420 "kp-4", /* VK_NUMPAD4 0x64 */
4421 "kp-5", /* VK_NUMPAD5 0x65 */
4422 "kp-6", /* VK_NUMPAD6 0x66 */
4423 "kp-7", /* VK_NUMPAD7 0x67 */
4424 "kp-8", /* VK_NUMPAD8 0x68 */
4425 "kp-9", /* VK_NUMPAD9 0x69 */
4426 "kp-multiply", /* VK_MULTIPLY 0x6A */
4427 "kp-add", /* VK_ADD 0x6B */
4428 "kp-separator", /* VK_SEPARATOR 0x6C */
4429 "kp-subtract", /* VK_SUBTRACT 0x6D */
4430 "kp-decimal", /* VK_DECIMAL 0x6E */
4431 "kp-divide", /* VK_DIVIDE 0x6F */
4432 "f1", /* VK_F1 0x70 */
4433 "f2", /* VK_F2 0x71 */
4434 "f3", /* VK_F3 0x72 */
4435 "f4", /* VK_F4 0x73 */
4436 "f5", /* VK_F5 0x74 */
4437 "f6", /* VK_F6 0x75 */
4438 "f7", /* VK_F7 0x76 */
4439 "f8", /* VK_F8 0x77 */
4440 "f9", /* VK_F9 0x78 */
4441 "f10", /* VK_F10 0x79 */
4442 "f11", /* VK_F11 0x7A */
4443 "f12", /* VK_F12 0x7B */
4444 "f13", /* VK_F13 0x7C */
4445 "f14", /* VK_F14 0x7D */
4446 "f15", /* VK_F15 0x7E */
4447 "f16", /* VK_F16 0x7F */
4448 "f17", /* VK_F17 0x80 */
4449 "f18", /* VK_F18 0x81 */
4450 "f19", /* VK_F19 0x82 */
4451 "f20", /* VK_F20 0x83 */
4452 "f21", /* VK_F21 0x84 */
4453 "f22", /* VK_F22 0x85 */
4454 "f23", /* VK_F23 0x86 */
4455 "f24", /* VK_F24 0x87 */
4457 0, 0, 0, 0, /* 0x88 .. 0x8B */
4458 0, 0, 0, 0, /* 0x8C .. 0x8F */
4460 "kp-numlock", /* VK_NUMLOCK 0x90 */
4461 "scroll", /* VK_SCROLL 0x91 */
4463 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4464 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4465 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4466 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4467 "kp-end", /* VK_NUMPAD_END 0x96 */
4468 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4469 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4470 "kp-up", /* VK_NUMPAD_UP 0x99 */
4471 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4472 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4473 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4474 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4476 0, 0, /* 0x9E .. 0x9F */
4479 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4480 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4481 * No other API or message will distinguish left and right keys this way.
4485 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4486 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4487 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4488 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4489 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4495 "attn", /* VK_ATTN 0xF6 */
4496 "crsel", /* VK_CRSEL 0xF7 */
4497 "exsel", /* VK_EXSEL 0xF8 */
4498 "ereof", /* VK_EREOF 0xF9 */
4499 "play", /* VK_PLAY 0xFA */
4500 "zoom", /* VK_ZOOM 0xFB */
4501 "noname", /* VK_NONAME 0xFC */
4502 "pa1", /* VK_PA1 0xFD */
4503 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4507 #else /* not HAVE_NTGUI */
4510 static char *lispy_kana_keys
[] =
4512 /* X Keysym value */
4513 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4514 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4515 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4516 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4517 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4518 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4519 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4520 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4521 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4522 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4523 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4524 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4525 "kana-i", "kana-u", "kana-e", "kana-o",
4526 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4527 "prolongedsound", "kana-A", "kana-I", "kana-U",
4528 "kana-E", "kana-O", "kana-KA", "kana-KI",
4529 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4530 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4531 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4532 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4533 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4534 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4535 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4536 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4537 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4538 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4539 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4540 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4542 #endif /* XK_kana_A */
4544 #define FUNCTION_KEY_OFFSET 0xff00
4546 /* You'll notice that this table is arranged to be conveniently
4547 indexed by X Windows keysym values. */
4548 static char *lispy_function_keys
[] =
4550 /* X Keysym value */
4552 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4553 "backspace", "tab", "linefeed", "clear",
4555 0, 0, 0, "pause", /* 0xff10...1f */
4556 0, 0, 0, 0, 0, 0, 0, "escape",
4558 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4559 "romaji", "hiragana", "katakana", "hiragana-katakana",
4560 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4561 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4562 "eisu-toggle", /* 0xff30...3f */
4563 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4564 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4566 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4567 "down", "prior", "next", "end",
4568 "begin", 0, 0, 0, 0, 0, 0, 0,
4569 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4580 "break", /* 0xff6b */
4583 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4584 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4585 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4586 0, 0, 0, 0, 0, 0, 0, 0,
4587 "kp-tab", /* 0xff89 */
4589 "kp-enter", /* 0xff8d */
4591 "kp-f1", /* 0xff91 */
4595 "kp-home", /* 0xff95 */
4600 "kp-prior", /* kp-page-up */
4601 "kp-next", /* kp-page-down */
4607 0, 0, 0, 0, 0, 0, 0, 0, 0,
4608 "kp-multiply", /* 0xffaa */
4613 "kp-divide", /* 0xffaf */
4614 "kp-0", /* 0xffb0 */
4615 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4618 "kp-equal", /* 0xffbd */
4619 "f1", /* 0xffbe */ /* IsFunctionKey */
4621 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4622 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4623 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4624 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4625 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4626 0, 0, 0, 0, 0, 0, 0, 0,
4627 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4628 0, 0, 0, 0, 0, 0, 0, "delete"
4631 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4632 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4634 static char *iso_lispy_function_keys
[] =
4636 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4637 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4638 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4639 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4640 "iso-lefttab", /* 0xfe20 */
4641 "iso-move-line-up", "iso-move-line-down",
4642 "iso-partial-line-up", "iso-partial-line-down",
4643 "iso-partial-space-left", "iso-partial-space-right",
4644 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4645 "iso-release-margin-left", "iso-release-margin-right",
4646 "iso-release-both-margins",
4647 "iso-fast-cursor-left", "iso-fast-cursor-right",
4648 "iso-fast-cursor-up", "iso-fast-cursor-down",
4649 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4650 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4653 #endif /* not HAVE_NTGUI */
4655 Lisp_Object Vlispy_mouse_stem
;
4658 /* mouse-wheel events are generated by the wheel on devices such as
4659 the MS Intellimouse. The wheel sits in between the left and right
4660 mouse buttons, and is typically used to scroll or zoom the window
4661 underneath the pointer. mouse-wheel events specify the object on
4662 which they operate, and a delta corresponding to the amount and
4663 direction that the wheel is rotated. Clicking the mouse-wheel
4664 generates a mouse-2 event. */
4665 static char *lispy_mouse_wheel_names
[] =
4670 #endif /* WINDOWSNT */
4672 /* drag-n-drop events are generated when a set of selected files are
4673 dragged from another application and dropped onto an Emacs window. */
4674 static char *lispy_drag_n_drop_names
[] =
4679 /* Scroll bar parts. */
4680 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4681 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4682 Lisp_Object Qtop
, Qratio
;
4684 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4685 Lisp_Object
*scroll_bar_parts
[] = {
4686 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4687 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4690 /* User signal events. */
4691 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4693 Lisp_Object
*lispy_user_signals
[] =
4695 &Qusr1_signal
, &Qusr2_signal
4699 /* A vector, indexed by button number, giving the down-going location
4700 of currently depressed buttons, both scroll bar and non-scroll bar.
4702 The elements have the form
4703 (BUTTON-NUMBER MODIFIER-MASK . REST)
4704 where REST is the cdr of a position as it would be reported in the event.
4706 The make_lispy_event function stores positions here to tell the
4707 difference between click and drag events, and to store the starting
4708 location to be included in drag events. */
4710 static Lisp_Object button_down_location
;
4712 /* Information about the most recent up-going button event: Which
4713 button, what location, and what time. */
4715 static int last_mouse_button
;
4716 static int last_mouse_x
;
4717 static int last_mouse_y
;
4718 static unsigned long button_down_time
;
4720 /* The maximum time between clicks to make a double-click, or Qnil to
4721 disable double-click detection, or Qt for no time limit. */
4723 Lisp_Object Vdouble_click_time
;
4725 /* Maximum number of pixels the mouse may be moved between clicks
4726 to make a double-click. */
4728 EMACS_INT double_click_fuzz
;
4730 /* The number of clicks in this multiple-click. */
4732 int double_click_count
;
4734 /* Given a struct input_event, build the lisp event which represents
4735 it. If EVENT is 0, build a mouse movement event from the mouse
4736 movement buffer, which should have a movement event in it.
4738 Note that events must be passed to this function in the order they
4739 are received; this function stores the location of button presses
4740 in order to build drag events when the button is released. */
4743 make_lispy_event (event
)
4744 struct input_event
*event
;
4748 switch (SWITCH_ENUM_CAST (event
->kind
))
4750 /* A simple keystroke. */
4751 case ASCII_KEYSTROKE_EVENT
:
4753 Lisp_Object lispy_c
;
4754 int c
= event
->code
& 0377;
4755 /* Turn ASCII characters into control characters
4757 if (event
->modifiers
& ctrl_modifier
)
4758 c
= make_ctrl_char (c
);
4760 /* Add in the other modifier bits. We took care of ctrl_modifier
4761 just above, and the shift key was taken care of by the X code,
4762 and applied to control characters by make_ctrl_char. */
4763 c
|= (event
->modifiers
4764 & (meta_modifier
| alt_modifier
4765 | hyper_modifier
| super_modifier
));
4766 /* Distinguish Shift-SPC from SPC. */
4767 if ((event
->code
& 0377) == 040
4768 && event
->modifiers
& shift_modifier
)
4769 c
|= shift_modifier
;
4770 button_down_time
= 0;
4771 XSETFASTINT (lispy_c
, c
);
4775 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4777 Lisp_Object lispy_c
;
4779 XSETFASTINT (lispy_c
, event
->code
);
4783 /* A function key. The symbol may need to have modifier prefixes
4785 case NON_ASCII_KEYSTROKE_EVENT
:
4786 button_down_time
= 0;
4788 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4789 if (event
->code
== lispy_accent_codes
[i
])
4790 return modify_event_symbol (i
,
4792 Qfunction_key
, Qnil
,
4793 lispy_accent_keys
, &accent_key_syms
,
4794 (sizeof (lispy_accent_keys
)
4795 / sizeof (lispy_accent_keys
[0])));
4798 if (event
->code
>= 0x400 && event
->code
< 0x500)
4799 return modify_event_symbol (event
->code
- 0x400,
4800 event
->modifiers
& ~shift_modifier
,
4801 Qfunction_key
, Qnil
,
4802 lispy_kana_keys
, &func_key_syms
,
4803 (sizeof (lispy_kana_keys
)
4804 / sizeof (lispy_kana_keys
[0])));
4805 #endif /* XK_kana_A */
4807 #ifdef ISO_FUNCTION_KEY_OFFSET
4808 if (event
->code
< FUNCTION_KEY_OFFSET
4809 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4810 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4812 Qfunction_key
, Qnil
,
4813 iso_lispy_function_keys
, &func_key_syms
,
4814 (sizeof (iso_lispy_function_keys
)
4815 / sizeof (iso_lispy_function_keys
[0])));
4818 /* Handle system-specific or unknown keysyms. */
4819 if (event
->code
& (1 << 28)
4820 || event
->code
- FUNCTION_KEY_OFFSET
< 0
4821 || (event
->code
- FUNCTION_KEY_OFFSET
4822 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
4823 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
4825 /* We need to use an alist rather than a vector as the cache
4826 since we can't make a vector long enuf. */
4827 if (NILP (current_kboard
->system_key_syms
))
4828 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4829 return modify_event_symbol (event
->code
,
4832 current_kboard
->Vsystem_key_alist
,
4833 0, ¤t_kboard
->system_key_syms
,
4837 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4839 Qfunction_key
, Qnil
,
4840 lispy_function_keys
, &func_key_syms
,
4841 (sizeof (lispy_function_keys
)
4842 / sizeof (lispy_function_keys
[0])));
4845 /* A mouse click. Figure out where it is, decide whether it's
4846 a press, click or drag, and build the appropriate structure. */
4847 case MOUSE_CLICK_EVENT
:
4848 #ifndef USE_TOOLKIT_SCROLL_BARS
4849 case SCROLL_BAR_CLICK_EVENT
:
4852 int button
= event
->code
;
4854 Lisp_Object position
;
4855 Lisp_Object
*start_pos_ptr
;
4856 Lisp_Object start_pos
;
4861 /* Build the position as appropriate for this mouse click. */
4862 if (event
->kind
== MOUSE_CLICK_EVENT
)
4865 struct frame
*f
= XFRAME (event
->frame_or_window
);
4867 Lisp_Object string_info
= Qnil
;
4870 /* Ignore mouse events that were made on frame that
4871 have been deleted. */
4872 if (! FRAME_LIVE_P (f
))
4875 /* EVENT->x and EVENT->y are frame-relative pixel
4876 coordinates at this place. Under old redisplay, COLUMN
4877 and ROW are set to frame relative glyph coordinates
4878 which are then used to determine whether this click is
4879 in a menu (non-toolkit version). */
4880 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4881 &column
, &row
, NULL
, 1);
4883 #ifndef USE_X_TOOLKIT
4884 /* In the non-toolkit version, clicks on the menu bar
4885 are ordinary button events in the event buffer.
4886 Distinguish them, and invoke the menu.
4888 (In the toolkit version, the toolkit handles the menu bar
4889 and Emacs doesn't know about it until after the user
4890 makes a selection.) */
4891 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4892 && (event
->modifiers
& down_modifier
))
4894 Lisp_Object items
, item
;
4899 /* Activate the menu bar on the down event. If the
4900 up event comes in before the menu code can deal with it,
4902 if (! (event
->modifiers
& down_modifier
))
4906 /* Find the menu bar item under `column'. */
4908 items
= FRAME_MENU_BAR_ITEMS (f
);
4909 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4911 Lisp_Object pos
, string
;
4912 string
= AREF (items
, i
+ 1);
4913 pos
= AREF (items
, i
+ 3);
4916 if (column
>= XINT (pos
)
4917 && column
< XINT (pos
) + XSTRING (string
)->size
)
4919 item
= AREF (items
, i
);
4924 /* ELisp manual 2.4b says (x y) are window relative but
4925 code says they are frame-relative. */
4927 = Fcons (event
->frame_or_window
,
4929 Fcons (Fcons (event
->x
, event
->y
),
4930 Fcons (make_number (event
->timestamp
),
4933 return Fcons (item
, Fcons (position
, Qnil
));
4935 #endif /* not USE_X_TOOLKIT */
4937 /* Set `window' to the window under frame pixel coordinates
4938 event->x/event->y. */
4939 window
= window_from_coordinates (f
, XINT (event
->x
),
4940 XINT (event
->y
), &part
, 0);
4942 if (!WINDOWP (window
))
4944 window
= event
->frame_or_window
;
4949 /* It's a click in window window at frame coordinates
4950 event->x/ event->y. */
4951 struct window
*w
= XWINDOW (window
);
4953 /* Get window relative coordinates. Original code
4954 `rounded' this to glyph boundaries. */
4955 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4956 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4958 /* Set event coordinates to window-relative coordinates
4959 for constructing the Lisp event below. */
4960 XSETINT (event
->x
, wx
);
4961 XSETINT (event
->y
, wy
);
4963 if (part
== 1 || part
== 3)
4965 /* Mode line or header line. Look for a string under
4966 the mouse that may have a `local-map' property. */
4970 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
4971 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
4972 if (STRINGP (string
))
4973 string_info
= Fcons (string
, make_number (charpos
));
4976 posn
= Qvertical_line
;
4977 else if (part
== 6 || part
== 7)
4980 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
4982 posn
= (part
== 6) ? Qleft_margin
: Qright_margin
;
4983 if (STRINGP (object
))
4984 string_info
= Fcons (object
, make_number (charpos
));
4989 struct display_pos p
;
4990 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
4991 posn
= make_number (CHARPOS (p
.pos
));
4992 if (STRINGP (object
))
4995 make_number (CHARPOS (p
.string_pos
)));
5002 Fcons (Fcons (event
->x
, event
->y
),
5003 Fcons (make_number (event
->timestamp
),
5006 : Fcons (string_info
, Qnil
))))));
5008 #ifndef USE_TOOLKIT_SCROLL_BARS
5011 /* It's a scrollbar click. */
5012 Lisp_Object portion_whole
;
5015 window
= event
->frame_or_window
;
5016 portion_whole
= Fcons (event
->x
, event
->y
);
5017 part
= *scroll_bar_parts
[(int) event
->part
];
5021 Fcons (Qvertical_scroll_bar
,
5022 Fcons (portion_whole
,
5023 Fcons (make_number (event
->timestamp
),
5024 Fcons (part
, Qnil
)))));
5026 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5028 if (button
>= ASIZE (button_down_location
))
5030 button_down_location
= larger_vector (button_down_location
,
5032 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5035 start_pos_ptr
= &AREF (button_down_location
, button
);
5036 start_pos
= *start_pos_ptr
;
5037 *start_pos_ptr
= Qnil
;
5040 /* On window-system frames, use the value of
5041 double-click-fuzz as is. On other frames, interpret it
5042 as a multiple of 1/8 characters. */
5046 if (WINDOWP (event
->frame_or_window
))
5047 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5048 else if (FRAMEP (event
->frame_or_window
))
5049 f
= XFRAME (event
->frame_or_window
);
5053 if (FRAME_WINDOW_P (f
))
5054 fuzz
= double_click_fuzz
;
5056 fuzz
= double_click_fuzz
/ 8;
5058 is_double
= (button
== last_mouse_button
5059 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5060 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5061 && button_down_time
!= 0
5062 && (EQ (Vdouble_click_time
, Qt
)
5063 || (INTEGERP (Vdouble_click_time
)
5064 && ((int)(event
->timestamp
- button_down_time
)
5065 < XINT (Vdouble_click_time
)))));
5068 last_mouse_button
= button
;
5069 last_mouse_x
= XINT (event
->x
);
5070 last_mouse_y
= XINT (event
->y
);
5072 /* If this is a button press, squirrel away the location, so
5073 we can decide later whether it was a click or a drag. */
5074 if (event
->modifiers
& down_modifier
)
5078 double_click_count
++;
5079 event
->modifiers
|= ((double_click_count
> 2)
5084 double_click_count
= 1;
5085 button_down_time
= event
->timestamp
;
5086 *start_pos_ptr
= Fcopy_alist (position
);
5089 /* Now we're releasing a button - check the co-ordinates to
5090 see if this was a click or a drag. */
5091 else if (event
->modifiers
& up_modifier
)
5093 /* If we did not see a down before this up, ignore the up.
5094 Probably this happened because the down event chose a
5095 menu item. It would be an annoyance to treat the
5096 release of the button that chose the menu item as a
5099 if (!CONSP (start_pos
))
5102 event
->modifiers
&= ~up_modifier
;
5103 #if 0 /* Formerly we treated an up with no down as a click event. */
5104 if (!CONSP (start_pos
))
5105 event
->modifiers
|= click_modifier
;
5110 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5112 /* The third element of every position
5113 should be the (x,y) pair. */
5114 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5116 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5118 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5119 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5122 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5123 && ydiff
< double_click_fuzz
5124 && ydiff
> - double_click_fuzz
)
5125 /* Mouse hasn't moved (much). */
5126 event
->modifiers
|= click_modifier
;
5129 button_down_time
= 0;
5130 event
->modifiers
|= drag_modifier
;
5133 /* Don't check is_double; treat this as multiple
5134 if the down-event was multiple. */
5135 if (double_click_count
> 1)
5136 event
->modifiers
|= ((double_click_count
> 2)
5142 /* Every mouse event should either have the down_modifier or
5143 the up_modifier set. */
5147 /* Get the symbol we should use for the mouse click. */
5150 head
= modify_event_symbol (button
,
5152 Qmouse_click
, Vlispy_mouse_stem
,
5155 XVECTOR (mouse_syms
)->size
);
5156 if (event
->modifiers
& drag_modifier
)
5161 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5164 Fcons (make_number (double_click_count
),
5173 #if USE_TOOLKIT_SCROLL_BARS
5175 /* We don't have down and up events if using toolkit scroll bars,
5176 so make this always a click event. Store in the `part' of
5177 the Lisp event a symbol which maps to the following actions:
5179 `above_handle' page up
5180 `below_handle' page down
5184 `bottom' bottom of buffer
5185 `handle' thumb has been dragged.
5186 `end-scroll' end of interaction with scroll bar
5188 The incoming input_event contains in its `part' member an
5189 index of type `enum scroll_bar_part' which we can use as an
5190 index in scroll_bar_parts to get the appropriate symbol. */
5192 case SCROLL_BAR_CLICK_EVENT
:
5194 Lisp_Object position
, head
, window
, portion_whole
, part
;
5196 window
= event
->frame_or_window
;
5197 portion_whole
= Fcons (event
->x
, event
->y
);
5198 part
= *scroll_bar_parts
[(int) event
->part
];
5202 Fcons (Qvertical_scroll_bar
,
5203 Fcons (portion_whole
,
5204 Fcons (make_number (event
->timestamp
),
5205 Fcons (part
, Qnil
)))));
5207 /* Always treat scroll bar events as clicks. */
5208 event
->modifiers
|= click_modifier
;
5210 /* Get the symbol we should use for the mouse click. */
5211 head
= modify_event_symbol (event
->code
,
5216 XVECTOR (mouse_syms
)->size
);
5217 return Fcons (head
, Fcons (position
, Qnil
));
5220 #endif /* USE_TOOLKIT_SCROLL_BARS */
5223 case W32_SCROLL_BAR_CLICK_EVENT
:
5225 int button
= event
->code
;
5227 Lisp_Object position
;
5228 Lisp_Object
*start_pos_ptr
;
5229 Lisp_Object start_pos
;
5233 Lisp_Object portion_whole
;
5236 window
= event
->frame_or_window
;
5237 portion_whole
= Fcons (event
->x
, event
->y
);
5238 part
= *scroll_bar_parts
[(int) event
->part
];
5242 Fcons (Qvertical_scroll_bar
,
5243 Fcons (portion_whole
,
5244 Fcons (make_number (event
->timestamp
),
5245 Fcons (part
, Qnil
)))));
5248 /* Always treat W32 scroll bar events as clicks. */
5249 event
->modifiers
|= click_modifier
;
5252 /* Get the symbol we should use for the mouse click. */
5255 head
= modify_event_symbol (button
,
5260 XVECTOR (mouse_syms
)->size
);
5266 case MOUSE_WHEEL_EVENT
:
5269 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5272 Lisp_Object head
, position
;
5275 /* Ignore mouse events that were made on frame that
5276 have been deleted. */
5277 if (! FRAME_LIVE_P (f
))
5279 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5280 &column
, &row
, NULL
, 1);
5281 window
= window_from_coordinates (f
, XINT (event
->x
),
5282 XINT (event
->y
), &part
, 0);
5284 if (!WINDOWP (window
))
5286 window
= event
->frame_or_window
;
5291 int pixcolumn
, pixrow
;
5292 column
-= XINT (XWINDOW (window
)->left
);
5293 row
-= XINT (XWINDOW (window
)->top
);
5294 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5295 &pixcolumn
, &pixrow
);
5296 XSETINT (event
->x
, pixcolumn
);
5297 XSETINT (event
->y
, pixrow
);
5302 posn
= Qvertical_line
;
5304 posn
= Qheader_line
;
5308 struct display_pos p
;
5309 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5311 posn
= make_number (CHARPOS (p
.pos
));
5316 Lisp_Object head
, position
;
5321 Fcons (Fcons (event
->x
, event
->y
),
5322 Fcons (make_number (event
->timestamp
),
5325 head
= modify_event_symbol (0, event
->modifiers
,
5327 lispy_mouse_wheel_names
,
5328 &mouse_wheel_syms
, 1);
5331 /* Insert 1 here so event-click-count works. */
5332 Fcons (make_number (1),
5333 Fcons (make_number (event
->code
),
5337 #endif /* WINDOWSNT */
5339 case DRAG_N_DROP_EVENT
:
5347 /* The frame_or_window field should be a cons of the frame in
5348 which the event occurred and a list of the filenames
5350 if (! CONSP (event
->frame_or_window
))
5353 f
= XFRAME (XCAR (event
->frame_or_window
));
5354 files
= XCDR (event
->frame_or_window
);
5356 /* Ignore mouse events that were made on frames that
5357 have been deleted. */
5358 if (! FRAME_LIVE_P (f
))
5361 window
= window_from_coordinates (f
, XINT (event
->x
),
5362 XINT (event
->y
), &part
, 0);
5364 if (!WINDOWP (window
))
5366 window
= XCAR (event
->frame_or_window
);
5371 /* It's an event in window `window' at frame coordinates
5372 event->x/ event->y. */
5373 struct window
*w
= XWINDOW (window
);
5375 /* Get window relative coordinates. */
5376 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5377 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5379 /* Set event coordinates to window-relative coordinates
5380 for constructing the Lisp event below. */
5381 XSETINT (event
->x
, wx
);
5382 XSETINT (event
->y
, wy
);
5387 posn
= Qvertical_line
;
5389 posn
= Qheader_line
;
5393 struct display_pos p
;
5394 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5395 posn
= make_number (CHARPOS (p
.pos
));
5400 Lisp_Object head
, position
;
5405 Fcons (Fcons (event
->x
, event
->y
),
5406 Fcons (make_number (event
->timestamp
),
5409 head
= modify_event_symbol (0, event
->modifiers
,
5411 lispy_drag_n_drop_names
,
5412 &drag_n_drop_syms
, 1);
5419 #endif /* HAVE_MOUSE */
5421 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
5422 case MENU_BAR_EVENT
:
5423 if (EQ (event
->arg
, event
->frame_or_window
))
5424 /* This is the prefix key. We translate this to
5425 `(menu_bar)' because the code in keyboard.c for menu
5426 events, which we use, relies on this. */
5427 return Fcons (Qmenu_bar
, Qnil
);
5431 case TOOL_BAR_EVENT
:
5432 if (EQ (event
->arg
, event
->frame_or_window
))
5433 /* This is the prefix key. We translate this to
5434 `(tool_bar)' because the code in keyboard.c for tool bar
5435 events, which we use, relies on this. */
5436 return Fcons (Qtool_bar
, Qnil
);
5437 else if (SYMBOLP (event
->arg
))
5438 return apply_modifiers (event
->modifiers
, event
->arg
);
5441 case USER_SIGNAL_EVENT
:
5442 /* A user signal. */
5443 return *lispy_user_signals
[event
->code
];
5445 case SAVE_SESSION_EVENT
:
5446 return Qsave_session
;
5448 /* The 'kind' field of the event is something we don't recognize. */
5457 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5459 Lisp_Object bar_window
;
5460 enum scroll_bar_part part
;
5464 /* Is it a scroll bar movement? */
5465 if (frame
&& ! NILP (bar_window
))
5467 Lisp_Object part_sym
;
5469 part_sym
= *scroll_bar_parts
[(int) part
];
5470 return Fcons (Qscroll_bar_movement
,
5471 (Fcons (Fcons (bar_window
,
5472 Fcons (Qvertical_scroll_bar
,
5473 Fcons (Fcons (x
, y
),
5474 Fcons (make_number (time
),
5480 /* Or is it an ordinary mouse movement? */
5488 /* It's in a frame; which window on that frame? */
5489 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5493 if (WINDOWP (window
))
5495 struct window
*w
= XWINDOW (window
);
5498 /* Get window relative coordinates. */
5499 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5500 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5507 posn
= Qvertical_line
;
5509 posn
= Qheader_line
;
5513 struct display_pos p
;
5514 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5515 posn
= make_number (CHARPOS (p
.pos
));
5518 else if (frame
!= 0)
5520 XSETFRAME (window
, frame
);
5531 return Fcons (Qmouse_movement
,
5532 Fcons (Fcons (window
,
5534 Fcons (Fcons (x
, y
),
5535 Fcons (make_number (time
),
5541 #endif /* HAVE_MOUSE */
5543 /* Construct a switch frame event. */
5545 make_lispy_switch_frame (frame
)
5548 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5551 /* Manipulating modifiers. */
5553 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5555 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5556 SYMBOL's name of the end of the modifiers; the string from this
5557 position is the unmodified symbol name.
5559 This doesn't use any caches. */
5562 parse_modifiers_uncached (symbol
, modifier_end
)
5566 struct Lisp_String
*name
;
5570 CHECK_SYMBOL (symbol
);
5573 name
= XSTRING (SYMBOL_NAME (symbol
));
5575 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
5577 int this_mod_end
= 0;
5580 /* See if the name continues with a modifier word.
5581 Check that the word appears, but don't check what follows it.
5582 Set this_mod and this_mod_end to record what we find. */
5584 switch (name
->data
[i
])
5586 #define SINGLE_LETTER_MOD(BIT) \
5587 (this_mod_end = i + 1, this_mod = BIT)
5590 SINGLE_LETTER_MOD (alt_modifier
);
5594 SINGLE_LETTER_MOD (ctrl_modifier
);
5598 SINGLE_LETTER_MOD (hyper_modifier
);
5602 SINGLE_LETTER_MOD (meta_modifier
);
5606 SINGLE_LETTER_MOD (shift_modifier
);
5610 SINGLE_LETTER_MOD (super_modifier
);
5613 #undef SINGLE_LETTER_MOD
5616 /* If we found no modifier, stop looking for them. */
5617 if (this_mod_end
== 0)
5620 /* Check there is a dash after the modifier, so that it
5621 really is a modifier. */
5622 if (this_mod_end
>= STRING_BYTES (name
)
5623 || name
->data
[this_mod_end
] != '-')
5626 /* This modifier is real; look for another. */
5627 modifiers
|= this_mod
;
5628 i
= this_mod_end
+ 1;
5631 /* Should we include the `click' modifier? */
5632 if (! (modifiers
& (down_modifier
| drag_modifier
5633 | double_modifier
| triple_modifier
))
5634 && i
+ 7 == STRING_BYTES (name
)
5635 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
5636 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
5637 modifiers
|= click_modifier
;
5645 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5646 prepended to the string BASE[0..BASE_LEN-1].
5647 This doesn't use any caches. */
5649 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5652 int base_len
, base_len_byte
;
5654 /* Since BASE could contain nulls, we can't use intern here; we have
5655 to use Fintern, which expects a genuine Lisp_String, and keeps a
5658 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5664 /* Only the event queue may use the `up' modifier; it should always
5665 be turned into a click or drag event before presented to lisp code. */
5666 if (modifiers
& up_modifier
)
5669 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5670 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5671 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5672 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5673 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5674 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5675 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5676 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5677 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5678 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5679 /* The click modifier is denoted by the absence of other modifiers. */
5683 mod_len
= p
- new_mods
;
5687 Lisp_Object new_name
;
5689 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5690 mod_len
+ base_len_byte
);
5691 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
5692 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
5694 return Fintern (new_name
, Qnil
);
5699 static char *modifier_names
[] =
5701 "up", "down", "drag", "click", "double", "triple", 0, 0,
5702 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5703 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5705 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5707 static Lisp_Object modifier_symbols
;
5709 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5711 lispy_modifier_list (modifiers
)
5714 Lisp_Object modifier_list
;
5717 modifier_list
= Qnil
;
5718 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5719 if (modifiers
& (1<<i
))
5720 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5723 return modifier_list
;
5727 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5728 where UNMODIFIED is the unmodified form of SYMBOL,
5729 MASK is the set of modifiers present in SYMBOL's name.
5730 This is similar to parse_modifiers_uncached, but uses the cache in
5731 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5732 Qevent_symbol_elements property. */
5735 parse_modifiers (symbol
)
5738 Lisp_Object elements
;
5740 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5741 if (CONSP (elements
))
5746 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5747 Lisp_Object unmodified
;
5750 unmodified
= Fintern (make_string (XSTRING (SYMBOL_NAME (symbol
))->data
+ end
,
5751 STRING_BYTES (XSTRING (SYMBOL_NAME (symbol
))) - end
),
5754 if (modifiers
& ~VALMASK
)
5756 XSETFASTINT (mask
, modifiers
);
5757 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5759 /* Cache the parsing results on SYMBOL. */
5760 Fput (symbol
, Qevent_symbol_element_mask
,
5762 Fput (symbol
, Qevent_symbol_elements
,
5763 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5765 /* Since we know that SYMBOL is modifiers applied to unmodified,
5766 it would be nice to put that in unmodified's cache.
5767 But we can't, since we're not sure that parse_modifiers is
5774 /* Apply the modifiers MODIFIERS to the symbol BASE.
5775 BASE must be unmodified.
5777 This is like apply_modifiers_uncached, but uses BASE's
5778 Qmodifier_cache property, if present. It also builds
5779 Qevent_symbol_elements properties, since it has that info anyway.
5781 apply_modifiers copies the value of BASE's Qevent_kind property to
5782 the modified symbol. */
5784 apply_modifiers (modifiers
, base
)
5788 Lisp_Object cache
, index
, entry
, new_symbol
;
5790 /* Mask out upper bits. We don't know where this value's been. */
5791 modifiers
&= VALMASK
;
5793 /* The click modifier never figures into cache indices. */
5794 cache
= Fget (base
, Qmodifier_cache
);
5795 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5796 entry
= assq_no_quit (index
, cache
);
5799 new_symbol
= XCDR (entry
);
5802 /* We have to create the symbol ourselves. */
5803 new_symbol
= apply_modifiers_uncached (modifiers
,
5804 XSTRING (SYMBOL_NAME (base
))->data
,
5805 XSTRING (SYMBOL_NAME (base
))->size
,
5806 STRING_BYTES (XSTRING (SYMBOL_NAME (base
))));
5808 /* Add the new symbol to the base's cache. */
5809 entry
= Fcons (index
, new_symbol
);
5810 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5812 /* We have the parsing info now for free, so add it to the caches. */
5813 XSETFASTINT (index
, modifiers
);
5814 Fput (new_symbol
, Qevent_symbol_element_mask
,
5815 Fcons (base
, Fcons (index
, Qnil
)));
5816 Fput (new_symbol
, Qevent_symbol_elements
,
5817 Fcons (base
, lispy_modifier_list (modifiers
)));
5820 /* Make sure this symbol is of the same kind as BASE.
5822 You'd think we could just set this once and for all when we
5823 intern the symbol above, but reorder_modifiers may call us when
5824 BASE's property isn't set right; we can't assume that just
5825 because it has a Qmodifier_cache property it must have its
5826 Qevent_kind set right as well. */
5827 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5831 kind
= Fget (base
, Qevent_kind
);
5833 Fput (new_symbol
, Qevent_kind
, kind
);
5840 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5841 return a symbol with the modifiers placed in the canonical order.
5842 Canonical order is alphabetical, except for down and drag, which
5843 always come last. The 'click' modifier is never written out.
5845 Fdefine_key calls this to make sure that (for example) C-M-foo
5846 and M-C-foo end up being equivalent in the keymap. */
5849 reorder_modifiers (symbol
)
5852 /* It's hopefully okay to write the code this way, since everything
5853 will soon be in caches, and no consing will be done at all. */
5856 parsed
= parse_modifiers (symbol
);
5857 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5862 /* For handling events, we often want to produce a symbol whose name
5863 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5864 to some base, like the name of a function key or mouse button.
5865 modify_event_symbol produces symbols of this sort.
5867 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5868 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5871 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5872 into symbol names, or a string specifying a name stem used to
5873 construct a symbol name or the form `STEM-N', where N is the decimal
5874 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5875 non-nil; otherwise NAME_TABLE is used.
5877 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5878 persist between calls to modify_event_symbol that it can use to
5879 store a cache of the symbols it's generated for this NAME_TABLE
5880 before. The object stored there may be a vector or an alist.
5882 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5884 MODIFIERS is a set of modifier bits (as given in struct input_events)
5885 whose prefixes should be applied to the symbol name.
5887 SYMBOL_KIND is the value to be placed in the event_kind property of
5888 the returned symbol.
5890 The symbols we create are supposed to have an
5891 `event-symbol-elements' property, which lists the modifiers present
5892 in the symbol's name. */
5895 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5896 name_table
, symbol_table
, table_size
)
5899 Lisp_Object symbol_kind
;
5900 Lisp_Object name_alist_or_stem
;
5902 Lisp_Object
*symbol_table
;
5903 unsigned int table_size
;
5906 Lisp_Object symbol_int
;
5908 /* Get rid of the "vendor-specific" bit here. */
5909 XSETINT (symbol_int
, symbol_num
& 0xffffff);
5911 /* Is this a request for a valid symbol? */
5912 if (symbol_num
< 0 || symbol_num
>= table_size
)
5915 if (CONSP (*symbol_table
))
5916 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
5918 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5919 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5920 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5921 we've never used that symbol before. */
5924 if (! VECTORP (*symbol_table
)
5925 || XVECTOR (*symbol_table
)->size
!= table_size
)
5929 XSETFASTINT (size
, table_size
);
5930 *symbol_table
= Fmake_vector (size
, Qnil
);
5933 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5936 /* Have we already used this symbol before? */
5939 /* No; let's create it. */
5940 if (CONSP (name_alist_or_stem
))
5941 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
5942 else if (STRINGP (name_alist_or_stem
))
5944 int len
= STRING_BYTES (XSTRING (name_alist_or_stem
));
5945 char *buf
= (char *) alloca (len
+ 50);
5946 sprintf (buf
, "%s-%d", XSTRING (name_alist_or_stem
)->data
,
5947 XINT (symbol_int
) + 1);
5948 value
= intern (buf
);
5950 else if (name_table
!= 0 && name_table
[symbol_num
])
5951 value
= intern (name_table
[symbol_num
]);
5953 #ifdef HAVE_WINDOW_SYSTEM
5956 char *name
= x_get_keysym_name (symbol_num
);
5958 value
= intern (name
);
5965 sprintf (buf
, "key-%d", symbol_num
);
5966 value
= intern (buf
);
5969 if (CONSP (*symbol_table
))
5970 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5972 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5974 /* Fill in the cache entries for this symbol; this also
5975 builds the Qevent_symbol_elements property, which the user
5977 apply_modifiers (modifiers
& click_modifier
, value
);
5978 Fput (value
, Qevent_kind
, symbol_kind
);
5981 /* Apply modifiers to that symbol. */
5982 return apply_modifiers (modifiers
, value
);
5985 /* Convert a list that represents an event type,
5986 such as (ctrl meta backspace), into the usual representation of that
5987 event type as a number or a symbol. */
5989 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5990 doc
: /* Convert the event description list EVENT-DESC to an event type.
5991 EVENT-DESC should contain one base event type (a character or symbol)
5992 and zero or more modifier names (control, meta, hyper, super, shift, alt,
5993 drag, down, double or triple). The base must be last.
5994 The return value is an event type (a character or symbol) which
5995 has the same base event type and all the specified modifiers. */)
5997 Lisp_Object event_desc
;
6005 while (CONSP (rest
))
6013 /* Given a symbol, see if it is a modifier name. */
6014 if (SYMBOLP (elt
) && CONSP (rest
))
6015 this = parse_solitary_modifier (elt
);
6019 else if (!NILP (base
))
6020 error ("Two bases given in one event");
6026 /* Let the symbol A refer to the character A. */
6027 if (SYMBOLP (base
) && XSTRING (SYMBOL_NAME (base
))->size
== 1)
6028 XSETINT (base
, XSTRING (SYMBOL_NAME (base
))->data
[0]);
6030 if (INTEGERP (base
))
6032 /* Turn (shift a) into A. */
6033 if ((modifiers
& shift_modifier
) != 0
6034 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6036 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6037 modifiers
&= ~shift_modifier
;
6040 /* Turn (control a) into C-a. */
6041 if (modifiers
& ctrl_modifier
)
6042 return make_number ((modifiers
& ~ctrl_modifier
)
6043 | make_ctrl_char (XINT (base
)));
6045 return make_number (modifiers
| XINT (base
));
6047 else if (SYMBOLP (base
))
6048 return apply_modifiers (modifiers
, base
);
6051 error ("Invalid base event");
6056 /* Try to recognize SYMBOL as a modifier name.
6057 Return the modifier flag bit, or 0 if not recognized. */
6060 parse_solitary_modifier (symbol
)
6063 struct Lisp_String
*name
= XSTRING (SYMBOL_NAME (symbol
));
6065 switch (name
->data
[0])
6067 #define SINGLE_LETTER_MOD(BIT) \
6068 if (STRING_BYTES (name) == 1) \
6071 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6072 if (LEN == STRING_BYTES (name) \
6073 && ! strncmp (name->data, NAME, LEN)) \
6077 SINGLE_LETTER_MOD (alt_modifier
);
6081 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6085 SINGLE_LETTER_MOD (ctrl_modifier
);
6089 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6090 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6094 SINGLE_LETTER_MOD (hyper_modifier
);
6098 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6102 SINGLE_LETTER_MOD (meta_modifier
);
6106 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6110 SINGLE_LETTER_MOD (shift_modifier
);
6114 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6115 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6116 SINGLE_LETTER_MOD (super_modifier
);
6120 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6121 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6122 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6126 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6129 #undef SINGLE_LETTER_MOD
6130 #undef MULTI_LETTER_MOD
6136 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6137 Such a list is not valid as an event,
6138 but it can be a Lucid-style event type list. */
6141 lucid_event_type_list_p (object
)
6146 if (! CONSP (object
))
6149 if (EQ (XCAR (object
), Qhelp_echo
)
6150 || EQ (XCAR (object
), Qvertical_line
)
6151 || EQ (XCAR (object
), Qmode_line
)
6152 || EQ (XCAR (object
), Qheader_line
))
6155 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6159 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6166 /* Store into *addr a value nonzero if terminal input chars are available.
6167 Serves the purpose of ioctl (0, FIONREAD, addr)
6168 but works even if FIONREAD does not exist.
6169 (In fact, this may actually read some input.)
6171 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6172 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6175 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6180 /* First of all, have we already counted some input? */
6181 *addr
= (!NILP (Vquit_flag
)
6182 || readable_filtered_events (do_timers_now
, filter_events
));
6184 /* If input is being read as it arrives, and we have none, there is none. */
6185 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6188 /* Try to read some input and see how much we get. */
6190 *addr
= (!NILP (Vquit_flag
)
6191 || readable_filtered_events (do_timers_now
, filter_events
));
6194 /* Store into *addr a value nonzero if terminal input chars are available.
6195 Serves the purpose of ioctl (0, FIONREAD, addr)
6196 but works even if FIONREAD does not exist.
6197 (In fact, this may actually read some input.)
6199 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6202 get_input_pending (addr
, do_timers_now
)
6206 get_filtered_input_pending (addr
, do_timers_now
, 0);
6209 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6212 gobble_input (expected
)
6217 if (interrupt_input
)
6220 mask
= sigblock (sigmask (SIGIO
));
6221 read_avail_input (expected
);
6225 #ifdef POLL_FOR_INPUT
6226 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6229 mask
= sigblock (sigmask (SIGALRM
));
6230 read_avail_input (expected
);
6236 read_avail_input (expected
);
6240 /* Put a BUFFER_SWITCH_EVENT in the buffer
6241 so that read_key_sequence will notice the new current buffer. */
6244 record_asynch_buffer_change ()
6246 struct input_event event
;
6249 event
.kind
= BUFFER_SWITCH_EVENT
;
6250 event
.frame_or_window
= Qnil
;
6254 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6255 The purpose of the event is to make read_key_sequence look up the
6256 keymaps again. If we aren't in read_key_sequence, we don't need one,
6257 and the event could cause trouble by messing up (input-pending-p). */
6258 tem
= Fwaiting_for_user_input_p ();
6262 /* We never need these events if we have no asynchronous subprocesses. */
6266 /* Make sure no interrupt happens while storing the event. */
6268 if (interrupt_input
)
6271 mask
= sigblock (sigmask (SIGIO
));
6272 kbd_buffer_store_event (&event
);
6279 kbd_buffer_store_event (&event
);
6286 /* Read any terminal input already buffered up by the system
6287 into the kbd_buffer, but do not wait.
6289 EXPECTED should be nonzero if the caller knows there is some input.
6291 Except on VMS, all input is read by this function.
6292 If interrupt_input is nonzero, this function MUST be called
6293 only when SIGIO is blocked.
6295 Returns the number of keyboard chars read, or -1 meaning
6296 this is a bad time to try to read input. */
6299 read_avail_input (expected
)
6302 struct input_event buf
[KBD_BUFFER_SIZE
];
6306 if (read_socket_hook
)
6307 /* No need for FIONREAD or fcntl; just say don't wait. */
6308 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6311 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6312 the kbd_buffer can really hold. That may prevent loss
6313 of characters on some systems when input is stuffed at us. */
6314 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6317 /* Determine how many characters we should *try* to read. */
6320 #else /* not WINDOWSNT */
6322 n_to_read
= dos_keysns ();
6325 #else /* not MSDOS */
6327 /* Find out how much input is available. */
6328 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6329 /* Formerly simply reported no input, but that sometimes led to
6330 a failure of Emacs to terminate.
6331 SIGHUP seems appropriate if we can't reach the terminal. */
6332 /* ??? Is it really right to send the signal just to this process
6333 rather than to the whole process group?
6334 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6335 kill (getpid (), SIGHUP
);
6338 if (n_to_read
> sizeof cbuf
)
6339 n_to_read
= sizeof cbuf
;
6340 #else /* no FIONREAD */
6341 #if defined (USG) || defined (DGUX)
6342 /* Read some input if available, but don't wait. */
6343 n_to_read
= sizeof cbuf
;
6344 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6349 #endif /* not MSDOS */
6350 #endif /* not WINDOWSNT */
6352 /* Now read; for one reason or another, this will not block.
6353 NREAD is set to the number of chars read. */
6357 cbuf
[0] = dos_keyread ();
6360 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6362 /* POSIX infers that processes which are not in the session leader's
6363 process group won't get SIGHUP's at logout time. BSDI adheres to
6364 this part standard and returns -1 from read (0) with errno==EIO
6365 when the control tty is taken away.
6366 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6367 if (nread
== -1 && errno
== EIO
)
6369 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6370 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6371 This looks incorrect, but it isn't, because _BSD causes
6372 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6373 and that causes a value other than 0 when there is no input. */
6379 /* We used to retry the read if it was interrupted.
6380 But this does the wrong thing when O_NDELAY causes
6381 an EAGAIN error. Does anybody know of a situation
6382 where a retry is actually needed? */
6384 nread
< 0 && (errno
== EAGAIN
6398 #if defined (USG) || defined (DGUX)
6399 fcntl (input_fd
, F_SETFL
, 0);
6400 #endif /* USG or DGUX */
6401 #endif /* no FIONREAD */
6402 for (i
= 0; i
< nread
; i
++)
6404 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6405 buf
[i
].modifiers
= 0;
6406 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6407 buf
[i
].modifiers
= meta_modifier
;
6411 buf
[i
].code
= cbuf
[i
];
6412 buf
[i
].frame_or_window
= selected_frame
;
6417 /* Scan the chars for C-g and store them in kbd_buffer. */
6418 for (i
= 0; i
< nread
; i
++)
6420 kbd_buffer_store_event (&buf
[i
]);
6421 /* Don't look at input that follows a C-g too closely.
6422 This reduces lossage due to autorepeat on C-g. */
6423 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6424 && buf
[i
].code
== quit_char
)
6430 #endif /* not VMS */
6432 #ifdef SIGIO /* for entire page */
6433 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6436 input_available_signal (signo
)
6439 /* Must preserve main program's value of errno. */
6440 int old_errno
= errno
;
6442 extern int select_alarmed
;
6445 #if defined (USG) && !defined (POSIX_SIGNALS)
6446 /* USG systems forget handlers when they are used;
6447 must reestablish each time */
6448 signal (signo
, input_available_signal
);
6455 if (input_available_clear_time
)
6456 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6461 nread
= read_avail_input (1);
6462 /* -1 means it's not ok to read the input now.
6463 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6464 0 means there was no keyboard input available. */
6469 select_alarmed
= 1; /* Force the select emulator back to life */
6480 /* Send ourselves a SIGIO.
6482 This function exists so that the UNBLOCK_INPUT macro in
6483 blockinput.h can have some way to take care of input we put off
6484 dealing with, without assuming that every file which uses
6485 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6487 reinvoke_input_signal ()
6490 kill (getpid (), SIGIO
);
6496 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6497 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6499 /* These variables hold the vector under construction within
6500 menu_bar_items and its subroutines, and the current index
6501 for storing into that vector. */
6502 static Lisp_Object menu_bar_items_vector
;
6503 static int menu_bar_items_index
;
6505 /* Return a vector of menu items for a menu bar, appropriate
6506 to the current buffer. Each item has three elements in the vector:
6509 OLD is an old vector we can optionally reuse, or nil. */
6512 menu_bar_items (old
)
6515 /* The number of keymaps we're scanning right now, and the number of
6516 keymaps we have allocated space for. */
6519 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6520 in the current keymaps, or nil where it is not a prefix. */
6523 Lisp_Object def
, tail
;
6532 struct gcpro gcpro1
;
6534 /* In order to build the menus, we need to call the keymap
6535 accessors. They all call QUIT. But this function is called
6536 during redisplay, during which a quit is fatal. So inhibit
6537 quitting while building the menus.
6538 We do this instead of specbind because (1) errors will clear it anyway
6539 and (2) this avoids risk of specpdl overflow. */
6540 oquit
= Vinhibit_quit
;
6544 menu_bar_items_vector
= old
;
6546 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6547 menu_bar_items_index
= 0;
6549 GCPRO1 (menu_bar_items_vector
);
6551 /* Build our list of keymaps.
6552 If we recognize a function key and replace its escape sequence in
6553 keybuf with its symbol, or if the sequence starts with a mouse
6554 click and we need to switch buffers, we jump back here to rebuild
6555 the initial keymaps from the current buffer. */
6559 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6560 if (!NILP (Voverriding_local_map_menu_flag
))
6562 /* Yes, use them (if non-nil) as well as the global map. */
6563 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6565 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6566 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6567 if (!NILP (Voverriding_local_map
))
6568 maps
[nmaps
++] = Voverriding_local_map
;
6572 /* No, so use major and minor mode keymaps and keymap property.
6573 Note that menu-bar bindings in the local-map and keymap
6574 properties may not work reliable, as they are only
6575 recognized when the menu-bar (or mode-line) is updated,
6576 which does not normally happen after every command. */
6579 nminor
= current_minor_maps (NULL
, &tmaps
);
6580 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6582 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6583 maps
[nmaps
++] = tem
;
6584 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6586 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6588 maps
[nmaps
++] = current_global_map
;
6591 /* Look up in each map the dummy prefix key `menu-bar'. */
6595 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6596 if (!NILP (maps
[mapno
]))
6598 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6601 menu_bar_one_keymap (def
);
6604 /* Move to the end those items that should be at the end. */
6606 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6609 int end
= menu_bar_items_index
;
6611 for (i
= 0; i
< end
; i
+= 4)
6612 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6614 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6615 /* Move the item at index I to the end,
6616 shifting all the others forward. */
6617 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6618 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6619 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6620 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6622 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6623 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6624 (end
- i
- 4) * sizeof (Lisp_Object
));
6625 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6626 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6627 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6628 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6633 /* Add nil, nil, nil, nil at the end. */
6634 i
= menu_bar_items_index
;
6635 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6638 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6639 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6640 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6641 menu_bar_items_vector
= tem
;
6643 /* Add this item. */
6644 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6645 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6646 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6647 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6648 menu_bar_items_index
= i
;
6650 Vinhibit_quit
= oquit
;
6652 return menu_bar_items_vector
;
6655 /* Scan one map KEYMAP, accumulating any menu items it defines
6656 in menu_bar_items_vector. */
6658 static Lisp_Object menu_bar_one_keymap_changed_items
;
6661 menu_bar_one_keymap (keymap
)
6664 Lisp_Object tail
, item
;
6666 menu_bar_one_keymap_changed_items
= Qnil
;
6668 /* Loop over all keymap entries that have menu strings. */
6669 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6673 menu_bar_item (XCAR (item
), XCDR (item
));
6674 else if (VECTORP (item
))
6676 /* Loop over the char values represented in the vector. */
6677 int len
= XVECTOR (item
)->size
;
6679 for (c
= 0; c
< len
; c
++)
6681 Lisp_Object character
;
6682 XSETFASTINT (character
, c
);
6683 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6689 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6690 If there's already an item for KEY, add this DEF to it. */
6692 Lisp_Object item_properties
;
6695 menu_bar_item (key
, item
)
6696 Lisp_Object key
, item
;
6698 struct gcpro gcpro1
;
6702 if (EQ (item
, Qundefined
))
6704 /* If a map has an explicit `undefined' as definition,
6705 discard any previously made menu bar item. */
6707 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6708 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6710 if (menu_bar_items_index
> i
+ 4)
6711 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6712 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6713 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6714 menu_bar_items_index
-= 4;
6718 /* If this keymap has already contributed to this KEY,
6719 don't contribute to it a second time. */
6720 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6721 if (!NILP (tem
) || NILP (item
))
6724 menu_bar_one_keymap_changed_items
6725 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6727 /* We add to menu_bar_one_keymap_changed_items before doing the
6728 parse_menu_item, so that if it turns out it wasn't a menu item,
6729 it still correctly hides any further menu item. */
6731 i
= parse_menu_item (item
, 0, 1);
6736 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6738 /* Find any existing item for this KEY. */
6739 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6740 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6743 /* If we did not find this KEY, add it at the end. */
6744 if (i
== menu_bar_items_index
)
6746 /* If vector is too small, get a bigger one. */
6747 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6750 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6751 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6752 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6753 menu_bar_items_vector
= tem
;
6756 /* Add this item. */
6757 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6758 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6759 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6760 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6761 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6762 menu_bar_items_index
= i
;
6764 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6768 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6769 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6773 /* This is used as the handler when calling menu_item_eval_property. */
6775 menu_item_eval_property_1 (arg
)
6778 /* If we got a quit from within the menu computation,
6779 quit all the way out of it. This takes care of C-] in the debugger. */
6780 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6781 Fsignal (Qquit
, Qnil
);
6786 /* Evaluate an expression and return the result (or nil if something
6787 went wrong). Used to evaluate dynamic parts of menu items. */
6789 menu_item_eval_property (sexpr
)
6792 int count
= specpdl_ptr
- specpdl
;
6794 specbind (Qinhibit_redisplay
, Qt
);
6795 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6796 menu_item_eval_property_1
);
6797 return unbind_to (count
, val
);
6800 /* This function parses a menu item and leaves the result in the
6801 vector item_properties.
6802 ITEM is a key binding, a possible menu item.
6803 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6804 evaluate dynamic expressions in the menu item.
6805 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6807 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6808 parse_menu_item returns true if the item is a menu item and false
6812 parse_menu_item (item
, notreal
, inmenubar
)
6814 int notreal
, inmenubar
;
6816 Lisp_Object def
, tem
, item_string
, start
;
6817 Lisp_Object cachelist
;
6819 Lisp_Object keyhint
;
6830 /* Create item_properties vector if necessary. */
6831 if (NILP (item_properties
))
6833 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6835 /* Initialize optional entries. */
6836 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6837 AREF (item_properties
, i
) = Qnil
;
6838 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
6840 /* Save the item here to protect it from GC. */
6841 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
6843 item_string
= XCAR (item
);
6847 if (STRINGP (item_string
))
6849 /* Old format menu item. */
6850 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6852 /* Maybe help string. */
6853 if (CONSP (item
) && STRINGP (XCAR (item
)))
6855 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6860 /* Maybe key binding cache. */
6861 if (CONSP (item
) && CONSP (XCAR (item
))
6862 && (NILP (XCAR (XCAR (item
)))
6863 || VECTORP (XCAR (XCAR (item
)))))
6865 cachelist
= XCAR (item
);
6869 /* This is the real definition--the function to run. */
6870 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
6872 /* Get enable property, if any. */
6875 tem
= Fget (item
, Qmenu_enable
);
6877 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6880 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6882 /* New format menu item. */
6883 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
6884 start
= XCDR (item
);
6887 /* We have a real binding. */
6888 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
6890 item
= XCDR (start
);
6891 /* Is there a cache list with key equivalences. */
6892 if (CONSP (item
) && CONSP (XCAR (item
)))
6894 cachelist
= XCAR (item
);
6898 /* Parse properties. */
6899 while (CONSP (item
) && CONSP (XCDR (item
)))
6904 if (EQ (tem
, QCenable
))
6905 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
6906 else if (EQ (tem
, QCvisible
) && !notreal
)
6908 /* If got a visible property and that evaluates to nil
6909 then ignore this item. */
6910 tem
= menu_item_eval_property (XCAR (item
));
6914 else if (EQ (tem
, QChelp
))
6915 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6916 else if (EQ (tem
, QCfilter
))
6918 else if (EQ (tem
, QCkey_sequence
))
6921 if (NILP (cachelist
)
6922 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
6923 /* Be GC protected. Set keyhint to item instead of tem. */
6926 else if (EQ (tem
, QCkeys
))
6929 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
6930 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6932 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
6937 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6939 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6941 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
6948 else if (inmenubar
|| !NILP (start
))
6952 return 0; /* not a menu item */
6954 /* If item string is not a string, evaluate it to get string.
6955 If we don't get a string, skip this item. */
6956 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
6957 if (!(STRINGP (item_string
) || notreal
))
6959 item_string
= menu_item_eval_property (item_string
);
6960 if (!STRINGP (item_string
))
6962 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6965 /* If got a filter apply it on definition. */
6966 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6969 def
= menu_item_eval_property (list2 (XCAR (filter
),
6970 list2 (Qquote
, def
)));
6972 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
6975 /* Enable or disable selection of item. */
6976 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
6982 tem
= menu_item_eval_property (tem
);
6983 if (inmenubar
&& NILP (tem
))
6984 return 0; /* Ignore disabled items in menu bar. */
6985 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6988 /* If we got no definition, this item is just unselectable text which
6989 is OK in a submenu but not in the menubar. */
6991 return (inmenubar
? 0 : 1);
6993 /* See if this is a separate pane or a submenu. */
6994 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6995 tem
= get_keymap (def
, 0, 1);
6996 /* For a subkeymap, just record its details and exit. */
6999 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7000 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7004 /* At the top level in the menu bar, do likewise for commands also.
7005 The menu bar does not display equivalent key bindings anyway.
7006 ITEM_PROPERTY_DEF is already set up properly. */
7010 /* This is a command. See if there is an equivalent key binding. */
7011 if (NILP (cachelist
))
7013 /* We have to create a cachelist. */
7014 CHECK_IMPURE (start
);
7015 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7016 cachelist
= XCAR (XCDR (start
));
7018 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7019 if (!NILP (keyhint
))
7021 XSETCAR (cachelist
, XCAR (keyhint
));
7024 else if (STRINGP (tem
))
7026 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7027 XSETCAR (cachelist
, Qt
);
7031 tem
= XCAR (cachelist
);
7038 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7040 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7043 def
= XCAR (prefix
);
7044 prefix
= XCDR (prefix
);
7047 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7049 if (!update_menu_bindings
)
7051 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7053 if (newcache
/* Always check first time. */
7054 /* Should we check everything when precomputing key
7056 /* If something had no key binding before, don't recheck it
7057 because that is too slow--except if we have a list of
7058 rebound commands in Vdefine_key_rebound_commands, do
7059 recheck any command that appears in that list. */
7060 || (CONSP (Vdefine_key_rebound_commands
)
7061 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7064 /* We had a saved key. Is it still bound to the command? */
7067 /* If the command is an alias for another
7068 (such as lmenu.el set it up), check if the
7069 original command matches the cached command. */
7070 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7071 chkcache
= 1; /* Need to recompute key binding. */
7075 /* Recompute equivalent key binding. If the command is an alias
7076 for another (such as lmenu.el set it up), see if the original
7077 command name has equivalent keys. Otherwise look up the
7078 specified command itself. We don't try both, because that
7079 makes lmenu menus slow. */
7081 && SYMBOLP (XSYMBOL (def
)->function
)
7082 && ! NILP (Fget (def
, Qmenu_alias
)))
7083 def
= XSYMBOL (def
)->function
;
7084 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7085 XSETCAR (cachelist
, tem
);
7088 XSETCDR (cachelist
, Qnil
);
7092 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7094 tem
= XCAR (cachelist
);
7098 newcache
= chkcache
;
7101 tem
= Fkey_description (tem
);
7104 if (STRINGP (XCAR (prefix
)))
7105 tem
= concat2 (XCAR (prefix
), tem
);
7106 if (STRINGP (XCDR (prefix
)))
7107 tem
= concat2 (tem
, XCDR (prefix
));
7109 XSETCDR (cachelist
, tem
);
7113 tem
= XCDR (cachelist
);
7114 if (newcache
&& !NILP (tem
))
7116 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7117 XSETCDR (cachelist
, tem
);
7120 /* If we only want to precompute equivalent key bindings, stop here. */
7124 /* If we have an equivalent key binding, use that. */
7125 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7127 /* Include this when menu help is implemented.
7128 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7129 if (!(NILP (tem) || STRINGP (tem)))
7131 tem = menu_item_eval_property (tem);
7134 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7138 /* Handle radio buttons or toggle boxes. */
7139 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7141 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7142 = menu_item_eval_property (tem
);
7149 /***********************************************************************
7151 ***********************************************************************/
7153 /* A vector holding tool bar items while they are parsed in function
7154 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7157 static Lisp_Object tool_bar_items_vector
;
7159 /* A vector holding the result of parse_tool_bar_item. Layout is like
7160 the one for a single item in tool_bar_items_vector. */
7162 static Lisp_Object tool_bar_item_properties
;
7164 /* Next free index in tool_bar_items_vector. */
7166 static int ntool_bar_items
;
7168 /* The symbols `tool-bar', and `:image'. */
7170 extern Lisp_Object Qtool_bar
;
7171 Lisp_Object QCimage
;
7173 /* Function prototypes. */
7175 static void init_tool_bar_items
P_ ((Lisp_Object
));
7176 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7177 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7178 static void append_tool_bar_item
P_ ((void));
7181 /* Return a vector of tool bar items for keymaps currently in effect.
7182 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7183 tool bar items found. */
7186 tool_bar_items (reuse
, nitems
)
7197 /* In order to build the menus, we need to call the keymap
7198 accessors. They all call QUIT. But this function is called
7199 during redisplay, during which a quit is fatal. So inhibit
7200 quitting while building the menus. We do this instead of
7201 specbind because (1) errors will clear it anyway and (2) this
7202 avoids risk of specpdl overflow. */
7203 oquit
= Vinhibit_quit
;
7206 /* Initialize tool_bar_items_vector and protect it from GC. */
7207 init_tool_bar_items (reuse
);
7209 /* Build list of keymaps in maps. Set nmaps to the number of maps
7212 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7213 if (!NILP (Voverriding_local_map_menu_flag
))
7215 /* Yes, use them (if non-nil) as well as the global map. */
7216 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7218 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7219 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7220 if (!NILP (Voverriding_local_map
))
7221 maps
[nmaps
++] = Voverriding_local_map
;
7225 /* No, so use major and minor mode keymaps and keymap property.
7226 Note that tool-bar bindings in the local-map and keymap
7227 properties may not work reliable, as they are only
7228 recognized when the tool-bar (or mode-line) is updated,
7229 which does not normally happen after every command. */
7232 nminor
= current_minor_maps (NULL
, &tmaps
);
7233 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7235 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7236 maps
[nmaps
++] = tem
;
7237 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7239 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7242 /* Add global keymap at the end. */
7243 maps
[nmaps
++] = current_global_map
;
7245 /* Process maps in reverse order and look up in each map the prefix
7247 for (i
= nmaps
- 1; i
>= 0; --i
)
7248 if (!NILP (maps
[i
]))
7252 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7257 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7258 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7260 Lisp_Object keydef
= XCAR (tail
);
7262 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7267 Vinhibit_quit
= oquit
;
7268 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7269 return tool_bar_items_vector
;
7273 /* Process the definition of KEY which is DEF. */
7276 process_tool_bar_item (key
, def
)
7277 Lisp_Object key
, def
;
7280 extern Lisp_Object Qundefined
;
7281 struct gcpro gcpro1
, gcpro2
;
7283 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7287 if (EQ (def
, Qundefined
))
7289 /* If a map has an explicit `undefined' as definition,
7290 discard any previously made item. */
7291 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7293 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7295 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7297 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7298 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7299 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7300 * sizeof (Lisp_Object
)));
7301 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7306 else if (parse_tool_bar_item (key
, def
))
7307 /* Append a new tool bar item to tool_bar_items_vector. Accept
7308 more than one definition for the same key. */
7309 append_tool_bar_item ();
7315 /* Parse a tool bar item specification ITEM for key KEY and return the
7316 result in tool_bar_item_properties. Value is zero if ITEM is
7319 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7321 CAPTION is the caption of the item, If it's not a string, it is
7322 evaluated to get a string.
7324 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7325 as binding are currently ignored.
7327 The following properties are recognized:
7331 FORM is evaluated and specifies whether the tool bar item is
7332 enabled or disabled.
7336 FORM is evaluated and specifies whether the tool bar item is visible.
7338 - `:filter FUNCTION'
7340 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7341 result is stored as the new binding.
7343 - `:button (TYPE SELECTED)'
7345 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7346 and specifies whether the button is selected (pressed) or not.
7350 IMAGES is either a single image specification or a vector of four
7351 image specifications. See enum tool_bar_item_images.
7353 - `:help HELP-STRING'.
7355 Gives a help string to display for the tool bar item. */
7358 parse_tool_bar_item (key
, item
)
7359 Lisp_Object key
, item
;
7361 /* Access slot with index IDX of vector tool_bar_item_properties. */
7362 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7364 Lisp_Object filter
= Qnil
;
7365 Lisp_Object caption
;
7368 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7369 Rule out items that aren't lists, don't start with
7370 `menu-item' or whose rest following `tool-bar-item' is not a
7373 || !EQ (XCAR (item
), Qmenu_item
)
7374 || (item
= XCDR (item
),
7378 /* Create tool_bar_item_properties vector if necessary. Reset it to
7380 if (VECTORP (tool_bar_item_properties
))
7382 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7386 tool_bar_item_properties
7387 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7390 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7391 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7393 /* Get the caption of the item. If the caption is not a string,
7394 evaluate it to get a string. If we don't get a string, skip this
7396 caption
= XCAR (item
);
7397 if (!STRINGP (caption
))
7399 caption
= menu_item_eval_property (caption
);
7400 if (!STRINGP (caption
))
7403 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7405 /* Give up if rest following the caption is not a list. */
7410 /* Store the binding. */
7411 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7414 /* Ignore cached key binding, if any. */
7415 if (CONSP (item
) && CONSP (XCAR (item
)))
7418 /* Process the rest of the properties. */
7419 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7421 Lisp_Object key
, value
;
7424 value
= XCAR (XCDR (item
));
7426 if (EQ (key
, QCenable
))
7427 /* `:enable FORM'. */
7428 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7429 else if (EQ (key
, QCvisible
))
7431 /* `:visible FORM'. If got a visible property and that
7432 evaluates to nil then ignore this item. */
7433 if (NILP (menu_item_eval_property (value
)))
7436 else if (EQ (key
, QChelp
))
7437 /* `:help HELP-STRING'. */
7438 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7439 else if (EQ (key
, QCfilter
))
7440 /* ':filter FORM'. */
7442 else if (EQ (key
, QCbutton
) && CONSP (value
))
7444 /* `:button (TYPE . SELECTED)'. */
7445 Lisp_Object type
, selected
;
7447 type
= XCAR (value
);
7448 selected
= XCDR (value
);
7449 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7451 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7452 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7455 else if (EQ (key
, QCimage
)
7457 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7458 /* Value is either a single image specification or a vector
7459 of 4 such specifications for the different button states. */
7460 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7463 /* If got a filter apply it on binding. */
7465 PROP (TOOL_BAR_ITEM_BINDING
)
7466 = menu_item_eval_property (list2 (filter
,
7468 PROP (TOOL_BAR_ITEM_BINDING
))));
7470 /* See if the binding is a keymap. Give up if it is. */
7471 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7474 /* Enable or disable selection of item. */
7475 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7476 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7477 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7479 /* Handle radio buttons or toggle boxes. */
7480 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7481 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7482 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7490 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7491 that can be reused. */
7494 init_tool_bar_items (reuse
)
7497 if (VECTORP (reuse
))
7498 tool_bar_items_vector
= reuse
;
7500 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7501 ntool_bar_items
= 0;
7505 /* Append parsed tool bar item properties from
7506 tool_bar_item_properties */
7509 append_tool_bar_item ()
7511 Lisp_Object
*to
, *from
;
7513 /* Enlarge tool_bar_items_vector if necessary. */
7514 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7515 >= XVECTOR (tool_bar_items_vector
)->size
)
7517 Lisp_Object new_vector
;
7518 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7520 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7521 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7522 XVECTOR (new_vector
)->contents
,
7523 old_size
* sizeof (Lisp_Object
));
7524 tool_bar_items_vector
= new_vector
;
7527 /* Append entries from tool_bar_item_properties to the end of
7528 tool_bar_items_vector. */
7529 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7530 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7531 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7532 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7539 /* Read a character using menus based on maps in the array MAPS.
7540 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7541 Return t if we displayed a menu but the user rejected it.
7543 PREV_EVENT is the previous input event, or nil if we are reading
7544 the first event of a key sequence.
7546 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7547 if we used a mouse menu to read the input, or zero otherwise. If
7548 USED_MOUSE_MENU is null, we don't dereference it.
7550 The prompting is done based on the prompt-string of the map
7551 and the strings associated with various map elements.
7553 This can be done with X menus or with menus put in the minibuf.
7554 These are done in different ways, depending on how the input will be read.
7555 Menus using X are done after auto-saving in read-char, getting the input
7556 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7557 and do auto-saving in the inner call of read_char. */
7560 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7563 Lisp_Object prev_event
;
7564 int *used_mouse_menu
;
7567 register Lisp_Object name
;
7569 if (used_mouse_menu
)
7570 *used_mouse_menu
= 0;
7572 /* Use local over global Menu maps */
7574 if (! menu_prompting
)
7577 /* Optionally disregard all but the global map. */
7578 if (inhibit_local_menu_bar_menus
)
7580 maps
+= (nmaps
- 1);
7584 /* Get the menu name from the first map that has one (a prompt string). */
7585 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7587 name
= Fkeymap_prompt (maps
[mapno
]);
7592 /* If we don't have any menus, just read a character normally. */
7593 if (!STRINGP (name
))
7597 /* If we got to this point via a mouse click,
7598 use a real menu for mouse selection. */
7599 if (EVENT_HAS_PARAMETERS (prev_event
)
7600 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7601 && !EQ (XCAR (prev_event
), Qtool_bar
))
7603 /* Display the menu and get the selection. */
7604 Lisp_Object
*realmaps
7605 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7609 /* Use the maps that are not nil. */
7610 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7611 if (!NILP (maps
[mapno
]))
7612 realmaps
[nmaps1
++] = maps
[mapno
];
7614 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7619 record_menu_key (XCAR (value
));
7621 /* If we got multiple events, unread all but
7623 There is no way to prevent those unread events
7624 from showing up later in last_nonmenu_event.
7625 So turn symbol and integer events into lists,
7626 to indicate that they came from a mouse menu,
7627 so that when present in last_nonmenu_event
7628 they won't confuse things. */
7629 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7631 record_menu_key (XCAR (tem
));
7632 if (SYMBOLP (XCAR (tem
))
7633 || INTEGERP (XCAR (tem
)))
7634 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7637 /* If we got more than one event, put all but the first
7638 onto this list to be read later.
7639 Return just the first event now. */
7640 Vunread_command_events
7641 = nconc2 (XCDR (value
), Vunread_command_events
);
7642 value
= XCAR (value
);
7644 else if (NILP (value
))
7646 if (used_mouse_menu
)
7647 *used_mouse_menu
= 1;
7650 #endif /* HAVE_MENUS */
7654 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7655 We make this bigger when necessary, and never free it. */
7656 static char *read_char_minibuf_menu_text
;
7657 /* Size of that buffer. */
7658 static int read_char_minibuf_menu_width
;
7661 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7667 register Lisp_Object name
;
7669 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7672 Lisp_Object rest
, vector
;
7678 if (! menu_prompting
)
7681 /* Make sure we have a big enough buffer for the menu text. */
7682 if (read_char_minibuf_menu_text
== 0)
7684 read_char_minibuf_menu_width
= width
+ 4;
7685 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7687 else if (width
+ 4 > read_char_minibuf_menu_width
)
7689 read_char_minibuf_menu_width
= width
+ 4;
7690 read_char_minibuf_menu_text
7691 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7693 menu
= read_char_minibuf_menu_text
;
7695 /* Get the menu name from the first map that has one (a prompt string). */
7696 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7698 name
= Fkeymap_prompt (maps
[mapno
]);
7703 /* If we don't have any menus, just read a character normally. */
7704 if (!STRINGP (name
))
7707 /* Prompt string always starts with map's prompt, and a space. */
7708 strcpy (menu
, XSTRING (name
)->data
);
7709 nlength
= STRING_BYTES (XSTRING (name
));
7710 menu
[nlength
++] = ':';
7711 menu
[nlength
++] = ' ';
7714 /* Start prompting at start of first map. */
7718 /* Present the documented bindings, a line at a time. */
7725 Lisp_Object orig_defn_macro
;
7727 /* Loop over elements of map. */
7732 /* If reached end of map, start at beginning of next map. */
7736 /* At end of last map, wrap around to first map if just starting,
7737 or end this line if already have something on it. */
7741 if (notfirst
|| nobindings
) break;
7746 /* Look at the next element of the map. */
7748 elt
= XVECTOR (vector
)->contents
[idx
];
7750 elt
= Fcar_safe (rest
);
7752 if (idx
< 0 && VECTORP (elt
))
7754 /* If we found a dense table in the keymap,
7755 advanced past it, but start scanning its contents. */
7756 rest
= Fcdr_safe (rest
);
7762 /* An ordinary element. */
7763 Lisp_Object event
, tem
;
7767 event
= Fcar_safe (elt
); /* alist */
7768 elt
= Fcdr_safe (elt
);
7772 XSETINT (event
, idx
); /* vector */
7775 /* Ignore the element if it has no prompt string. */
7776 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7778 /* 1 if the char to type matches the string. */
7780 Lisp_Object upcased_event
, downcased_event
;
7781 Lisp_Object desc
= Qnil
;
7783 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7785 upcased_event
= Fupcase (event
);
7786 downcased_event
= Fdowncase (event
);
7787 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
7788 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
7790 desc
= Fsingle_key_description (event
, Qnil
);
7792 #if 0 /* It is redundant to list the equivalent key bindings because
7793 the prefix is what the user has already typed. */
7795 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7797 /* Insert equivalent keybinding. */
7798 s
= concat2 (s
, tem
);
7801 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7802 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7804 /* Insert button prefix. */
7805 Lisp_Object selected
7806 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7807 if (EQ (tem
, QCradio
))
7808 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7810 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7811 s
= concat2 (tem
, s
);
7815 /* If we have room for the prompt string, add it to this line.
7816 If this is the first on the line, always add it. */
7817 if ((XSTRING (s
)->size
+ i
+ 2
7818 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
7824 /* Punctuate between strings. */
7827 strcpy (menu
+ i
, ", ");
7833 /* If the char to type doesn't match the string's
7834 first char, explicitly show what char to type. */
7837 /* Add as much of string as fits. */
7838 thiswidth
= XSTRING (desc
)->size
;
7839 if (thiswidth
+ i
> width
)
7840 thiswidth
= width
- i
;
7841 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
7843 strcpy (menu
+ i
, " = ");
7847 /* Add as much of string as fits. */
7848 thiswidth
= XSTRING (s
)->size
;
7849 if (thiswidth
+ i
> width
)
7850 thiswidth
= width
- i
;
7851 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
7857 /* If this element does not fit, end the line now,
7858 and save the element for the next line. */
7859 strcpy (menu
+ i
, "...");
7864 /* Move past this element. */
7865 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7866 /* Handle reaching end of dense table. */
7871 rest
= Fcdr_safe (rest
);
7875 /* Prompt with that and read response. */
7876 message2_nolog (menu
, strlen (menu
),
7877 ! NILP (current_buffer
->enable_multibyte_characters
));
7879 /* Make believe its not a keyboard macro in case the help char
7880 is pressed. Help characters are not recorded because menu prompting
7881 is not used on replay.
7883 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7884 current_kboard
->defining_kbd_macro
= Qnil
;
7886 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
7887 while (BUFFERP (obj
));
7888 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7890 if (!INTEGERP (obj
))
7895 if (! EQ (obj
, menu_prompt_more_char
)
7896 && (!INTEGERP (menu_prompt_more_char
)
7897 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
7899 if (!NILP (current_kboard
->defining_kbd_macro
))
7900 store_kbd_macro_char (obj
);
7903 /* Help char - go round again */
7907 /* Reading key sequences. */
7909 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7910 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7911 keymap, or nil otherwise. Return the index of the first keymap in
7912 which KEY has any binding, or NMAPS if no map has a binding.
7914 If KEY is a meta ASCII character, treat it like meta-prefix-char
7915 followed by the corresponding non-meta character. Keymaps in
7916 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7919 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7922 NEXT may be the same array as CURRENT. */
7925 follow_key (key
, nmaps
, current
, defs
, next
)
7927 Lisp_Object
*current
, *defs
, *next
;
7930 int i
, first_binding
;
7933 first_binding
= nmaps
;
7934 for (i
= nmaps
- 1; i
>= 0; i
--)
7936 if (! NILP (current
[i
]))
7944 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
7945 if (! NILP (defs
[i
]))
7952 /* Given the set of bindings we've found, produce the next set of maps. */
7953 if (first_binding
< nmaps
)
7954 for (i
= 0; i
< nmaps
; i
++)
7955 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
7957 return first_binding
;
7960 /* Read a sequence of keys that ends with a non prefix character,
7961 storing it in KEYBUF, a buffer of size BUFSIZE.
7963 Return the length of the key sequence stored.
7964 Return -1 if the user rejected a command menu.
7966 Echo starting immediately unless `prompt' is 0.
7968 Where a key sequence ends depends on the currently active keymaps.
7969 These include any minor mode keymaps active in the current buffer,
7970 the current buffer's local map, and the global map.
7972 If a key sequence has no other bindings, we check Vfunction_key_map
7973 to see if some trailing subsequence might be the beginning of a
7974 function key's sequence. If so, we try to read the whole function
7975 key, and substitute its symbolic name into the key sequence.
7977 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7978 `double-' events into similar click events, if that would make them
7979 bound. We try to turn `triple-' events first into `double-' events,
7982 If we get a mouse click in a mode line, vertical divider, or other
7983 non-text area, we treat the click as if it were prefixed by the
7984 symbol denoting that area - `mode-line', `vertical-line', or
7987 If the sequence starts with a mouse click, we read the key sequence
7988 with respect to the buffer clicked on, not the current buffer.
7990 If the user switches frames in the midst of a key sequence, we put
7991 off the switch-frame event until later; the next call to
7992 read_char will return it.
7994 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
7995 from the selected window's buffer. */
7998 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
7999 can_return_switch_frame
, fix_current_buffer
)
8000 Lisp_Object
*keybuf
;
8003 int dont_downcase_last
;
8004 int can_return_switch_frame
;
8005 int fix_current_buffer
;
8007 volatile Lisp_Object from_string
;
8008 volatile int count
= specpdl_ptr
- specpdl
;
8010 /* How many keys there are in the current key sequence. */
8013 /* The length of the echo buffer when we started reading, and
8014 the length of this_command_keys when we started reading. */
8015 volatile int echo_start
;
8016 volatile int keys_start
;
8018 /* The number of keymaps we're scanning right now, and the number of
8019 keymaps we have allocated space for. */
8021 volatile int nmaps_allocated
= 0;
8023 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8024 the current keymaps. */
8025 Lisp_Object
*volatile defs
= NULL
;
8027 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8028 in the current keymaps, or nil where it is not a prefix. */
8029 Lisp_Object
*volatile submaps
= NULL
;
8031 /* The local map to start out with at start of key sequence. */
8032 volatile Lisp_Object orig_local_map
;
8034 /* The map from the `keymap' property to start out with at start of
8036 volatile Lisp_Object orig_keymap
;
8038 /* 1 if we have already considered switching to the local-map property
8039 of the place where a mouse click occurred. */
8040 volatile int localized_local_map
= 0;
8042 /* The index in defs[] of the first keymap that has a binding for
8043 this key sequence. In other words, the lowest i such that
8044 defs[i] is non-nil. */
8045 volatile int first_binding
;
8046 /* Index of the first key that has no binding.
8047 It is useless to try fkey_start larger than that. */
8048 volatile int first_unbound
;
8050 /* If t < mock_input, then KEYBUF[t] should be read as the next
8053 We use this to recover after recognizing a function key. Once we
8054 realize that a suffix of the current key sequence is actually a
8055 function key's escape sequence, we replace the suffix with the
8056 function key's binding from Vfunction_key_map. Now keybuf
8057 contains a new and different key sequence, so the echo area,
8058 this_command_keys, and the submaps and defs arrays are wrong. In
8059 this situation, we set mock_input to t, set t to 0, and jump to
8060 restart_sequence; the loop will read keys from keybuf up until
8061 mock_input, thus rebuilding the state; and then it will resume
8062 reading characters from the keyboard. */
8063 volatile int mock_input
= 0;
8065 /* If the sequence is unbound in submaps[], then
8066 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
8067 and fkey_map is its binding.
8069 These might be > t, indicating that all function key scanning
8070 should hold off until t reaches them. We do this when we've just
8071 recognized a function key, to avoid searching for the function
8072 key's again in Vfunction_key_map. */
8073 volatile int fkey_start
= 0, fkey_end
= 0;
8074 volatile Lisp_Object fkey_map
;
8076 /* Likewise, for key_translation_map. */
8077 volatile int keytran_start
= 0, keytran_end
= 0;
8078 volatile Lisp_Object keytran_map
;
8080 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8081 we put it off for later. While we're reading, we keep the event here. */
8082 volatile Lisp_Object delayed_switch_frame
;
8084 /* See the comment below... */
8085 #if defined (GOBBLE_FIRST_EVENT)
8086 Lisp_Object first_event
;
8089 volatile Lisp_Object original_uppercase
;
8090 volatile int original_uppercase_position
= -1;
8092 /* Gets around Microsoft compiler limitations. */
8095 struct buffer
*starting_buffer
;
8097 /* List of events for which a fake prefix key has been generated. */
8098 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8100 #if defined (GOBBLE_FIRST_EVENT)
8104 struct gcpro gcpro1
;
8106 GCPRO1 (fake_prefixed_keys
);
8107 raw_keybuf_count
= 0;
8109 last_nonmenu_event
= Qnil
;
8111 delayed_switch_frame
= Qnil
;
8112 fkey_map
= Vfunction_key_map
;
8113 keytran_map
= Vkey_translation_map
;
8115 /* If there is no function-key-map, turn off function key scanning. */
8116 if (!KEYMAPP (Vfunction_key_map
))
8117 fkey_start
= fkey_end
= bufsize
+ 1;
8119 /* If there is no key-translation-map, turn off scanning. */
8120 if (!KEYMAPP (Vkey_translation_map
))
8121 keytran_start
= keytran_end
= bufsize
+ 1;
8126 echo_prompt (prompt
);
8127 else if (cursor_in_echo_area
8128 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8129 && NILP (Fzerop (Vecho_keystrokes
)))
8130 /* This doesn't put in a dash if the echo buffer is empty, so
8131 you don't always see a dash hanging out in the minibuffer. */
8135 /* Record the initial state of the echo area and this_command_keys;
8136 we will need to restore them if we replay a key sequence. */
8138 echo_start
= echo_length ();
8139 keys_start
= this_command_key_count
;
8140 this_single_command_key_start
= keys_start
;
8142 #if defined (GOBBLE_FIRST_EVENT)
8143 /* This doesn't quite work, because some of the things that read_char
8144 does cannot safely be bypassed. It seems too risky to try to make
8147 /* Read the first char of the sequence specially, before setting
8148 up any keymaps, in case a filter runs and switches buffers on us. */
8149 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8151 #endif /* GOBBLE_FIRST_EVENT */
8153 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8154 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8157 /* We jump here when the key sequence has been thoroughly changed, and
8158 we need to rescan it starting from the beginning. When we jump here,
8159 keybuf[0..mock_input] holds the sequence we should reread. */
8162 starting_buffer
= current_buffer
;
8163 first_unbound
= bufsize
+ 1;
8165 /* Build our list of keymaps.
8166 If we recognize a function key and replace its escape sequence in
8167 keybuf with its symbol, or if the sequence starts with a mouse
8168 click and we need to switch buffers, we jump back here to rebuild
8169 the initial keymaps from the current buffer. */
8172 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8173 || !NILP (Voverriding_local_map
))
8175 if (3 > nmaps_allocated
)
8177 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8178 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8179 nmaps_allocated
= 3;
8181 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8182 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8183 if (!NILP (Voverriding_local_map
))
8184 submaps
[nmaps
++] = Voverriding_local_map
;
8192 nminor
= current_minor_maps (0, &maps
);
8193 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8195 if (total
> nmaps_allocated
)
8197 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8198 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8199 nmaps_allocated
= total
;
8202 if (!NILP (orig_keymap
))
8203 submaps
[nmaps
++] = orig_keymap
;
8205 bcopy (maps
, (void *) (submaps
+ nmaps
),
8206 nminor
* sizeof (submaps
[0]));
8210 submaps
[nmaps
++] = orig_local_map
;
8212 submaps
[nmaps
++] = current_global_map
;
8214 /* Find an accurate initial value for first_binding. */
8215 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8216 if (! NILP (submaps
[first_binding
]))
8219 /* Start from the beginning in keybuf. */
8222 /* These are no-ops the first time through, but if we restart, they
8223 revert the echo area and this_command_keys to their original state. */
8224 this_command_key_count
= keys_start
;
8225 if (INTERACTIVE
&& t
< mock_input
)
8226 echo_truncate (echo_start
);
8228 /* If the best binding for the current key sequence is a keymap, or
8229 we may be looking at a function key's escape sequence, keep on
8231 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
8232 || (first_binding
>= nmaps
&& fkey_start
< t
)
8233 || (first_binding
>= nmaps
&& keytran_start
< t
)
8234 /* Don't return in the middle of a possible function key sequence,
8235 if the only bindings we found were via case conversion.
8236 Thus, if ESC O a has a function-key-map translation
8237 and ESC o has a binding, don't return after ESC O,
8238 so that we can translate ESC O plus the next character. */
8242 int used_mouse_menu
= 0;
8244 /* Where the last real key started. If we need to throw away a
8245 key that has expanded into more than one element of keybuf
8246 (say, a mouse click on the mode line which is being treated
8247 as [mode-line (mouse-...)], then we backtrack to this point
8249 volatile int last_real_key_start
;
8251 /* These variables are analogous to echo_start and keys_start;
8252 while those allow us to restart the entire key sequence,
8253 echo_local_start and keys_local_start allow us to throw away
8255 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8257 /* key-translation-map is applied *after* function-key-map. */
8258 eassert (keytran_end
<= fkey_start
);
8260 if (first_unbound
< fkey_start
&& first_unbound
< keytran_start
)
8261 { /* The prefix upto first_unbound has no binding and has
8262 no translation left to do either, so we know it's unbound.
8263 If we don't stop now, we risk staying here indefinitely
8264 (if the user keeps entering fkey or keytran prefixes
8265 like C-c ESC ESC ESC ESC ...) */
8267 for (i
= first_unbound
+ 1; i
< t
; i
++)
8268 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8269 mock_input
= t
- first_unbound
- 1;
8270 fkey_end
= fkey_start
-= first_unbound
+ 1;
8271 fkey_map
= Vfunction_key_map
;
8272 keytran_end
= keytran_start
-= first_unbound
+ 1;
8273 keytran_map
= Vkey_translation_map
;
8274 goto replay_sequence
;
8278 error ("Key sequence too long");
8281 echo_local_start
= echo_length ();
8282 keys_local_start
= this_command_key_count
;
8283 local_first_binding
= first_binding
;
8286 /* These are no-ops, unless we throw away a keystroke below and
8287 jumped back up to replay_key; in that case, these restore the
8288 variables to their original state, allowing us to replay the
8290 if (INTERACTIVE
&& t
< mock_input
)
8291 echo_truncate (echo_local_start
);
8292 this_command_key_count
= keys_local_start
;
8293 first_binding
= local_first_binding
;
8295 /* By default, assume each event is "real". */
8296 last_real_key_start
= t
;
8298 /* Does mock_input indicate that we are re-reading a key sequence? */
8302 add_command_key (key
);
8303 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8304 && NILP (Fzerop (Vecho_keystrokes
)))
8308 /* If not, we should actually read a character. */
8313 KBOARD
*interrupted_kboard
= current_kboard
;
8314 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8315 if (setjmp (wrong_kboard_jmpbuf
))
8317 if (!NILP (delayed_switch_frame
))
8319 interrupted_kboard
->kbd_queue
8320 = Fcons (delayed_switch_frame
,
8321 interrupted_kboard
->kbd_queue
);
8322 delayed_switch_frame
= Qnil
;
8325 interrupted_kboard
->kbd_queue
8326 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8328 /* If the side queue is non-empty, ensure it begins with a
8329 switch-frame, so we'll replay it in the right context. */
8330 if (CONSP (interrupted_kboard
->kbd_queue
)
8331 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8332 !(EVENT_HAS_PARAMETERS (key
)
8333 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8337 XSETFRAME (frame
, interrupted_frame
);
8338 interrupted_kboard
->kbd_queue
8339 = Fcons (make_lispy_switch_frame (frame
),
8340 interrupted_kboard
->kbd_queue
);
8343 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8344 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8345 goto replay_sequence
;
8348 key
= read_char (NILP (prompt
), nmaps
,
8349 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8353 /* read_char returns t when it shows a menu and the user rejects it.
8357 unbind_to (count
, Qnil
);
8362 /* read_char returns -1 at the end of a macro.
8363 Emacs 18 handles this by returning immediately with a
8364 zero, so that's what we'll do. */
8365 if (INTEGERP (key
) && XINT (key
) == -1)
8368 /* The Microsoft C compiler can't handle the goto that
8374 /* If the current buffer has been changed from under us, the
8375 keymap may have changed, so replay the sequence. */
8378 EMACS_TIME initial_idleness_start_time
;
8379 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8380 EMACS_SECS (timer_last_idleness_start_time
),
8381 EMACS_USECS (timer_last_idleness_start_time
));
8383 /* Resume idle state, using the same start-time as before. */
8384 timer_start_idle ();
8385 timer_idleness_start_time
= initial_idleness_start_time
;
8388 /* Reset the current buffer from the selected window
8389 in case something changed the former and not the latter.
8390 This is to be more consistent with the behavior
8391 of the command_loop_1. */
8392 if (fix_current_buffer
)
8394 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8396 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8397 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8400 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8401 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8402 goto replay_sequence
;
8405 /* If we have a quit that was typed in another frame, and
8406 quit_throw_to_read_char switched buffers,
8407 replay to get the right keymap. */
8409 && XINT (key
) == quit_char
8410 && current_buffer
!= starting_buffer
)
8413 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8417 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8418 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8419 goto replay_sequence
;
8424 if (EVENT_HAS_PARAMETERS (key
)
8425 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8427 /* If we're at the beginning of a key sequence, and the caller
8428 says it's okay, go ahead and return this event. If we're
8429 in the midst of a key sequence, delay it until the end. */
8430 if (t
> 0 || !can_return_switch_frame
)
8432 delayed_switch_frame
= key
;
8438 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8441 /* Clicks in non-text areas get prefixed by the symbol
8442 in their CHAR-ADDRESS field. For example, a click on
8443 the mode line is prefixed by the symbol `mode-line'.
8445 Furthermore, key sequences beginning with mouse clicks
8446 are read using the keymaps of the buffer clicked on, not
8447 the current buffer. So we may have to switch the buffer
8450 When we turn one event into two events, we must make sure
8451 that neither of the two looks like the original--so that,
8452 if we replay the events, they won't be expanded again.
8453 If not for this, such reexpansion could happen either here
8454 or when user programs play with this-command-keys. */
8455 if (EVENT_HAS_PARAMETERS (key
))
8459 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8460 if (EQ (kind
, Qmouse_click
))
8462 Lisp_Object window
, posn
;
8464 window
= POSN_WINDOW (EVENT_START (key
));
8465 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8468 || (!NILP (fake_prefixed_keys
)
8469 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8471 /* We're looking a second time at an event for which
8472 we generated a fake prefix key. Set
8473 last_real_key_start appropriately. */
8475 last_real_key_start
= t
- 1;
8478 /* Key sequences beginning with mouse clicks are
8479 read using the keymaps in the buffer clicked on,
8480 not the current buffer. If we're at the
8481 beginning of a key sequence, switch buffers. */
8482 if (last_real_key_start
== 0
8484 && BUFFERP (XWINDOW (window
)->buffer
)
8485 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8487 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8491 /* Arrange to go back to the original buffer once we're
8492 done reading the key sequence. Note that we can't
8493 use save_excursion_{save,restore} here, because they
8494 save point as well as the current buffer; we don't
8495 want to save point, because redisplay may change it,
8496 to accommodate a Fset_window_start or something. We
8497 don't want to do this at the top of the function,
8498 because we may get input from a subprocess which
8499 wants to change the selected window and stuff (say,
8501 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8503 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8505 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8506 orig_local_map
= get_local_map (PT
, current_buffer
,
8508 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8509 goto replay_sequence
;
8512 /* For a mouse click, get the local text-property keymap
8513 of the place clicked on, rather than point. */
8514 if (last_real_key_start
== 0
8515 && CONSP (XCDR (key
))
8516 && ! localized_local_map
)
8518 Lisp_Object map_here
, start
, pos
;
8520 localized_local_map
= 1;
8521 start
= EVENT_START (key
);
8523 if (CONSP (start
) && CONSP (XCDR (start
)))
8525 pos
= POSN_BUFFER_POSN (start
);
8527 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8529 map_here
= get_local_map (XINT (pos
),
8530 current_buffer
, Qlocal_map
);
8531 if (!EQ (map_here
, orig_local_map
))
8533 orig_local_map
= map_here
;
8537 goto replay_sequence
;
8539 map_here
= get_local_map (XINT (pos
),
8540 current_buffer
, Qkeymap
);
8541 if (!EQ (map_here
, orig_keymap
))
8543 orig_keymap
= map_here
;
8547 goto replay_sequence
;
8553 /* Expand mode-line and scroll-bar events into two events:
8554 use posn as a fake prefix key. */
8556 && (NILP (fake_prefixed_keys
)
8557 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8559 if (t
+ 1 >= bufsize
)
8560 error ("Key sequence too long");
8563 keybuf
[t
+ 1] = key
;
8566 /* Record that a fake prefix key has been generated
8567 for KEY. Don't modify the event; this would
8568 prevent proper action when the event is pushed
8569 back tino unread-command-events. */
8570 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8572 /* If on a mode line string with a local keymap,
8573 reconsider the key sequence with that keymap. */
8574 if (CONSP (POSN_STRING (EVENT_START (key
))))
8576 Lisp_Object string
, pos
, map
, map2
;
8578 string
= POSN_STRING (EVENT_START (key
));
8579 pos
= XCDR (string
);
8580 string
= XCAR (string
);
8582 && XINT (pos
) < XSTRING (string
)->size
)
8584 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8586 orig_local_map
= map
;
8587 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8590 if (!NILP (map
) || !NILP (map2
))
8591 goto replay_sequence
;
8597 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8598 && NILP (from_string
))
8600 /* For a click on a string, i.e. overlay string or a
8601 string displayed via the `display' property,
8602 consider `local-map' and `keymap' properties of
8604 Lisp_Object string
, pos
, map
, map2
;
8606 string
= POSN_STRING (EVENT_START (key
));
8607 pos
= XCDR (string
);
8608 string
= XCAR (string
);
8610 && XINT (pos
) < XSTRING (string
)->size
)
8612 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8614 orig_local_map
= map
;
8615 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8619 if (!NILP (map
) || !NILP (map2
))
8621 from_string
= string
;
8622 goto replay_sequence
;
8627 else if (CONSP (XCDR (key
))
8628 && CONSP (EVENT_START (key
))
8629 && CONSP (XCDR (EVENT_START (key
))))
8633 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8634 /* Handle menu-bar events:
8635 insert the dummy prefix event `menu-bar'. */
8636 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8638 if (t
+ 1 >= bufsize
)
8639 error ("Key sequence too long");
8643 /* Zap the position in key, so we know that we've
8644 expanded it, and don't try to do so again. */
8645 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8646 Fcons (posn
, Qnil
));
8649 goto replay_sequence
;
8651 else if (CONSP (posn
))
8653 /* We're looking at the second event of a
8654 sequence which we expanded before. Set
8655 last_real_key_start appropriately. */
8656 if (last_real_key_start
== t
&& t
> 0)
8657 last_real_key_start
= t
- 1;
8662 /* We have finally decided that KEY is something we might want
8664 first_binding
= (follow_key (key
,
8665 nmaps
- first_binding
,
8666 submaps
+ first_binding
,
8667 defs
+ first_binding
,
8668 submaps
+ first_binding
)
8671 /* If KEY wasn't bound, we'll try some fallbacks. */
8672 if (first_binding
< nmaps
)
8673 /* This is needed for the following scenario:
8674 event 0: a down-event that gets dropped by calling replay_key.
8675 event 1: some normal prefix like C-h.
8676 After event 0, first_unbound is 0, after event 1 fkey_start
8677 and keytran_start are both 1, so when we see that C-h is bound,
8678 we need to update first_unbound. */
8679 first_unbound
= max (t
+ 1, first_unbound
);
8684 /* Remember the position to put an upper bound on fkey_start. */
8685 first_unbound
= min (t
, first_unbound
);
8687 head
= EVENT_HEAD (key
);
8688 if (help_char_p (head
) && t
> 0)
8690 read_key_sequence_cmd
= Vprefix_help_command
;
8692 last_nonmenu_event
= key
;
8693 /* The Microsoft C compiler can't handle the goto that
8701 Lisp_Object breakdown
;
8704 breakdown
= parse_modifiers (head
);
8705 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8706 /* Attempt to reduce an unbound mouse event to a simpler
8707 event that is bound:
8708 Drags reduce to clicks.
8709 Double-clicks reduce to clicks.
8710 Triple-clicks reduce to double-clicks, then to clicks.
8711 Down-clicks are eliminated.
8712 Double-downs reduce to downs, then are eliminated.
8713 Triple-downs reduce to double-downs, then to downs,
8714 then are eliminated. */
8715 if (modifiers
& (down_modifier
| drag_modifier
8716 | double_modifier
| triple_modifier
))
8718 while (modifiers
& (down_modifier
| drag_modifier
8719 | double_modifier
| triple_modifier
))
8721 Lisp_Object new_head
, new_click
;
8722 if (modifiers
& triple_modifier
)
8723 modifiers
^= (double_modifier
| triple_modifier
);
8724 else if (modifiers
& double_modifier
)
8725 modifiers
&= ~double_modifier
;
8726 else if (modifiers
& drag_modifier
)
8727 modifiers
&= ~drag_modifier
;
8730 /* Dispose of this `down' event by simply jumping
8731 back to replay_key, to get another event.
8733 Note that if this event came from mock input,
8734 then just jumping back to replay_key will just
8735 hand it to us again. So we have to wipe out any
8738 We could delete keybuf[t] and shift everything
8739 after that to the left by one spot, but we'd also
8740 have to fix up any variable that points into
8741 keybuf, and shifting isn't really necessary
8744 Adding prefixes for non-textual mouse clicks
8745 creates two characters of mock input, and both
8746 must be thrown away. If we're only looking at
8747 the prefix now, we can just jump back to
8748 replay_key. On the other hand, if we've already
8749 processed the prefix, and now the actual click
8750 itself is giving us trouble, then we've lost the
8751 state of the keymaps we want to backtrack to, and
8752 we need to replay the whole sequence to rebuild
8755 Beyond that, only function key expansion could
8756 create more than two keys, but that should never
8757 generate mouse events, so it's okay to zero
8758 mock_input in that case too.
8760 FIXME: The above paragraph seems just plain
8761 wrong, if you consider things like
8762 xterm-mouse-mode. -stef
8764 Isn't this just the most wonderful code ever? */
8765 if (t
== last_real_key_start
)
8772 mock_input
= last_real_key_start
;
8773 goto replay_sequence
;
8778 = apply_modifiers (modifiers
, XCAR (breakdown
));
8780 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8782 /* Look for a binding for this new key. follow_key
8783 promises that it didn't munge submaps the
8784 last time we called it, since key was unbound. */
8786 = (follow_key (new_click
,
8787 nmaps
- local_first_binding
,
8788 submaps
+ local_first_binding
,
8789 defs
+ local_first_binding
,
8790 submaps
+ local_first_binding
)
8791 + local_first_binding
);
8793 /* If that click is bound, go for it. */
8794 if (first_binding
< nmaps
)
8799 /* Otherwise, we'll leave key set to the drag event. */
8806 /* Normally, last_nonmenu_event gets the previous key we read.
8807 But when a mouse popup menu is being used,
8808 we don't update last_nonmenu_event; it continues to hold the mouse
8809 event that preceded the first level of menu. */
8810 if (!used_mouse_menu
)
8811 last_nonmenu_event
= key
;
8813 /* Record what part of this_command_keys is the current key sequence. */
8814 this_single_command_key_start
= this_command_key_count
- t
;
8816 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
8817 /* There is a binding and it's not a prefix.
8818 There is thus no function-key in this sequence.
8819 Moving fkey.start is important in this case to allow keytran.start
8820 to go over the sequence before we return (since we keep the
8821 invariant that keytran.end <= fkey.start). */
8824 (fkey_start
= fkey_end
= t
, fkey_map
= Vfunction_key_map
);
8827 /* If the sequence is unbound, see if we can hang a function key
8828 off the end of it. */
8830 Lisp_Object fkey_next
;
8832 /* Continue scan from fkey_end until we find a bound suffix.
8833 If we fail, increment fkey_start and start over from there. */
8834 while (fkey_end
< t
)
8838 key
= keybuf
[fkey_end
++];
8839 fkey_next
= access_keymap (fkey_map
, key
, 1, 0, 1);
8841 /* Handle symbol with autoload definition. */
8842 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8843 && CONSP (XSYMBOL (fkey_next
)->function
)
8844 && EQ (XCAR (XSYMBOL (fkey_next
)->function
), Qautoload
))
8845 do_autoload (XSYMBOL (fkey_next
)->function
,
8848 /* Handle a symbol whose function definition is a keymap
8850 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8851 && (!NILP (Farrayp (XSYMBOL (fkey_next
)->function
))
8852 || KEYMAPP (XSYMBOL (fkey_next
)->function
)))
8853 fkey_next
= XSYMBOL (fkey_next
)->function
;
8855 #if 0 /* I didn't turn this on, because it might cause trouble
8856 for the mapping of return into C-m and tab into C-i. */
8857 /* Optionally don't map function keys into other things.
8858 This enables the user to redefine kp- keys easily. */
8859 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8863 /* If the function key map gives a function, not an
8864 array, then call the function with no args and use
8865 its value instead. */
8866 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8867 /* If there's a binding (i.e. first_binding >= nmaps)
8868 we don't want to apply this function-key-mapping. */
8869 && fkey_end
== t
&& first_binding
>= nmaps
)
8871 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8875 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8876 fkey_next
= call1 (fkey_next
, prompt
);
8878 /* If the function returned something invalid,
8879 barf--don't ignore it.
8880 (To ignore it safely, we would need to gcpro a bunch of
8881 other variables.) */
8882 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
8883 error ("Function in key-translation-map returns invalid key sequence");
8886 /* If keybuf[fkey_start..fkey_end] is bound in the
8887 function key map and it's a suffix of the current
8888 sequence (i.e. fkey_end == t), replace it with
8889 the binding and restart with fkey_start at the end. */
8890 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
8891 /* If there's a binding (i.e. first_binding >= nmaps)
8892 we don't want to apply this function-key-mapping. */
8893 && fkey_end
== t
&& first_binding
>= nmaps
)
8895 int len
= XFASTINT (Flength (fkey_next
));
8897 t
= fkey_start
+ len
;
8899 error ("Key sequence too long");
8901 if (VECTORP (fkey_next
))
8902 bcopy (XVECTOR (fkey_next
)->contents
,
8903 keybuf
+ fkey_start
,
8904 (t
- fkey_start
) * sizeof (keybuf
[0]));
8905 else if (STRINGP (fkey_next
))
8909 for (i
= 0; i
< len
; i
++)
8910 XSETFASTINT (keybuf
[fkey_start
+ i
],
8911 XSTRING (fkey_next
)->data
[i
]);
8915 fkey_start
= fkey_end
= t
;
8916 fkey_map
= Vfunction_key_map
;
8918 /* Do pass the results through key-translation-map.
8919 But don't retranslate what key-translation-map
8920 has already translated. */
8921 keytran_end
= keytran_start
;
8922 keytran_map
= Vkey_translation_map
;
8924 goto replay_sequence
;
8927 fkey_map
= get_keymap (fkey_next
, 0, 1);
8929 /* If we no longer have a bound suffix, try a new positions for
8931 if (!CONSP (fkey_map
))
8933 fkey_end
= ++fkey_start
;
8934 fkey_map
= Vfunction_key_map
;
8939 /* Look for this sequence in key-translation-map. */
8941 Lisp_Object keytran_next
;
8943 /* Scan from keytran_end until we find a bound suffix. */
8944 while (keytran_end
< fkey_start
)
8948 key
= keybuf
[keytran_end
++];
8950 = access_keymap (keytran_map
, key
, 1, 0, 1);
8952 /* Handle symbol with autoload definition. */
8953 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8954 && CONSP (XSYMBOL (keytran_next
)->function
)
8955 && EQ (XCAR (XSYMBOL (keytran_next
)->function
), Qautoload
))
8956 do_autoload (XSYMBOL (keytran_next
)->function
,
8959 /* Handle a symbol whose function definition is a keymap
8961 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8962 && (!NILP (Farrayp (XSYMBOL (keytran_next
)->function
))
8963 || KEYMAPP (XSYMBOL (keytran_next
)->function
)))
8964 keytran_next
= XSYMBOL (keytran_next
)->function
;
8966 /* If the key translation map gives a function, not an
8967 array, then call the function with one arg and use
8968 its value instead. */
8969 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
)))
8971 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8975 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8976 keytran_next
= call1 (keytran_next
, prompt
);
8978 /* If the function returned something invalid,
8979 barf--don't ignore it.
8980 (To ignore it safely, we would need to gcpro a bunch of
8981 other variables.) */
8982 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8983 error ("Function in key-translation-map returns invalid key sequence");
8986 /* If keybuf[keytran_start..keytran_end] is bound in the
8987 key translation map and it's a suffix of the current
8988 sequence (i.e. keytran_end == t), replace it with
8989 the binding and restart with keytran_start at the end. */
8990 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8992 int len
= XFASTINT (Flength (keytran_next
));
8993 int i
, diff
= len
- (keytran_end
- keytran_start
);
8995 mock_input
= max (t
, mock_input
);
8996 if (mock_input
+ diff
>= bufsize
)
8997 error ("Key sequence too long");
8999 /* Shift the keys that are after keytran_end. */
9001 for (i
= keytran_end
; i
< mock_input
; i
++)
9002 keybuf
[i
+ diff
] = keybuf
[i
];
9004 for (i
= mock_input
- 1; i
>= keytran_end
; i
--)
9005 keybuf
[i
+ diff
] = keybuf
[i
];
9006 /* Replace the keys between keytran_start and keytran_end
9007 with those from keytran_next. */
9008 for (i
= 0; i
< len
; i
++)
9009 keybuf
[keytran_start
+ i
]
9010 = Faref (keytran_next
, make_number (i
));
9013 keytran_start
= keytran_end
+= diff
;
9014 keytran_map
= Vkey_translation_map
;
9016 /* Adjust the function-key-map counters. */
9020 goto replay_sequence
;
9023 keytran_map
= get_keymap (keytran_next
, 0, 1);
9025 /* If we no longer have a bound suffix, try a new positions for
9027 if (!CONSP (keytran_map
))
9029 keytran_end
= ++keytran_start
;
9030 keytran_map
= Vkey_translation_map
;
9035 /* If KEY is not defined in any of the keymaps,
9036 and cannot be part of a function key or translation,
9037 and is an upper case letter
9038 use the corresponding lower-case letter instead. */
9039 if (first_binding
>= nmaps
9040 && fkey_start
>= t
&& keytran_start
>= t
9042 && ((((XINT (key
) & 0x3ffff)
9043 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9044 && UPPERCASEP (XINT (key
) & 0x3ffff))
9045 || (XINT (key
) & shift_modifier
)))
9047 Lisp_Object new_key
;
9049 original_uppercase
= key
;
9050 original_uppercase_position
= t
- 1;
9052 if (XINT (key
) & shift_modifier
)
9053 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9055 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9056 | (XINT (key
) & ~0x3ffff)));
9058 /* We have to do this unconditionally, regardless of whether
9059 the lower-case char is defined in the keymaps, because they
9060 might get translated through function-key-map. */
9061 keybuf
[t
- 1] = new_key
;
9062 mock_input
= max (t
, mock_input
);
9064 goto replay_sequence
;
9066 /* If KEY is not defined in any of the keymaps,
9067 and cannot be part of a function key or translation,
9068 and is a shifted function key,
9069 use the corresponding unshifted function key instead. */
9070 if (first_binding
>= nmaps
9071 && fkey_start
>= t
&& keytran_start
>= t
9074 Lisp_Object breakdown
;
9077 breakdown
= parse_modifiers (key
);
9078 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9079 if (modifiers
& shift_modifier
)
9081 Lisp_Object new_key
;
9083 original_uppercase
= key
;
9084 original_uppercase_position
= t
- 1;
9086 modifiers
&= ~shift_modifier
;
9087 new_key
= apply_modifiers (modifiers
,
9090 keybuf
[t
- 1] = new_key
;
9091 mock_input
= max (t
, mock_input
);
9093 goto replay_sequence
;
9099 read_key_sequence_cmd
= (first_binding
< nmaps
9100 ? defs
[first_binding
]
9103 unread_switch_frame
= delayed_switch_frame
;
9104 unbind_to (count
, Qnil
);
9106 /* Don't downcase the last character if the caller says don't.
9107 Don't downcase it if the result is undefined, either. */
9108 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9109 && t
- 1 == original_uppercase_position
)
9110 keybuf
[t
- 1] = original_uppercase
;
9112 /* Occasionally we fabricate events, perhaps by expanding something
9113 according to function-key-map, or by adding a prefix symbol to a
9114 mouse click in the scroll bar or modeline. In this cases, return
9115 the entire generated key sequence, even if we hit an unbound
9116 prefix or a definition before the end. This means that you will
9117 be able to push back the event properly, and also means that
9118 read-key-sequence will always return a logical unit.
9121 for (; t
< mock_input
; t
++)
9123 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9124 && NILP (Fzerop (Vecho_keystrokes
)))
9125 echo_char (keybuf
[t
]);
9126 add_command_key (keybuf
[t
]);
9135 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9136 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9137 The sequence is sufficient to specify a non-prefix command in the
9138 current local and global maps.
9140 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9141 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9142 as a continuation of the previous key.
9144 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9145 convert the last event to lower case. (Normally any upper case event
9146 is converted to lower case if the original event is undefined and the lower
9147 case equivalent is defined.) A non-nil value is appropriate for reading
9148 a key sequence to be defined.
9150 A C-g typed while in this function is treated like any other character,
9151 and `quit-flag' is not set.
9153 If the key sequence starts with a mouse click, then the sequence is read
9154 using the keymaps of the buffer of the window clicked in, not the buffer
9155 of the selected window as normal.
9157 `read-key-sequence' drops unbound button-down events, since you normally
9158 only care about the click or drag events which follow them. If a drag
9159 or multi-click event is unbound, but the corresponding click event would
9160 be bound, `read-key-sequence' turns the event into a click event at the
9161 drag's starting position. This means that you don't have to distinguish
9162 between click and drag, double, or triple events unless you want to.
9164 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9165 lines separating windows, and scroll bars with imaginary keys
9166 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9168 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9169 function will process a switch-frame event if the user switches frames
9170 before typing anything. If the user switches frames in the middle of a
9171 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9172 is nil, then the event will be put off until after the current key sequence.
9174 `read-key-sequence' checks `function-key-map' for function key
9175 sequences, where they wouldn't conflict with ordinary bindings. See
9176 `function-key-map' for more details.
9178 The optional fifth argument COMMAND-LOOP, if non-nil, means
9179 that this key sequence is being read by something that will
9180 read commands one after another. It should be nil if the caller
9181 will read just one key sequence. */)
9182 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9184 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9185 Lisp_Object can_return_switch_frame
, command_loop
;
9187 Lisp_Object keybuf
[30];
9189 struct gcpro gcpro1
;
9190 int count
= specpdl_ptr
- specpdl
;
9193 CHECK_STRING (prompt
);
9196 specbind (Qinput_method_exit_on_first_char
,
9197 (NILP (command_loop
) ? Qt
: Qnil
));
9198 specbind (Qinput_method_use_echo_area
,
9199 (NILP (command_loop
) ? Qt
: Qnil
));
9201 bzero (keybuf
, sizeof keybuf
);
9203 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9205 if (NILP (continue_echo
))
9207 this_command_key_count
= 0;
9208 this_single_command_key_start
= 0;
9211 #ifdef HAVE_X_WINDOWS
9212 if (display_hourglass_p
)
9213 cancel_hourglass ();
9216 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9217 prompt
, ! NILP (dont_downcase_last
),
9218 ! NILP (can_return_switch_frame
), 0);
9220 #if 0 /* The following is fine for code reading a key sequence and
9221 then proceeding with a lenghty computation, but it's not good
9222 for code reading keys in a loop, like an input method. */
9223 #ifdef HAVE_X_WINDOWS
9224 if (display_hourglass_p
)
9235 return unbind_to (count
, make_event_array (i
, keybuf
));
9238 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9239 Sread_key_sequence_vector
, 1, 5, 0,
9240 doc
: /* Like `read-key-sequence' but always return a vector. */)
9241 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9243 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9244 Lisp_Object can_return_switch_frame
, command_loop
;
9246 Lisp_Object keybuf
[30];
9248 struct gcpro gcpro1
;
9249 int count
= specpdl_ptr
- specpdl
;
9252 CHECK_STRING (prompt
);
9255 specbind (Qinput_method_exit_on_first_char
,
9256 (NILP (command_loop
) ? Qt
: Qnil
));
9257 specbind (Qinput_method_use_echo_area
,
9258 (NILP (command_loop
) ? Qt
: Qnil
));
9260 bzero (keybuf
, sizeof keybuf
);
9262 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9264 if (NILP (continue_echo
))
9266 this_command_key_count
= 0;
9267 this_single_command_key_start
= 0;
9270 #ifdef HAVE_X_WINDOWS
9271 if (display_hourglass_p
)
9272 cancel_hourglass ();
9275 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9276 prompt
, ! NILP (dont_downcase_last
),
9277 ! NILP (can_return_switch_frame
), 0);
9279 #ifdef HAVE_X_WINDOWS
9280 if (display_hourglass_p
)
9290 return unbind_to (count
, Fvector (i
, keybuf
));
9293 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9294 doc
: /* Execute CMD as an editor command.
9295 CMD must be a symbol that satisfies the `commandp' predicate.
9296 Optional second arg RECORD-FLAG non-nil
9297 means unconditionally put this command in `command-history'.
9298 Otherwise, that is done only if an arg is read using the minibuffer.
9299 The argument KEYS specifies the value to use instead of (this-command-keys)
9300 when reading the arguments; if it is nil, (this-command-keys) is used.
9301 The argument SPECIAL, if non-nil, means that this command is executing
9302 a special event, so ignore the prefix argument and don't clear it. */)
9303 (cmd
, record_flag
, keys
, special
)
9304 Lisp_Object cmd
, record_flag
, keys
, special
;
9306 register Lisp_Object final
;
9307 register Lisp_Object tem
;
9308 Lisp_Object prefixarg
;
9309 struct backtrace backtrace
;
9310 extern int debug_on_next_call
;
9312 debug_on_next_call
= 0;
9316 prefixarg
= current_kboard
->Vprefix_arg
;
9317 Vcurrent_prefix_arg
= prefixarg
;
9318 current_kboard
->Vprefix_arg
= Qnil
;
9325 tem
= Fget (cmd
, Qdisabled
);
9326 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9328 tem
= Fsymbol_value (Qdisabled_command_hook
);
9330 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9336 final
= Findirect_function (cmd
);
9338 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9340 struct gcpro gcpro1
, gcpro2
;
9342 GCPRO2 (cmd
, prefixarg
);
9343 do_autoload (final
, cmd
);
9350 if (STRINGP (final
) || VECTORP (final
))
9352 /* If requested, place the macro in the command history. For
9353 other sorts of commands, call-interactively takes care of
9355 if (!NILP (record_flag
))
9358 = Fcons (Fcons (Qexecute_kbd_macro
,
9359 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9362 /* Don't keep command history around forever. */
9363 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9365 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9367 XSETCDR (tem
, Qnil
);
9371 return Fexecute_kbd_macro (final
, prefixarg
);
9374 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9376 backtrace
.next
= backtrace_list
;
9377 backtrace_list
= &backtrace
;
9378 backtrace
.function
= &Qcall_interactively
;
9379 backtrace
.args
= &cmd
;
9380 backtrace
.nargs
= 1;
9381 backtrace
.evalargs
= 0;
9383 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9385 backtrace_list
= backtrace
.next
;
9393 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9395 doc
: /* Read function name, then read its arguments and call it. */)
9397 Lisp_Object prefixarg
;
9399 Lisp_Object function
;
9401 int saved_last_point_position
;
9402 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9403 Lisp_Object bindings
, value
;
9404 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9406 saved_keys
= Fvector (this_command_key_count
,
9407 XVECTOR (this_command_keys
)->contents
);
9408 saved_last_point_position_buffer
= last_point_position_buffer
;
9409 saved_last_point_position
= last_point_position
;
9411 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9413 if (EQ (prefixarg
, Qminus
))
9415 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9416 strcpy (buf
, "C-u ");
9417 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9419 if (sizeof (int) == sizeof (EMACS_INT
))
9420 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9421 else if (sizeof (long) == sizeof (EMACS_INT
))
9422 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9426 else if (INTEGERP (prefixarg
))
9428 if (sizeof (int) == sizeof (EMACS_INT
))
9429 sprintf (buf
, "%d ", XINT (prefixarg
));
9430 else if (sizeof (long) == sizeof (EMACS_INT
))
9431 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9436 /* This isn't strictly correct if execute-extended-command
9437 is bound to anything else. Perhaps it should use
9438 this_command_keys? */
9439 strcat (buf
, "M-x ");
9441 /* Prompt with buf, and then read a string, completing from and
9442 restricting to the set of all defined commands. Don't provide
9443 any initial input. Save the command read on the extended-command
9445 function
= Fcompleting_read (build_string (buf
),
9446 Vobarray
, Qcommandp
,
9447 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9450 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
9451 error ("No command name given");
9453 /* Set this_command_keys to the concatenation of saved_keys and
9454 function, followed by a RET. */
9456 struct Lisp_String
*str
;
9460 this_command_key_count
= 0;
9461 this_single_command_key_start
= 0;
9463 keys
= XVECTOR (saved_keys
)->contents
;
9464 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9465 add_command_key (keys
[i
]);
9467 str
= XSTRING (function
);
9468 for (i
= 0; i
< str
->size
; i
++)
9469 add_command_key (Faref (function
, make_number (i
)));
9471 add_command_key (make_number ('\015'));
9474 last_point_position
= saved_last_point_position
;
9475 last_point_position_buffer
= saved_last_point_position_buffer
;
9479 function
= Fintern (function
, Qnil
);
9480 current_kboard
->Vprefix_arg
= prefixarg
;
9481 Vthis_command
= function
;
9482 real_this_command
= function
;
9484 /* If enabled, show which key runs this command. */
9485 if (!NILP (Vsuggest_key_bindings
)
9486 && NILP (Vexecuting_macro
)
9487 && SYMBOLP (function
))
9488 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9494 GCPRO2 (bindings
, value
);
9495 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9497 /* If the command has a key binding, print it now. */
9498 if (!NILP (bindings
)
9499 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9502 /* But first wait, and skip the message if there is input. */
9504 if (!NILP (echo_area_buffer
[0]))
9505 /* This command displayed something in the echo area;
9506 so wait a few seconds, then display our suggestion message. */
9507 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9508 ? XINT (Vsuggest_key_bindings
) : 2);
9510 /* This command left the echo area empty,
9511 so display our message immediately. */
9514 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9515 && ! CONSP (Vunread_command_events
))
9517 Lisp_Object binding
;
9519 int message_p
= push_message ();
9520 int count
= BINDING_STACK_SIZE ();
9522 record_unwind_protect (push_message_unwind
, Qnil
);
9523 binding
= Fkey_description (bindings
);
9526 = (char *) alloca (XSTRING (SYMBOL_NAME (function
))->size
9527 + STRING_BYTES (XSTRING (binding
))
9529 sprintf (newmessage
, "You can run the command `%s' with %s",
9530 XSTRING (SYMBOL_NAME (function
))->data
,
9531 XSTRING (binding
)->data
);
9532 message2_nolog (newmessage
,
9533 strlen (newmessage
),
9534 STRING_MULTIBYTE (binding
));
9535 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9536 ? Vsuggest_key_bindings
: make_number (2)),
9541 unbind_to (count
, Qnil
);
9545 RETURN_UNGCPRO (value
);
9549 /* Return nonzero if input events are pending. */
9552 detect_input_pending ()
9555 get_input_pending (&input_pending
, 0);
9557 return input_pending
;
9560 /* Return nonzero if input events are pending, and run any pending timers. */
9563 detect_input_pending_run_timers (do_display
)
9566 int old_timers_run
= timers_run
;
9569 get_input_pending (&input_pending
, 1);
9571 if (old_timers_run
!= timers_run
&& do_display
)
9573 redisplay_preserve_echo_area (8);
9574 /* The following fixes a bug when using lazy-lock with
9575 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9576 from an idle timer function. The symptom of the bug is that
9577 the cursor sometimes doesn't become visible until the next X
9578 event is processed. --gerd. */
9580 rif
->flush_display (NULL
);
9583 return input_pending
;
9586 /* This is called in some cases before a possible quit.
9587 It cases the next call to detect_input_pending to recompute input_pending.
9588 So calling this function unnecessarily can't do any harm. */
9591 clear_input_pending ()
9596 /* Return nonzero if there are pending requeued events.
9597 This isn't used yet. The hope is to make wait_reading_process_input
9598 call it, and return if it runs Lisp code that unreads something.
9599 The problem is, kbd_buffer_get_event needs to be fixed to know what
9600 to do in that case. It isn't trivial. */
9603 requeued_events_pending_p ()
9605 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9609 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9610 doc
: /* Return t if command input is currently available with no wait.
9611 Actually, the value is nil only if we can be sure that no input is available;
9612 if there is a doubt, the value is t. */)
9615 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9618 get_filtered_input_pending (&input_pending
, 1, 1);
9619 return input_pending
> 0 ? Qt
: Qnil
;
9622 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9623 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9626 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9629 if (total_keys
< NUM_RECENT_KEYS
)
9630 return Fvector (total_keys
, keys
);
9633 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9634 bcopy (keys
+ recent_keys_index
,
9635 XVECTOR (val
)->contents
,
9636 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9638 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9639 recent_keys_index
* sizeof (Lisp_Object
));
9644 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9645 doc
: /* Return the key sequence that invoked this command.
9646 However, if the command has called `read-key-sequence', it returns
9647 the last key sequence that has been read.
9648 The value is a string or a vector. */)
9651 return make_event_array (this_command_key_count
,
9652 XVECTOR (this_command_keys
)->contents
);
9655 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9656 doc
: /* Return the key sequence that invoked this command, as a vector.
9657 However, if the command has called `read-key-sequence', it returns
9658 the last key sequence that has been read. */)
9661 return Fvector (this_command_key_count
,
9662 XVECTOR (this_command_keys
)->contents
);
9665 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9666 Sthis_single_command_keys
, 0, 0, 0,
9667 doc
: /* Return the key sequence that invoked this command.
9668 More generally, it returns the last key sequence read, either by
9669 the command loop or by `read-key-sequence'.
9670 Unlike `this-command-keys', this function's value
9671 does not include prefix arguments.
9672 The value is always a vector. */)
9675 return Fvector (this_command_key_count
9676 - this_single_command_key_start
,
9677 (XVECTOR (this_command_keys
)->contents
9678 + this_single_command_key_start
));
9681 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9682 Sthis_single_command_raw_keys
, 0, 0, 0,
9683 doc
: /* Return the raw events that were read for this command.
9684 More generally, it returns the last key sequence read, either by
9685 the command loop or by `read-key-sequence'.
9686 Unlike `this-single-command-keys', this function's value
9687 shows the events before all translations (except for input methods).
9688 The value is always a vector. */)
9691 return Fvector (raw_keybuf_count
,
9692 (XVECTOR (raw_keybuf
)->contents
));
9695 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9696 Sreset_this_command_lengths
, 0, 0, 0,
9697 doc
: /* Used for complicated reasons in `universal-argument-other-key'.
9699 `universal-argument-other-key' rereads the event just typed.
9700 It then gets translated through `function-key-map'.
9701 The translated event gets included in the echo area and in
9702 the value of `this-command-keys' in addition to the raw original event.
9705 Calling this function directs the translated event to replace
9706 the original event, so that only one version of the event actually
9707 appears in the echo area and in the value of `this-command-keys'. */)
9710 before_command_restore_flag
= 1;
9711 before_command_key_count_1
= before_command_key_count
;
9712 before_command_echo_length_1
= before_command_echo_length
;
9716 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9717 Sclear_this_command_keys
, 0, 0, 0,
9718 doc
: /* Clear out the vector that `this-command-keys' returns.
9719 Also clear the record of the last 100 events. */)
9724 this_command_key_count
= 0;
9726 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9727 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9729 recent_keys_index
= 0;
9733 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9734 doc
: /* Return the current depth in recursive edits. */)
9738 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9742 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9743 "FOpen dribble file: ",
9744 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9745 If FILE is nil, close any open dribble file. */)
9756 file
= Fexpand_file_name (file
, Qnil
);
9757 dribble
= fopen (XSTRING (file
)->data
, "w");
9759 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9764 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9765 doc
: /* Discard the contents of the terminal input buffer.
9766 Also cancel any kbd macro being defined. */)
9769 current_kboard
->defining_kbd_macro
= Qnil
;
9770 update_mode_lines
++;
9772 Vunread_command_events
= Qnil
;
9773 unread_command_char
= -1;
9775 discard_tty_input ();
9777 kbd_fetch_ptr
= kbd_store_ptr
;
9778 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9784 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9785 doc
: /* Stop Emacs and return to superior process. You can resume later.
9786 If `cannot-suspend' is non-nil, or if the system doesn't support job
9787 control, run a subshell instead.
9789 If optional arg STUFFSTRING is non-nil, its characters are stuffed
9790 to be read as terminal input by Emacs's parent, after suspension.
9792 Before suspending, run the normal hook `suspend-hook'.
9793 After resumption run the normal hook `suspend-resume-hook'.
9795 Some operating systems cannot stop the Emacs process and resume it later.
9796 On such systems, Emacs starts a subshell instead of suspending. */)
9798 Lisp_Object stuffstring
;
9800 int count
= specpdl_ptr
- specpdl
;
9801 int old_height
, old_width
;
9803 struct gcpro gcpro1
;
9805 if (!NILP (stuffstring
))
9806 CHECK_STRING (stuffstring
);
9808 /* Run the functions in suspend-hook. */
9809 if (!NILP (Vrun_hooks
))
9810 call1 (Vrun_hooks
, intern ("suspend-hook"));
9812 GCPRO1 (stuffstring
);
9813 get_frame_size (&old_width
, &old_height
);
9815 /* sys_suspend can get an error if it tries to fork a subshell
9816 and the system resources aren't available for that. */
9817 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9819 stuff_buffered_input (stuffstring
);
9824 unbind_to (count
, Qnil
);
9826 /* Check if terminal/window size has changed.
9827 Note that this is not useful when we are running directly
9828 with a window system; but suspend should be disabled in that case. */
9829 get_frame_size (&width
, &height
);
9830 if (width
!= old_width
|| height
!= old_height
)
9831 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9833 /* Run suspend-resume-hook. */
9834 if (!NILP (Vrun_hooks
))
9835 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9841 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9842 Then in any case stuff anything Emacs has read ahead and not used. */
9845 stuff_buffered_input (stuffstring
)
9846 Lisp_Object stuffstring
;
9848 /* stuff_char works only in BSD, versions 4.2 and up. */
9851 register unsigned char *p
;
9853 if (STRINGP (stuffstring
))
9857 p
= XSTRING (stuffstring
)->data
;
9858 count
= STRING_BYTES (XSTRING (stuffstring
));
9864 /* Anything we have read ahead, put back for the shell to read. */
9865 /* ?? What should this do when we have multiple keyboards??
9866 Should we ignore anything that was typed in at the "wrong" kboard? */
9867 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9871 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9872 kbd_fetch_ptr
= kbd_buffer
;
9873 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
9874 stuff_char (kbd_fetch_ptr
->code
);
9876 kbd_fetch_ptr
->kind
= NO_EVENT
;
9877 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
9878 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
9879 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
9884 #endif /* BSD_SYSTEM and not BSD4_1 */
9888 set_waiting_for_input (time_to_clear
)
9889 EMACS_TIME
*time_to_clear
;
9891 input_available_clear_time
= time_to_clear
;
9893 /* Tell interrupt_signal to throw back to read_char, */
9894 waiting_for_input
= 1;
9896 /* If interrupt_signal was called before and buffered a C-g,
9897 make it run again now, to avoid timing error. */
9898 if (!NILP (Vquit_flag
))
9899 quit_throw_to_read_char ();
9903 clear_waiting_for_input ()
9905 /* Tell interrupt_signal not to throw back to read_char, */
9906 waiting_for_input
= 0;
9907 input_available_clear_time
= 0;
9910 /* This routine is called at interrupt level in response to C-g.
9912 If interrupt_input, this is the handler for SIGINT. Otherwise, it
9913 is called from kbd_buffer_store_event, in handling SIGIO or
9916 If `waiting_for_input' is non zero, then unless `echoing' is
9917 nonzero, immediately throw back to read_char.
9919 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
9920 eval to throw, when it gets a chance. If quit-flag is already
9921 non-nil, it stops the job right away. */
9924 interrupt_signal (signalnum
) /* If we don't have an argument, */
9925 int signalnum
; /* some compilers complain in signal calls. */
9928 /* Must preserve main program's value of errno. */
9929 int old_errno
= errno
;
9930 struct frame
*sf
= SELECTED_FRAME ();
9932 #if defined (USG) && !defined (POSIX_SIGNALS)
9933 if (!read_socket_hook
&& NILP (Vwindow_system
))
9935 /* USG systems forget handlers when they are used;
9936 must reestablish each time */
9937 signal (SIGINT
, interrupt_signal
);
9938 signal (SIGQUIT
, interrupt_signal
);
9944 if (!NILP (Vquit_flag
)
9945 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
9947 /* If SIGINT isn't blocked, don't let us be interrupted by
9948 another SIGINT, it might be harmful due to non-reentrancy
9949 in I/O functions. */
9950 sigblock (sigmask (SIGINT
));
9955 #ifdef SIGTSTP /* Support possible in later USG versions */
9957 * On systems which can suspend the current process and return to the original
9958 * shell, this command causes the user to end up back at the shell.
9959 * The "Auto-save" and "Abort" questions are not asked until
9960 * the user elects to return to emacs, at which point he can save the current
9961 * job and either dump core or continue.
9966 if (sys_suspend () == -1)
9968 printf ("Not running as a subprocess;\n");
9969 printf ("you can continue or abort.\n");
9972 /* Perhaps should really fork an inferior shell?
9973 But that would not provide any way to get back
9974 to the original shell, ever. */
9975 printf ("No support for stopping a process on this operating system;\n");
9976 printf ("you can continue or abort.\n");
9977 #endif /* not VMS */
9978 #endif /* not SIGTSTP */
9980 /* We must remain inside the screen area when the internal terminal
9981 is used. Note that [Enter] is not echoed by dos. */
9984 /* It doesn't work to autosave while GC is in progress;
9985 the code used for auto-saving doesn't cope with the mark bit. */
9986 if (!gc_in_progress
)
9988 printf ("Auto-save? (y or n) ");
9990 if (((c
= getchar ()) & ~040) == 'Y')
9992 Fdo_auto_save (Qt
, Qnil
);
9994 printf ("\r\nAuto-save done");
9995 #else /* not MSDOS */
9996 printf ("Auto-save done\n");
9997 #endif /* not MSDOS */
9999 while (c
!= '\n') c
= getchar ();
10003 /* During GC, it must be safe to reenable quitting again. */
10004 Vinhibit_quit
= Qnil
;
10007 #endif /* not MSDOS */
10008 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10009 printf ("but will instead do a real quit after garbage collection ends\r\n");
10014 printf ("\r\nAbort? (y or n) ");
10015 #else /* not MSDOS */
10017 printf ("Abort (and enter debugger)? (y or n) ");
10018 #else /* not VMS */
10019 printf ("Abort (and dump core)? (y or n) ");
10020 #endif /* not VMS */
10021 #endif /* not MSDOS */
10023 if (((c
= getchar ()) & ~040) == 'Y')
10025 while (c
!= '\n') c
= getchar ();
10027 printf ("\r\nContinuing...\r\n");
10028 #else /* not MSDOS */
10029 printf ("Continuing...\n");
10030 #endif /* not MSDOS */
10037 /* If executing a function that wants to be interrupted out of
10038 and the user has not deferred quitting by binding `inhibit-quit'
10039 then quit right away. */
10040 if (immediate_quit
&& NILP (Vinhibit_quit
))
10042 struct gl_state_s saved
;
10043 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10045 immediate_quit
= 0;
10048 GCPRO4 (saved
.object
, saved
.global_code
,
10049 saved
.current_syntax_table
, saved
.old_prop
);
10050 Fsignal (Qquit
, Qnil
);
10055 /* Else request quit when it's safe */
10059 if (waiting_for_input
&& !echoing
)
10060 quit_throw_to_read_char ();
10065 /* Handle a C-g by making read_char return C-g. */
10068 quit_throw_to_read_char ()
10071 /* Prevent another signal from doing this before we finish. */
10072 clear_waiting_for_input ();
10075 Vunread_command_events
= Qnil
;
10076 unread_command_char
= -1;
10078 #if 0 /* Currently, sit_for is called from read_char without turning
10079 off polling. And that can call set_waiting_for_input.
10080 It seems to be harmless. */
10081 #ifdef POLL_FOR_INPUT
10082 /* May be > 1 if in recursive minibuffer. */
10083 if (poll_suppress_count
== 0)
10087 if (FRAMEP (internal_last_event_frame
)
10088 && !EQ (internal_last_event_frame
, selected_frame
))
10089 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10092 _longjmp (getcjmp
, 1);
10095 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10096 doc
: /* Set mode of reading keyboard input.
10097 First arg INTERRUPT non-nil means use input interrupts;
10098 nil means use CBREAK mode.
10099 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10100 (no effect except in CBREAK mode).
10101 Third arg META t means accept 8-bit input (for a Meta key).
10102 META nil means ignore the top bit, on the assumption it is parity.
10103 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10104 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10105 See also `current-input-mode'. */)
10106 (interrupt
, flow
, meta
, quit
)
10107 Lisp_Object interrupt
, flow
, meta
, quit
;
10110 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10111 error ("set-input-mode: QUIT must be an ASCII character");
10113 #ifdef POLL_FOR_INPUT
10118 /* this causes startup screen to be restored and messes with the mouse */
10119 reset_sys_modes ();
10123 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10124 if (read_socket_hook
)
10126 /* When using X, don't give the user a real choice,
10127 because we haven't implemented the mechanisms to support it. */
10128 #ifdef NO_SOCK_SIGIO
10129 interrupt_input
= 0;
10130 #else /* not NO_SOCK_SIGIO */
10131 interrupt_input
= 1;
10132 #endif /* NO_SOCK_SIGIO */
10135 interrupt_input
= !NILP (interrupt
);
10136 #else /* not SIGIO */
10137 interrupt_input
= 0;
10138 #endif /* not SIGIO */
10140 /* Our VMS input only works by interrupts, as of now. */
10142 interrupt_input
= 1;
10145 flow_control
= !NILP (flow
);
10148 else if (EQ (meta
, Qt
))
10153 /* Don't let this value be out of range. */
10154 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10160 #ifdef POLL_FOR_INPUT
10161 poll_suppress_count
= 1;
10167 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10168 doc
: /* Return information about the way Emacs currently reads keyboard input.
10169 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10170 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10171 nil, Emacs is using CBREAK mode.
10172 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10173 terminal; this does not apply if Emacs uses interrupt-driven input.
10174 META is t if accepting 8-bit input with 8th bit as Meta flag.
10175 META nil means ignoring the top bit, on the assumption it is parity.
10176 META is neither t nor nil if accepting 8-bit input and using
10177 all 8 bits as the character code.
10178 QUIT is the character Emacs currently uses to quit.
10179 The elements of this list correspond to the arguments of
10180 `set-input-mode'. */)
10183 Lisp_Object val
[4];
10185 val
[0] = interrupt_input
? Qt
: Qnil
;
10186 val
[1] = flow_control
? Qt
: Qnil
;
10187 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10188 XSETFASTINT (val
[3], quit_char
);
10190 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10195 * Set up a new kboard object with reasonable initial values.
10201 kb
->Voverriding_terminal_local_map
= Qnil
;
10202 kb
->Vlast_command
= Qnil
;
10203 kb
->Vreal_last_command
= Qnil
;
10204 kb
->Vprefix_arg
= Qnil
;
10205 kb
->Vlast_prefix_arg
= Qnil
;
10206 kb
->kbd_queue
= Qnil
;
10207 kb
->kbd_queue_has_data
= 0;
10208 kb
->immediate_echo
= 0;
10209 kb
->echo_string
= Qnil
;
10210 kb
->echo_after_prompt
= -1;
10211 kb
->kbd_macro_buffer
= 0;
10212 kb
->kbd_macro_bufsize
= 0;
10213 kb
->defining_kbd_macro
= Qnil
;
10214 kb
->Vlast_kbd_macro
= Qnil
;
10215 kb
->reference_count
= 0;
10216 kb
->Vsystem_key_alist
= Qnil
;
10217 kb
->system_key_syms
= Qnil
;
10218 kb
->Vdefault_minibuffer_frame
= Qnil
;
10222 * Destroy the contents of a kboard object, but not the object itself.
10223 * We use this just before deleting it, or if we're going to initialize
10224 * it a second time.
10230 if (kb
->kbd_macro_buffer
)
10231 xfree (kb
->kbd_macro_buffer
);
10234 #ifdef MULTI_KBOARD
10236 /* Free KB and memory referenced from it. */
10244 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10247 *kbp
= kb
->next_kboard
;
10249 /* Prevent a dangling reference to KB. */
10250 if (kb
== current_kboard
10251 && FRAMEP (selected_frame
)
10252 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10254 current_kboard
= XFRAME (selected_frame
)->kboard
;
10255 if (current_kboard
== kb
)
10263 #endif /* MULTI_KBOARD */
10268 /* This is correct before outermost invocation of the editor loop */
10269 command_loop_level
= -1;
10270 immediate_quit
= 0;
10271 quit_char
= Ctl ('g');
10272 Vunread_command_events
= Qnil
;
10273 unread_command_char
= -1;
10274 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10276 recent_keys_index
= 0;
10277 kbd_fetch_ptr
= kbd_buffer
;
10278 kbd_store_ptr
= kbd_buffer
;
10279 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10281 do_mouse_tracking
= Qnil
;
10285 /* This means that command_loop_1 won't try to select anything the first
10287 internal_last_event_frame
= Qnil
;
10288 Vlast_event_frame
= internal_last_event_frame
;
10290 #ifdef MULTI_KBOARD
10291 current_kboard
= initial_kboard
;
10293 wipe_kboard (current_kboard
);
10294 init_kboard (current_kboard
);
10296 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10298 signal (SIGINT
, interrupt_signal
);
10299 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10300 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10301 SIGQUIT and we can't tell which one it will give us. */
10302 signal (SIGQUIT
, interrupt_signal
);
10303 #endif /* HAVE_TERMIO */
10305 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10307 if (!noninteractive
)
10308 signal (SIGIO
, input_available_signal
);
10311 /* Use interrupt input by default, if it works and noninterrupt input
10312 has deficiencies. */
10314 #ifdef INTERRUPT_INPUT
10315 interrupt_input
= 1;
10317 interrupt_input
= 0;
10320 /* Our VMS input only works by interrupts, as of now. */
10322 interrupt_input
= 1;
10328 if (keyboard_init_hook
)
10329 (*keyboard_init_hook
) ();
10331 #ifdef POLL_FOR_INPUT
10332 poll_suppress_count
= 1;
10337 /* This type's only use is in syms_of_keyboard, to initialize the
10338 event header symbols and put properties on them. */
10339 struct event_head
{
10345 struct event_head head_table
[] = {
10346 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10347 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10348 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10349 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10350 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10351 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10352 {&Qselect_window
, "select-window", &Qselect_window
}
10356 syms_of_keyboard ()
10358 Vpre_help_message
= Qnil
;
10359 staticpro (&Vpre_help_message
);
10361 Vlispy_mouse_stem
= build_string ("mouse");
10362 staticpro (&Vlispy_mouse_stem
);
10365 QCimage
= intern (":image");
10366 staticpro (&QCimage
);
10368 staticpro (&Qhelp_echo
);
10369 Qhelp_echo
= intern ("help-echo");
10371 staticpro (&item_properties
);
10372 item_properties
= Qnil
;
10374 staticpro (&tool_bar_item_properties
);
10375 tool_bar_item_properties
= Qnil
;
10376 staticpro (&tool_bar_items_vector
);
10377 tool_bar_items_vector
= Qnil
;
10379 staticpro (&real_this_command
);
10380 real_this_command
= Qnil
;
10382 Qtimer_event_handler
= intern ("timer-event-handler");
10383 staticpro (&Qtimer_event_handler
);
10385 Qdisabled_command_hook
= intern ("disabled-command-hook");
10386 staticpro (&Qdisabled_command_hook
);
10388 Qself_insert_command
= intern ("self-insert-command");
10389 staticpro (&Qself_insert_command
);
10391 Qforward_char
= intern ("forward-char");
10392 staticpro (&Qforward_char
);
10394 Qbackward_char
= intern ("backward-char");
10395 staticpro (&Qbackward_char
);
10397 Qdisabled
= intern ("disabled");
10398 staticpro (&Qdisabled
);
10400 Qundefined
= intern ("undefined");
10401 staticpro (&Qundefined
);
10403 Qpre_command_hook
= intern ("pre-command-hook");
10404 staticpro (&Qpre_command_hook
);
10406 Qpost_command_hook
= intern ("post-command-hook");
10407 staticpro (&Qpost_command_hook
);
10409 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10410 staticpro (&Qpost_command_idle_hook
);
10412 Qdeferred_action_function
= intern ("deferred-action-function");
10413 staticpro (&Qdeferred_action_function
);
10415 Qcommand_hook_internal
= intern ("command-hook-internal");
10416 staticpro (&Qcommand_hook_internal
);
10418 Qfunction_key
= intern ("function-key");
10419 staticpro (&Qfunction_key
);
10420 Qmouse_click
= intern ("mouse-click");
10421 staticpro (&Qmouse_click
);
10423 Qmouse_wheel
= intern ("mouse-wheel");
10424 staticpro (&Qmouse_wheel
);
10425 Qlanguage_change
= intern ("language-change");
10426 staticpro (&Qlanguage_change
);
10428 Qdrag_n_drop
= intern ("drag-n-drop");
10429 staticpro (&Qdrag_n_drop
);
10431 Qsave_session
= intern ("save-session");
10432 staticpro(&Qsave_session
);
10434 Qusr1_signal
= intern ("usr1-signal");
10435 staticpro (&Qusr1_signal
);
10436 Qusr2_signal
= intern ("usr2-signal");
10437 staticpro (&Qusr2_signal
);
10439 Qmenu_enable
= intern ("menu-enable");
10440 staticpro (&Qmenu_enable
);
10441 Qmenu_alias
= intern ("menu-alias");
10442 staticpro (&Qmenu_alias
);
10443 QCenable
= intern (":enable");
10444 staticpro (&QCenable
);
10445 QCvisible
= intern (":visible");
10446 staticpro (&QCvisible
);
10447 QChelp
= intern (":help");
10448 staticpro (&QChelp
);
10449 QCfilter
= intern (":filter");
10450 staticpro (&QCfilter
);
10451 QCbutton
= intern (":button");
10452 staticpro (&QCbutton
);
10453 QCkeys
= intern (":keys");
10454 staticpro (&QCkeys
);
10455 QCkey_sequence
= intern (":key-sequence");
10456 staticpro (&QCkey_sequence
);
10457 QCtoggle
= intern (":toggle");
10458 staticpro (&QCtoggle
);
10459 QCradio
= intern (":radio");
10460 staticpro (&QCradio
);
10462 Qmode_line
= intern ("mode-line");
10463 staticpro (&Qmode_line
);
10464 Qvertical_line
= intern ("vertical-line");
10465 staticpro (&Qvertical_line
);
10466 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10467 staticpro (&Qvertical_scroll_bar
);
10468 Qmenu_bar
= intern ("menu-bar");
10469 staticpro (&Qmenu_bar
);
10471 Qabove_handle
= intern ("above-handle");
10472 staticpro (&Qabove_handle
);
10473 Qhandle
= intern ("handle");
10474 staticpro (&Qhandle
);
10475 Qbelow_handle
= intern ("below-handle");
10476 staticpro (&Qbelow_handle
);
10477 Qup
= intern ("up");
10479 Qdown
= intern ("down");
10480 staticpro (&Qdown
);
10481 Qtop
= intern ("top");
10483 Qbottom
= intern ("bottom");
10484 staticpro (&Qbottom
);
10485 Qend_scroll
= intern ("end-scroll");
10486 staticpro (&Qend_scroll
);
10487 Qratio
= intern ("ratio");
10488 staticpro (&Qratio
);
10490 Qevent_kind
= intern ("event-kind");
10491 staticpro (&Qevent_kind
);
10492 Qevent_symbol_elements
= intern ("event-symbol-elements");
10493 staticpro (&Qevent_symbol_elements
);
10494 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10495 staticpro (&Qevent_symbol_element_mask
);
10496 Qmodifier_cache
= intern ("modifier-cache");
10497 staticpro (&Qmodifier_cache
);
10499 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10500 staticpro (&Qrecompute_lucid_menubar
);
10501 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10502 staticpro (&Qactivate_menubar_hook
);
10504 Qpolling_period
= intern ("polling-period");
10505 staticpro (&Qpolling_period
);
10507 Qinput_method_function
= intern ("input-method-function");
10508 staticpro (&Qinput_method_function
);
10510 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10511 staticpro (&Qinput_method_exit_on_first_char
);
10512 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10513 staticpro (&Qinput_method_use_echo_area
);
10515 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10516 Fset (Qinput_method_use_echo_area
, Qnil
);
10518 last_point_position_buffer
= Qnil
;
10521 struct event_head
*p
;
10523 for (p
= head_table
;
10524 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10527 *p
->var
= intern (p
->name
);
10528 staticpro (p
->var
);
10529 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10530 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10534 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10535 staticpro (&button_down_location
);
10536 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10537 staticpro (&mouse_syms
);
10541 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10543 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10544 for (i
= 0; i
< len
; i
++)
10545 if (modifier_names
[i
])
10546 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10547 staticpro (&modifier_symbols
);
10550 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10551 staticpro (&recent_keys
);
10553 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10554 staticpro (&this_command_keys
);
10556 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10557 staticpro (&raw_keybuf
);
10559 Qextended_command_history
= intern ("extended-command-history");
10560 Fset (Qextended_command_history
, Qnil
);
10561 staticpro (&Qextended_command_history
);
10563 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10564 staticpro (&kbd_buffer_gcpro
);
10566 accent_key_syms
= Qnil
;
10567 staticpro (&accent_key_syms
);
10569 func_key_syms
= Qnil
;
10570 staticpro (&func_key_syms
);
10573 mouse_wheel_syms
= Qnil
;
10574 staticpro (&mouse_wheel_syms
);
10576 drag_n_drop_syms
= Qnil
;
10577 staticpro (&drag_n_drop_syms
);
10580 unread_switch_frame
= Qnil
;
10581 staticpro (&unread_switch_frame
);
10583 internal_last_event_frame
= Qnil
;
10584 staticpro (&internal_last_event_frame
);
10586 read_key_sequence_cmd
= Qnil
;
10587 staticpro (&read_key_sequence_cmd
);
10589 menu_bar_one_keymap_changed_items
= Qnil
;
10590 staticpro (&menu_bar_one_keymap_changed_items
);
10592 defsubr (&Sevent_convert_list
);
10593 defsubr (&Sread_key_sequence
);
10594 defsubr (&Sread_key_sequence_vector
);
10595 defsubr (&Srecursive_edit
);
10597 defsubr (&Strack_mouse
);
10599 defsubr (&Sinput_pending_p
);
10600 defsubr (&Scommand_execute
);
10601 defsubr (&Srecent_keys
);
10602 defsubr (&Sthis_command_keys
);
10603 defsubr (&Sthis_command_keys_vector
);
10604 defsubr (&Sthis_single_command_keys
);
10605 defsubr (&Sthis_single_command_raw_keys
);
10606 defsubr (&Sreset_this_command_lengths
);
10607 defsubr (&Sclear_this_command_keys
);
10608 defsubr (&Ssuspend_emacs
);
10609 defsubr (&Sabort_recursive_edit
);
10610 defsubr (&Sexit_recursive_edit
);
10611 defsubr (&Srecursion_depth
);
10612 defsubr (&Stop_level
);
10613 defsubr (&Sdiscard_input
);
10614 defsubr (&Sopen_dribble_file
);
10615 defsubr (&Sset_input_mode
);
10616 defsubr (&Scurrent_input_mode
);
10617 defsubr (&Sexecute_extended_command
);
10619 DEFVAR_LISP ("last-command-char", &last_command_char
,
10620 doc
: /* Last input event that was part of a command. */);
10622 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10623 doc
: /* Last input event that was part of a command. */);
10625 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10626 doc
: /* Last input event in a command, except for mouse menu events.
10627 Mouse menus give back keys that don't look like mouse events;
10628 this variable holds the actual mouse event that led to the menu,
10629 so that you can determine whether the command was run by mouse or not. */);
10631 DEFVAR_LISP ("last-input-char", &last_input_char
,
10632 doc
: /* Last input event. */);
10634 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10635 doc
: /* Last input event. */);
10637 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10638 doc
: /* List of events to be read as the command input.
10639 These events are processed first, before actual keyboard input. */);
10640 Vunread_command_events
= Qnil
;
10642 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10643 doc
: /* If not -1, an object to be read as next command input event. */);
10645 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10646 doc
: /* List of events to be processed as input by input methods.
10647 These events are processed after `unread-command-events', but
10648 before actual keyboard input. */);
10649 Vunread_post_input_method_events
= Qnil
;
10651 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10652 doc
: /* List of events to be processed as input by input methods.
10653 These events are processed after `unread-command-events', but
10654 before actual keyboard input. */);
10655 Vunread_input_method_events
= Qnil
;
10657 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10658 doc
: /* Meta-prefix character code.
10659 Meta-foo as command input turns into this character followed by foo. */);
10660 XSETINT (meta_prefix_char
, 033);
10662 DEFVAR_KBOARD ("last-command", Vlast_command
,
10663 doc
: /* The last command executed.
10664 Normally a symbol with a function definition, but can be whatever was found
10665 in the keymap, or whatever the variable `this-command' was set to by that
10668 The value `mode-exit' is special; it means that the previous command
10669 read an event that told it to exit, and it did so and unread that event.
10670 In other words, the present command is the event that made the previous
10673 The value `kill-region' is special; it means that the previous command
10674 was a kill command. */);
10676 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10677 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10679 DEFVAR_LISP ("this-command", &Vthis_command
,
10680 doc
: /* The command now being executed.
10681 The command can set this variable; whatever is put here
10682 will be in `last-command' during the following command. */);
10683 Vthis_command
= Qnil
;
10685 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10686 doc
: /* If non-nil, the original command bound to the current key sequence.
10687 The value of `this-command' is the result of looking up the original
10688 command in the active keymaps. */);
10689 Vthis_original_command
= Qnil
;
10691 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10692 doc
: /* *Number of input events between auto-saves.
10693 Zero means disable autosaving due to number of characters typed. */);
10694 auto_save_interval
= 300;
10696 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10697 doc
: /* *Number of seconds idle time before auto-save.
10698 Zero or nil means disable auto-saving due to idleness.
10699 After auto-saving due to this many seconds of idle time,
10700 Emacs also does a garbage collection if that seems to be warranted. */);
10701 XSETFASTINT (Vauto_save_timeout
, 30);
10703 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10704 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10705 The value may be integer or floating point. */);
10706 Vecho_keystrokes
= make_number (1);
10708 DEFVAR_INT ("polling-period", &polling_period
,
10709 doc
: /* *Interval between polling for input during Lisp execution.
10710 The reason for polling is to make C-g work to stop a running program.
10711 Polling is needed only when using X windows and SIGIO does not work.
10712 Polling is automatically disabled in all other cases. */);
10713 polling_period
= 2;
10715 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10716 doc
: /* *Maximum time between mouse clicks to make a double-click.
10717 Measured in milliseconds. nil means disable double-click recognition;
10718 t means double-clicks have no time limit and are detected
10719 by position only. */);
10720 Vdouble_click_time
= make_number (500);
10722 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10723 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10724 On window-system frames, value is the number of pixels the mouse may have
10725 moved horizontally or vertically between two clicks to make a double-click.
10726 On non window-system frames, value is interpreted in units of 1/8 characters
10729 This variable is also the threshold for motion of the mouse
10730 to count as a drag. */);
10731 double_click_fuzz
= 3;
10733 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10734 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10735 inhibit_local_menu_bar_menus
= 0;
10737 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10738 doc
: /* Number of complete key sequences read as input so far.
10739 This includes key sequences read from keyboard macros.
10740 The number is effectively the number of interactive command invocations. */);
10741 num_input_keys
= 0;
10743 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10744 doc
: /* Number of input events read from the keyboard so far.
10745 This does not include events generated by keyboard macros. */);
10746 num_nonmacro_input_events
= 0;
10748 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10749 doc
: /* The frame in which the most recently read event occurred.
10750 If the last event came from a keyboard macro, this is set to `macro'. */);
10751 Vlast_event_frame
= Qnil
;
10753 /* This variable is set up in sysdep.c. */
10754 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10755 doc
: /* The ERASE character as set by the user with stty. */);
10757 DEFVAR_LISP ("help-char", &Vhelp_char
,
10758 doc
: /* Character to recognize as meaning Help.
10759 When it is read, do `(eval help-form)', and display result if it's a string.
10760 If the value of `help-form' is nil, this char can be read normally. */);
10761 XSETINT (Vhelp_char
, Ctl ('H'));
10763 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10764 doc
: /* List of input events to recognize as meaning Help.
10765 These work just like the value of `help-char' (see that). */);
10766 Vhelp_event_list
= Qnil
;
10768 DEFVAR_LISP ("help-form", &Vhelp_form
,
10769 doc
: /* Form to execute when character `help-char' is read.
10770 If the form returns a string, that string is displayed.
10771 If `help-form' is nil, the help char is not recognized. */);
10774 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10775 doc
: /* Command to run when `help-char' character follows a prefix key.
10776 This command is used only when there is no actual binding
10777 for that character after that prefix key. */);
10778 Vprefix_help_command
= Qnil
;
10780 DEFVAR_LISP ("top-level", &Vtop_level
,
10781 doc
: /* Form to evaluate when Emacs starts up.
10782 Useful to set before you dump a modified Emacs. */);
10785 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10786 doc
: /* Translate table for keyboard input, or nil.
10787 Each character is looked up in this string and the contents used instead.
10788 The value may be a string, a vector, or a char-table.
10789 If it is a string or vector of length N,
10790 character codes N and up are untranslated.
10791 In a vector or a char-table, an element which is nil means "no translation". */);
10792 Vkeyboard_translate_table
= Qnil
;
10794 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10795 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
10796 \(Even if the operating system has support for stopping a process.\) */);
10797 cannot_suspend
= 0;
10799 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10800 doc
: /* Non-nil means prompt with menus when appropriate.
10801 This is done when reading from a keymap that has a prompt string,
10802 for elements that have prompt strings.
10803 The menu is displayed on the screen
10804 if X menus were enabled at configuration
10805 time and the previous event was a mouse click prefix key.
10806 Otherwise, menu prompting uses the echo area. */);
10807 menu_prompting
= 1;
10809 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10810 doc
: /* Character to see next line of menu prompt.
10811 Type this character while in a menu prompt to rotate around the lines of it. */);
10812 XSETINT (menu_prompt_more_char
, ' ');
10814 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10815 doc
: /* A mask of additional modifier keys to use with every keyboard character.
10816 Emacs applies the modifiers of the character stored here to each keyboard
10817 character it reads. For example, after evaluating the expression
10818 (setq extra-keyboard-modifiers ?\\C-x)
10819 all input characters will have the control modifier applied to them.
10821 Note that the character ?\\C-@, equivalent to the integer zero, does
10822 not count as a control character; rather, it counts as a character
10823 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
10824 cancels any modification. */);
10825 extra_keyboard_modifiers
= 0;
10827 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10828 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
10829 The command loop sets this to nil before each command,
10830 and tests the value when the command returns.
10831 Buffer modification stores t in this variable. */);
10832 Vdeactivate_mark
= Qnil
;
10834 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10835 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
10836 Vcommand_hook_internal
= Qnil
;
10838 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10839 doc
: /* Normal hook run before each command is executed.
10840 If an unhandled error happens in running this hook,
10841 the hook value is set to nil, since otherwise the error
10842 might happen repeatedly and make Emacs nonfunctional. */);
10843 Vpre_command_hook
= Qnil
;
10845 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10846 doc
: /* Normal hook run after each command is executed.
10847 If an unhandled error happens in running this hook,
10848 the hook value is set to nil, since otherwise the error
10849 might happen repeatedly and make Emacs nonfunctional. */);
10850 Vpost_command_hook
= Qnil
;
10852 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10853 doc
: /* Normal hook run after each command is executed, if idle.
10854 Errors running the hook are caught and ignored. */);
10855 Vpost_command_idle_hook
= Qnil
;
10857 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10858 doc
: /* Delay time before running `post-command-idle-hook'.
10859 This is measured in microseconds. */);
10860 post_command_idle_delay
= 100000;
10863 DEFVAR_LISP ("echo-area-clear-hook", ...,
10864 doc
: /* Normal hook run when clearing the echo area. */);
10866 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10867 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
10869 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10870 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
10871 Vlucid_menu_bar_dirty_flag
= Qnil
;
10873 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10874 doc
: /* List of menu bar items to move to the end of the menu bar.
10875 The elements of the list are event types that may have menu bar bindings. */);
10876 Vmenu_bar_final_items
= Qnil
;
10878 DEFVAR_KBOARD ("overriding-terminal-local-map",
10879 Voverriding_terminal_local_map
,
10880 doc
: /* Per-terminal keymap that overrides all other local keymaps.
10881 If this variable is non-nil, it is used as a keymap instead of the
10882 buffer's local map, and the minor mode keymaps and text property keymaps.
10883 This variable is intended to let commands such as `universal-argument'
10884 set up a different keymap for reading the next command. */);
10886 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
10887 doc
: /* Keymap that overrides all other local keymaps.
10888 If this variable is non-nil, it is used as a keymap instead of the
10889 buffer's local map, and the minor mode keymaps and text property keymaps. */);
10890 Voverriding_local_map
= Qnil
;
10892 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
10893 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
10894 Otherwise, the menu bar continues to reflect the buffer's local map
10895 and the minor mode maps regardless of `overriding-local-map'. */);
10896 Voverriding_local_map_menu_flag
= Qnil
;
10898 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
10899 doc
: /* Keymap defining bindings for special events to execute at low level. */);
10900 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
10902 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
10903 doc
: /* *Non-nil means generate motion events for mouse motion. */);
10905 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
10906 doc
: /* Alist of system-specific X windows key symbols.
10907 Each element should have the form (N . SYMBOL) where N is the
10908 numeric keysym code (sans the \"system-specific\" bit 1<<28)
10909 and SYMBOL is its name. */);
10911 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
10912 doc
: /* List of deferred actions to be performed at a later time.
10913 The precise format isn't relevant here; we just check whether it is nil. */);
10914 Vdeferred_action_list
= Qnil
;
10916 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
10917 doc
: /* Function to call to handle deferred actions, after each command.
10918 This function is called with no arguments after each command
10919 whenever `deferred-action-list' is non-nil. */);
10920 Vdeferred_action_function
= Qnil
;
10922 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
10923 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
10924 The value can be a length of time to show the message for.
10925 If the value is non-nil and not a number, we wait 2 seconds. */);
10926 Vsuggest_key_bindings
= Qt
;
10928 DEFVAR_LISP ("timer-list", &Vtimer_list
,
10929 doc
: /* List of active absolute time timers in order of increasing time. */);
10930 Vtimer_list
= Qnil
;
10932 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
10933 doc
: /* List of active idle-time timers in order of increasing time. */);
10934 Vtimer_idle_list
= Qnil
;
10936 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
10937 doc
: /* If non-nil, the function that implements the current input method.
10938 It's called with one argument, a printing character that was just read.
10939 \(That means a character with code 040...0176.)
10940 Typically this function uses `read-event' to read additional events.
10941 When it does so, it should first bind `input-method-function' to nil
10942 so it will not be called recursively.
10944 The function should return a list of zero or more events
10945 to be used as input. If it wants to put back some events
10946 to be reconsidered, separately, by the input method,
10947 it can add them to the beginning of `unread-command-events'.
10949 The input method function can find in `input-method-previous-method'
10950 the previous echo area message.
10952 The input method function should refer to the variables
10953 `input-method-use-echo-area' and `input-method-exit-on-first-char'
10954 for guidance on what to do. */);
10955 Vinput_method_function
= Qnil
;
10957 DEFVAR_LISP ("input-method-previous-message",
10958 &Vinput_method_previous_message
,
10959 doc
: /* When `input-method-function' is called, hold the previous echo area message.
10960 This variable exists because `read-event' clears the echo area
10961 before running the input method. It is nil if there was no message. */);
10962 Vinput_method_previous_message
= Qnil
;
10964 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
10965 doc
: /* If non-nil, the function that implements the display of help.
10966 It's called with one argument, the help string to display. */);
10967 Vshow_help_function
= Qnil
;
10969 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
10970 doc
: /* If non-nil, suppress point adjustment after executing a command.
10972 After a command is executed, if point is moved into a region that has
10973 special properties (e.g. composition, display), we adjust point to
10974 the boundary of the region. But, several special commands sets this
10975 variable to non-nil, then we suppress the point adjustment.
10977 This variable is set to nil before reading a command, and is checked
10978 just after executing the command. */);
10979 Vdisable_point_adjustment
= Qnil
;
10981 DEFVAR_LISP ("global-disable-point-adjustment",
10982 &Vglobal_disable_point_adjustment
,
10983 doc
: /* *If non-nil, always suppress point adjustment.
10985 The default value is nil, in which case, point adjustment are
10986 suppressed only after special commands that set
10987 `disable-point-adjustment' (which see) to non-nil. */);
10988 Vglobal_disable_point_adjustment
= Qnil
;
10990 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
10991 doc
: /* Non-nil means updating menu bindings is allowed.
10992 A value of nil means menu bindings should not be updated.
10993 Used during Emacs' startup. */);
10994 update_menu_bindings
= 1;
10996 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
10997 doc
: /* *How long to display an echo-area message when the minibuffer is active.
10998 If the value is not a number, such messages don't time out. */);
10999 Vminibuffer_message_timeout
= make_number (2);
11003 keys_of_keyboard ()
11005 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11006 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11007 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11008 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11009 initial_define_key (meta_map
, 'x', "execute-extended-command");
11011 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11012 "handle-delete-frame");
11013 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11015 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11017 initial_define_lispy_key (Vspecial_event_map
, "select-window",
11018 "handle-select-window");
11019 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11020 "handle-save-session");