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 table to translate input characters. */
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
;
553 #if defined(WINDOWSNT) || defined(MAC_OSX)
554 Lisp_Object Qmouse_wheel
;
557 Lisp_Object Qlanguage_change
;
559 Lisp_Object Qdrag_n_drop
;
560 Lisp_Object Qsave_session
;
562 /* Lisp_Object Qmouse_movement; - also an event header */
564 /* Properties of event headers. */
565 Lisp_Object Qevent_kind
;
566 Lisp_Object Qevent_symbol_elements
;
568 /* menu item parts */
569 Lisp_Object Qmenu_alias
;
570 Lisp_Object Qmenu_enable
;
571 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
572 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
573 extern Lisp_Object Vdefine_key_rebound_commands
;
574 extern Lisp_Object Qmenu_item
;
576 /* An event header symbol HEAD may have a property named
577 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
578 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
579 mask of modifiers applied to it. If present, this is used to help
580 speed up parse_modifiers. */
581 Lisp_Object Qevent_symbol_element_mask
;
583 /* An unmodified event header BASE may have a property named
584 Qmodifier_cache, which is an alist mapping modifier masks onto
585 modified versions of BASE. If present, this helps speed up
587 Lisp_Object Qmodifier_cache
;
589 /* Symbols to use for parts of windows. */
590 Lisp_Object Qmode_line
;
591 Lisp_Object Qvertical_line
;
592 Lisp_Object Qvertical_scroll_bar
;
593 Lisp_Object Qmenu_bar
;
594 extern Lisp_Object Qleft_margin
, Qright_margin
;
596 Lisp_Object
recursive_edit_unwind (), command_loop ();
597 Lisp_Object
Fthis_command_keys ();
598 Lisp_Object Qextended_command_history
;
599 EMACS_TIME
timer_check ();
601 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
603 extern char *x_get_keysym_name ();
605 static void record_menu_key ();
607 Lisp_Object Qpolling_period
;
609 /* List of absolute timers. Appears in order of next scheduled event. */
610 Lisp_Object Vtimer_list
;
612 /* List of idle time timers. Appears in order of next scheduled event. */
613 Lisp_Object Vtimer_idle_list
;
615 /* Incremented whenever a timer is run. */
618 extern Lisp_Object Vprint_level
, Vprint_length
;
620 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
622 EMACS_TIME
*input_available_clear_time
;
624 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
625 Default is 1 if INTERRUPT_INPUT is defined. */
628 /* Nonzero while interrupts are temporarily deferred during redisplay. */
629 int interrupts_deferred
;
631 /* Nonzero means use ^S/^Q for flow control. */
634 /* Allow m- file to inhibit use of FIONREAD. */
635 #ifdef BROKEN_FIONREAD
639 /* We are unable to use interrupts if FIONREAD is not available,
640 so flush SIGIO so we won't try. */
647 /* If we support a window system, turn on the code to poll periodically
648 to detect C-g. It isn't actually used when doing interrupt input. */
649 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
650 #define POLL_FOR_INPUT
653 /* After a command is executed, if point is moved into a region that
654 has specific properties (e.g. composition, display), we adjust
655 point to the boundary of the region. But, if a command sets this
656 variable to non-nil, we suppress this point adjustment. This
657 variable is set to nil before reading a command. */
659 Lisp_Object Vdisable_point_adjustment
;
661 /* If non-nil, always disable point adjustment. */
663 Lisp_Object Vglobal_disable_point_adjustment
;
665 /* The time when Emacs started being idle. */
667 static EMACS_TIME timer_idleness_start_time
;
669 /* After Emacs stops being idle, this saves the last value
670 of timer_idleness_start_time from when it was idle. */
672 static EMACS_TIME timer_last_idleness_start_time
;
675 /* Global variable declarations. */
677 /* Function for init_keyboard to call with no args (if nonzero). */
678 void (*keyboard_init_hook
) ();
680 static int read_avail_input
P_ ((int));
681 static void get_input_pending
P_ ((int *, int));
682 static void get_filtered_input_pending
P_ ((int *, int, int));
683 static int readable_events
P_ ((int));
684 static int readable_filtered_events
P_ ((int, int));
685 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
686 Lisp_Object
, int *));
687 static Lisp_Object
read_char_x_menu_prompt ();
688 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
690 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
692 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
693 enum scroll_bar_part
,
694 Lisp_Object
, Lisp_Object
,
697 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
698 Lisp_Object
, char **,
699 Lisp_Object
*, unsigned));
700 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
701 static int parse_solitary_modifier
P_ ((Lisp_Object
));
702 static int parse_solitary_modifier ();
703 static void save_getcjmp
P_ ((jmp_buf));
704 static void save_getcjmp ();
705 static void restore_getcjmp
P_ ((jmp_buf));
706 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
707 static void clear_event
P_ ((struct input_event
*));
708 static void any_kboard_state
P_ ((void));
710 /* Nonzero means don't try to suspend even if the operating system seems
712 static int cannot_suspend
;
714 /* Install the string STR as the beginning of the string of echoing,
715 so that it serves as a prompt for the next character.
716 Also start echoing. */
722 current_kboard
->echo_string
= str
;
723 current_kboard
->echo_after_prompt
= SCHARS (str
);
727 /* Add C to the echo string, if echoing is going on.
728 C can be a character, which is printed prettily ("M-C-x" and all that
729 jazz), or a symbol, whose name is printed. */
735 if (current_kboard
->immediate_echo
)
737 int size
= KEY_DESCRIPTION_SIZE
+ 100;
738 char *buffer
= (char *) alloca (size
);
740 Lisp_Object echo_string
;
742 echo_string
= current_kboard
->echo_string
;
744 /* If someone has passed us a composite event, use its head symbol. */
749 ptr
= push_key_description (XINT (c
), ptr
, 1);
751 else if (SYMBOLP (c
))
753 Lisp_Object name
= SYMBOL_NAME (c
);
754 int nbytes
= SBYTES (name
);
756 if (size
- (ptr
- buffer
) < nbytes
)
758 int offset
= ptr
- buffer
;
759 size
= max (2 * size
, size
+ nbytes
);
760 buffer
= (char *) alloca (size
);
761 ptr
= buffer
+ offset
;
764 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
765 STRING_MULTIBYTE (name
), 1);
768 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
771 const char *text
= " (Type ? for further options)";
772 int len
= strlen (text
);
774 if (size
- (ptr
- buffer
) < len
)
776 int offset
= ptr
- buffer
;
778 buffer
= (char *) alloca (size
);
779 ptr
= buffer
+ offset
;
782 bcopy (text
, ptr
, len
);
786 /* Replace a dash from echo_dash with a space, otherwise
787 add a space at the end as a separator between keys. */
788 if (STRINGP (echo_string
)
789 && SCHARS (echo_string
) > 0)
791 Lisp_Object last_char
, idx
;
793 idx
= make_number (SCHARS (echo_string
) - 1);
794 last_char
= Faref (echo_string
, idx
);
796 if (XINT (last_char
) == '-')
797 Faset (echo_string
, idx
, make_number (' '));
799 echo_string
= concat2 (echo_string
, build_string (" "));
802 current_kboard
->echo_string
803 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
809 /* Temporarily add a dash to the end of the echo string if it's not
810 empty, so that it serves as a mini-prompt for the very next character. */
815 /* Do nothing if not echoing at all. */
816 if (NILP (current_kboard
->echo_string
))
819 if (!current_kboard
->immediate_echo
820 && SCHARS (current_kboard
->echo_string
) == 0)
823 /* Do nothing if we just printed a prompt. */
824 if (current_kboard
->echo_after_prompt
825 == SCHARS (current_kboard
->echo_string
))
828 /* Put a dash at the end of the buffer temporarily,
829 but make it go away when the next character is added. */
830 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
835 /* Display the current echo string, and begin echoing if not already
841 if (!current_kboard
->immediate_echo
)
844 current_kboard
->immediate_echo
= 1;
846 for (i
= 0; i
< this_command_key_count
; i
++)
849 c
= XVECTOR (this_command_keys
)->contents
[i
];
850 if (! (EVENT_HAS_PARAMETERS (c
)
851 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
858 message3_nolog (current_kboard
->echo_string
,
859 SBYTES (current_kboard
->echo_string
),
860 STRING_MULTIBYTE (current_kboard
->echo_string
));
863 /* Record in what buffer we echoed, and from which kboard. */
864 echo_message_buffer
= echo_area_buffer
[0];
865 echo_kboard
= current_kboard
;
867 if (waiting_for_input
&& !NILP (Vquit_flag
))
868 quit_throw_to_read_char ();
871 /* Turn off echoing, for the start of a new command. */
876 current_kboard
->immediate_echo
= 0;
877 current_kboard
->echo_after_prompt
= -1;
878 current_kboard
->echo_string
= Qnil
;
879 ok_to_echo_at_next_pause
= NULL
;
881 echo_message_buffer
= Qnil
;
884 /* Return the length of the current echo string. */
889 return (STRINGP (current_kboard
->echo_string
)
890 ? SCHARS (current_kboard
->echo_string
)
894 /* Truncate the current echo message to its first LEN chars.
895 This and echo_char get used by read_key_sequence when the user
896 switches frames while entering a key sequence. */
899 echo_truncate (nchars
)
902 if (STRINGP (current_kboard
->echo_string
))
903 current_kboard
->echo_string
904 = Fsubstring (current_kboard
->echo_string
,
905 make_number (0), make_number (nchars
));
906 truncate_echo_area (nchars
);
910 /* Functions for manipulating this_command_keys. */
912 add_command_key (key
)
915 /* If reset-this-command-length was called recently, obey it now.
916 See the doc string of that function for an explanation of why. */
917 if (before_command_restore_flag
)
919 this_command_key_count
= before_command_key_count_1
;
920 if (this_command_key_count
< this_single_command_key_start
)
921 this_single_command_key_start
= this_command_key_count
;
922 echo_truncate (before_command_echo_length_1
);
923 before_command_restore_flag
= 0;
926 if (this_command_key_count
>= ASIZE (this_command_keys
))
927 this_command_keys
= larger_vector (this_command_keys
,
928 2 * ASIZE (this_command_keys
),
931 AREF (this_command_keys
, this_command_key_count
) = key
;
932 ++this_command_key_count
;
939 int count
= SPECPDL_INDEX ();
942 if (command_loop_level
> 0)
944 specbind (Qstandard_output
, Qt
);
945 specbind (Qstandard_input
, Qt
);
948 #ifdef HAVE_X_WINDOWS
949 /* The command loop has started an hourglass timer, so we have to
950 cancel it here, otherwise it will fire because the recursive edit
951 can take some time. Do not check for display_hourglass_p here,
952 because it could already be nil. */
956 /* This function may have been called from a debugger called from
957 within redisplay, for instance by Edebugging a function called
958 from fontification-functions. We want to allow redisplay in
959 the debugging session.
961 The recursive edit is left with a `(throw exit ...)'. The `exit'
962 tag is not caught anywhere in redisplay, i.e. when we leave the
963 recursive edit, the original redisplay leading to the recursive
964 edit will be unwound. The outcome should therefore be safe. */
965 specbind (Qinhibit_redisplay
, Qnil
);
968 val
= command_loop ();
970 Fsignal (Qquit
, Qnil
);
971 /* Handle throw from read_minibuf when using minibuffer
972 while it's active but we're in another window. */
974 Fsignal (Qerror
, Fcons (val
, Qnil
));
976 return unbind_to (count
, Qnil
);
979 /* When an auto-save happens, record the "time", and don't do again soon. */
984 last_auto_save
= num_nonmacro_input_events
;
987 /* Make an auto save happen as soon as possible at command level. */
990 force_auto_save_soon ()
992 last_auto_save
= - auto_save_interval
- 1;
994 record_asynch_buffer_change ();
997 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
998 doc
: /* Invoke the editor command loop recursively.
999 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1000 that tells this function to return.
1001 Alternately, `(throw 'exit t)' makes this function signal an error.
1002 This function is called by the editor initialization to begin editing. */)
1005 int count
= SPECPDL_INDEX ();
1008 command_loop_level
++;
1009 update_mode_lines
= 1;
1011 if (command_loop_level
1012 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1013 buffer
= Fcurrent_buffer ();
1017 /* If we leave recursive_edit_1 below with a `throw' for instance,
1018 like it is done in the splash screen display, we have to
1019 make sure that we restore single_kboard as command_loop_1
1020 would have done if it were left normally. */
1021 record_unwind_protect (recursive_edit_unwind
,
1022 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1024 recursive_edit_1 ();
1025 return unbind_to (count
, Qnil
);
1029 recursive_edit_unwind (info
)
1032 if (BUFFERP (XCAR (info
)))
1033 Fset_buffer (XCAR (info
));
1035 if (NILP (XCDR (info
)))
1036 any_kboard_state ();
1038 single_kboard_state ();
1040 command_loop_level
--;
1041 update_mode_lines
= 1;
1050 #if 0 /* Theory: if there's anything in Vunread_command_events,
1051 it will right away be read by read_key_sequence,
1052 and then if we do switch KBOARDS, it will go into the side
1053 queue then. So we don't need to do anything special here -- rms. */
1054 if (CONSP (Vunread_command_events
))
1056 current_kboard
->kbd_queue
1057 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1058 current_kboard
->kbd_queue_has_data
= 1;
1060 Vunread_command_events
= Qnil
;
1066 /* Switch to the single-kboard state, making current_kboard
1067 the only KBOARD from which further input is accepted. */
1070 single_kboard_state ()
1077 /* Maintain a stack of kboards, so other parts of Emacs
1078 can switch temporarily to the kboard of a given frame
1079 and then revert to the previous status. */
1084 struct kboard_stack
*next
;
1087 static struct kboard_stack
*kboard_stack
;
1090 push_frame_kboard (f
)
1094 struct kboard_stack
*p
1095 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1097 p
->next
= kboard_stack
;
1098 p
->kboard
= current_kboard
;
1101 current_kboard
= FRAME_KBOARD (f
);
1109 struct kboard_stack
*p
= kboard_stack
;
1110 current_kboard
= p
->kboard
;
1111 kboard_stack
= p
->next
;
1116 /* Handle errors that are not handled at inner levels
1117 by printing an error message and returning to the editor command loop. */
1123 Lisp_Object old_level
, old_length
;
1124 char macroerror
[50];
1126 #ifdef HAVE_X_WINDOWS
1127 if (display_hourglass_p
)
1128 cancel_hourglass ();
1131 if (!NILP (executing_macro
))
1133 if (executing_macro_iterations
== 1)
1134 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1136 sprintf (macroerror
, "After %d kbd macro iterations: ",
1137 executing_macro_iterations
);
1142 Vstandard_output
= Qt
;
1143 Vstandard_input
= Qt
;
1144 Vexecuting_macro
= Qnil
;
1145 executing_macro
= Qnil
;
1146 current_kboard
->Vprefix_arg
= Qnil
;
1147 current_kboard
->Vlast_prefix_arg
= Qnil
;
1150 /* Avoid unquittable loop if data contains a circular list. */
1151 old_level
= Vprint_level
;
1152 old_length
= Vprint_length
;
1153 XSETFASTINT (Vprint_level
, 10);
1154 XSETFASTINT (Vprint_length
, 10);
1155 cmd_error_internal (data
, macroerror
);
1156 Vprint_level
= old_level
;
1157 Vprint_length
= old_length
;
1161 Vinhibit_quit
= Qnil
;
1163 any_kboard_state ();
1166 return make_number (0);
1169 /* Take actions on handling an error. DATA is the data that describes
1172 CONTEXT is a C-string containing ASCII characters only which
1173 describes the context in which the error happened. If we need to
1174 generalize CONTEXT to allow multibyte characters, make it a Lisp
1178 cmd_error_internal (data
, context
)
1183 int kill_emacs_p
= 0;
1184 struct frame
*sf
= SELECTED_FRAME ();
1188 clear_message (1, 0);
1190 /* If the window system or terminal frame hasn't been initialized
1191 yet, or we're not interactive, it's best to dump this message out
1192 to stderr and exit. */
1193 if (!sf
->glyphs_initialized_p
1194 /* This is the case of the frame dumped with Emacs, when we're
1195 running under a window system. */
1196 || (!NILP (Vwindow_system
)
1197 && !inhibit_window_system
1198 && FRAME_TERMCAP_P (sf
))
1201 stream
= Qexternal_debugging_output
;
1207 message_log_maybe_newline ();
1212 /* The immediate context is not interesting for Quits,
1213 since they are asyncronous. */
1214 if (EQ (XCAR (data
), Qquit
))
1215 Vsignaling_function
= Qnil
;
1217 print_error_message (data
, stream
, context
, Vsignaling_function
);
1219 Vsignaling_function
= Qnil
;
1221 /* If the window system or terminal frame hasn't been initialized
1222 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1226 Fkill_emacs (make_number (-1));
1230 Lisp_Object
command_loop_1 ();
1231 Lisp_Object
command_loop_2 ();
1232 Lisp_Object
top_level_1 ();
1234 /* Entry to editor-command-loop.
1235 This level has the catches for exiting/returning to editor command loop.
1236 It returns nil to exit recursive edit, t to abort it. */
1241 if (command_loop_level
> 0 || minibuf_level
> 0)
1244 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1245 executing_macro
= Qnil
;
1251 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1252 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1253 executing_macro
= Qnil
;
1255 /* End of file in -batch run causes exit here. */
1261 /* Here we catch errors in execution of commands within the
1262 editing loop, and reenter the editing loop.
1263 When there is an error, cmd_error runs and returns a non-nil
1264 value to us. A value of nil means that command_loop_1 itself
1265 returned due to end of file (or end of kbd macro). */
1270 register Lisp_Object val
;
1273 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1274 while (!NILP (val
));
1282 return Feval (Vtop_level
);
1288 /* On entry to the outer level, run the startup file */
1289 if (!NILP (Vtop_level
))
1290 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1291 else if (!NILP (Vpurify_flag
))
1292 message ("Bare impure Emacs (standard Lisp code not loaded)");
1294 message ("Bare Emacs (standard Lisp code not loaded)");
1298 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1299 doc
: /* Exit all recursive editing levels. */)
1302 #ifdef HAVE_X_WINDOWS
1303 if (display_hourglass_p
)
1304 cancel_hourglass ();
1306 return Fthrow (Qtop_level
, Qnil
);
1309 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1310 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1313 if (command_loop_level
> 0 || minibuf_level
> 0)
1314 Fthrow (Qexit
, Qnil
);
1316 error ("No recursive edit is in progress");
1320 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1321 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1324 if (command_loop_level
> 0 || minibuf_level
> 0)
1327 error ("No recursive edit is in progress");
1331 /* This is the actual command reading loop,
1332 sans error-handling encapsulation. */
1334 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1336 void safe_run_hooks
P_ ((Lisp_Object
));
1337 static void adjust_point_for_property
P_ ((int));
1345 Lisp_Object keybuf
[30];
1349 struct buffer
*prev_buffer
= NULL
;
1351 int was_locked
= single_kboard
;
1354 current_kboard
->Vprefix_arg
= Qnil
;
1355 current_kboard
->Vlast_prefix_arg
= Qnil
;
1356 Vdeactivate_mark
= Qnil
;
1357 waiting_for_input
= 0;
1361 this_command_key_count
= 0;
1362 this_single_command_key_start
= 0;
1364 if (NILP (Vmemory_full
))
1366 /* Make sure this hook runs after commands that get errors and
1367 throw to top level. */
1368 /* Note that the value cell will never directly contain nil
1369 if the symbol is a local variable. */
1370 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1371 safe_run_hooks (Qpost_command_hook
);
1373 /* If displaying a message, resize the echo area window to fit
1374 that message's size exactly. */
1375 if (!NILP (echo_area_buffer
[0]))
1376 resize_echo_area_exactly ();
1378 if (!NILP (Vdeferred_action_list
))
1379 call0 (Vdeferred_action_function
);
1381 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1383 if (NILP (Vunread_command_events
)
1384 && NILP (Vunread_input_method_events
)
1385 && NILP (Vunread_post_input_method_events
)
1386 && NILP (Vexecuting_macro
)
1387 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1388 safe_run_hooks (Qpost_command_idle_hook
);
1392 Vmemory_full
= Qnil
;
1394 /* Do this after running Vpost_command_hook, for consistency. */
1395 current_kboard
->Vlast_command
= Vthis_command
;
1396 current_kboard
->Vreal_last_command
= real_this_command
;
1400 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1403 /* Make sure the current window's buffer is selected. */
1404 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1405 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1407 /* Display any malloc warning that just came out. Use while because
1408 displaying one warning can cause another. */
1410 while (pending_malloc_warning
)
1411 display_malloc_warning ();
1415 Vdeactivate_mark
= Qnil
;
1417 /* If minibuffer on and echo area in use,
1418 wait a short time and redraw minibuffer. */
1421 && !NILP (echo_area_buffer
[0])
1422 && EQ (minibuf_window
, echo_area_window
)
1423 && NUMBERP (Vminibuffer_message_timeout
))
1425 /* Bind inhibit-quit to t so that C-g gets read in
1426 rather than quitting back to the minibuffer. */
1427 int count
= SPECPDL_INDEX ();
1428 specbind (Qinhibit_quit
, Qt
);
1430 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1431 /* Clear the echo area. */
1433 safe_run_hooks (Qecho_area_clear_hook
);
1435 unbind_to (count
, Qnil
);
1437 /* If a C-g came in before, treat it as input now. */
1438 if (!NILP (Vquit_flag
))
1441 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1446 alloca (0); /* Cause a garbage collection now */
1447 /* Since we can free the most stuff here. */
1448 #endif /* C_ALLOCA */
1451 /* Select the frame that the last event came from. Usually,
1452 switch-frame events will take care of this, but if some lisp
1453 code swallows a switch-frame event, we'll fix things up here.
1454 Is this a good idea? */
1455 if (FRAMEP (internal_last_event_frame
)
1456 && !EQ (internal_last_event_frame
, selected_frame
))
1457 Fselect_frame (internal_last_event_frame
, Qnil
);
1459 /* If it has changed current-menubar from previous value,
1460 really recompute the menubar from the value. */
1461 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1462 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1463 call0 (Qrecompute_lucid_menubar
);
1465 before_command_key_count
= this_command_key_count
;
1466 before_command_echo_length
= echo_length ();
1468 Vthis_command
= Qnil
;
1469 real_this_command
= Qnil
;
1471 /* Read next key sequence; i gets its length. */
1472 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1475 /* A filter may have run while we were reading the input. */
1476 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1478 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1479 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1483 /* Now we have read a key sequence of length I,
1484 or else I is 0 and we found end of file. */
1486 if (i
== 0) /* End of file -- happens only in */
1487 return Qnil
; /* a kbd macro, at the end. */
1488 /* -1 means read_key_sequence got a menu that was rejected.
1489 Just loop around and read another command. */
1493 this_command_key_count
= 0;
1494 this_single_command_key_start
= 0;
1498 last_command_char
= keybuf
[i
- 1];
1500 /* If the previous command tried to force a specific window-start,
1501 forget about that, in case this command moves point far away
1502 from that position. But also throw away beg_unchanged and
1503 end_unchanged information in that case, so that redisplay will
1504 update the whole window properly. */
1505 if (!NILP (XWINDOW (selected_window
)->force_start
))
1508 XWINDOW (selected_window
)->force_start
= Qnil
;
1509 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1510 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1513 cmd
= read_key_sequence_cmd
;
1514 if (!NILP (Vexecuting_macro
))
1516 if (!NILP (Vquit_flag
))
1518 Vexecuting_macro
= Qt
;
1519 QUIT
; /* Make some noise. */
1520 /* Will return since macro now empty. */
1524 /* Do redisplay processing after this command except in special
1525 cases identified below. */
1526 prev_buffer
= current_buffer
;
1527 prev_modiff
= MODIFF
;
1528 last_point_position
= PT
;
1529 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1531 /* By default, we adjust point to a boundary of a region that
1532 has such a property that should be treated intangible
1533 (e.g. composition, display). But, some commands will set
1534 this variable differently. */
1535 Vdisable_point_adjustment
= Qnil
;
1537 /* Process filters and timers may have messed with deactivate-mark.
1538 reset it before we execute the command. */
1539 Vdeactivate_mark
= Qnil
;
1541 /* Remap command through active keymaps */
1542 Vthis_original_command
= cmd
;
1546 if (cmd1
= Fremap_command (cmd
), !NILP (cmd1
))
1550 /* Execute the command. */
1552 Vthis_command
= cmd
;
1553 real_this_command
= cmd
;
1554 /* Note that the value cell will never directly contain nil
1555 if the symbol is a local variable. */
1556 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1557 safe_run_hooks (Qpre_command_hook
);
1559 if (NILP (Vthis_command
))
1561 /* nil means key is undefined. */
1563 current_kboard
->defining_kbd_macro
= Qnil
;
1564 update_mode_lines
= 1;
1565 current_kboard
->Vprefix_arg
= Qnil
;
1569 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1571 /* In case we jump to directly_done. */
1572 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1574 /* Recognize some common commands in common situations and
1575 do them directly. */
1576 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1578 struct Lisp_Char_Table
*dp
1579 = window_display_table (XWINDOW (selected_window
));
1580 lose
= FETCH_CHAR (PT_BYTE
);
1583 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1584 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1585 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1586 && (lose
>= 0x20 && lose
< 0x7f)))
1587 : (lose
>= 0x20 && lose
< 0x7f))
1588 /* To extract the case of continuation on
1589 wide-column characters. */
1590 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1591 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1593 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1595 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1597 && !windows_or_buffers_changed
1598 && EQ (current_buffer
->selective_display
, Qnil
)
1599 && !detect_input_pending ()
1600 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1601 && NILP (Vexecuting_macro
))
1602 direct_output_forward_char (1);
1605 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1607 struct Lisp_Char_Table
*dp
1608 = window_display_table (XWINDOW (selected_window
));
1610 lose
= FETCH_CHAR (PT_BYTE
);
1612 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1613 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1614 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1615 && (lose
>= 0x20 && lose
< 0x7f)))
1616 : (lose
>= 0x20 && lose
< 0x7f))
1617 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1619 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1621 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1623 && !windows_or_buffers_changed
1624 && EQ (current_buffer
->selective_display
, Qnil
)
1625 && !detect_input_pending ()
1626 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1627 && NILP (Vexecuting_macro
))
1628 direct_output_forward_char (-1);
1631 else if (EQ (Vthis_command
, Qself_insert_command
)
1632 /* Try this optimization only on character keystrokes. */
1633 && CHAR_VALID_P (last_command_char
, 0))
1636 translate_char (Vtranslation_table_for_input
,
1637 XINT (last_command_char
), 0, 0, 0);
1639 if (NILP (Vexecuting_macro
)
1640 && !EQ (minibuf_window
, selected_window
))
1642 if (!nonundocount
|| nonundocount
>= 20)
1650 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1652 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1654 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1656 || MODIFF
<= SAVE_MODIFF
1657 || windows_or_buffers_changed
1658 || !EQ (current_buffer
->selective_display
, Qnil
)
1659 || detect_input_pending ()
1660 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1661 || !NILP (Vexecuting_macro
));
1663 value
= internal_self_insert (c
, 0);
1668 /* VALUE == 1 when AFTER-CHANGE functions are
1669 installed which is the case most of the time
1670 because FONT-LOCK installs one. */
1671 if (!lose
&& !value
)
1672 direct_output_for_insert (c
);
1677 /* Here for a command that isn't executed directly */
1679 #ifdef HAVE_X_WINDOWS
1680 if (display_hourglass_p
1681 && NILP (Vexecuting_macro
))
1686 if (NILP (current_kboard
->Vprefix_arg
))
1688 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1690 #ifdef HAVE_X_WINDOWS
1691 /* Do not check display_hourglass_p here, because
1692 Fcommand_execute could change it, but we should cancel
1693 hourglass cursor anyway.
1694 But don't cancel the hourglass within a macro
1695 just because a command in the macro finishes. */
1696 if (NILP (Vexecuting_macro
))
1697 cancel_hourglass ();
1701 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1703 /* Note that the value cell will never directly contain nil
1704 if the symbol is a local variable. */
1705 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1706 safe_run_hooks (Qpost_command_hook
);
1708 /* If displaying a message, resize the echo area window to fit
1709 that message's size exactly. */
1710 if (!NILP (echo_area_buffer
[0]))
1711 resize_echo_area_exactly ();
1713 if (!NILP (Vdeferred_action_list
))
1714 safe_run_hooks (Qdeferred_action_function
);
1716 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1718 if (NILP (Vunread_command_events
)
1719 && NILP (Vunread_input_method_events
)
1720 && NILP (Vunread_post_input_method_events
)
1721 && NILP (Vexecuting_macro
)
1722 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1723 safe_run_hooks (Qpost_command_idle_hook
);
1726 /* If there is a prefix argument,
1727 1) We don't want Vlast_command to be ``universal-argument''
1728 (that would be dumb), so don't set Vlast_command,
1729 2) we want to leave echoing on so that the prefix will be
1730 echoed as part of this key sequence, so don't call
1732 3) we want to leave this_command_key_count non-zero, so that
1733 read_char will realize that it is re-reading a character, and
1734 not echo it a second time.
1736 If the command didn't actually create a prefix arg,
1737 but is merely a frame event that is transparent to prefix args,
1738 then the above doesn't apply. */
1739 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1741 current_kboard
->Vlast_command
= Vthis_command
;
1742 current_kboard
->Vreal_last_command
= real_this_command
;
1744 this_command_key_count
= 0;
1745 this_single_command_key_start
= 0;
1748 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1750 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1752 /* We could also call `deactivate'mark'. */
1753 if (EQ (Vtransient_mark_mode
, Qlambda
))
1754 Vtransient_mark_mode
= Qnil
;
1757 current_buffer
->mark_active
= Qnil
;
1758 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1761 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1762 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1767 if (current_buffer
== prev_buffer
1768 && last_point_position
!= PT
1769 && NILP (Vdisable_point_adjustment
)
1770 && NILP (Vglobal_disable_point_adjustment
))
1771 adjust_point_for_property (last_point_position
);
1773 /* Install chars successfully executed in kbd macro. */
1775 if (!NILP (current_kboard
->defining_kbd_macro
)
1776 && NILP (current_kboard
->Vprefix_arg
))
1777 finalize_kbd_macro_chars ();
1781 any_kboard_state ();
1786 extern Lisp_Object Qcomposition
, Qdisplay
;
1788 /* Adjust point to a boundary of a region that has such a property
1789 that should be treated intangible. For the moment, we check
1790 `composition', `display' and `invisible' properties.
1791 LAST_PT is the last position of point. */
1794 adjust_point_for_property (last_pt
)
1798 Lisp_Object val
, overlay
, tmp
;
1799 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1801 while (check_composition
|| check_display
|| check_invisible
)
1803 if (check_composition
1804 && PT
> BEGV
&& PT
< ZV
1805 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1806 && COMPOSITION_VALID_P (beg
, end
, val
)
1807 && beg
< PT
/* && end > PT <- It's always the case. */
1808 && (last_pt
<= beg
|| last_pt
>= end
))
1810 SET_PT (PT
< last_pt
? beg
: end
);
1812 check_invisible
= 1;
1814 check_composition
= 0;
1816 && PT
> BEGV
&& PT
< ZV
1817 && !NILP (val
= get_char_property_and_overlay
1818 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1819 && display_prop_intangible_p (val
)
1820 && (!OVERLAYP (overlay
)
1821 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1822 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1823 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1824 && beg
< PT
/* && end > PT <- It's always the case. */
1825 && (last_pt
<= beg
|| last_pt
>= end
))
1827 SET_PT (PT
< last_pt
? beg
: end
);
1828 check_composition
= 1;
1829 check_invisible
= 1;
1833 && PT
> BEGV
&& PT
< ZV
1834 && !NILP (val
= get_char_property_and_overlay
1835 (make_number (PT
), Qinvisible
, Qnil
, &overlay
))
1836 && TEXT_PROP_MEANS_INVISIBLE (val
)
1837 && (tmp
= Fprevious_single_char_property_change
1838 (make_number (PT
+ 1), Qinvisible
, Qnil
, Qnil
),
1839 beg
= NILP (tmp
) ? BEGV
: XFASTINT (tmp
),
1841 && (tmp
= Fnext_single_char_property_change
1842 (make_number (PT
), Qinvisible
, Qnil
, Qnil
),
1843 end
= NILP (tmp
) ? ZV
: XFASTINT (tmp
),
1844 (last_pt
<= beg
|| last_pt
>= end
)))
1846 SET_PT (PT
< last_pt
? beg
: end
);
1847 check_composition
= 1;
1850 check_invisible
= 0;
1854 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1857 safe_run_hooks_1 (hook
)
1860 return call1 (Vrun_hooks
, Vinhibit_quit
);
1863 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1866 safe_run_hooks_error (data
)
1869 return Fset (Vinhibit_quit
, Qnil
);
1872 /* If we get an error while running the hook, cause the hook variable
1873 to be nil. Also inhibit quits, so that C-g won't cause the hook
1874 to mysteriously evaporate. */
1877 safe_run_hooks (hook
)
1880 int count
= SPECPDL_INDEX ();
1881 specbind (Qinhibit_quit
, hook
);
1883 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1885 unbind_to (count
, Qnil
);
1889 /* Number of seconds between polling for input. This is a Lisp
1890 variable that can be bound. */
1892 EMACS_INT polling_period
;
1894 /* Nonzero means polling for input is temporarily suppressed. */
1896 int poll_suppress_count
;
1898 /* Asynchronous timer for polling. */
1900 struct atimer
*poll_timer
;
1903 #ifdef POLL_FOR_INPUT
1905 /* Poll for input, so what we catch a C-g if it comes in. This
1906 function is called from x_make_frame_visible, see comment
1912 if (interrupt_input_blocked
== 0
1913 && !waiting_for_input
)
1914 read_avail_input (0);
1917 /* Timer callback function for poll_timer. TIMER is equal to
1921 poll_for_input (timer
)
1922 struct atimer
*timer
;
1924 if (poll_suppress_count
== 0)
1925 poll_for_input_1 ();
1928 #endif /* POLL_FOR_INPUT */
1930 /* Begin signals to poll for input, if they are appropriate.
1931 This function is called unconditionally from various places. */
1936 #ifdef POLL_FOR_INPUT
1937 if (read_socket_hook
&& !interrupt_input
)
1939 /* Turn alarm handling on unconditionally. It might have
1940 been turned off in process.c. */
1941 turn_on_atimers (1);
1943 /* If poll timer doesn't exist, are we need one with
1944 a different interval, start a new one. */
1945 if (poll_timer
== NULL
1946 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1948 EMACS_TIME interval
;
1951 cancel_atimer (poll_timer
);
1953 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1954 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1955 poll_for_input
, NULL
);
1958 /* Let the timer's callback function poll for input
1959 if this becomes zero. */
1960 --poll_suppress_count
;
1965 /* Nonzero if we are using polling to handle input asynchronously. */
1968 input_polling_used ()
1970 #ifdef POLL_FOR_INPUT
1971 return read_socket_hook
&& !interrupt_input
;
1977 /* Turn off polling. */
1982 #ifdef POLL_FOR_INPUT
1983 if (read_socket_hook
&& !interrupt_input
)
1984 ++poll_suppress_count
;
1988 /* Set the value of poll_suppress_count to COUNT
1989 and start or stop polling accordingly. */
1992 set_poll_suppress_count (count
)
1995 #ifdef POLL_FOR_INPUT
1996 if (count
== 0 && poll_suppress_count
!= 0)
1998 poll_suppress_count
= 1;
2001 else if (count
!= 0 && poll_suppress_count
== 0)
2005 poll_suppress_count
= count
;
2009 /* Bind polling_period to a value at least N.
2010 But don't decrease it. */
2013 bind_polling_period (n
)
2016 #ifdef POLL_FOR_INPUT
2017 int new = polling_period
;
2022 stop_other_atimers (poll_timer
);
2024 specbind (Qpolling_period
, make_number (new));
2025 /* Start a new alarm with the new period. */
2030 /* Apply the control modifier to CHARACTER. */
2036 /* Save the upper bits here. */
2037 int upper
= c
& ~0177;
2041 /* Everything in the columns containing the upper-case letters
2042 denotes a control character. */
2043 if (c
>= 0100 && c
< 0140)
2047 /* Set the shift modifier for a control char
2048 made from a shifted letter. But only for letters! */
2049 if (oc
>= 'A' && oc
<= 'Z')
2050 c
|= shift_modifier
;
2053 /* The lower-case letters denote control characters too. */
2054 else if (c
>= 'a' && c
<= 'z')
2057 /* Include the bits for control and shift
2058 only if the basic ASCII code can't indicate them. */
2062 /* Replace the high bits. */
2063 c
|= (upper
& ~ctrl_modifier
);
2068 /* Display help echo in the echo area.
2070 HELP a string means display that string, HELP nil means clear the
2071 help echo. If HELP is a function, call it with OBJECT and POS as
2072 arguments; the function should return a help string or nil for
2073 none. For all other types of HELP evaluate it to obtain a string.
2075 WINDOW is the window in which the help was generated, if any.
2076 It is nil if not in a window.
2078 If OBJECT is a buffer, POS is the position in the buffer where the
2079 `help-echo' text property was found.
2081 If OBJECT is an overlay, that overlay has a `help-echo' property,
2082 and POS is the position in the overlay's buffer under the mouse.
2084 If OBJECT is a string (an overlay string or a string displayed with
2085 the `display' property). POS is the position in that string under
2088 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2089 echo overwrites a keystroke echo currently displayed in the echo
2092 Note: this function may only be called with HELP nil or a string
2093 from X code running asynchronously. */
2096 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2097 Lisp_Object help
, window
, object
, pos
;
2098 int ok_to_overwrite_keystroke_echo
;
2100 if (!NILP (help
) && !STRINGP (help
))
2102 if (FUNCTIONP (help
))
2104 Lisp_Object args
[4];
2109 help
= safe_call (4, args
);
2112 help
= safe_eval (help
);
2114 if (!STRINGP (help
))
2118 if (STRINGP (help
) || NILP (help
))
2120 if (!NILP (Vshow_help_function
))
2121 call1 (Vshow_help_function
, help
);
2122 else if (/* Don't overwrite minibuffer contents. */
2123 !MINI_WINDOW_P (XWINDOW (selected_window
))
2124 /* Don't overwrite a keystroke echo. */
2125 && (NILP (echo_message_buffer
)
2126 || ok_to_overwrite_keystroke_echo
)
2127 /* Don't overwrite a prompt. */
2128 && !cursor_in_echo_area
)
2132 int count
= SPECPDL_INDEX ();
2134 if (!help_echo_showing_p
)
2135 Vpre_help_message
= current_message ();
2137 specbind (Qmessage_truncate_lines
, Qt
);
2138 message3_nolog (help
, SBYTES (help
),
2139 STRING_MULTIBYTE (help
));
2140 unbind_to (count
, Qnil
);
2142 else if (STRINGP (Vpre_help_message
))
2144 message3_nolog (Vpre_help_message
,
2145 SBYTES (Vpre_help_message
),
2146 STRING_MULTIBYTE (Vpre_help_message
));
2147 Vpre_help_message
= Qnil
;
2153 help_echo_showing_p
= STRINGP (help
);
2159 /* Input of single characters from keyboard */
2161 Lisp_Object
print_help ();
2162 static Lisp_Object
kbd_buffer_get_event ();
2163 static void record_char ();
2166 static jmp_buf wrong_kboard_jmpbuf
;
2169 #define STOP_POLLING \
2170 do { if (! polling_stopped_here) stop_polling (); \
2171 polling_stopped_here = 1; } while (0)
2173 #define RESUME_POLLING \
2174 do { if (polling_stopped_here) start_polling (); \
2175 polling_stopped_here = 0; } while (0)
2177 /* read a character from the keyboard; call the redisplay if needed */
2178 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2179 -1 means do not do redisplay, but do do autosaving.
2182 /* The arguments MAPS and NMAPS are for menu prompting.
2183 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2185 PREV_EVENT is the previous input event, or nil if we are reading
2186 the first event of a key sequence (or not reading a key sequence).
2187 If PREV_EVENT is t, that is a "magic" value that says
2188 not to run input methods, but in other respects to act as if
2189 not reading a key sequence.
2191 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2192 if we used a mouse menu to read the input, or zero otherwise. If
2193 USED_MOUSE_MENU is null, we don't dereference it.
2195 Value is t if we showed a menu and the user rejected it. */
2198 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2202 Lisp_Object prev_event
;
2203 int *used_mouse_menu
;
2205 volatile Lisp_Object c
;
2207 jmp_buf local_getcjmp
;
2209 volatile int key_already_recorded
= 0;
2210 Lisp_Object tem
, save
;
2211 volatile Lisp_Object previous_echo_area_message
;
2212 volatile Lisp_Object also_record
;
2213 volatile int reread
;
2214 struct gcpro gcpro1
, gcpro2
;
2215 EMACS_TIME last_idle_start
;
2216 int polling_stopped_here
= 0;
2220 before_command_key_count
= this_command_key_count
;
2221 before_command_echo_length
= echo_length ();
2223 previous_echo_area_message
= Qnil
;
2225 GCPRO2 (c
, previous_echo_area_message
);
2230 if (CONSP (Vunread_post_input_method_events
))
2232 c
= XCAR (Vunread_post_input_method_events
);
2233 Vunread_post_input_method_events
2234 = XCDR (Vunread_post_input_method_events
);
2236 /* Undo what read_char_x_menu_prompt did when it unread
2237 additional keys returned by Fx_popup_menu. */
2239 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2247 if (unread_command_char
!= -1)
2249 XSETINT (c
, unread_command_char
);
2250 unread_command_char
= -1;
2256 if (CONSP (Vunread_command_events
))
2258 c
= XCAR (Vunread_command_events
);
2259 Vunread_command_events
= XCDR (Vunread_command_events
);
2261 /* Undo what read_char_x_menu_prompt did when it unread
2262 additional keys returned by Fx_popup_menu. */
2264 && EQ (XCDR (c
), Qdisabled
)
2265 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2268 /* If the queued event is something that used the mouse,
2269 set used_mouse_menu accordingly. */
2271 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2272 *used_mouse_menu
= 1;
2275 goto reread_for_input_method
;
2278 if (CONSP (Vunread_input_method_events
))
2280 c
= XCAR (Vunread_input_method_events
);
2281 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2283 /* Undo what read_char_x_menu_prompt did when it unread
2284 additional keys returned by Fx_popup_menu. */
2286 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2290 goto reread_for_input_method
;
2293 /* If there is no function key translated before
2294 reset-this-command-lengths takes effect, forget about it. */
2295 before_command_restore_flag
= 0;
2297 if (!NILP (Vexecuting_macro
))
2299 /* We set this to Qmacro; since that's not a frame, nobody will
2300 try to switch frames on us, and the selected window will
2303 Since this event came from a macro, it would be misleading to
2304 leave internal_last_event_frame set to wherever the last
2305 real event came from. Normally, a switch-frame event selects
2306 internal_last_event_frame after each command is read, but
2307 events read from a macro should never cause a new frame to be
2309 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2311 /* Exit the macro if we are at the end.
2312 Also, some things replace the macro with t
2313 to force an early exit. */
2314 if (EQ (Vexecuting_macro
, Qt
)
2315 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2321 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2322 if (STRINGP (Vexecuting_macro
)
2323 && (XINT (c
) & 0x80))
2324 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2326 executing_macro_index
++;
2331 if (!NILP (unread_switch_frame
))
2333 c
= unread_switch_frame
;
2334 unread_switch_frame
= Qnil
;
2336 /* This event should make it into this_command_keys, and get echoed
2337 again, so we do not set `reread'. */
2341 /* if redisplay was requested */
2342 if (commandflag
>= 0)
2344 /* If there is pending input, process any events which are not
2345 user-visible, such as X selection_request events. */
2347 || detect_input_pending_run_timers (0))
2348 swallow_events (0); /* may clear input_pending */
2350 /* Redisplay if no pending input. */
2351 while (!input_pending
)
2353 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2354 redisplay_preserve_echo_area (5);
2359 /* Normal case: no input arrived during redisplay. */
2362 /* Input arrived and pre-empted redisplay.
2363 Process any events which are not user-visible. */
2365 /* If that cleared input_pending, try again to redisplay. */
2369 /* Message turns off echoing unless more keystrokes turn it on again.
2371 The code in 20.x for the condition was
2373 1. echo_area_glyphs && *echo_area_glyphs
2374 2. && echo_area_glyphs != current_kboard->echobuf
2375 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2377 (1) means there's a current message displayed
2379 (2) means it's not the message from echoing from the current
2382 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2383 is set to a non-null value. This is done in read_char and it is
2384 set to echo_area_glyphs after a call to echo_char. That means
2385 ok_to_echo_at_next_pause is either null or
2386 current_kboard->echobuf with the appropriate current_kboard at
2389 So, condition (3) means in clear text ok_to_echo_at_next_pause
2390 must be either null, or the current message isn't from echoing at
2391 all, or it's from echoing from a different kboard than the
2394 if (/* There currently is something in the echo area. */
2395 !NILP (echo_area_buffer
[0])
2396 && (/* And it's either not from echoing. */
2397 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2398 /* Or it's an echo from a different kboard. */
2399 || echo_kboard
!= current_kboard
2400 /* Or we explicitly allow overwriting whatever there is. */
2401 || ok_to_echo_at_next_pause
== NULL
))
2406 /* Try reading a character via menu prompting in the minibuf.
2407 Try this before the sit-for, because the sit-for
2408 would do the wrong thing if we are supposed to do
2409 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2410 after a mouse event so don't try a minibuf menu. */
2412 if (nmaps
> 0 && INTERACTIVE
2413 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2414 /* Don't bring up a menu if we already have another event. */
2415 && NILP (Vunread_command_events
)
2416 && unread_command_char
< 0
2417 && !detect_input_pending_run_timers (0))
2419 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2422 key_already_recorded
= 1;
2427 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2428 We will do that below, temporarily for short sections of code,
2429 when appropriate. local_getcjmp must be in effect
2430 around any call to sit_for or kbd_buffer_get_event;
2431 it *must not* be in effect when we call redisplay. */
2433 if (_setjmp (local_getcjmp
))
2435 XSETINT (c
, quit_char
);
2436 internal_last_event_frame
= selected_frame
;
2437 Vlast_event_frame
= internal_last_event_frame
;
2438 /* If we report the quit char as an event,
2439 don't do so more than once. */
2440 if (!NILP (Vinhibit_quit
))
2445 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2446 if (kb
!= current_kboard
)
2448 Lisp_Object link
= kb
->kbd_queue
;
2449 /* We shouldn't get here if we were in single-kboard mode! */
2454 while (CONSP (XCDR (link
)))
2456 if (!NILP (XCDR (link
)))
2460 kb
->kbd_queue
= Fcons (c
, Qnil
);
2462 XSETCDR (link
, Fcons (c
, Qnil
));
2463 kb
->kbd_queue_has_data
= 1;
2464 current_kboard
= kb
;
2465 /* This is going to exit from read_char
2466 so we had better get rid of this frame's stuff. */
2468 longjmp (wrong_kboard_jmpbuf
, 1);
2475 timer_start_idle ();
2477 /* If in middle of key sequence and minibuffer not active,
2478 start echoing if enough time elapses. */
2480 if (minibuf_level
== 0
2481 && !current_kboard
->immediate_echo
2482 && this_command_key_count
> 0
2484 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2485 && NILP (Fzerop (Vecho_keystrokes
))
2486 && (/* No message. */
2487 NILP (echo_area_buffer
[0])
2488 /* Or empty message. */
2489 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2490 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2491 /* Or already echoing from same kboard. */
2492 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2493 /* Or not echoing before and echoing allowed. */
2494 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2498 /* After a mouse event, start echoing right away.
2499 This is because we are probably about to display a menu,
2500 and we don't want to delay before doing so. */
2501 if (EVENT_HAS_PARAMETERS (prev_event
))
2506 double duration
= extract_float (Vecho_keystrokes
);
2507 sec
= (int) duration
;
2508 usec
= (duration
- sec
) * 1000000;
2509 save_getcjmp (save_jump
);
2510 restore_getcjmp (local_getcjmp
);
2511 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2512 restore_getcjmp (save_jump
);
2514 && ! CONSP (Vunread_command_events
))
2519 /* Maybe auto save due to number of keystrokes. */
2521 if (commandflag
!= 0
2522 && auto_save_interval
> 0
2523 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2524 && !detect_input_pending_run_timers (0))
2526 Fdo_auto_save (Qnil
, Qnil
);
2527 /* Hooks can actually change some buffers in auto save. */
2531 /* Try reading using an X menu.
2532 This is never confused with reading using the minibuf
2533 because the recursive call of read_char in read_char_minibuf_menu_prompt
2534 does not pass on any keymaps. */
2536 if (nmaps
> 0 && INTERACTIVE
2537 && !NILP (prev_event
)
2538 && EVENT_HAS_PARAMETERS (prev_event
)
2539 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2540 && !EQ (XCAR (prev_event
), Qtool_bar
)
2541 /* Don't bring up a menu if we already have another event. */
2542 && NILP (Vunread_command_events
)
2543 && unread_command_char
< 0)
2545 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2547 /* Now that we have read an event, Emacs is not idle. */
2553 /* Maybe autosave and/or garbage collect due to idleness. */
2555 if (INTERACTIVE
&& NILP (c
))
2557 int delay_level
, buffer_size
;
2559 /* Slow down auto saves logarithmically in size of current buffer,
2560 and garbage collect while we're at it. */
2561 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2562 last_non_minibuf_size
= Z
- BEG
;
2563 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2565 while (buffer_size
> 64)
2566 delay_level
++, buffer_size
-= buffer_size
>> 2;
2567 if (delay_level
< 4) delay_level
= 4;
2568 /* delay_level is 4 for files under around 50k, 7 at 100k,
2569 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2571 /* Auto save if enough time goes by without input. */
2572 if (commandflag
!= 0
2573 && num_nonmacro_input_events
> last_auto_save
2574 && INTEGERP (Vauto_save_timeout
)
2575 && XINT (Vauto_save_timeout
) > 0)
2579 save_getcjmp (save_jump
);
2580 restore_getcjmp (local_getcjmp
);
2581 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2583 restore_getcjmp (save_jump
);
2586 && ! CONSP (Vunread_command_events
))
2588 Fdo_auto_save (Qnil
, Qnil
);
2590 /* If we have auto-saved and there is still no input
2591 available, garbage collect if there has been enough
2592 consing going on to make it worthwhile. */
2593 if (!detect_input_pending_run_timers (0)
2594 && consing_since_gc
> gc_cons_threshold
/ 2)
2595 Fgarbage_collect ();
2602 /* If this has become non-nil here, it has been set by a timer
2603 or sentinel or filter. */
2604 if (CONSP (Vunread_command_events
))
2606 c
= XCAR (Vunread_command_events
);
2607 Vunread_command_events
= XCDR (Vunread_command_events
);
2610 /* Read something from current KBOARD's side queue, if possible. */
2614 if (current_kboard
->kbd_queue_has_data
)
2616 if (!CONSP (current_kboard
->kbd_queue
))
2618 c
= XCAR (current_kboard
->kbd_queue
);
2619 current_kboard
->kbd_queue
2620 = XCDR (current_kboard
->kbd_queue
);
2621 if (NILP (current_kboard
->kbd_queue
))
2622 current_kboard
->kbd_queue_has_data
= 0;
2623 input_pending
= readable_events (0);
2624 if (EVENT_HAS_PARAMETERS (c
)
2625 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2626 internal_last_event_frame
= XCAR (XCDR (c
));
2627 Vlast_event_frame
= internal_last_event_frame
;
2632 /* If current_kboard's side queue is empty check the other kboards.
2633 If one of them has data that we have not yet seen here,
2634 switch to it and process the data waiting for it.
2636 Note: if the events queued up for another kboard
2637 have already been seen here, and therefore are not a complete command,
2638 the kbd_queue_has_data field is 0, so we skip that kboard here.
2639 That's to avoid an infinite loop switching between kboards here. */
2640 if (NILP (c
) && !single_kboard
)
2643 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2644 if (kb
->kbd_queue_has_data
)
2646 current_kboard
= kb
;
2647 /* This is going to exit from read_char
2648 so we had better get rid of this frame's stuff. */
2650 longjmp (wrong_kboard_jmpbuf
, 1);
2659 /* Finally, we read from the main queue,
2660 and if that gives us something we can't use yet, we put it on the
2661 appropriate side queue and try again. */
2667 /* Actually read a character, waiting if necessary. */
2668 save_getcjmp (save_jump
);
2669 restore_getcjmp (local_getcjmp
);
2670 timer_start_idle ();
2671 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2672 restore_getcjmp (save_jump
);
2675 if (! NILP (c
) && (kb
!= current_kboard
))
2677 Lisp_Object link
= kb
->kbd_queue
;
2680 while (CONSP (XCDR (link
)))
2682 if (!NILP (XCDR (link
)))
2686 kb
->kbd_queue
= Fcons (c
, Qnil
);
2688 XSETCDR (link
, Fcons (c
, Qnil
));
2689 kb
->kbd_queue_has_data
= 1;
2693 current_kboard
= kb
;
2694 /* This is going to exit from read_char
2695 so we had better get rid of this frame's stuff. */
2697 longjmp (wrong_kboard_jmpbuf
, 1);
2702 /* Terminate Emacs in batch mode if at eof. */
2703 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2704 Fkill_emacs (make_number (1));
2708 /* Add in any extra modifiers, where appropriate. */
2709 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2710 || ((extra_keyboard_modifiers
& 0177) < ' '
2711 && (extra_keyboard_modifiers
& 0177) != 0))
2712 XSETINT (c
, make_ctrl_char (XINT (c
)));
2714 /* Transfer any other modifier bits directly from
2715 extra_keyboard_modifiers to c. Ignore the actual character code
2716 in the low 16 bits of extra_keyboard_modifiers. */
2717 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2722 /* Record the last idle start time so that we can reset it
2723 should the next event read be a help-echo. */
2724 last_idle_start
= timer_idleness_start_time
;
2730 if (commandflag
>= 0
2731 && !input_pending
&& !detect_input_pending_run_timers (0))
2739 /* Buffer switch events are only for internal wakeups
2740 so don't show them to the user.
2741 Also, don't record a key if we already did. */
2742 if (BUFFERP (c
) || key_already_recorded
)
2745 /* Process special events within read_char
2746 and loop around to read another event. */
2749 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2754 int was_locked
= single_kboard
;
2756 last_input_char
= c
;
2757 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2759 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2760 /* We stopped being idle for this event; undo that. This
2761 prevents automatic window selection (under
2762 mouse_autoselect_window from acting as a real input event, for
2763 example banishing the mouse under mouse-avoidance-mode. */
2764 timer_idleness_start_time
= last_idle_start
;
2766 /* Resume allowing input from any kboard, if that was true before. */
2768 any_kboard_state ();
2773 /* Handle things that only apply to characters. */
2776 /* If kbd_buffer_get_event gave us an EOF, return that. */
2780 if ((STRINGP (Vkeyboard_translate_table
)
2781 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2782 || (VECTORP (Vkeyboard_translate_table
)
2783 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2784 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2785 && CHAR_VALID_P (XINT (c
), 0)))
2788 d
= Faref (Vkeyboard_translate_table
, c
);
2789 /* nil in keyboard-translate-table means no translation. */
2795 /* If this event is a mouse click in the menu bar,
2796 return just menu-bar for now. Modify the mouse click event
2797 so we won't do this twice, then queue it up. */
2798 if (EVENT_HAS_PARAMETERS (c
)
2800 && CONSP (EVENT_START (c
))
2801 && CONSP (XCDR (EVENT_START (c
))))
2805 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2806 /* Handle menu-bar events:
2807 insert the dummy prefix event `menu-bar'. */
2808 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2810 /* Change menu-bar to (menu-bar) as the event "position". */
2811 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2814 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2819 /* Store these characters into recent_keys, the dribble file if any,
2820 and the keyboard macro being defined, if any. */
2822 if (! NILP (also_record
))
2823 record_char (also_record
);
2825 /* Wipe the echo area.
2826 But first, if we are about to use an input method,
2827 save the echo area contents for it to refer to. */
2829 && ! NILP (Vinput_method_function
)
2830 && (unsigned) XINT (c
) >= ' '
2831 && (unsigned) XINT (c
) != 127
2832 && (unsigned) XINT (c
) < 256)
2834 previous_echo_area_message
= Fcurrent_message ();
2835 Vinput_method_previous_message
= previous_echo_area_message
;
2838 /* Now wipe the echo area, except for help events which do their
2839 own stuff with the echo area. */
2841 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2842 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2844 if (!NILP (echo_area_buffer
[0]))
2845 safe_run_hooks (Qecho_area_clear_hook
);
2846 clear_message (1, 0);
2849 reread_for_input_method
:
2851 /* Pass this to the input method, if appropriate. */
2853 && ! NILP (Vinput_method_function
)
2854 /* Don't run the input method within a key sequence,
2855 after the first event of the key sequence. */
2856 && NILP (prev_event
)
2857 && (unsigned) XINT (c
) >= ' '
2858 && (unsigned) XINT (c
) != 127
2859 && (unsigned) XINT (c
) < 256)
2863 struct gcpro gcpro1
;
2864 int count
= SPECPDL_INDEX ();
2866 /* Save the echo status. */
2867 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2868 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2869 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2871 if (before_command_restore_flag
)
2873 this_command_key_count
= before_command_key_count_1
;
2874 if (this_command_key_count
< this_single_command_key_start
)
2875 this_single_command_key_start
= this_command_key_count
;
2876 echo_truncate (before_command_echo_length_1
);
2877 before_command_restore_flag
= 0;
2880 /* Save the this_command_keys status. */
2881 key_count
= this_command_key_count
;
2884 keys
= Fcopy_sequence (this_command_keys
);
2889 /* Clear out this_command_keys. */
2890 this_command_key_count
= 0;
2892 /* Now wipe the echo area. */
2893 if (!NILP (echo_area_buffer
[0]))
2894 safe_run_hooks (Qecho_area_clear_hook
);
2895 clear_message (1, 0);
2898 /* If we are not reading a key sequence,
2899 never use the echo area. */
2902 specbind (Qinput_method_use_echo_area
, Qt
);
2905 /* Call the input method. */
2906 tem
= call1 (Vinput_method_function
, c
);
2908 tem
= unbind_to (count
, tem
);
2910 /* Restore the saved echoing state
2911 and this_command_keys state. */
2912 this_command_key_count
= key_count
;
2914 this_command_keys
= keys
;
2917 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2918 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2919 if (saved_immediate_echo
)
2924 /* The input method can return no events. */
2927 /* Bring back the previous message, if any. */
2928 if (! NILP (previous_echo_area_message
))
2929 message_with_string ("%s", previous_echo_area_message
, 0);
2932 /* It returned one event or more. */
2934 Vunread_post_input_method_events
2935 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2940 /* Display help if not echoing. */
2941 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2943 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
2944 Lisp_Object help
, object
, position
, window
, tem
;
2946 tem
= Fcdr (XCDR (c
));
2949 window
= Fcar (tem
);
2951 object
= Fcar (tem
);
2953 position
= Fcar (tem
);
2955 show_help_echo (help
, window
, object
, position
, 0);
2957 /* We stopped being idle for this event; undo that. */
2958 timer_idleness_start_time
= last_idle_start
;
2962 if (this_command_key_count
== 0 || ! reread
)
2964 before_command_key_count
= this_command_key_count
;
2965 before_command_echo_length
= echo_length ();
2967 /* Don't echo mouse motion events. */
2968 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2969 && NILP (Fzerop (Vecho_keystrokes
))
2970 && ! (EVENT_HAS_PARAMETERS (c
)
2971 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2974 if (! NILP (also_record
))
2975 echo_char (also_record
);
2976 /* Once we reread a character, echoing can happen
2977 the next time we pause to read a new one. */
2978 ok_to_echo_at_next_pause
= current_kboard
;
2981 /* Record this character as part of the current key. */
2982 add_command_key (c
);
2983 if (! NILP (also_record
))
2984 add_command_key (also_record
);
2987 last_input_char
= c
;
2990 /* Process the help character specially if enabled */
2991 if (!NILP (Vhelp_form
) && help_char_p (c
))
2994 count
= SPECPDL_INDEX ();
2996 record_unwind_protect (Fset_window_configuration
,
2997 Fcurrent_window_configuration (Qnil
));
2999 tem0
= Feval (Vhelp_form
);
3001 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3005 c
= read_char (0, 0, 0, Qnil
, 0);
3006 while (BUFFERP (c
));
3007 /* Remove the help from the frame */
3008 unbind_to (count
, Qnil
);
3011 if (EQ (c
, make_number (040)))
3015 c
= read_char (0, 0, 0, Qnil
, 0);
3016 while (BUFFERP (c
));
3025 /* Record a key that came from a mouse menu.
3026 Record it for echoing, for this-command-keys, and so on. */
3032 /* Wipe the echo area. */
3033 clear_message (1, 0);
3037 before_command_key_count
= this_command_key_count
;
3038 before_command_echo_length
= echo_length ();
3040 /* Don't echo mouse motion events. */
3041 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3042 && NILP (Fzerop (Vecho_keystrokes
)))
3046 /* Once we reread a character, echoing can happen
3047 the next time we pause to read a new one. */
3048 ok_to_echo_at_next_pause
= 0;
3051 /* Record this character as part of the current key. */
3052 add_command_key (c
);
3054 /* Re-reading in the middle of a command */
3055 last_input_char
= c
;
3059 /* Return 1 if should recognize C as "the help character". */
3067 if (EQ (c
, Vhelp_char
))
3069 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3070 if (EQ (c
, XCAR (tail
)))
3075 /* Record the input event C in various ways. */
3083 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3085 /* To avoid filling recent_keys with help-echo and mouse-movement
3086 events, we filter out repeated help-echo events, only store the
3087 first and last in a series of mouse-movement events, and don't
3088 store repeated help-echo events which are only separated by
3089 mouse-movement events. */
3091 Lisp_Object ev1
, ev2
, ev3
;
3094 if ((ix1
= recent_keys_index
- 1) < 0)
3095 ix1
= NUM_RECENT_KEYS
- 1;
3096 ev1
= AREF (recent_keys
, ix1
);
3098 if ((ix2
= ix1
- 1) < 0)
3099 ix2
= NUM_RECENT_KEYS
- 1;
3100 ev2
= AREF (recent_keys
, ix2
);
3102 if ((ix3
= ix2
- 1) < 0)
3103 ix3
= NUM_RECENT_KEYS
- 1;
3104 ev3
= AREF (recent_keys
, ix3
);
3106 if (EQ (XCAR (c
), Qhelp_echo
))
3108 /* Don't record `help-echo' in recent_keys unless it shows some help
3109 message, and a different help than the previously recorded
3111 Lisp_Object help
, last_help
;
3113 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3114 if (!STRINGP (help
))
3116 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3117 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3119 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3120 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3121 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3123 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3124 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3125 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3126 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3129 else if (EQ (XCAR (c
), Qmouse_movement
))
3131 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3132 So additional mouse movement events replace the last element. */
3133 Lisp_Object last_window
, window
;
3135 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3136 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3137 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3138 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3139 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3141 ASET (recent_keys
, ix1
, c
);
3147 store_kbd_macro_char (c
);
3152 ASET (recent_keys
, recent_keys_index
, c
);
3153 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3154 recent_keys_index
= 0;
3156 else if (recorded
< 0)
3158 /* We need to remove one or two events from recent_keys.
3159 To do this, we simply put nil at those events and move the
3160 recent_keys_index backwards over those events. Usually,
3161 users will never see those nil events, as they will be
3162 overwritten by the command keys entered to see recent_keys
3165 while (recorded
++ < 0 && total_keys
> 0)
3167 if (total_keys
< NUM_RECENT_KEYS
)
3169 if (--recent_keys_index
< 0)
3170 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3171 ASET (recent_keys
, recent_keys_index
, Qnil
);
3175 num_nonmacro_input_events
++;
3177 /* Write c to the dribble file. If c is a lispy event, write
3178 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3179 If you, dear reader, have a better idea, you've got the source. :-) */
3184 if (XUINT (c
) < 0x100)
3185 putc (XINT (c
), dribble
);
3187 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3191 Lisp_Object dribblee
;
3193 /* If it's a structured event, take the event header. */
3194 dribblee
= EVENT_HEAD (c
);
3196 if (SYMBOLP (dribblee
))
3198 putc ('<', dribble
);
3199 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3200 SBYTES (SYMBOL_NAME (dribblee
)),
3202 putc ('>', dribble
);
3214 struct buffer
*old
= current_buffer
;
3215 Fprinc (object
, Qnil
);
3216 set_buffer_internal (XBUFFER (Vstandard_output
));
3217 call0 (intern ("help-mode"));
3218 set_buffer_internal (old
);
3222 /* Copy out or in the info on where C-g should throw to.
3223 This is used when running Lisp code from within get_char,
3224 in case get_char is called recursively.
3225 See read_process_output. */
3231 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3235 restore_getcjmp (temp
)
3238 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3243 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3244 of this function. */
3247 tracking_off (old_value
)
3248 Lisp_Object old_value
;
3250 do_mouse_tracking
= old_value
;
3251 if (NILP (old_value
))
3253 /* Redisplay may have been preempted because there was input
3254 available, and it assumes it will be called again after the
3255 input has been processed. If the only input available was
3256 the sort that we have just disabled, then we need to call
3258 if (!readable_events (1))
3260 redisplay_preserve_echo_area (6);
3261 get_input_pending (&input_pending
, 1);
3267 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3268 doc
: /* Evaluate BODY with mouse movement events enabled.
3269 Within a `track-mouse' form, mouse motion generates input events that
3270 you can read with `read-event'.
3271 Normally, mouse motion is ignored.
3272 usage: (track-mouse BODY ...) */)
3276 int count
= SPECPDL_INDEX ();
3279 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3281 do_mouse_tracking
= Qt
;
3283 val
= Fprogn (args
);
3284 return unbind_to (count
, val
);
3287 /* If mouse has moved on some frame, return one of those frames.
3288 Return 0 otherwise. */
3293 Lisp_Object tail
, frame
;
3295 FOR_EACH_FRAME (tail
, frame
)
3297 if (XFRAME (frame
)->mouse_moved
)
3298 return XFRAME (frame
);
3304 #endif /* HAVE_MOUSE */
3306 /* Low level keyboard/mouse input.
3307 kbd_buffer_store_event places events in kbd_buffer, and
3308 kbd_buffer_get_event retrieves them. */
3310 /* Return true iff there are any events in the queue that read-char
3311 would return. If this returns false, a read-char would block. */
3313 readable_filtered_events (do_timers_now
, filter_events
)
3318 timer_check (do_timers_now
);
3320 /* If the buffer contains only FOCUS_IN_EVENT events,
3321 and FILTER_EVENTS is nonzero, report it as empty. */
3322 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3324 int have_live_event
= 1;
3328 struct input_event
*event
;
3330 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3334 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3337 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3339 if (event
== kbd_store_ptr
)
3340 have_live_event
= 0;
3343 if (have_live_event
) return 1;
3347 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3352 if (current_kboard
->kbd_queue_has_data
)
3358 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3359 if (kb
->kbd_queue_has_data
)
3365 /* Return true iff there are any events in the queue that read-char
3366 would return. If this returns false, a read-char would block. */
3368 readable_events (do_timers_now
)
3371 return readable_filtered_events (do_timers_now
, 0);
3374 /* Set this for debugging, to have a way to get out */
3379 event_to_kboard (event
)
3380 struct input_event
*event
;
3383 frame
= event
->frame_or_window
;
3385 frame
= XCAR (frame
);
3386 else if (WINDOWP (frame
))
3387 frame
= WINDOW_FRAME (XWINDOW (frame
));
3389 /* There are still some events that don't set this field.
3390 For now, just ignore the problem.
3391 Also ignore dead frames here. */
3392 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3395 return FRAME_KBOARD (XFRAME (frame
));
3399 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3402 kbd_buffer_store_event (event
)
3403 register struct input_event
*event
;
3405 if (event
->kind
== NO_EVENT
)
3408 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3410 register int c
= event
->code
& 0377;
3412 if (event
->modifiers
& ctrl_modifier
)
3413 c
= make_ctrl_char (c
);
3415 c
|= (event
->modifiers
3416 & (meta_modifier
| alt_modifier
3417 | hyper_modifier
| super_modifier
));
3421 static SIGTYPE interrupt_signal
P_ ((int));
3424 struct input_event
*sp
;
3427 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3428 kb
!= current_kboard
))
3431 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3432 Fcons (make_number (c
), Qnil
));
3433 kb
->kbd_queue_has_data
= 1;
3434 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3436 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3439 if (event_to_kboard (sp
) == kb
)
3441 sp
->kind
= NO_EVENT
;
3442 sp
->frame_or_window
= Qnil
;
3450 /* If this results in a quit_char being returned to Emacs as
3451 input, set Vlast_event_frame properly. If this doesn't
3452 get returned to Emacs as an event, the next event read
3453 will set Vlast_event_frame again, so this is safe to do. */
3457 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3459 focus
= event
->frame_or_window
;
3460 internal_last_event_frame
= focus
;
3461 Vlast_event_frame
= focus
;
3464 last_event_timestamp
= event
->timestamp
;
3465 interrupt_signal (0 /* dummy */);
3469 if (c
&& c
== stop_character
)
3475 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3476 Just ignore the second one. */
3477 else if (event
->kind
== BUFFER_SWITCH_EVENT
3478 && kbd_fetch_ptr
!= kbd_store_ptr
3479 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3482 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3483 kbd_store_ptr
= kbd_buffer
;
3485 /* Don't let the very last slot in the buffer become full,
3486 since that would make the two pointers equal,
3487 and that is indistinguishable from an empty buffer.
3488 Discard the event if it would fill the last slot. */
3489 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3493 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3494 prone to assign individual members for other events, in case
3495 the input_event structure is changed. --2000-07-13, gerd. */
3496 struct input_event
*sp
= kbd_store_ptr
;
3497 sp
->kind
= event
->kind
;
3498 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3500 /* We must not use the ordinary copying code for this case,
3501 since `part' is an enum and copying it might not copy enough
3503 bcopy (event
, (char *) sp
, sizeof (*event
));
3508 sp
->code
= event
->code
;
3509 sp
->part
= event
->part
;
3510 sp
->frame_or_window
= event
->frame_or_window
;
3511 sp
->arg
= event
->arg
;
3512 sp
->modifiers
= event
->modifiers
;
3515 sp
->timestamp
= event
->timestamp
;
3518 *kbd_store_ptr
= *event
;
3521 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3522 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3523 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3529 /* Generate HELP_EVENT input_events in BUFP which has room for
3530 SIZE events. If there's not enough room in BUFP, ignore this
3533 HELP is the help form.
3535 FRAME is the frame on which the help is generated. OBJECT is the
3536 Lisp object where the help was found (a buffer, a string, an
3537 overlay, or nil if neither from a string nor from a buffer. POS is
3538 the position within OBJECT where the help was found.
3540 Value is the number of input_events generated. */
3543 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3544 struct input_event
*bufp
;
3546 Lisp_Object help
, frame
, object
, window
;
3551 bufp
->kind
= HELP_EVENT
;
3552 bufp
->frame_or_window
= frame
;
3554 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3563 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3566 kbd_buffer_store_help_event (frame
, help
)
3567 Lisp_Object frame
, help
;
3569 struct input_event event
;
3571 event
.kind
= HELP_EVENT
;
3572 event
.frame_or_window
= frame
;
3577 kbd_buffer_store_event (&event
);
3581 /* Discard any mouse events in the event buffer by setting them to
3584 discard_mouse_events ()
3586 struct input_event
*sp
;
3587 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3589 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3592 if (sp
->kind
== MOUSE_CLICK_EVENT
3594 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3596 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3598 sp
->kind
= NO_EVENT
;
3604 /* Return non-zero if there are any real events waiting in the event
3605 buffer, not counting `NO_EVENT's.
3607 If DISCARD is non-zero, discard NO_EVENT events at the front of
3608 the input queue, possibly leaving the input queue empty if there
3609 are no real input events. */
3612 kbd_buffer_events_waiting (discard
)
3615 struct input_event
*sp
;
3617 for (sp
= kbd_fetch_ptr
;
3618 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3621 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3628 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3632 /* Clear input event EVENT. */
3636 struct input_event
*event
;
3638 int idx
= 2 * (event
- kbd_buffer
);
3639 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3640 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3641 event
->kind
= NO_EVENT
;
3645 /* Read one event from the event buffer, waiting if necessary.
3646 The value is a Lisp object representing the event.
3647 The value is nil for an event that should be ignored,
3648 or that was handled here.
3649 We always read and discard one event. */
3652 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3654 int *used_mouse_menu
;
3663 *kbp
= current_kboard
;
3667 /* Wait until there is input available. */
3670 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3673 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3677 /* If the quit flag is set, then read_char will return
3678 quit_char, so that counts as "available input." */
3679 if (!NILP (Vquit_flag
))
3680 quit_throw_to_read_char ();
3682 /* One way or another, wait until input is available; then, if
3683 interrupt handlers have not read it, read it now. */
3686 wait_for_kbd_input ();
3688 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3692 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3695 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3699 Lisp_Object minus_one
;
3701 XSETINT (minus_one
, -1);
3702 wait_reading_process_input (0, 0, minus_one
, 1);
3704 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3705 /* Pass 1 for EXPECT since we just waited to have input. */
3706 read_avail_input (1);
3708 #endif /* not VMS */
3711 if (CONSP (Vunread_command_events
))
3714 first
= XCAR (Vunread_command_events
);
3715 Vunread_command_events
= XCDR (Vunread_command_events
);
3716 *kbp
= current_kboard
;
3720 /* At this point, we know that there is a readable event available
3721 somewhere. If the event queue is empty, then there must be a
3722 mouse movement enabled and available. */
3723 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3725 struct input_event
*event
;
3727 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3731 last_event_timestamp
= event
->timestamp
;
3734 *kbp
= event_to_kboard (event
);
3736 *kbp
= current_kboard
; /* Better than returning null ptr? */
3738 *kbp
= &the_only_kboard
;
3743 /* These two kinds of events get special handling
3744 and don't actually appear to the command loop.
3745 We return nil for them. */
3746 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3749 struct input_event copy
;
3751 /* Remove it from the buffer before processing it,
3752 since otherwise swallow_events will see it
3753 and process it again. */
3755 kbd_fetch_ptr
= event
+ 1;
3756 input_pending
= readable_events (0);
3757 x_handle_selection_request (©
);
3759 /* We're getting selection request events, but we don't have
3765 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3768 struct input_event copy
;
3770 /* Remove it from the buffer before processing it. */
3772 kbd_fetch_ptr
= event
+ 1;
3773 input_pending
= readable_events (0);
3774 x_handle_selection_clear (©
);
3776 /* We're getting selection request events, but we don't have
3781 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3782 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3784 /* Make an event (delete-frame (FRAME)). */
3785 obj
= Fcons (event
->frame_or_window
, Qnil
);
3786 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3787 kbd_fetch_ptr
= event
+ 1;
3790 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3791 else if (event
->kind
== ICONIFY_EVENT
)
3793 /* Make an event (iconify-frame (FRAME)). */
3794 obj
= Fcons (event
->frame_or_window
, Qnil
);
3795 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3796 kbd_fetch_ptr
= event
+ 1;
3798 else if (event
->kind
== DEICONIFY_EVENT
)
3800 /* Make an event (make-frame-visible (FRAME)). */
3801 obj
= Fcons (event
->frame_or_window
, Qnil
);
3802 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3803 kbd_fetch_ptr
= event
+ 1;
3806 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3808 /* The value doesn't matter here; only the type is tested. */
3809 XSETBUFFER (obj
, current_buffer
);
3810 kbd_fetch_ptr
= event
+ 1;
3812 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
3813 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3815 kbd_fetch_ptr
= event
+ 1;
3816 input_pending
= readable_events (0);
3817 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3818 x_activate_menubar (XFRAME (event
->frame_or_window
));
3822 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3824 /* Make an event (language-change (FRAME CHARSET LCID)). */
3825 obj
= Fcons (event
->modifiers
, Qnil
);
3826 obj
= Fcons (event
->code
, obj
);
3827 obj
= Fcons (event
->frame_or_window
, obj
);
3828 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3829 kbd_fetch_ptr
= event
+ 1;
3832 else if (event
->kind
== SAVE_SESSION_EVENT
)
3834 obj
= Fcons (Qsave_session
, Qnil
);
3835 kbd_fetch_ptr
= event
+ 1;
3837 /* Just discard these, by returning nil.
3838 With MULTI_KBOARD, these events are used as placeholders
3839 when we need to randomly delete events from the queue.
3840 (They shouldn't otherwise be found in the buffer,
3841 but on some machines it appears they do show up
3842 even without MULTI_KBOARD.) */
3843 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3844 mouse events during a popup-menu call. */
3845 else if (event
->kind
== NO_EVENT
)
3846 kbd_fetch_ptr
= event
+ 1;
3847 else if (event
->kind
== HELP_EVENT
)
3849 Lisp_Object object
, position
, help
, frame
, window
;
3851 frame
= event
->frame_or_window
;
3852 object
= event
->arg
;
3853 position
= make_number (event
->code
);
3856 clear_event (event
);
3858 kbd_fetch_ptr
= event
+ 1;
3859 if (!WINDOWP (window
))
3861 obj
= Fcons (Qhelp_echo
,
3862 list5 (frame
, help
, window
, object
, position
));
3864 else if (event
->kind
== FOCUS_IN_EVENT
)
3866 /* Notification of a FocusIn event. The frame receiving the
3867 focus is in event->frame_or_window. Generate a
3868 switch-frame event if necessary. */
3869 Lisp_Object frame
, focus
;
3871 frame
= event
->frame_or_window
;
3872 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3876 if (!EQ (frame
, internal_last_event_frame
)
3877 && !EQ (frame
, selected_frame
))
3878 obj
= make_lispy_switch_frame (frame
);
3879 internal_last_event_frame
= frame
;
3880 kbd_fetch_ptr
= event
+ 1;
3882 else if (event
->kind
== SELECT_WINDOW_EVENT
)
3884 /* Make an event (select-window (WINDOW)). */
3885 obj
= Fcons (event
->frame_or_window
, Qnil
);
3886 obj
= Fcons (Qselect_window
, Fcons (obj
, Qnil
));
3888 kbd_fetch_ptr
= event
+ 1;
3892 /* If this event is on a different frame, return a switch-frame this
3893 time, and leave the event in the queue for next time. */
3897 frame
= event
->frame_or_window
;
3899 frame
= XCAR (frame
);
3900 else if (WINDOWP (frame
))
3901 frame
= WINDOW_FRAME (XWINDOW (frame
));
3903 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3907 if (! EQ (frame
, internal_last_event_frame
)
3908 && !EQ (frame
, selected_frame
))
3909 obj
= make_lispy_switch_frame (frame
);
3910 internal_last_event_frame
= frame
;
3912 /* If we didn't decide to make a switch-frame event, go ahead
3913 and build a real event from the queue entry. */
3917 obj
= make_lispy_event (event
);
3919 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS)
3920 /* If this was a menu selection, then set the flag to inhibit
3921 writing to last_nonmenu_event. Don't do this if the event
3922 we're returning is (menu-bar), though; that indicates the
3923 beginning of the menu sequence, and we might as well leave
3924 that as the `event with parameters' for this selection. */
3926 && !EQ (event
->frame_or_window
, event
->arg
)
3927 && (event
->kind
== MENU_BAR_EVENT
3928 || event
->kind
== TOOL_BAR_EVENT
))
3929 *used_mouse_menu
= 1;
3932 /* Wipe out this event, to catch bugs. */
3933 clear_event (event
);
3934 kbd_fetch_ptr
= event
+ 1;
3939 /* Try generating a mouse motion event. */
3940 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3942 FRAME_PTR f
= some_mouse_moved ();
3943 Lisp_Object bar_window
;
3944 enum scroll_bar_part part
;
3948 *kbp
= current_kboard
;
3949 /* Note that this uses F to determine which display to look at.
3950 If there is no valid info, it does not store anything
3951 so x remains nil. */
3953 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3957 /* Decide if we should generate a switch-frame event. Don't
3958 generate switch-frame events for motion outside of all Emacs
3964 frame
= FRAME_FOCUS_FRAME (f
);
3966 XSETFRAME (frame
, f
);
3968 if (! EQ (frame
, internal_last_event_frame
)
3969 && !EQ (frame
, selected_frame
))
3970 obj
= make_lispy_switch_frame (frame
);
3971 internal_last_event_frame
= frame
;
3974 /* If we didn't decide to make a switch-frame event, go ahead and
3975 return a mouse-motion event. */
3976 if (!NILP (x
) && NILP (obj
))
3977 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3979 #endif /* HAVE_MOUSE */
3981 /* We were promised by the above while loop that there was
3982 something for us to read! */
3985 input_pending
= readable_events (0);
3987 Vlast_event_frame
= internal_last_event_frame
;
3992 /* Process any events that are not user-visible,
3993 then return, without reading any user-visible events. */
3996 swallow_events (do_display
)
4001 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4003 struct input_event
*event
;
4005 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4009 last_event_timestamp
= event
->timestamp
;
4011 /* These two kinds of events get special handling
4012 and don't actually appear to the command loop. */
4013 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4016 struct input_event copy
;
4018 /* Remove it from the buffer before processing it,
4019 since otherwise swallow_events called recursively could see it
4020 and process it again. */
4022 kbd_fetch_ptr
= event
+ 1;
4023 input_pending
= readable_events (0);
4024 x_handle_selection_request (©
);
4026 /* We're getting selection request events, but we don't have
4032 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4035 struct input_event copy
;
4037 /* Remove it from the buffer before processing it, */
4040 kbd_fetch_ptr
= event
+ 1;
4041 input_pending
= readable_events (0);
4042 x_handle_selection_clear (©
);
4044 /* We're getting selection request events, but we don't have
4053 old_timers_run
= timers_run
;
4054 get_input_pending (&input_pending
, 1);
4056 if (timers_run
!= old_timers_run
&& do_display
)
4057 redisplay_preserve_echo_area (7);
4060 /* Record the start of when Emacs is idle,
4061 for the sake of running idle-time timers. */
4068 /* If we are already in the idle state, do nothing. */
4069 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4072 EMACS_GET_TIME (timer_idleness_start_time
);
4074 timer_last_idleness_start_time
= timer_idleness_start_time
;
4076 /* Mark all idle-time timers as once again candidates for running. */
4077 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4081 timer
= XCAR (timers
);
4083 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4085 XVECTOR (timer
)->contents
[0] = Qnil
;
4089 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4094 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4097 /* This is only for debugging. */
4098 struct input_event last_timer_event
;
4100 /* Check whether a timer has fired. To prevent larger problems we simply
4101 disregard elements that are not proper timers. Do not make a circular
4102 timer list for the time being.
4104 Returns the number of seconds to wait until the next timer fires. If a
4105 timer is triggering now, return zero seconds.
4106 If no timer is active, return -1 seconds.
4108 If a timer is ripe, we run it, with quitting turned off.
4110 DO_IT_NOW is now ignored. It used to mean that we should
4111 run the timer directly instead of queueing a timer-event.
4112 Now we always run timers directly. */
4115 timer_check (do_it_now
)
4118 EMACS_TIME nexttime
;
4119 EMACS_TIME now
, idleness_now
;
4120 Lisp_Object timers
, idle_timers
, chosen_timer
;
4121 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4123 EMACS_SET_SECS (nexttime
, -1);
4124 EMACS_SET_USECS (nexttime
, -1);
4126 /* Always consider the ordinary timers. */
4127 timers
= Vtimer_list
;
4128 /* Consider the idle timers only if Emacs is idle. */
4129 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4130 idle_timers
= Vtimer_idle_list
;
4133 chosen_timer
= Qnil
;
4134 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4136 if (CONSP (timers
) || CONSP (idle_timers
))
4138 EMACS_GET_TIME (now
);
4139 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4140 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4143 while (CONSP (timers
) || CONSP (idle_timers
))
4145 Lisp_Object
*vector
;
4146 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4147 EMACS_TIME timer_time
, idle_timer_time
;
4148 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4150 /* Skip past invalid timers and timers already handled. */
4153 timer
= XCAR (timers
);
4154 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4156 timers
= XCDR (timers
);
4159 vector
= XVECTOR (timer
)->contents
;
4161 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4162 || !INTEGERP (vector
[3])
4163 || ! NILP (vector
[0]))
4165 timers
= XCDR (timers
);
4169 if (!NILP (idle_timers
))
4171 timer
= XCAR (idle_timers
);
4172 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4174 idle_timers
= XCDR (idle_timers
);
4177 vector
= XVECTOR (timer
)->contents
;
4179 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4180 || !INTEGERP (vector
[3])
4181 || ! NILP (vector
[0]))
4183 idle_timers
= XCDR (idle_timers
);
4188 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4189 based on the next ordinary timer.
4190 TIMER_DIFFERENCE is the distance in time from NOW to when
4191 this timer becomes ripe (negative if it's already ripe). */
4194 timer
= XCAR (timers
);
4195 vector
= XVECTOR (timer
)->contents
;
4196 EMACS_SET_SECS (timer_time
,
4197 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4198 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4199 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4202 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4203 based on the next idle timer. */
4204 if (!NILP (idle_timers
))
4206 idle_timer
= XCAR (idle_timers
);
4207 vector
= XVECTOR (idle_timer
)->contents
;
4208 EMACS_SET_SECS (idle_timer_time
,
4209 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4210 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4211 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4214 /* Decide which timer is the next timer,
4215 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4216 Also step down the list where we found that timer. */
4218 if (! NILP (timers
) && ! NILP (idle_timers
))
4221 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4222 if (EMACS_TIME_NEG_P (temp
))
4224 chosen_timer
= timer
;
4225 timers
= XCDR (timers
);
4226 difference
= timer_difference
;
4230 chosen_timer
= idle_timer
;
4231 idle_timers
= XCDR (idle_timers
);
4232 difference
= idle_timer_difference
;
4235 else if (! NILP (timers
))
4237 chosen_timer
= timer
;
4238 timers
= XCDR (timers
);
4239 difference
= timer_difference
;
4243 chosen_timer
= idle_timer
;
4244 idle_timers
= XCDR (idle_timers
);
4245 difference
= idle_timer_difference
;
4247 vector
= XVECTOR (chosen_timer
)->contents
;
4249 /* If timer is ripe, run it if it hasn't been run. */
4250 if (EMACS_TIME_NEG_P (difference
)
4251 || (EMACS_SECS (difference
) == 0
4252 && EMACS_USECS (difference
) == 0))
4254 if (NILP (vector
[0]))
4256 int was_locked
= single_kboard
;
4257 int count
= SPECPDL_INDEX ();
4258 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4260 /* Mark the timer as triggered to prevent problems if the lisp
4261 code fails to reschedule it right. */
4264 specbind (Qinhibit_quit
, Qt
);
4266 call1 (Qtimer_event_handler
, chosen_timer
);
4267 Vdeactivate_mark
= old_deactivate_mark
;
4269 unbind_to (count
, Qnil
);
4271 /* Resume allowing input from any kboard, if that was true before. */
4273 any_kboard_state ();
4275 /* Since we have handled the event,
4276 we don't need to tell the caller to wake up and do it. */
4280 /* When we encounter a timer that is still waiting,
4281 return the amount of time to wait before it is ripe. */
4288 /* No timers are pending in the future. */
4289 /* Return 0 if we generated an event, and -1 if not. */
4294 /* Caches for modify_event_symbol. */
4295 static Lisp_Object accent_key_syms
;
4296 static Lisp_Object func_key_syms
;
4297 static Lisp_Object mouse_syms
;
4298 #if defined(WINDOWSNT) || defined(MAC_OSX)
4299 static Lisp_Object mouse_wheel_syms
;
4301 static Lisp_Object drag_n_drop_syms
;
4303 /* This is a list of keysym codes for special "accent" characters.
4304 It parallels lispy_accent_keys. */
4306 static int lispy_accent_codes
[] =
4308 #ifdef XK_dead_circumflex
4313 #ifdef XK_dead_grave
4318 #ifdef XK_dead_tilde
4323 #ifdef XK_dead_diaeresis
4328 #ifdef XK_dead_macron
4333 #ifdef XK_dead_degree
4338 #ifdef XK_dead_acute
4343 #ifdef XK_dead_cedilla
4348 #ifdef XK_dead_breve
4353 #ifdef XK_dead_ogonek
4358 #ifdef XK_dead_caron
4363 #ifdef XK_dead_doubleacute
4364 XK_dead_doubleacute
,
4368 #ifdef XK_dead_abovedot
4373 #ifdef XK_dead_abovering
4383 #ifdef XK_dead_belowdot
4388 #ifdef XK_dead_voiced_sound
4389 XK_dead_voiced_sound
,
4393 #ifdef XK_dead_semivoiced_sound
4394 XK_dead_semivoiced_sound
,
4410 /* This is a list of Lisp names for special "accent" characters.
4411 It parallels lispy_accent_codes. */
4413 static char *lispy_accent_keys
[] =
4431 "dead-voiced-sound",
4432 "dead-semivoiced-sound",
4438 #define FUNCTION_KEY_OFFSET 0x0
4440 char *lispy_function_keys
[] =
4444 0, /* VK_LBUTTON 0x01 */
4445 0, /* VK_RBUTTON 0x02 */
4446 "cancel", /* VK_CANCEL 0x03 */
4447 0, /* VK_MBUTTON 0x04 */
4449 0, 0, 0, /* 0x05 .. 0x07 */
4451 "backspace", /* VK_BACK 0x08 */
4452 "tab", /* VK_TAB 0x09 */
4454 0, 0, /* 0x0A .. 0x0B */
4456 "clear", /* VK_CLEAR 0x0C */
4457 "return", /* VK_RETURN 0x0D */
4459 0, 0, /* 0x0E .. 0x0F */
4461 0, /* VK_SHIFT 0x10 */
4462 0, /* VK_CONTROL 0x11 */
4463 0, /* VK_MENU 0x12 */
4464 "pause", /* VK_PAUSE 0x13 */
4465 "capslock", /* VK_CAPITAL 0x14 */
4467 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4469 "escape", /* VK_ESCAPE 0x1B */
4471 0, 0, 0, 0, /* 0x1C .. 0x1F */
4473 0, /* VK_SPACE 0x20 */
4474 "prior", /* VK_PRIOR 0x21 */
4475 "next", /* VK_NEXT 0x22 */
4476 "end", /* VK_END 0x23 */
4477 "home", /* VK_HOME 0x24 */
4478 "left", /* VK_LEFT 0x25 */
4479 "up", /* VK_UP 0x26 */
4480 "right", /* VK_RIGHT 0x27 */
4481 "down", /* VK_DOWN 0x28 */
4482 "select", /* VK_SELECT 0x29 */
4483 "print", /* VK_PRINT 0x2A */
4484 "execute", /* VK_EXECUTE 0x2B */
4485 "snapshot", /* VK_SNAPSHOT 0x2C */
4486 "insert", /* VK_INSERT 0x2D */
4487 "delete", /* VK_DELETE 0x2E */
4488 "help", /* VK_HELP 0x2F */
4490 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4492 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4494 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4496 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4498 0, 0, 0, 0, 0, 0, 0, 0, 0,
4499 0, 0, 0, 0, 0, 0, 0, 0, 0,
4500 0, 0, 0, 0, 0, 0, 0, 0,
4502 "lwindow", /* VK_LWIN 0x5B */
4503 "rwindow", /* VK_RWIN 0x5C */
4504 "apps", /* VK_APPS 0x5D */
4506 0, 0, /* 0x5E .. 0x5F */
4508 "kp-0", /* VK_NUMPAD0 0x60 */
4509 "kp-1", /* VK_NUMPAD1 0x61 */
4510 "kp-2", /* VK_NUMPAD2 0x62 */
4511 "kp-3", /* VK_NUMPAD3 0x63 */
4512 "kp-4", /* VK_NUMPAD4 0x64 */
4513 "kp-5", /* VK_NUMPAD5 0x65 */
4514 "kp-6", /* VK_NUMPAD6 0x66 */
4515 "kp-7", /* VK_NUMPAD7 0x67 */
4516 "kp-8", /* VK_NUMPAD8 0x68 */
4517 "kp-9", /* VK_NUMPAD9 0x69 */
4518 "kp-multiply", /* VK_MULTIPLY 0x6A */
4519 "kp-add", /* VK_ADD 0x6B */
4520 "kp-separator", /* VK_SEPARATOR 0x6C */
4521 "kp-subtract", /* VK_SUBTRACT 0x6D */
4522 "kp-decimal", /* VK_DECIMAL 0x6E */
4523 "kp-divide", /* VK_DIVIDE 0x6F */
4524 "f1", /* VK_F1 0x70 */
4525 "f2", /* VK_F2 0x71 */
4526 "f3", /* VK_F3 0x72 */
4527 "f4", /* VK_F4 0x73 */
4528 "f5", /* VK_F5 0x74 */
4529 "f6", /* VK_F6 0x75 */
4530 "f7", /* VK_F7 0x76 */
4531 "f8", /* VK_F8 0x77 */
4532 "f9", /* VK_F9 0x78 */
4533 "f10", /* VK_F10 0x79 */
4534 "f11", /* VK_F11 0x7A */
4535 "f12", /* VK_F12 0x7B */
4536 "f13", /* VK_F13 0x7C */
4537 "f14", /* VK_F14 0x7D */
4538 "f15", /* VK_F15 0x7E */
4539 "f16", /* VK_F16 0x7F */
4540 "f17", /* VK_F17 0x80 */
4541 "f18", /* VK_F18 0x81 */
4542 "f19", /* VK_F19 0x82 */
4543 "f20", /* VK_F20 0x83 */
4544 "f21", /* VK_F21 0x84 */
4545 "f22", /* VK_F22 0x85 */
4546 "f23", /* VK_F23 0x86 */
4547 "f24", /* VK_F24 0x87 */
4549 0, 0, 0, 0, /* 0x88 .. 0x8B */
4550 0, 0, 0, 0, /* 0x8C .. 0x8F */
4552 "kp-numlock", /* VK_NUMLOCK 0x90 */
4553 "scroll", /* VK_SCROLL 0x91 */
4555 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4556 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4557 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4558 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4559 "kp-end", /* VK_NUMPAD_END 0x96 */
4560 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4561 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4562 "kp-up", /* VK_NUMPAD_UP 0x99 */
4563 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4564 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4565 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4566 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4568 0, 0, /* 0x9E .. 0x9F */
4571 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4572 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4573 * No other API or message will distinguish left and right keys this way.
4577 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4578 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4579 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4580 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4581 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4587 "attn", /* VK_ATTN 0xF6 */
4588 "crsel", /* VK_CRSEL 0xF7 */
4589 "exsel", /* VK_EXSEL 0xF8 */
4590 "ereof", /* VK_EREOF 0xF9 */
4591 "play", /* VK_PLAY 0xFA */
4592 "zoom", /* VK_ZOOM 0xFB */
4593 "noname", /* VK_NONAME 0xFC */
4594 "pa1", /* VK_PA1 0xFD */
4595 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4599 #else /* not HAVE_NTGUI */
4601 /* This should be dealt with in XTread_socket now, and that doesn't
4602 depend on the client system having the Kana syms defined. See also
4603 the XK_kana_A case below. */
4606 static char *lispy_kana_keys
[] =
4608 /* X Keysym value */
4609 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4610 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4611 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4612 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4613 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4614 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4615 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4616 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4617 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4618 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4619 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4620 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4621 "kana-i", "kana-u", "kana-e", "kana-o",
4622 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4623 "prolongedsound", "kana-A", "kana-I", "kana-U",
4624 "kana-E", "kana-O", "kana-KA", "kana-KI",
4625 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4626 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4627 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4628 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4629 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4630 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4631 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4632 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4633 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4634 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4635 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4636 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4638 #endif /* XK_kana_A */
4641 #define FUNCTION_KEY_OFFSET 0xff00
4643 /* You'll notice that this table is arranged to be conveniently
4644 indexed by X Windows keysym values. */
4645 static char *lispy_function_keys
[] =
4647 /* X Keysym value */
4649 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4650 "backspace", "tab", "linefeed", "clear",
4652 0, 0, 0, "pause", /* 0xff10...1f */
4653 0, 0, 0, 0, 0, 0, 0, "escape",
4655 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4656 "romaji", "hiragana", "katakana", "hiragana-katakana",
4657 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4658 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4659 "eisu-toggle", /* 0xff30...3f */
4660 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4661 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4663 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4664 "down", "prior", "next", "end",
4665 "begin", 0, 0, 0, 0, 0, 0, 0,
4666 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4677 "break", /* 0xff6b */
4680 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4681 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4682 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4683 0, 0, 0, 0, 0, 0, 0, 0,
4684 "kp-tab", /* 0xff89 */
4686 "kp-enter", /* 0xff8d */
4688 "kp-f1", /* 0xff91 */
4692 "kp-home", /* 0xff95 */
4697 "kp-prior", /* kp-page-up */
4698 "kp-next", /* kp-page-down */
4704 0, 0, 0, 0, 0, 0, 0, 0, 0,
4705 "kp-multiply", /* 0xffaa */
4710 "kp-divide", /* 0xffaf */
4711 "kp-0", /* 0xffb0 */
4712 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4715 "kp-equal", /* 0xffbd */
4716 "f1", /* 0xffbe */ /* IsFunctionKey */
4718 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4719 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4720 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4721 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4722 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4723 0, 0, 0, 0, 0, 0, 0, 0,
4724 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4725 0, 0, 0, 0, 0, 0, 0, "delete"
4728 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4729 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4731 static char *iso_lispy_function_keys
[] =
4733 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4734 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4735 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4736 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4737 "iso-lefttab", /* 0xfe20 */
4738 "iso-move-line-up", "iso-move-line-down",
4739 "iso-partial-line-up", "iso-partial-line-down",
4740 "iso-partial-space-left", "iso-partial-space-right",
4741 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4742 "iso-release-margin-left", "iso-release-margin-right",
4743 "iso-release-both-margins",
4744 "iso-fast-cursor-left", "iso-fast-cursor-right",
4745 "iso-fast-cursor-up", "iso-fast-cursor-down",
4746 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4747 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4750 #endif /* not HAVE_NTGUI */
4752 Lisp_Object Vlispy_mouse_stem
;
4754 #if defined(WINDOWSNT) || defined(MAC_OSX)
4755 /* mouse-wheel events are generated by the wheel on devices such as
4756 the MS Intellimouse. The wheel sits in between the left and right
4757 mouse buttons, and is typically used to scroll or zoom the window
4758 underneath the pointer. mouse-wheel events specify the object on
4759 which they operate, and a delta corresponding to the amount and
4760 direction that the wheel is rotated. Clicking the mouse-wheel
4761 generates a mouse-2 event. */
4762 static char *lispy_mouse_wheel_names
[] =
4767 #endif /* WINDOWSNT */
4769 /* drag-n-drop events are generated when a set of selected files are
4770 dragged from another application and dropped onto an Emacs window. */
4771 static char *lispy_drag_n_drop_names
[] =
4776 /* Scroll bar parts. */
4777 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4778 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4779 Lisp_Object Qtop
, Qratio
;
4781 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4782 Lisp_Object
*scroll_bar_parts
[] = {
4783 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4784 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4787 /* User signal events. */
4788 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4790 Lisp_Object
*lispy_user_signals
[] =
4792 &Qusr1_signal
, &Qusr2_signal
4796 /* A vector, indexed by button number, giving the down-going location
4797 of currently depressed buttons, both scroll bar and non-scroll bar.
4799 The elements have the form
4800 (BUTTON-NUMBER MODIFIER-MASK . REST)
4801 where REST is the cdr of a position as it would be reported in the event.
4803 The make_lispy_event function stores positions here to tell the
4804 difference between click and drag events, and to store the starting
4805 location to be included in drag events. */
4807 static Lisp_Object button_down_location
;
4809 /* Information about the most recent up-going button event: Which
4810 button, what location, and what time. */
4812 static int last_mouse_button
;
4813 static int last_mouse_x
;
4814 static int last_mouse_y
;
4815 static unsigned long button_down_time
;
4817 /* The maximum time between clicks to make a double-click, or Qnil to
4818 disable double-click detection, or Qt for no time limit. */
4820 Lisp_Object Vdouble_click_time
;
4822 /* Maximum number of pixels the mouse may be moved between clicks
4823 to make a double-click. */
4825 EMACS_INT double_click_fuzz
;
4827 /* The number of clicks in this multiple-click. */
4829 int double_click_count
;
4831 /* Given a struct input_event, build the lisp event which represents
4832 it. If EVENT is 0, build a mouse movement event from the mouse
4833 movement buffer, which should have a movement event in it.
4835 Note that events must be passed to this function in the order they
4836 are received; this function stores the location of button presses
4837 in order to build drag events when the button is released. */
4840 make_lispy_event (event
)
4841 struct input_event
*event
;
4845 switch (SWITCH_ENUM_CAST (event
->kind
))
4847 /* A simple keystroke. */
4848 case ASCII_KEYSTROKE_EVENT
:
4850 Lisp_Object lispy_c
;
4851 int c
= event
->code
& 0377;
4852 /* Turn ASCII characters into control characters
4854 if (event
->modifiers
& ctrl_modifier
)
4855 c
= make_ctrl_char (c
);
4857 /* Add in the other modifier bits. We took care of ctrl_modifier
4858 just above, and the shift key was taken care of by the X code,
4859 and applied to control characters by make_ctrl_char. */
4860 c
|= (event
->modifiers
4861 & (meta_modifier
| alt_modifier
4862 | hyper_modifier
| super_modifier
));
4863 /* Distinguish Shift-SPC from SPC. */
4864 if ((event
->code
& 0377) == 040
4865 && event
->modifiers
& shift_modifier
)
4866 c
|= shift_modifier
;
4867 button_down_time
= 0;
4868 XSETFASTINT (lispy_c
, c
);
4872 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4874 Lisp_Object lispy_c
;
4876 XSETFASTINT (lispy_c
, event
->code
);
4880 /* A function key. The symbol may need to have modifier prefixes
4882 case NON_ASCII_KEYSTROKE_EVENT
:
4883 button_down_time
= 0;
4885 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4886 if (event
->code
== lispy_accent_codes
[i
])
4887 return modify_event_symbol (i
,
4889 Qfunction_key
, Qnil
,
4890 lispy_accent_keys
, &accent_key_syms
,
4891 (sizeof (lispy_accent_keys
)
4892 / sizeof (lispy_accent_keys
[0])));
4896 if (event
->code
>= 0x400 && event
->code
< 0x500)
4897 return modify_event_symbol (event
->code
- 0x400,
4898 event
->modifiers
& ~shift_modifier
,
4899 Qfunction_key
, Qnil
,
4900 lispy_kana_keys
, &func_key_syms
,
4901 (sizeof (lispy_kana_keys
)
4902 / sizeof (lispy_kana_keys
[0])));
4903 #endif /* XK_kana_A */
4906 #ifdef ISO_FUNCTION_KEY_OFFSET
4907 if (event
->code
< FUNCTION_KEY_OFFSET
4908 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4909 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4911 Qfunction_key
, Qnil
,
4912 iso_lispy_function_keys
, &func_key_syms
,
4913 (sizeof (iso_lispy_function_keys
)
4914 / sizeof (iso_lispy_function_keys
[0])));
4917 /* Handle system-specific or unknown keysyms. */
4918 if (event
->code
& (1 << 28)
4919 || event
->code
- FUNCTION_KEY_OFFSET
< 0
4920 || (event
->code
- FUNCTION_KEY_OFFSET
4921 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
4922 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
4924 /* We need to use an alist rather than a vector as the cache
4925 since we can't make a vector long enuf. */
4926 if (NILP (current_kboard
->system_key_syms
))
4927 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4928 return modify_event_symbol (event
->code
,
4931 current_kboard
->Vsystem_key_alist
,
4932 0, ¤t_kboard
->system_key_syms
,
4936 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4938 Qfunction_key
, Qnil
,
4939 lispy_function_keys
, &func_key_syms
,
4940 (sizeof (lispy_function_keys
)
4941 / sizeof (lispy_function_keys
[0])));
4944 /* A mouse click. Figure out where it is, decide whether it's
4945 a press, click or drag, and build the appropriate structure. */
4946 case MOUSE_CLICK_EVENT
:
4947 #ifndef USE_TOOLKIT_SCROLL_BARS
4948 case SCROLL_BAR_CLICK_EVENT
:
4951 int button
= event
->code
;
4953 Lisp_Object position
;
4954 Lisp_Object
*start_pos_ptr
;
4955 Lisp_Object start_pos
;
4960 /* Build the position as appropriate for this mouse click. */
4961 if (event
->kind
== MOUSE_CLICK_EVENT
)
4964 struct frame
*f
= XFRAME (event
->frame_or_window
);
4966 Lisp_Object string_info
= Qnil
;
4969 /* Ignore mouse events that were made on frame that
4970 have been deleted. */
4971 if (! FRAME_LIVE_P (f
))
4974 /* EVENT->x and EVENT->y are frame-relative pixel
4975 coordinates at this place. Under old redisplay, COLUMN
4976 and ROW are set to frame relative glyph coordinates
4977 which are then used to determine whether this click is
4978 in a menu (non-toolkit version). */
4979 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4980 &column
, &row
, NULL
, 1);
4982 #ifndef USE_X_TOOLKIT
4983 /* In the non-toolkit version, clicks on the menu bar
4984 are ordinary button events in the event buffer.
4985 Distinguish them, and invoke the menu.
4987 (In the toolkit version, the toolkit handles the menu bar
4988 and Emacs doesn't know about it until after the user
4989 makes a selection.) */
4990 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4991 && (event
->modifiers
& down_modifier
))
4993 Lisp_Object items
, item
;
4998 /* Activate the menu bar on the down event. If the
4999 up event comes in before the menu code can deal with it,
5001 if (! (event
->modifiers
& down_modifier
))
5005 /* Find the menu bar item under `column'. */
5007 items
= FRAME_MENU_BAR_ITEMS (f
);
5008 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5010 Lisp_Object pos
, string
;
5011 string
= AREF (items
, i
+ 1);
5012 pos
= AREF (items
, i
+ 3);
5015 if (column
>= XINT (pos
)
5016 && column
< XINT (pos
) + SCHARS (string
))
5018 item
= AREF (items
, i
);
5023 /* ELisp manual 2.4b says (x y) are window relative but
5024 code says they are frame-relative. */
5026 = Fcons (event
->frame_or_window
,
5028 Fcons (Fcons (event
->x
, event
->y
),
5029 Fcons (make_number (event
->timestamp
),
5032 return Fcons (item
, Fcons (position
, Qnil
));
5034 #endif /* not USE_X_TOOLKIT */
5036 /* Set `window' to the window under frame pixel coordinates
5037 event->x/event->y. */
5038 window
= window_from_coordinates (f
, XINT (event
->x
),
5039 XINT (event
->y
), &part
, 0);
5041 if (!WINDOWP (window
))
5043 window
= event
->frame_or_window
;
5048 /* It's a click in window window at frame coordinates
5049 event->x/ event->y. */
5050 struct window
*w
= XWINDOW (window
);
5052 /* Get window relative coordinates. Original code
5053 `rounded' this to glyph boundaries. */
5054 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5055 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5057 /* Set event coordinates to window-relative coordinates
5058 for constructing the Lisp event below. */
5059 XSETINT (event
->x
, wx
);
5060 XSETINT (event
->y
, wy
);
5062 if (part
== 1 || part
== 3)
5064 /* Mode line or header line. Look for a string under
5065 the mouse that may have a `local-map' property. */
5069 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
5070 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
5071 if (STRINGP (string
))
5072 string_info
= Fcons (string
, make_number (charpos
));
5075 posn
= Qvertical_line
;
5076 else if (part
== 6 || part
== 7)
5079 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5081 posn
= (part
== 6) ? Qleft_margin
: Qright_margin
;
5082 if (STRINGP (object
))
5083 string_info
= Fcons (object
, make_number (charpos
));
5088 struct display_pos p
;
5089 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5090 posn
= make_number (CHARPOS (p
.pos
));
5091 if (STRINGP (object
))
5094 make_number (CHARPOS (p
.string_pos
)));
5101 Fcons (Fcons (event
->x
, event
->y
),
5102 Fcons (make_number (event
->timestamp
),
5105 : Fcons (string_info
, Qnil
))))));
5107 #ifndef USE_TOOLKIT_SCROLL_BARS
5110 /* It's a scrollbar click. */
5111 Lisp_Object portion_whole
;
5114 window
= event
->frame_or_window
;
5115 portion_whole
= Fcons (event
->x
, event
->y
);
5116 part
= *scroll_bar_parts
[(int) event
->part
];
5120 Fcons (Qvertical_scroll_bar
,
5121 Fcons (portion_whole
,
5122 Fcons (make_number (event
->timestamp
),
5123 Fcons (part
, Qnil
)))));
5125 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5127 if (button
>= ASIZE (button_down_location
))
5129 button_down_location
= larger_vector (button_down_location
,
5131 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5134 start_pos_ptr
= &AREF (button_down_location
, button
);
5135 start_pos
= *start_pos_ptr
;
5136 *start_pos_ptr
= Qnil
;
5139 /* On window-system frames, use the value of
5140 double-click-fuzz as is. On other frames, interpret it
5141 as a multiple of 1/8 characters. */
5145 if (WINDOWP (event
->frame_or_window
))
5146 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5147 else if (FRAMEP (event
->frame_or_window
))
5148 f
= XFRAME (event
->frame_or_window
);
5152 if (FRAME_WINDOW_P (f
))
5153 fuzz
= double_click_fuzz
;
5155 fuzz
= double_click_fuzz
/ 8;
5157 is_double
= (button
== last_mouse_button
5158 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5159 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5160 && button_down_time
!= 0
5161 && (EQ (Vdouble_click_time
, Qt
)
5162 || (INTEGERP (Vdouble_click_time
)
5163 && ((int)(event
->timestamp
- button_down_time
)
5164 < XINT (Vdouble_click_time
)))));
5167 last_mouse_button
= button
;
5168 last_mouse_x
= XINT (event
->x
);
5169 last_mouse_y
= XINT (event
->y
);
5171 /* If this is a button press, squirrel away the location, so
5172 we can decide later whether it was a click or a drag. */
5173 if (event
->modifiers
& down_modifier
)
5177 double_click_count
++;
5178 event
->modifiers
|= ((double_click_count
> 2)
5183 double_click_count
= 1;
5184 button_down_time
= event
->timestamp
;
5185 *start_pos_ptr
= Fcopy_alist (position
);
5188 /* Now we're releasing a button - check the co-ordinates to
5189 see if this was a click or a drag. */
5190 else if (event
->modifiers
& up_modifier
)
5192 /* If we did not see a down before this up, ignore the up.
5193 Probably this happened because the down event chose a
5194 menu item. It would be an annoyance to treat the
5195 release of the button that chose the menu item as a
5198 if (!CONSP (start_pos
))
5201 event
->modifiers
&= ~up_modifier
;
5202 #if 0 /* Formerly we treated an up with no down as a click event. */
5203 if (!CONSP (start_pos
))
5204 event
->modifiers
|= click_modifier
;
5209 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5211 /* The third element of every position
5212 should be the (x,y) pair. */
5213 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5215 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5217 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5218 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5221 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5222 && ydiff
< double_click_fuzz
5223 && ydiff
> - double_click_fuzz
)
5224 /* Mouse hasn't moved (much). */
5225 event
->modifiers
|= click_modifier
;
5228 button_down_time
= 0;
5229 event
->modifiers
|= drag_modifier
;
5232 /* Don't check is_double; treat this as multiple
5233 if the down-event was multiple. */
5234 if (double_click_count
> 1)
5235 event
->modifiers
|= ((double_click_count
> 2)
5241 /* Every mouse event should either have the down_modifier or
5242 the up_modifier set. */
5246 /* Get the symbol we should use for the mouse click. */
5249 head
= modify_event_symbol (button
,
5251 Qmouse_click
, Vlispy_mouse_stem
,
5254 XVECTOR (mouse_syms
)->size
);
5255 if (event
->modifiers
& drag_modifier
)
5260 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5263 Fcons (make_number (double_click_count
),
5272 #ifdef USE_TOOLKIT_SCROLL_BARS
5274 /* We don't have down and up events if using toolkit scroll bars,
5275 so make this always a click event. Store in the `part' of
5276 the Lisp event a symbol which maps to the following actions:
5278 `above_handle' page up
5279 `below_handle' page down
5283 `bottom' bottom of buffer
5284 `handle' thumb has been dragged.
5285 `end-scroll' end of interaction with scroll bar
5287 The incoming input_event contains in its `part' member an
5288 index of type `enum scroll_bar_part' which we can use as an
5289 index in scroll_bar_parts to get the appropriate symbol. */
5291 case SCROLL_BAR_CLICK_EVENT
:
5293 Lisp_Object position
, head
, window
, portion_whole
, part
;
5295 window
= event
->frame_or_window
;
5296 portion_whole
= Fcons (event
->x
, event
->y
);
5297 part
= *scroll_bar_parts
[(int) event
->part
];
5301 Fcons (Qvertical_scroll_bar
,
5302 Fcons (portion_whole
,
5303 Fcons (make_number (event
->timestamp
),
5304 Fcons (part
, Qnil
)))));
5306 /* Always treat scroll bar events as clicks. */
5307 event
->modifiers
|= click_modifier
;
5308 event
->modifiers
&= ~up_modifier
;
5310 /* Get the symbol we should use for the mouse click. */
5311 head
= modify_event_symbol (event
->code
,
5316 XVECTOR (mouse_syms
)->size
);
5317 return Fcons (head
, Fcons (position
, Qnil
));
5320 #endif /* USE_TOOLKIT_SCROLL_BARS */
5323 case W32_SCROLL_BAR_CLICK_EVENT
:
5325 int button
= event
->code
;
5327 Lisp_Object position
;
5328 Lisp_Object
*start_pos_ptr
;
5329 Lisp_Object start_pos
;
5333 Lisp_Object portion_whole
;
5336 window
= event
->frame_or_window
;
5337 portion_whole
= Fcons (event
->x
, event
->y
);
5338 part
= *scroll_bar_parts
[(int) event
->part
];
5342 Fcons (Qvertical_scroll_bar
,
5343 Fcons (portion_whole
,
5344 Fcons (make_number (event
->timestamp
),
5345 Fcons (part
, Qnil
)))));
5348 /* Always treat W32 scroll bar events as clicks. */
5349 event
->modifiers
|= click_modifier
;
5352 /* Get the symbol we should use for the mouse click. */
5355 head
= modify_event_symbol (button
,
5360 XVECTOR (mouse_syms
)->size
);
5366 #endif /* WINDOWSNT */
5367 #if defined(WINDOWSNT) || defined(MAC_OSX)
5368 case MOUSE_WHEEL_EVENT
:
5371 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5374 Lisp_Object head
, position
;
5377 /* Ignore mouse events that were made on frame that
5378 have been deleted. */
5379 if (! FRAME_LIVE_P (f
))
5381 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5382 &column
, &row
, NULL
, 1);
5383 window
= window_from_coordinates (f
, XINT (event
->x
),
5384 XINT (event
->y
), &part
, 0);
5386 if (!WINDOWP (window
))
5388 window
= event
->frame_or_window
;
5393 int pixcolumn
, pixrow
;
5394 column
-= XINT (XWINDOW (window
)->left
);
5395 row
-= XINT (XWINDOW (window
)->top
);
5396 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5397 &pixcolumn
, &pixrow
);
5398 XSETINT (event
->x
, pixcolumn
);
5399 XSETINT (event
->y
, pixrow
);
5404 posn
= Qvertical_line
;
5406 posn
= Qheader_line
;
5410 struct display_pos p
;
5411 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5413 posn
= make_number (CHARPOS (p
.pos
));
5418 Lisp_Object head
, position
;
5423 Fcons (Fcons (event
->x
, event
->y
),
5424 Fcons (make_number (event
->timestamp
),
5427 head
= modify_event_symbol (0, event
->modifiers
,
5429 lispy_mouse_wheel_names
,
5430 &mouse_wheel_syms
, 1);
5433 /* Insert 1 here so event-click-count works. */
5434 Fcons (make_number (1),
5435 Fcons (make_number (event
->code
),
5439 #endif /* WINDOWSNT || MAC_OSX */
5441 case DRAG_N_DROP_EVENT
:
5449 /* The frame_or_window field should be a cons of the frame in
5450 which the event occurred and a list of the filenames
5452 if (! CONSP (event
->frame_or_window
))
5455 f
= XFRAME (XCAR (event
->frame_or_window
));
5456 files
= XCDR (event
->frame_or_window
);
5458 /* Ignore mouse events that were made on frames that
5459 have been deleted. */
5460 if (! FRAME_LIVE_P (f
))
5463 window
= window_from_coordinates (f
, XINT (event
->x
),
5464 XINT (event
->y
), &part
, 0);
5466 if (!WINDOWP (window
))
5468 window
= XCAR (event
->frame_or_window
);
5473 /* It's an event in window `window' at frame coordinates
5474 event->x/ event->y. */
5475 struct window
*w
= XWINDOW (window
);
5477 /* Get window relative coordinates. */
5478 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5479 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5481 /* Set event coordinates to window-relative coordinates
5482 for constructing the Lisp event below. */
5483 XSETINT (event
->x
, wx
);
5484 XSETINT (event
->y
, wy
);
5489 posn
= Qvertical_line
;
5491 posn
= Qheader_line
;
5495 struct display_pos p
;
5496 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5497 posn
= make_number (CHARPOS (p
.pos
));
5502 Lisp_Object head
, position
;
5507 Fcons (Fcons (event
->x
, event
->y
),
5508 Fcons (make_number (event
->timestamp
),
5511 head
= modify_event_symbol (0, event
->modifiers
,
5513 lispy_drag_n_drop_names
,
5514 &drag_n_drop_syms
, 1);
5521 #endif /* HAVE_MOUSE */
5523 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
5524 case MENU_BAR_EVENT
:
5525 if (EQ (event
->arg
, event
->frame_or_window
))
5526 /* This is the prefix key. We translate this to
5527 `(menu_bar)' because the code in keyboard.c for menu
5528 events, which we use, relies on this. */
5529 return Fcons (Qmenu_bar
, Qnil
);
5533 case TOOL_BAR_EVENT
:
5534 if (EQ (event
->arg
, event
->frame_or_window
))
5535 /* This is the prefix key. We translate this to
5536 `(tool_bar)' because the code in keyboard.c for tool bar
5537 events, which we use, relies on this. */
5538 return Fcons (Qtool_bar
, Qnil
);
5539 else if (SYMBOLP (event
->arg
))
5540 return apply_modifiers (event
->modifiers
, event
->arg
);
5543 case USER_SIGNAL_EVENT
:
5544 /* A user signal. */
5545 return *lispy_user_signals
[event
->code
];
5547 case SAVE_SESSION_EVENT
:
5548 return Qsave_session
;
5550 /* The 'kind' field of the event is something we don't recognize. */
5559 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5561 Lisp_Object bar_window
;
5562 enum scroll_bar_part part
;
5566 /* Is it a scroll bar movement? */
5567 if (frame
&& ! NILP (bar_window
))
5569 Lisp_Object part_sym
;
5571 part_sym
= *scroll_bar_parts
[(int) part
];
5572 return Fcons (Qscroll_bar_movement
,
5573 (Fcons (Fcons (bar_window
,
5574 Fcons (Qvertical_scroll_bar
,
5575 Fcons (Fcons (x
, y
),
5576 Fcons (make_number (time
),
5582 /* Or is it an ordinary mouse movement? */
5590 /* It's in a frame; which window on that frame? */
5591 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5595 if (WINDOWP (window
))
5597 struct window
*w
= XWINDOW (window
);
5600 /* Get window relative coordinates. */
5601 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5602 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5609 posn
= Qvertical_line
;
5611 posn
= Qheader_line
;
5615 struct display_pos p
;
5616 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5617 posn
= make_number (CHARPOS (p
.pos
));
5620 else if (frame
!= 0)
5622 XSETFRAME (window
, frame
);
5633 return Fcons (Qmouse_movement
,
5634 Fcons (Fcons (window
,
5636 Fcons (Fcons (x
, y
),
5637 Fcons (make_number (time
),
5643 #endif /* HAVE_MOUSE */
5645 /* Construct a switch frame event. */
5647 make_lispy_switch_frame (frame
)
5650 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5653 /* Manipulating modifiers. */
5655 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5657 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5658 SYMBOL's name of the end of the modifiers; the string from this
5659 position is the unmodified symbol name.
5661 This doesn't use any caches. */
5664 parse_modifiers_uncached (symbol
, modifier_end
)
5672 CHECK_SYMBOL (symbol
);
5675 name
= SYMBOL_NAME (symbol
);
5677 for (i
= 0; i
+2 <= SBYTES (name
); )
5679 int this_mod_end
= 0;
5682 /* See if the name continues with a modifier word.
5683 Check that the word appears, but don't check what follows it.
5684 Set this_mod and this_mod_end to record what we find. */
5686 switch (SREF (name
, i
))
5688 #define SINGLE_LETTER_MOD(BIT) \
5689 (this_mod_end = i + 1, this_mod = BIT)
5692 SINGLE_LETTER_MOD (alt_modifier
);
5696 SINGLE_LETTER_MOD (ctrl_modifier
);
5700 SINGLE_LETTER_MOD (hyper_modifier
);
5704 SINGLE_LETTER_MOD (meta_modifier
);
5708 SINGLE_LETTER_MOD (shift_modifier
);
5712 SINGLE_LETTER_MOD (super_modifier
);
5715 #undef SINGLE_LETTER_MOD
5718 /* If we found no modifier, stop looking for them. */
5719 if (this_mod_end
== 0)
5722 /* Check there is a dash after the modifier, so that it
5723 really is a modifier. */
5724 if (this_mod_end
>= SBYTES (name
)
5725 || SREF (name
, this_mod_end
) != '-')
5728 /* This modifier is real; look for another. */
5729 modifiers
|= this_mod
;
5730 i
= this_mod_end
+ 1;
5733 /* Should we include the `click' modifier? */
5734 if (! (modifiers
& (down_modifier
| drag_modifier
5735 | double_modifier
| triple_modifier
))
5736 && i
+ 7 == SBYTES (name
)
5737 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5738 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5739 modifiers
|= click_modifier
;
5747 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5748 prepended to the string BASE[0..BASE_LEN-1].
5749 This doesn't use any caches. */
5751 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5754 int base_len
, base_len_byte
;
5756 /* Since BASE could contain nulls, we can't use intern here; we have
5757 to use Fintern, which expects a genuine Lisp_String, and keeps a
5760 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5766 /* Only the event queue may use the `up' modifier; it should always
5767 be turned into a click or drag event before presented to lisp code. */
5768 if (modifiers
& up_modifier
)
5771 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5772 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5773 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5774 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5775 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5776 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5777 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5778 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5779 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5780 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5781 /* The click modifier is denoted by the absence of other modifiers. */
5785 mod_len
= p
- new_mods
;
5789 Lisp_Object new_name
;
5791 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5792 mod_len
+ base_len_byte
);
5793 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5794 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5796 return Fintern (new_name
, Qnil
);
5801 static char *modifier_names
[] =
5803 "up", "down", "drag", "click", "double", "triple", 0, 0,
5804 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5805 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5807 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5809 static Lisp_Object modifier_symbols
;
5811 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5813 lispy_modifier_list (modifiers
)
5816 Lisp_Object modifier_list
;
5819 modifier_list
= Qnil
;
5820 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5821 if (modifiers
& (1<<i
))
5822 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5825 return modifier_list
;
5829 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5830 where UNMODIFIED is the unmodified form of SYMBOL,
5831 MASK is the set of modifiers present in SYMBOL's name.
5832 This is similar to parse_modifiers_uncached, but uses the cache in
5833 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5834 Qevent_symbol_elements property. */
5837 parse_modifiers (symbol
)
5840 Lisp_Object elements
;
5842 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5843 if (CONSP (elements
))
5848 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5849 Lisp_Object unmodified
;
5852 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
5853 SBYTES (SYMBOL_NAME (symbol
)) - end
),
5856 if (modifiers
& ~VALMASK
)
5858 XSETFASTINT (mask
, modifiers
);
5859 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5861 /* Cache the parsing results on SYMBOL. */
5862 Fput (symbol
, Qevent_symbol_element_mask
,
5864 Fput (symbol
, Qevent_symbol_elements
,
5865 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5867 /* Since we know that SYMBOL is modifiers applied to unmodified,
5868 it would be nice to put that in unmodified's cache.
5869 But we can't, since we're not sure that parse_modifiers is
5876 /* Apply the modifiers MODIFIERS to the symbol BASE.
5877 BASE must be unmodified.
5879 This is like apply_modifiers_uncached, but uses BASE's
5880 Qmodifier_cache property, if present. It also builds
5881 Qevent_symbol_elements properties, since it has that info anyway.
5883 apply_modifiers copies the value of BASE's Qevent_kind property to
5884 the modified symbol. */
5886 apply_modifiers (modifiers
, base
)
5890 Lisp_Object cache
, index
, entry
, new_symbol
;
5892 /* Mask out upper bits. We don't know where this value's been. */
5893 modifiers
&= VALMASK
;
5895 /* The click modifier never figures into cache indices. */
5896 cache
= Fget (base
, Qmodifier_cache
);
5897 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5898 entry
= assq_no_quit (index
, cache
);
5901 new_symbol
= XCDR (entry
);
5904 /* We have to create the symbol ourselves. */
5905 new_symbol
= apply_modifiers_uncached (modifiers
,
5906 SDATA (SYMBOL_NAME (base
)),
5907 SCHARS (SYMBOL_NAME (base
)),
5908 SBYTES (SYMBOL_NAME (base
)));
5910 /* Add the new symbol to the base's cache. */
5911 entry
= Fcons (index
, new_symbol
);
5912 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5914 /* We have the parsing info now for free, so add it to the caches. */
5915 XSETFASTINT (index
, modifiers
);
5916 Fput (new_symbol
, Qevent_symbol_element_mask
,
5917 Fcons (base
, Fcons (index
, Qnil
)));
5918 Fput (new_symbol
, Qevent_symbol_elements
,
5919 Fcons (base
, lispy_modifier_list (modifiers
)));
5922 /* Make sure this symbol is of the same kind as BASE.
5924 You'd think we could just set this once and for all when we
5925 intern the symbol above, but reorder_modifiers may call us when
5926 BASE's property isn't set right; we can't assume that just
5927 because it has a Qmodifier_cache property it must have its
5928 Qevent_kind set right as well. */
5929 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5933 kind
= Fget (base
, Qevent_kind
);
5935 Fput (new_symbol
, Qevent_kind
, kind
);
5942 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5943 return a symbol with the modifiers placed in the canonical order.
5944 Canonical order is alphabetical, except for down and drag, which
5945 always come last. The 'click' modifier is never written out.
5947 Fdefine_key calls this to make sure that (for example) C-M-foo
5948 and M-C-foo end up being equivalent in the keymap. */
5951 reorder_modifiers (symbol
)
5954 /* It's hopefully okay to write the code this way, since everything
5955 will soon be in caches, and no consing will be done at all. */
5958 parsed
= parse_modifiers (symbol
);
5959 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5964 /* For handling events, we often want to produce a symbol whose name
5965 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5966 to some base, like the name of a function key or mouse button.
5967 modify_event_symbol produces symbols of this sort.
5969 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5970 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5973 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5974 into symbol names, or a string specifying a name stem used to
5975 construct a symbol name or the form `STEM-N', where N is the decimal
5976 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5977 non-nil; otherwise NAME_TABLE is used.
5979 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5980 persist between calls to modify_event_symbol that it can use to
5981 store a cache of the symbols it's generated for this NAME_TABLE
5982 before. The object stored there may be a vector or an alist.
5984 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5986 MODIFIERS is a set of modifier bits (as given in struct input_events)
5987 whose prefixes should be applied to the symbol name.
5989 SYMBOL_KIND is the value to be placed in the event_kind property of
5990 the returned symbol.
5992 The symbols we create are supposed to have an
5993 `event-symbol-elements' property, which lists the modifiers present
5994 in the symbol's name. */
5997 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5998 name_table
, symbol_table
, table_size
)
6001 Lisp_Object symbol_kind
;
6002 Lisp_Object name_alist_or_stem
;
6004 Lisp_Object
*symbol_table
;
6005 unsigned int table_size
;
6008 Lisp_Object symbol_int
;
6010 /* Get rid of the "vendor-specific" bit here. */
6011 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6013 /* Is this a request for a valid symbol? */
6014 if (symbol_num
< 0 || symbol_num
>= table_size
)
6017 if (CONSP (*symbol_table
))
6018 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6020 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6021 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6022 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6023 we've never used that symbol before. */
6026 if (! VECTORP (*symbol_table
)
6027 || XVECTOR (*symbol_table
)->size
!= table_size
)
6031 XSETFASTINT (size
, table_size
);
6032 *symbol_table
= Fmake_vector (size
, Qnil
);
6035 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6038 /* Have we already used this symbol before? */
6041 /* No; let's create it. */
6042 if (CONSP (name_alist_or_stem
))
6043 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6044 else if (STRINGP (name_alist_or_stem
))
6046 int len
= SBYTES (name_alist_or_stem
);
6047 char *buf
= (char *) alloca (len
+ 50);
6048 if (sizeof (int) == sizeof (EMACS_INT
))
6049 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6050 XINT (symbol_int
) + 1);
6051 else if (sizeof (long) == sizeof (EMACS_INT
))
6052 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6053 XINT (symbol_int
) + 1);
6054 value
= intern (buf
);
6056 else if (name_table
!= 0 && name_table
[symbol_num
])
6057 value
= intern (name_table
[symbol_num
]);
6059 #ifdef HAVE_WINDOW_SYSTEM
6062 char *name
= x_get_keysym_name (symbol_num
);
6064 value
= intern (name
);
6071 sprintf (buf
, "key-%d", symbol_num
);
6072 value
= intern (buf
);
6075 if (CONSP (*symbol_table
))
6076 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6078 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6080 /* Fill in the cache entries for this symbol; this also
6081 builds the Qevent_symbol_elements property, which the user
6083 apply_modifiers (modifiers
& click_modifier
, value
);
6084 Fput (value
, Qevent_kind
, symbol_kind
);
6087 /* Apply modifiers to that symbol. */
6088 return apply_modifiers (modifiers
, value
);
6091 /* Convert a list that represents an event type,
6092 such as (ctrl meta backspace), into the usual representation of that
6093 event type as a number or a symbol. */
6095 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6096 doc
: /* Convert the event description list EVENT-DESC to an event type.
6097 EVENT-DESC should contain one base event type (a character or symbol)
6098 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6099 drag, down, double or triple). The base must be last.
6100 The return value is an event type (a character or symbol) which
6101 has the same base event type and all the specified modifiers. */)
6103 Lisp_Object event_desc
;
6111 while (CONSP (rest
))
6119 /* Given a symbol, see if it is a modifier name. */
6120 if (SYMBOLP (elt
) && CONSP (rest
))
6121 this = parse_solitary_modifier (elt
);
6125 else if (!NILP (base
))
6126 error ("Two bases given in one event");
6132 /* Let the symbol A refer to the character A. */
6133 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6134 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6136 if (INTEGERP (base
))
6138 /* Turn (shift a) into A. */
6139 if ((modifiers
& shift_modifier
) != 0
6140 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6142 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6143 modifiers
&= ~shift_modifier
;
6146 /* Turn (control a) into C-a. */
6147 if (modifiers
& ctrl_modifier
)
6148 return make_number ((modifiers
& ~ctrl_modifier
)
6149 | make_ctrl_char (XINT (base
)));
6151 return make_number (modifiers
| XINT (base
));
6153 else if (SYMBOLP (base
))
6154 return apply_modifiers (modifiers
, base
);
6157 error ("Invalid base event");
6162 /* Try to recognize SYMBOL as a modifier name.
6163 Return the modifier flag bit, or 0 if not recognized. */
6166 parse_solitary_modifier (symbol
)
6169 Lisp_Object name
= SYMBOL_NAME (symbol
);
6171 switch (SREF (name
, 0))
6173 #define SINGLE_LETTER_MOD(BIT) \
6174 if (SBYTES (name) == 1) \
6177 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6178 if (LEN == SBYTES (name) \
6179 && ! strncmp (SDATA (name), NAME, LEN)) \
6183 SINGLE_LETTER_MOD (alt_modifier
);
6187 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6191 SINGLE_LETTER_MOD (ctrl_modifier
);
6195 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6196 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6200 SINGLE_LETTER_MOD (hyper_modifier
);
6204 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6208 SINGLE_LETTER_MOD (meta_modifier
);
6212 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6216 SINGLE_LETTER_MOD (shift_modifier
);
6220 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6221 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6222 SINGLE_LETTER_MOD (super_modifier
);
6226 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6227 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6228 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6232 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6235 #undef SINGLE_LETTER_MOD
6236 #undef MULTI_LETTER_MOD
6242 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6243 Such a list is not valid as an event,
6244 but it can be a Lucid-style event type list. */
6247 lucid_event_type_list_p (object
)
6252 if (! CONSP (object
))
6255 if (EQ (XCAR (object
), Qhelp_echo
)
6256 || EQ (XCAR (object
), Qvertical_line
)
6257 || EQ (XCAR (object
), Qmode_line
)
6258 || EQ (XCAR (object
), Qheader_line
))
6261 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6265 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6272 /* Store into *addr a value nonzero if terminal input chars are available.
6273 Serves the purpose of ioctl (0, FIONREAD, addr)
6274 but works even if FIONREAD does not exist.
6275 (In fact, this may actually read some input.)
6277 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6278 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6281 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6286 /* First of all, have we already counted some input? */
6287 *addr
= (!NILP (Vquit_flag
)
6288 || readable_filtered_events (do_timers_now
, filter_events
));
6290 /* If input is being read as it arrives, and we have none, there is none. */
6291 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6294 /* Try to read some input and see how much we get. */
6296 *addr
= (!NILP (Vquit_flag
)
6297 || readable_filtered_events (do_timers_now
, filter_events
));
6300 /* Store into *addr a value nonzero if terminal input chars are available.
6301 Serves the purpose of ioctl (0, FIONREAD, addr)
6302 but works even if FIONREAD does not exist.
6303 (In fact, this may actually read some input.)
6305 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6308 get_input_pending (addr
, do_timers_now
)
6312 get_filtered_input_pending (addr
, do_timers_now
, 0);
6315 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6318 gobble_input (expected
)
6323 if (interrupt_input
)
6326 mask
= sigblock (sigmask (SIGIO
));
6327 read_avail_input (expected
);
6331 #ifdef POLL_FOR_INPUT
6332 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6335 mask
= sigblock (sigmask (SIGALRM
));
6336 read_avail_input (expected
);
6342 read_avail_input (expected
);
6346 /* Put a BUFFER_SWITCH_EVENT in the buffer
6347 so that read_key_sequence will notice the new current buffer. */
6350 record_asynch_buffer_change ()
6352 struct input_event event
;
6355 event
.kind
= BUFFER_SWITCH_EVENT
;
6356 event
.frame_or_window
= Qnil
;
6360 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6361 The purpose of the event is to make read_key_sequence look up the
6362 keymaps again. If we aren't in read_key_sequence, we don't need one,
6363 and the event could cause trouble by messing up (input-pending-p). */
6364 tem
= Fwaiting_for_user_input_p ();
6368 /* We never need these events if we have no asynchronous subprocesses. */
6372 /* Make sure no interrupt happens while storing the event. */
6374 if (interrupt_input
)
6377 mask
= sigblock (sigmask (SIGIO
));
6378 kbd_buffer_store_event (&event
);
6385 kbd_buffer_store_event (&event
);
6392 /* Read any terminal input already buffered up by the system
6393 into the kbd_buffer, but do not wait.
6395 EXPECTED should be nonzero if the caller knows there is some input.
6397 Except on VMS, all input is read by this function.
6398 If interrupt_input is nonzero, this function MUST be called
6399 only when SIGIO is blocked.
6401 Returns the number of keyboard chars read, or -1 meaning
6402 this is a bad time to try to read input. */
6405 read_avail_input (expected
)
6408 struct input_event buf
[KBD_BUFFER_SIZE
];
6412 if (read_socket_hook
)
6413 /* No need for FIONREAD or fcntl; just say don't wait. */
6414 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6417 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6418 the kbd_buffer can really hold. That may prevent loss
6419 of characters on some systems when input is stuffed at us. */
6420 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6423 /* Determine how many characters we should *try* to read. */
6426 #else /* not WINDOWSNT */
6428 n_to_read
= dos_keysns ();
6431 #else /* not MSDOS */
6433 /* Find out how much input is available. */
6434 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6435 /* Formerly simply reported no input, but that sometimes led to
6436 a failure of Emacs to terminate.
6437 SIGHUP seems appropriate if we can't reach the terminal. */
6438 /* ??? Is it really right to send the signal just to this process
6439 rather than to the whole process group?
6440 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6441 kill (getpid (), SIGHUP
);
6444 if (n_to_read
> sizeof cbuf
)
6445 n_to_read
= sizeof cbuf
;
6446 #else /* no FIONREAD */
6447 #if defined (USG) || defined (DGUX)
6448 /* Read some input if available, but don't wait. */
6449 n_to_read
= sizeof cbuf
;
6450 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6455 #endif /* not MSDOS */
6456 #endif /* not WINDOWSNT */
6458 /* Now read; for one reason or another, this will not block.
6459 NREAD is set to the number of chars read. */
6463 cbuf
[0] = dos_keyread ();
6466 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6468 /* POSIX infers that processes which are not in the session leader's
6469 process group won't get SIGHUP's at logout time. BSDI adheres to
6470 this part standard and returns -1 from read (0) with errno==EIO
6471 when the control tty is taken away.
6472 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6473 if (nread
== -1 && errno
== EIO
)
6475 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6476 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6477 This looks incorrect, but it isn't, because _BSD causes
6478 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6479 and that causes a value other than 0 when there is no input. */
6485 /* We used to retry the read if it was interrupted.
6486 But this does the wrong thing when O_NDELAY causes
6487 an EAGAIN error. Does anybody know of a situation
6488 where a retry is actually needed? */
6490 nread
< 0 && (errno
== EAGAIN
6504 #if defined (USG) || defined (DGUX)
6505 fcntl (input_fd
, F_SETFL
, 0);
6506 #endif /* USG or DGUX */
6507 #endif /* no FIONREAD */
6508 for (i
= 0; i
< nread
; i
++)
6510 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6511 buf
[i
].modifiers
= 0;
6512 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6513 buf
[i
].modifiers
= meta_modifier
;
6517 buf
[i
].code
= cbuf
[i
];
6518 buf
[i
].frame_or_window
= selected_frame
;
6523 /* Scan the chars for C-g and store them in kbd_buffer. */
6524 for (i
= 0; i
< nread
; i
++)
6526 kbd_buffer_store_event (&buf
[i
]);
6527 /* Don't look at input that follows a C-g too closely.
6528 This reduces lossage due to autorepeat on C-g. */
6529 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6530 && buf
[i
].code
== quit_char
)
6536 #endif /* not VMS */
6538 #ifdef SIGIO /* for entire page */
6539 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6542 input_available_signal (signo
)
6545 /* Must preserve main program's value of errno. */
6546 int old_errno
= errno
;
6548 extern int select_alarmed
;
6551 #if defined (USG) && !defined (POSIX_SIGNALS)
6552 /* USG systems forget handlers when they are used;
6553 must reestablish each time */
6554 signal (signo
, input_available_signal
);
6561 if (input_available_clear_time
)
6562 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6567 nread
= read_avail_input (1);
6568 /* -1 means it's not ok to read the input now.
6569 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6570 0 means there was no keyboard input available. */
6575 select_alarmed
= 1; /* Force the select emulator back to life */
6586 /* Send ourselves a SIGIO.
6588 This function exists so that the UNBLOCK_INPUT macro in
6589 blockinput.h can have some way to take care of input we put off
6590 dealing with, without assuming that every file which uses
6591 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6593 reinvoke_input_signal ()
6596 kill (getpid (), SIGIO
);
6602 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6603 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6605 /* These variables hold the vector under construction within
6606 menu_bar_items and its subroutines, and the current index
6607 for storing into that vector. */
6608 static Lisp_Object menu_bar_items_vector
;
6609 static int menu_bar_items_index
;
6611 /* Return a vector of menu items for a menu bar, appropriate
6612 to the current buffer. Each item has three elements in the vector:
6615 OLD is an old vector we can optionally reuse, or nil. */
6618 menu_bar_items (old
)
6621 /* The number of keymaps we're scanning right now, and the number of
6622 keymaps we have allocated space for. */
6625 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6626 in the current keymaps, or nil where it is not a prefix. */
6629 Lisp_Object def
, tail
;
6638 struct gcpro gcpro1
;
6640 /* In order to build the menus, we need to call the keymap
6641 accessors. They all call QUIT. But this function is called
6642 during redisplay, during which a quit is fatal. So inhibit
6643 quitting while building the menus.
6644 We do this instead of specbind because (1) errors will clear it anyway
6645 and (2) this avoids risk of specpdl overflow. */
6646 oquit
= Vinhibit_quit
;
6650 menu_bar_items_vector
= old
;
6652 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6653 menu_bar_items_index
= 0;
6655 GCPRO1 (menu_bar_items_vector
);
6657 /* Build our list of keymaps.
6658 If we recognize a function key and replace its escape sequence in
6659 keybuf with its symbol, or if the sequence starts with a mouse
6660 click and we need to switch buffers, we jump back here to rebuild
6661 the initial keymaps from the current buffer. */
6665 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6666 if (!NILP (Voverriding_local_map_menu_flag
))
6668 /* Yes, use them (if non-nil) as well as the global map. */
6669 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6671 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6672 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6673 if (!NILP (Voverriding_local_map
))
6674 maps
[nmaps
++] = Voverriding_local_map
;
6678 /* No, so use major and minor mode keymaps and keymap property.
6679 Note that menu-bar bindings in the local-map and keymap
6680 properties may not work reliable, as they are only
6681 recognized when the menu-bar (or mode-line) is updated,
6682 which does not normally happen after every command. */
6685 nminor
= current_minor_maps (NULL
, &tmaps
);
6686 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6688 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6689 maps
[nmaps
++] = tem
;
6690 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6692 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6694 maps
[nmaps
++] = current_global_map
;
6697 /* Look up in each map the dummy prefix key `menu-bar'. */
6701 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6702 if (!NILP (maps
[mapno
]))
6704 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6707 menu_bar_one_keymap (def
);
6710 /* Move to the end those items that should be at the end. */
6712 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6715 int end
= menu_bar_items_index
;
6717 for (i
= 0; i
< end
; i
+= 4)
6718 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6720 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6721 /* Move the item at index I to the end,
6722 shifting all the others forward. */
6723 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6724 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6725 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6726 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6728 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6729 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6730 (end
- i
- 4) * sizeof (Lisp_Object
));
6731 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6732 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6733 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6734 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6739 /* Add nil, nil, nil, nil at the end. */
6740 i
= menu_bar_items_index
;
6741 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6744 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6745 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6746 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6747 menu_bar_items_vector
= tem
;
6749 /* Add this item. */
6750 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6751 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6752 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6753 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6754 menu_bar_items_index
= i
;
6756 Vinhibit_quit
= oquit
;
6758 return menu_bar_items_vector
;
6761 /* Scan one map KEYMAP, accumulating any menu items it defines
6762 in menu_bar_items_vector. */
6764 static Lisp_Object menu_bar_one_keymap_changed_items
;
6767 menu_bar_one_keymap (keymap
)
6770 Lisp_Object tail
, item
;
6772 menu_bar_one_keymap_changed_items
= Qnil
;
6774 /* Loop over all keymap entries that have menu strings. */
6775 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6779 menu_bar_item (XCAR (item
), XCDR (item
));
6780 else if (VECTORP (item
))
6782 /* Loop over the char values represented in the vector. */
6783 int len
= XVECTOR (item
)->size
;
6785 for (c
= 0; c
< len
; c
++)
6787 Lisp_Object character
;
6788 XSETFASTINT (character
, c
);
6789 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6795 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6796 If there's already an item for KEY, add this DEF to it. */
6798 Lisp_Object item_properties
;
6801 menu_bar_item (key
, item
)
6802 Lisp_Object key
, item
;
6804 struct gcpro gcpro1
;
6808 if (EQ (item
, Qundefined
))
6810 /* If a map has an explicit `undefined' as definition,
6811 discard any previously made menu bar item. */
6813 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6814 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6816 if (menu_bar_items_index
> i
+ 4)
6817 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6818 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6819 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6820 menu_bar_items_index
-= 4;
6824 /* If this keymap has already contributed to this KEY,
6825 don't contribute to it a second time. */
6826 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6827 if (!NILP (tem
) || NILP (item
))
6830 menu_bar_one_keymap_changed_items
6831 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6833 /* We add to menu_bar_one_keymap_changed_items before doing the
6834 parse_menu_item, so that if it turns out it wasn't a menu item,
6835 it still correctly hides any further menu item. */
6837 i
= parse_menu_item (item
, 0, 1);
6842 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6844 /* Find any existing item for this KEY. */
6845 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6846 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6849 /* If we did not find this KEY, add it at the end. */
6850 if (i
== menu_bar_items_index
)
6852 /* If vector is too small, get a bigger one. */
6853 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6856 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6857 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6858 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6859 menu_bar_items_vector
= tem
;
6862 /* Add this item. */
6863 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6864 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6865 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6866 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6867 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6868 menu_bar_items_index
= i
;
6870 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6874 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6875 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6879 /* This is used as the handler when calling menu_item_eval_property. */
6881 menu_item_eval_property_1 (arg
)
6884 /* If we got a quit from within the menu computation,
6885 quit all the way out of it. This takes care of C-] in the debugger. */
6886 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6887 Fsignal (Qquit
, Qnil
);
6892 /* Evaluate an expression and return the result (or nil if something
6893 went wrong). Used to evaluate dynamic parts of menu items. */
6895 menu_item_eval_property (sexpr
)
6898 int count
= SPECPDL_INDEX ();
6900 specbind (Qinhibit_redisplay
, Qt
);
6901 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6902 menu_item_eval_property_1
);
6903 return unbind_to (count
, val
);
6906 /* This function parses a menu item and leaves the result in the
6907 vector item_properties.
6908 ITEM is a key binding, a possible menu item.
6909 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6910 evaluate dynamic expressions in the menu item.
6911 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6913 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6914 parse_menu_item returns true if the item is a menu item and false
6918 parse_menu_item (item
, notreal
, inmenubar
)
6920 int notreal
, inmenubar
;
6922 Lisp_Object def
, tem
, item_string
, start
;
6923 Lisp_Object cachelist
;
6925 Lisp_Object keyhint
;
6936 /* Create item_properties vector if necessary. */
6937 if (NILP (item_properties
))
6939 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6941 /* Initialize optional entries. */
6942 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6943 AREF (item_properties
, i
) = Qnil
;
6944 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
6946 /* Save the item here to protect it from GC. */
6947 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
6949 item_string
= XCAR (item
);
6953 if (STRINGP (item_string
))
6955 /* Old format menu item. */
6956 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6958 /* Maybe help string. */
6959 if (CONSP (item
) && STRINGP (XCAR (item
)))
6961 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6966 /* Maybe key binding cache. */
6967 if (CONSP (item
) && CONSP (XCAR (item
))
6968 && (NILP (XCAR (XCAR (item
)))
6969 || VECTORP (XCAR (XCAR (item
)))))
6971 cachelist
= XCAR (item
);
6975 /* This is the real definition--the function to run. */
6976 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
6978 /* Get enable property, if any. */
6981 tem
= Fget (item
, Qmenu_enable
);
6983 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6986 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6988 /* New format menu item. */
6989 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
6990 start
= XCDR (item
);
6993 /* We have a real binding. */
6994 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
6996 item
= XCDR (start
);
6997 /* Is there a cache list with key equivalences. */
6998 if (CONSP (item
) && CONSP (XCAR (item
)))
7000 cachelist
= XCAR (item
);
7004 /* Parse properties. */
7005 while (CONSP (item
) && CONSP (XCDR (item
)))
7010 if (EQ (tem
, QCenable
))
7011 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7012 else if (EQ (tem
, QCvisible
) && !notreal
)
7014 /* If got a visible property and that evaluates to nil
7015 then ignore this item. */
7016 tem
= menu_item_eval_property (XCAR (item
));
7020 else if (EQ (tem
, QChelp
))
7021 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7022 else if (EQ (tem
, QCfilter
))
7024 else if (EQ (tem
, QCkey_sequence
))
7027 if (NILP (cachelist
)
7028 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7029 /* Be GC protected. Set keyhint to item instead of tem. */
7032 else if (EQ (tem
, QCkeys
))
7035 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7036 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7038 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7043 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7045 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7047 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7054 else if (inmenubar
|| !NILP (start
))
7058 return 0; /* not a menu item */
7060 /* If item string is not a string, evaluate it to get string.
7061 If we don't get a string, skip this item. */
7062 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7063 if (!(STRINGP (item_string
) || notreal
))
7065 item_string
= menu_item_eval_property (item_string
);
7066 if (!STRINGP (item_string
))
7068 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7071 /* If got a filter apply it on definition. */
7072 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7075 def
= menu_item_eval_property (list2 (XCAR (filter
),
7076 list2 (Qquote
, def
)));
7078 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7081 /* Enable or disable selection of item. */
7082 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7088 tem
= menu_item_eval_property (tem
);
7089 if (inmenubar
&& NILP (tem
))
7090 return 0; /* Ignore disabled items in menu bar. */
7091 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7094 /* If we got no definition, this item is just unselectable text which
7095 is OK in a submenu but not in the menubar. */
7097 return (inmenubar
? 0 : 1);
7099 /* See if this is a separate pane or a submenu. */
7100 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7101 tem
= get_keymap (def
, 0, 1);
7102 /* For a subkeymap, just record its details and exit. */
7105 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7106 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7110 /* At the top level in the menu bar, do likewise for commands also.
7111 The menu bar does not display equivalent key bindings anyway.
7112 ITEM_PROPERTY_DEF is already set up properly. */
7116 /* This is a command. See if there is an equivalent key binding. */
7117 if (NILP (cachelist
))
7119 /* We have to create a cachelist. */
7120 CHECK_IMPURE (start
);
7121 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7122 cachelist
= XCAR (XCDR (start
));
7124 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7125 if (!NILP (keyhint
))
7127 XSETCAR (cachelist
, XCAR (keyhint
));
7130 else if (STRINGP (tem
))
7132 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7133 XSETCAR (cachelist
, Qt
);
7137 tem
= XCAR (cachelist
);
7144 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7146 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7149 def
= XCAR (prefix
);
7150 prefix
= XCDR (prefix
);
7153 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7155 if (!update_menu_bindings
)
7157 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7159 if (newcache
/* Always check first time. */
7160 /* Should we check everything when precomputing key
7162 /* If something had no key binding before, don't recheck it
7163 because that is too slow--except if we have a list of
7164 rebound commands in Vdefine_key_rebound_commands, do
7165 recheck any command that appears in that list. */
7166 || (CONSP (Vdefine_key_rebound_commands
)
7167 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7170 /* We had a saved key. Is it still bound to the command? */
7173 /* If the command is an alias for another
7174 (such as lmenu.el set it up), check if the
7175 original command matches the cached command. */
7176 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7177 chkcache
= 1; /* Need to recompute key binding. */
7181 /* Recompute equivalent key binding. If the command is an alias
7182 for another (such as lmenu.el set it up), see if the original
7183 command name has equivalent keys. Otherwise look up the
7184 specified command itself. We don't try both, because that
7185 makes lmenu menus slow. */
7187 && SYMBOLP (XSYMBOL (def
)->function
)
7188 && ! NILP (Fget (def
, Qmenu_alias
)))
7189 def
= XSYMBOL (def
)->function
;
7190 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7191 XSETCAR (cachelist
, tem
);
7194 XSETCDR (cachelist
, Qnil
);
7198 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7200 tem
= XCAR (cachelist
);
7204 newcache
= chkcache
;
7207 tem
= Fkey_description (tem
);
7210 if (STRINGP (XCAR (prefix
)))
7211 tem
= concat2 (XCAR (prefix
), tem
);
7212 if (STRINGP (XCDR (prefix
)))
7213 tem
= concat2 (tem
, XCDR (prefix
));
7215 XSETCDR (cachelist
, tem
);
7219 tem
= XCDR (cachelist
);
7220 if (newcache
&& !NILP (tem
))
7222 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7223 XSETCDR (cachelist
, tem
);
7226 /* If we only want to precompute equivalent key bindings, stop here. */
7230 /* If we have an equivalent key binding, use that. */
7231 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7233 /* Include this when menu help is implemented.
7234 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7235 if (!(NILP (tem) || STRINGP (tem)))
7237 tem = menu_item_eval_property (tem);
7240 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7244 /* Handle radio buttons or toggle boxes. */
7245 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7247 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7248 = menu_item_eval_property (tem
);
7255 /***********************************************************************
7257 ***********************************************************************/
7259 /* A vector holding tool bar items while they are parsed in function
7260 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7263 static Lisp_Object tool_bar_items_vector
;
7265 /* A vector holding the result of parse_tool_bar_item. Layout is like
7266 the one for a single item in tool_bar_items_vector. */
7268 static Lisp_Object tool_bar_item_properties
;
7270 /* Next free index in tool_bar_items_vector. */
7272 static int ntool_bar_items
;
7274 /* The symbols `tool-bar', and `:image'. */
7276 extern Lisp_Object Qtool_bar
;
7277 Lisp_Object QCimage
;
7279 /* Function prototypes. */
7281 static void init_tool_bar_items
P_ ((Lisp_Object
));
7282 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7283 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7284 static void append_tool_bar_item
P_ ((void));
7287 /* Return a vector of tool bar items for keymaps currently in effect.
7288 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7289 tool bar items found. */
7292 tool_bar_items (reuse
, nitems
)
7303 /* In order to build the menus, we need to call the keymap
7304 accessors. They all call QUIT. But this function is called
7305 during redisplay, during which a quit is fatal. So inhibit
7306 quitting while building the menus. We do this instead of
7307 specbind because (1) errors will clear it anyway and (2) this
7308 avoids risk of specpdl overflow. */
7309 oquit
= Vinhibit_quit
;
7312 /* Initialize tool_bar_items_vector and protect it from GC. */
7313 init_tool_bar_items (reuse
);
7315 /* Build list of keymaps in maps. Set nmaps to the number of maps
7318 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7319 if (!NILP (Voverriding_local_map_menu_flag
))
7321 /* Yes, use them (if non-nil) as well as the global map. */
7322 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7324 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7325 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7326 if (!NILP (Voverriding_local_map
))
7327 maps
[nmaps
++] = Voverriding_local_map
;
7331 /* No, so use major and minor mode keymaps and keymap property.
7332 Note that tool-bar bindings in the local-map and keymap
7333 properties may not work reliable, as they are only
7334 recognized when the tool-bar (or mode-line) is updated,
7335 which does not normally happen after every command. */
7338 nminor
= current_minor_maps (NULL
, &tmaps
);
7339 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7341 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7342 maps
[nmaps
++] = tem
;
7343 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7345 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7348 /* Add global keymap at the end. */
7349 maps
[nmaps
++] = current_global_map
;
7351 /* Process maps in reverse order and look up in each map the prefix
7353 for (i
= nmaps
- 1; i
>= 0; --i
)
7354 if (!NILP (maps
[i
]))
7358 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7363 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7364 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7366 Lisp_Object keydef
= XCAR (tail
);
7368 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7373 Vinhibit_quit
= oquit
;
7374 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7375 return tool_bar_items_vector
;
7379 /* Process the definition of KEY which is DEF. */
7382 process_tool_bar_item (key
, def
)
7383 Lisp_Object key
, def
;
7386 extern Lisp_Object Qundefined
;
7387 struct gcpro gcpro1
, gcpro2
;
7389 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7393 if (EQ (def
, Qundefined
))
7395 /* If a map has an explicit `undefined' as definition,
7396 discard any previously made item. */
7397 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7399 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7401 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7403 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7404 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7405 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7406 * sizeof (Lisp_Object
)));
7407 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7412 else if (parse_tool_bar_item (key
, def
))
7413 /* Append a new tool bar item to tool_bar_items_vector. Accept
7414 more than one definition for the same key. */
7415 append_tool_bar_item ();
7421 /* Parse a tool bar item specification ITEM for key KEY and return the
7422 result in tool_bar_item_properties. Value is zero if ITEM is
7425 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7427 CAPTION is the caption of the item, If it's not a string, it is
7428 evaluated to get a string.
7430 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7431 as binding are currently ignored.
7433 The following properties are recognized:
7437 FORM is evaluated and specifies whether the tool bar item is
7438 enabled or disabled.
7442 FORM is evaluated and specifies whether the tool bar item is visible.
7444 - `:filter FUNCTION'
7446 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7447 result is stored as the new binding.
7449 - `:button (TYPE SELECTED)'
7451 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7452 and specifies whether the button is selected (pressed) or not.
7456 IMAGES is either a single image specification or a vector of four
7457 image specifications. See enum tool_bar_item_images.
7459 - `:help HELP-STRING'.
7461 Gives a help string to display for the tool bar item. */
7464 parse_tool_bar_item (key
, item
)
7465 Lisp_Object key
, item
;
7467 /* Access slot with index IDX of vector tool_bar_item_properties. */
7468 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7470 Lisp_Object filter
= Qnil
;
7471 Lisp_Object caption
;
7474 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7475 Rule out items that aren't lists, don't start with
7476 `menu-item' or whose rest following `tool-bar-item' is not a
7479 || !EQ (XCAR (item
), Qmenu_item
)
7480 || (item
= XCDR (item
),
7484 /* Create tool_bar_item_properties vector if necessary. Reset it to
7486 if (VECTORP (tool_bar_item_properties
))
7488 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7492 tool_bar_item_properties
7493 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7496 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7497 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7499 /* Get the caption of the item. If the caption is not a string,
7500 evaluate it to get a string. If we don't get a string, skip this
7502 caption
= XCAR (item
);
7503 if (!STRINGP (caption
))
7505 caption
= menu_item_eval_property (caption
);
7506 if (!STRINGP (caption
))
7509 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7511 /* Give up if rest following the caption is not a list. */
7516 /* Store the binding. */
7517 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7520 /* Ignore cached key binding, if any. */
7521 if (CONSP (item
) && CONSP (XCAR (item
)))
7524 /* Process the rest of the properties. */
7525 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7527 Lisp_Object key
, value
;
7530 value
= XCAR (XCDR (item
));
7532 if (EQ (key
, QCenable
))
7533 /* `:enable FORM'. */
7534 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7535 else if (EQ (key
, QCvisible
))
7537 /* `:visible FORM'. If got a visible property and that
7538 evaluates to nil then ignore this item. */
7539 if (NILP (menu_item_eval_property (value
)))
7542 else if (EQ (key
, QChelp
))
7543 /* `:help HELP-STRING'. */
7544 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7545 else if (EQ (key
, QCfilter
))
7546 /* ':filter FORM'. */
7548 else if (EQ (key
, QCbutton
) && CONSP (value
))
7550 /* `:button (TYPE . SELECTED)'. */
7551 Lisp_Object type
, selected
;
7553 type
= XCAR (value
);
7554 selected
= XCDR (value
);
7555 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7557 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7558 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7561 else if (EQ (key
, QCimage
)
7563 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7564 /* Value is either a single image specification or a vector
7565 of 4 such specifications for the different button states. */
7566 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7569 /* If got a filter apply it on binding. */
7571 PROP (TOOL_BAR_ITEM_BINDING
)
7572 = menu_item_eval_property (list2 (filter
,
7574 PROP (TOOL_BAR_ITEM_BINDING
))));
7576 /* See if the binding is a keymap. Give up if it is. */
7577 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7580 /* Enable or disable selection of item. */
7581 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7582 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7583 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7585 /* Handle radio buttons or toggle boxes. */
7586 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7587 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7588 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7596 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7597 that can be reused. */
7600 init_tool_bar_items (reuse
)
7603 if (VECTORP (reuse
))
7604 tool_bar_items_vector
= reuse
;
7606 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7607 ntool_bar_items
= 0;
7611 /* Append parsed tool bar item properties from
7612 tool_bar_item_properties */
7615 append_tool_bar_item ()
7617 Lisp_Object
*to
, *from
;
7619 /* Enlarge tool_bar_items_vector if necessary. */
7620 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7621 >= XVECTOR (tool_bar_items_vector
)->size
)
7623 Lisp_Object new_vector
;
7624 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7626 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7627 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7628 XVECTOR (new_vector
)->contents
,
7629 old_size
* sizeof (Lisp_Object
));
7630 tool_bar_items_vector
= new_vector
;
7633 /* Append entries from tool_bar_item_properties to the end of
7634 tool_bar_items_vector. */
7635 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7636 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7637 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7638 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7645 /* Read a character using menus based on maps in the array MAPS.
7646 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7647 Return t if we displayed a menu but the user rejected it.
7649 PREV_EVENT is the previous input event, or nil if we are reading
7650 the first event of a key sequence.
7652 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7653 if we used a mouse menu to read the input, or zero otherwise. If
7654 USED_MOUSE_MENU is null, we don't dereference it.
7656 The prompting is done based on the prompt-string of the map
7657 and the strings associated with various map elements.
7659 This can be done with X menus or with menus put in the minibuf.
7660 These are done in different ways, depending on how the input will be read.
7661 Menus using X are done after auto-saving in read-char, getting the input
7662 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7663 and do auto-saving in the inner call of read_char. */
7666 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7669 Lisp_Object prev_event
;
7670 int *used_mouse_menu
;
7673 register Lisp_Object name
;
7675 if (used_mouse_menu
)
7676 *used_mouse_menu
= 0;
7678 /* Use local over global Menu maps */
7680 if (! menu_prompting
)
7683 /* Optionally disregard all but the global map. */
7684 if (inhibit_local_menu_bar_menus
)
7686 maps
+= (nmaps
- 1);
7690 /* Get the menu name from the first map that has one (a prompt string). */
7691 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7693 name
= Fkeymap_prompt (maps
[mapno
]);
7698 /* If we don't have any menus, just read a character normally. */
7699 if (!STRINGP (name
))
7703 /* If we got to this point via a mouse click,
7704 use a real menu for mouse selection. */
7705 if (EVENT_HAS_PARAMETERS (prev_event
)
7706 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7707 && !EQ (XCAR (prev_event
), Qtool_bar
))
7709 /* Display the menu and get the selection. */
7710 Lisp_Object
*realmaps
7711 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7715 /* Use the maps that are not nil. */
7716 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7717 if (!NILP (maps
[mapno
]))
7718 realmaps
[nmaps1
++] = maps
[mapno
];
7720 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7725 record_menu_key (XCAR (value
));
7727 /* If we got multiple events, unread all but
7729 There is no way to prevent those unread events
7730 from showing up later in last_nonmenu_event.
7731 So turn symbol and integer events into lists,
7732 to indicate that they came from a mouse menu,
7733 so that when present in last_nonmenu_event
7734 they won't confuse things. */
7735 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7737 record_menu_key (XCAR (tem
));
7738 if (SYMBOLP (XCAR (tem
))
7739 || INTEGERP (XCAR (tem
)))
7740 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7743 /* If we got more than one event, put all but the first
7744 onto this list to be read later.
7745 Return just the first event now. */
7746 Vunread_command_events
7747 = nconc2 (XCDR (value
), Vunread_command_events
);
7748 value
= XCAR (value
);
7750 else if (NILP (value
))
7752 if (used_mouse_menu
)
7753 *used_mouse_menu
= 1;
7756 #endif /* HAVE_MENUS */
7760 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7761 We make this bigger when necessary, and never free it. */
7762 static char *read_char_minibuf_menu_text
;
7763 /* Size of that buffer. */
7764 static int read_char_minibuf_menu_width
;
7767 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7773 register Lisp_Object name
;
7775 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7778 Lisp_Object rest
, vector
;
7784 if (! menu_prompting
)
7787 /* Make sure we have a big enough buffer for the menu text. */
7788 if (read_char_minibuf_menu_text
== 0)
7790 read_char_minibuf_menu_width
= width
+ 4;
7791 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7793 else if (width
+ 4 > read_char_minibuf_menu_width
)
7795 read_char_minibuf_menu_width
= width
+ 4;
7796 read_char_minibuf_menu_text
7797 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7799 menu
= read_char_minibuf_menu_text
;
7801 /* Get the menu name from the first map that has one (a prompt string). */
7802 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7804 name
= Fkeymap_prompt (maps
[mapno
]);
7809 /* If we don't have any menus, just read a character normally. */
7810 if (!STRINGP (name
))
7813 /* Prompt string always starts with map's prompt, and a space. */
7814 strcpy (menu
, SDATA (name
));
7815 nlength
= SBYTES (name
);
7816 menu
[nlength
++] = ':';
7817 menu
[nlength
++] = ' ';
7820 /* Start prompting at start of first map. */
7824 /* Present the documented bindings, a line at a time. */
7831 Lisp_Object orig_defn_macro
;
7833 /* Loop over elements of map. */
7838 /* If reached end of map, start at beginning of next map. */
7842 /* At end of last map, wrap around to first map if just starting,
7843 or end this line if already have something on it. */
7847 if (notfirst
|| nobindings
) break;
7852 /* Look at the next element of the map. */
7854 elt
= XVECTOR (vector
)->contents
[idx
];
7856 elt
= Fcar_safe (rest
);
7858 if (idx
< 0 && VECTORP (elt
))
7860 /* If we found a dense table in the keymap,
7861 advanced past it, but start scanning its contents. */
7862 rest
= Fcdr_safe (rest
);
7868 /* An ordinary element. */
7869 Lisp_Object event
, tem
;
7873 event
= Fcar_safe (elt
); /* alist */
7874 elt
= Fcdr_safe (elt
);
7878 XSETINT (event
, idx
); /* vector */
7881 /* Ignore the element if it has no prompt string. */
7882 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7884 /* 1 if the char to type matches the string. */
7886 Lisp_Object upcased_event
, downcased_event
;
7887 Lisp_Object desc
= Qnil
;
7889 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7891 upcased_event
= Fupcase (event
);
7892 downcased_event
= Fdowncase (event
);
7893 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
7894 || XINT (downcased_event
) == SREF (s
, 0));
7896 desc
= Fsingle_key_description (event
, Qnil
);
7898 #if 0 /* It is redundant to list the equivalent key bindings because
7899 the prefix is what the user has already typed. */
7901 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7903 /* Insert equivalent keybinding. */
7904 s
= concat2 (s
, tem
);
7907 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7908 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7910 /* Insert button prefix. */
7911 Lisp_Object selected
7912 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7913 if (EQ (tem
, QCradio
))
7914 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7916 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7917 s
= concat2 (tem
, s
);
7921 /* If we have room for the prompt string, add it to this line.
7922 If this is the first on the line, always add it. */
7923 if ((SCHARS (s
) + i
+ 2
7924 + (char_matches
? 0 : SCHARS (desc
) + 3))
7930 /* Punctuate between strings. */
7933 strcpy (menu
+ i
, ", ");
7939 /* If the char to type doesn't match the string's
7940 first char, explicitly show what char to type. */
7943 /* Add as much of string as fits. */
7944 thiswidth
= SCHARS (desc
);
7945 if (thiswidth
+ i
> width
)
7946 thiswidth
= width
- i
;
7947 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
7949 strcpy (menu
+ i
, " = ");
7953 /* Add as much of string as fits. */
7954 thiswidth
= SCHARS (s
);
7955 if (thiswidth
+ i
> width
)
7956 thiswidth
= width
- i
;
7957 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
7963 /* If this element does not fit, end the line now,
7964 and save the element for the next line. */
7965 strcpy (menu
+ i
, "...");
7970 /* Move past this element. */
7971 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7972 /* Handle reaching end of dense table. */
7977 rest
= Fcdr_safe (rest
);
7981 /* Prompt with that and read response. */
7982 message2_nolog (menu
, strlen (menu
),
7983 ! NILP (current_buffer
->enable_multibyte_characters
));
7985 /* Make believe its not a keyboard macro in case the help char
7986 is pressed. Help characters are not recorded because menu prompting
7987 is not used on replay.
7989 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7990 current_kboard
->defining_kbd_macro
= Qnil
;
7992 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
7993 while (BUFFERP (obj
));
7994 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7996 if (!INTEGERP (obj
))
8001 if (! EQ (obj
, menu_prompt_more_char
)
8002 && (!INTEGERP (menu_prompt_more_char
)
8003 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8005 if (!NILP (current_kboard
->defining_kbd_macro
))
8006 store_kbd_macro_char (obj
);
8009 /* Help char - go round again */
8013 /* Reading key sequences. */
8015 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8016 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8017 keymap, or nil otherwise. Return the index of the first keymap in
8018 which KEY has any binding, or NMAPS if no map has a binding.
8020 If KEY is a meta ASCII character, treat it like meta-prefix-char
8021 followed by the corresponding non-meta character. Keymaps in
8022 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8025 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8028 NEXT may be the same array as CURRENT. */
8031 follow_key (key
, nmaps
, current
, defs
, next
)
8033 Lisp_Object
*current
, *defs
, *next
;
8036 int i
, first_binding
;
8039 first_binding
= nmaps
;
8040 for (i
= nmaps
- 1; i
>= 0; i
--)
8042 if (! NILP (current
[i
]))
8050 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
8051 if (! NILP (defs
[i
]))
8058 /* Given the set of bindings we've found, produce the next set of maps. */
8059 if (first_binding
< nmaps
)
8060 for (i
= 0; i
< nmaps
; i
++)
8061 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8063 return first_binding
;
8066 /* Structure used to keep track of partial application of key remapping
8067 such as Vfunction_key_map and Vkey_translation_map. */
8068 typedef struct keyremap
8075 /* Read a sequence of keys that ends with a non prefix character,
8076 storing it in KEYBUF, a buffer of size BUFSIZE.
8078 Return the length of the key sequence stored.
8079 Return -1 if the user rejected a command menu.
8081 Echo starting immediately unless `prompt' is 0.
8083 Where a key sequence ends depends on the currently active keymaps.
8084 These include any minor mode keymaps active in the current buffer,
8085 the current buffer's local map, and the global map.
8087 If a key sequence has no other bindings, we check Vfunction_key_map
8088 to see if some trailing subsequence might be the beginning of a
8089 function key's sequence. If so, we try to read the whole function
8090 key, and substitute its symbolic name into the key sequence.
8092 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8093 `double-' events into similar click events, if that would make them
8094 bound. We try to turn `triple-' events first into `double-' events,
8097 If we get a mouse click in a mode line, vertical divider, or other
8098 non-text area, we treat the click as if it were prefixed by the
8099 symbol denoting that area - `mode-line', `vertical-line', or
8102 If the sequence starts with a mouse click, we read the key sequence
8103 with respect to the buffer clicked on, not the current buffer.
8105 If the user switches frames in the midst of a key sequence, we put
8106 off the switch-frame event until later; the next call to
8107 read_char will return it.
8109 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8110 from the selected window's buffer. */
8113 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8114 can_return_switch_frame
, fix_current_buffer
)
8115 Lisp_Object
*keybuf
;
8118 int dont_downcase_last
;
8119 int can_return_switch_frame
;
8120 int fix_current_buffer
;
8122 volatile Lisp_Object from_string
;
8123 volatile int count
= SPECPDL_INDEX ();
8125 /* How many keys there are in the current key sequence. */
8128 /* The length of the echo buffer when we started reading, and
8129 the length of this_command_keys when we started reading. */
8130 volatile int echo_start
;
8131 volatile int keys_start
;
8133 /* The number of keymaps we're scanning right now, and the number of
8134 keymaps we have allocated space for. */
8136 volatile int nmaps_allocated
= 0;
8138 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8139 the current keymaps. */
8140 Lisp_Object
*volatile defs
= NULL
;
8142 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8143 in the current keymaps, or nil where it is not a prefix. */
8144 Lisp_Object
*volatile submaps
= NULL
;
8146 /* The local map to start out with at start of key sequence. */
8147 volatile Lisp_Object orig_local_map
;
8149 /* The map from the `keymap' property to start out with at start of
8151 volatile Lisp_Object orig_keymap
;
8153 /* 1 if we have already considered switching to the local-map property
8154 of the place where a mouse click occurred. */
8155 volatile int localized_local_map
= 0;
8157 /* The index in defs[] of the first keymap that has a binding for
8158 this key sequence. In other words, the lowest i such that
8159 defs[i] is non-nil. */
8160 volatile int first_binding
;
8161 /* Index of the first key that has no binding.
8162 It is useless to try fkey.start larger than that. */
8163 volatile int first_unbound
;
8165 /* If t < mock_input, then KEYBUF[t] should be read as the next
8168 We use this to recover after recognizing a function key. Once we
8169 realize that a suffix of the current key sequence is actually a
8170 function key's escape sequence, we replace the suffix with the
8171 function key's binding from Vfunction_key_map. Now keybuf
8172 contains a new and different key sequence, so the echo area,
8173 this_command_keys, and the submaps and defs arrays are wrong. In
8174 this situation, we set mock_input to t, set t to 0, and jump to
8175 restart_sequence; the loop will read keys from keybuf up until
8176 mock_input, thus rebuilding the state; and then it will resume
8177 reading characters from the keyboard. */
8178 volatile int mock_input
= 0;
8180 /* If the sequence is unbound in submaps[], then
8181 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8182 and fkey.map is its binding.
8184 These might be > t, indicating that all function key scanning
8185 should hold off until t reaches them. We do this when we've just
8186 recognized a function key, to avoid searching for the function
8187 key's again in Vfunction_key_map. */
8188 volatile keyremap fkey
;
8190 /* Likewise, for key_translation_map. */
8191 volatile keyremap keytran
;
8193 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8194 we put it off for later. While we're reading, we keep the event here. */
8195 volatile Lisp_Object delayed_switch_frame
;
8197 /* See the comment below... */
8198 #if defined (GOBBLE_FIRST_EVENT)
8199 Lisp_Object first_event
;
8202 volatile Lisp_Object original_uppercase
;
8203 volatile int original_uppercase_position
= -1;
8205 /* Gets around Microsoft compiler limitations. */
8208 struct buffer
*starting_buffer
;
8210 /* List of events for which a fake prefix key has been generated. */
8211 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8213 #if defined (GOBBLE_FIRST_EVENT)
8217 struct gcpro gcpro1
;
8219 GCPRO1 (fake_prefixed_keys
);
8220 raw_keybuf_count
= 0;
8222 last_nonmenu_event
= Qnil
;
8224 delayed_switch_frame
= Qnil
;
8225 fkey
.map
= Vfunction_key_map
;
8226 keytran
.map
= Vkey_translation_map
;
8227 /* If there is no translation-map, turn off scanning. */
8228 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8229 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8234 echo_prompt (prompt
);
8235 else if (cursor_in_echo_area
8236 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8237 && NILP (Fzerop (Vecho_keystrokes
)))
8238 /* This doesn't put in a dash if the echo buffer is empty, so
8239 you don't always see a dash hanging out in the minibuffer. */
8243 /* Record the initial state of the echo area and this_command_keys;
8244 we will need to restore them if we replay a key sequence. */
8246 echo_start
= echo_length ();
8247 keys_start
= this_command_key_count
;
8248 this_single_command_key_start
= keys_start
;
8250 #if defined (GOBBLE_FIRST_EVENT)
8251 /* This doesn't quite work, because some of the things that read_char
8252 does cannot safely be bypassed. It seems too risky to try to make
8255 /* Read the first char of the sequence specially, before setting
8256 up any keymaps, in case a filter runs and switches buffers on us. */
8257 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8259 #endif /* GOBBLE_FIRST_EVENT */
8261 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8262 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8265 /* We jump here when the key sequence has been thoroughly changed, and
8266 we need to rescan it starting from the beginning. When we jump here,
8267 keybuf[0..mock_input] holds the sequence we should reread. */
8270 starting_buffer
= current_buffer
;
8271 first_unbound
= bufsize
+ 1;
8273 /* Build our list of keymaps.
8274 If we recognize a function key and replace its escape sequence in
8275 keybuf with its symbol, or if the sequence starts with a mouse
8276 click and we need to switch buffers, we jump back here to rebuild
8277 the initial keymaps from the current buffer. */
8280 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8281 || !NILP (Voverriding_local_map
))
8283 if (3 > nmaps_allocated
)
8285 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8286 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8287 nmaps_allocated
= 3;
8289 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8290 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8291 if (!NILP (Voverriding_local_map
))
8292 submaps
[nmaps
++] = Voverriding_local_map
;
8300 nminor
= current_minor_maps (0, &maps
);
8301 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8303 if (total
> nmaps_allocated
)
8305 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8306 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8307 nmaps_allocated
= total
;
8310 if (!NILP (orig_keymap
))
8311 submaps
[nmaps
++] = orig_keymap
;
8313 bcopy (maps
, (void *) (submaps
+ nmaps
),
8314 nminor
* sizeof (submaps
[0]));
8318 submaps
[nmaps
++] = orig_local_map
;
8320 submaps
[nmaps
++] = current_global_map
;
8322 /* Find an accurate initial value for first_binding. */
8323 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8324 if (! NILP (submaps
[first_binding
]))
8327 /* Start from the beginning in keybuf. */
8330 /* These are no-ops the first time through, but if we restart, they
8331 revert the echo area and this_command_keys to their original state. */
8332 this_command_key_count
= keys_start
;
8333 if (INTERACTIVE
&& t
< mock_input
)
8334 echo_truncate (echo_start
);
8336 /* If the best binding for the current key sequence is a keymap, or
8337 we may be looking at a function key's escape sequence, keep on
8339 while (first_binding
< nmaps
8340 /* Keep reading as long as there's a prefix binding. */
8341 ? !NILP (submaps
[first_binding
])
8342 /* Don't return in the middle of a possible function key sequence,
8343 if the only bindings we found were via case conversion.
8344 Thus, if ESC O a has a function-key-map translation
8345 and ESC o has a binding, don't return after ESC O,
8346 so that we can translate ESC O plus the next character. */
8347 : (fkey
.start
< t
|| keytran
.start
< t
))
8350 int used_mouse_menu
= 0;
8352 /* Where the last real key started. If we need to throw away a
8353 key that has expanded into more than one element of keybuf
8354 (say, a mouse click on the mode line which is being treated
8355 as [mode-line (mouse-...)], then we backtrack to this point
8357 volatile int last_real_key_start
;
8359 /* These variables are analogous to echo_start and keys_start;
8360 while those allow us to restart the entire key sequence,
8361 echo_local_start and keys_local_start allow us to throw away
8363 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8365 /* key-translation-map is applied *after* function-key-map. */
8366 eassert (keytran
.end
<= fkey
.start
);
8368 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8369 { /* The prefix upto first_unbound has no binding and has
8370 no translation left to do either, so we know it's unbound.
8371 If we don't stop now, we risk staying here indefinitely
8372 (if the user keeps entering fkey or keytran prefixes
8373 like C-c ESC ESC ESC ESC ...) */
8375 for (i
= first_unbound
+ 1; i
< t
; i
++)
8376 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8377 mock_input
= t
- first_unbound
- 1;
8378 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8379 fkey
.map
= Vfunction_key_map
;
8380 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8381 keytran
.map
= Vkey_translation_map
;
8382 goto replay_sequence
;
8386 error ("Key sequence too long");
8389 echo_local_start
= echo_length ();
8390 keys_local_start
= this_command_key_count
;
8391 local_first_binding
= first_binding
;
8394 /* These are no-ops, unless we throw away a keystroke below and
8395 jumped back up to replay_key; in that case, these restore the
8396 variables to their original state, allowing us to replay the
8398 if (INTERACTIVE
&& t
< mock_input
)
8399 echo_truncate (echo_local_start
);
8400 this_command_key_count
= keys_local_start
;
8401 first_binding
= local_first_binding
;
8403 /* By default, assume each event is "real". */
8404 last_real_key_start
= t
;
8406 /* Does mock_input indicate that we are re-reading a key sequence? */
8410 add_command_key (key
);
8411 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8412 && NILP (Fzerop (Vecho_keystrokes
)))
8416 /* If not, we should actually read a character. */
8421 KBOARD
*interrupted_kboard
= current_kboard
;
8422 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8423 if (setjmp (wrong_kboard_jmpbuf
))
8425 if (!NILP (delayed_switch_frame
))
8427 interrupted_kboard
->kbd_queue
8428 = Fcons (delayed_switch_frame
,
8429 interrupted_kboard
->kbd_queue
);
8430 delayed_switch_frame
= Qnil
;
8433 interrupted_kboard
->kbd_queue
8434 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8436 /* If the side queue is non-empty, ensure it begins with a
8437 switch-frame, so we'll replay it in the right context. */
8438 if (CONSP (interrupted_kboard
->kbd_queue
)
8439 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8440 !(EVENT_HAS_PARAMETERS (key
)
8441 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8445 XSETFRAME (frame
, interrupted_frame
);
8446 interrupted_kboard
->kbd_queue
8447 = Fcons (make_lispy_switch_frame (frame
),
8448 interrupted_kboard
->kbd_queue
);
8451 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8452 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8453 goto replay_sequence
;
8456 key
= read_char (NILP (prompt
), nmaps
,
8457 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8461 /* read_char returns t when it shows a menu and the user rejects it.
8465 unbind_to (count
, Qnil
);
8470 /* read_char returns -1 at the end of a macro.
8471 Emacs 18 handles this by returning immediately with a
8472 zero, so that's what we'll do. */
8473 if (INTEGERP (key
) && XINT (key
) == -1)
8476 /* The Microsoft C compiler can't handle the goto that
8482 /* If the current buffer has been changed from under us, the
8483 keymap may have changed, so replay the sequence. */
8486 EMACS_TIME initial_idleness_start_time
;
8487 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8488 EMACS_SECS (timer_last_idleness_start_time
),
8489 EMACS_USECS (timer_last_idleness_start_time
));
8491 /* Resume idle state, using the same start-time as before. */
8492 timer_start_idle ();
8493 timer_idleness_start_time
= initial_idleness_start_time
;
8496 /* Reset the current buffer from the selected window
8497 in case something changed the former and not the latter.
8498 This is to be more consistent with the behavior
8499 of the command_loop_1. */
8500 if (fix_current_buffer
)
8502 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8504 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8505 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8508 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8509 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8510 goto replay_sequence
;
8513 /* If we have a quit that was typed in another frame, and
8514 quit_throw_to_read_char switched buffers,
8515 replay to get the right keymap. */
8517 && XINT (key
) == quit_char
8518 && current_buffer
!= starting_buffer
)
8521 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8525 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8526 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8527 goto replay_sequence
;
8532 if (EVENT_HAS_PARAMETERS (key
)
8533 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8535 /* If we're at the beginning of a key sequence, and the caller
8536 says it's okay, go ahead and return this event. If we're
8537 in the midst of a key sequence, delay it until the end. */
8538 if (t
> 0 || !can_return_switch_frame
)
8540 delayed_switch_frame
= key
;
8546 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8549 /* Clicks in non-text areas get prefixed by the symbol
8550 in their CHAR-ADDRESS field. For example, a click on
8551 the mode line is prefixed by the symbol `mode-line'.
8553 Furthermore, key sequences beginning with mouse clicks
8554 are read using the keymaps of the buffer clicked on, not
8555 the current buffer. So we may have to switch the buffer
8558 When we turn one event into two events, we must make sure
8559 that neither of the two looks like the original--so that,
8560 if we replay the events, they won't be expanded again.
8561 If not for this, such reexpansion could happen either here
8562 or when user programs play with this-command-keys. */
8563 if (EVENT_HAS_PARAMETERS (key
))
8567 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8568 if (EQ (kind
, Qmouse_click
))
8570 Lisp_Object window
, posn
;
8572 window
= POSN_WINDOW (EVENT_START (key
));
8573 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8576 || (!NILP (fake_prefixed_keys
)
8577 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8579 /* We're looking a second time at an event for which
8580 we generated a fake prefix key. Set
8581 last_real_key_start appropriately. */
8583 last_real_key_start
= t
- 1;
8586 /* Key sequences beginning with mouse clicks are
8587 read using the keymaps in the buffer clicked on,
8588 not the current buffer. If we're at the
8589 beginning of a key sequence, switch buffers. */
8590 if (last_real_key_start
== 0
8592 && BUFFERP (XWINDOW (window
)->buffer
)
8593 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8595 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8599 /* Arrange to go back to the original buffer once we're
8600 done reading the key sequence. Note that we can't
8601 use save_excursion_{save,restore} here, because they
8602 save point as well as the current buffer; we don't
8603 want to save point, because redisplay may change it,
8604 to accommodate a Fset_window_start or something. We
8605 don't want to do this at the top of the function,
8606 because we may get input from a subprocess which
8607 wants to change the selected window and stuff (say,
8609 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8611 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8613 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8614 orig_local_map
= get_local_map (PT
, current_buffer
,
8616 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8617 goto replay_sequence
;
8620 /* For a mouse click, get the local text-property keymap
8621 of the place clicked on, rather than point. */
8622 if (last_real_key_start
== 0
8623 && CONSP (XCDR (key
))
8624 && ! localized_local_map
)
8626 Lisp_Object map_here
, start
, pos
;
8628 localized_local_map
= 1;
8629 start
= EVENT_START (key
);
8631 if (CONSP (start
) && CONSP (XCDR (start
)))
8633 pos
= POSN_BUFFER_POSN (start
);
8635 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8637 map_here
= get_local_map (XINT (pos
),
8638 current_buffer
, Qlocal_map
);
8639 if (!EQ (map_here
, orig_local_map
))
8641 orig_local_map
= map_here
;
8645 goto replay_sequence
;
8647 map_here
= get_local_map (XINT (pos
),
8648 current_buffer
, Qkeymap
);
8649 if (!EQ (map_here
, orig_keymap
))
8651 orig_keymap
= map_here
;
8655 goto replay_sequence
;
8661 /* Expand mode-line and scroll-bar events into two events:
8662 use posn as a fake prefix key. */
8664 && (NILP (fake_prefixed_keys
)
8665 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8667 if (t
+ 1 >= bufsize
)
8668 error ("Key sequence too long");
8671 keybuf
[t
+ 1] = key
;
8674 /* Record that a fake prefix key has been generated
8675 for KEY. Don't modify the event; this would
8676 prevent proper action when the event is pushed
8677 back into unread-command-events. */
8678 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8680 /* If on a mode line string with a local keymap,
8681 reconsider the key sequence with that keymap. */
8682 if (CONSP (POSN_STRING (EVENT_START (key
))))
8684 Lisp_Object string
, pos
, map
, map2
;
8686 string
= POSN_STRING (EVENT_START (key
));
8687 pos
= XCDR (string
);
8688 string
= XCAR (string
);
8690 && XINT (pos
) < SCHARS (string
))
8692 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8694 orig_local_map
= map
;
8695 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8698 if (!NILP (map
) || !NILP (map2
))
8699 goto replay_sequence
;
8705 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8706 && NILP (from_string
))
8708 /* For a click on a string, i.e. overlay string or a
8709 string displayed via the `display' property,
8710 consider `local-map' and `keymap' properties of
8712 Lisp_Object string
, pos
, map
, map2
;
8714 string
= POSN_STRING (EVENT_START (key
));
8715 pos
= XCDR (string
);
8716 string
= XCAR (string
);
8718 && XINT (pos
) < SCHARS (string
))
8720 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8722 orig_local_map
= map
;
8723 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8727 if (!NILP (map
) || !NILP (map2
))
8729 from_string
= string
;
8730 goto replay_sequence
;
8735 else if (CONSP (XCDR (key
))
8736 && CONSP (EVENT_START (key
))
8737 && CONSP (XCDR (EVENT_START (key
))))
8741 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8742 /* Handle menu-bar events:
8743 insert the dummy prefix event `menu-bar'. */
8744 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8746 if (t
+ 1 >= bufsize
)
8747 error ("Key sequence too long");
8751 /* Zap the position in key, so we know that we've
8752 expanded it, and don't try to do so again. */
8753 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8754 Fcons (posn
, Qnil
));
8757 goto replay_sequence
;
8759 else if (CONSP (posn
))
8761 /* We're looking at the second event of a
8762 sequence which we expanded before. Set
8763 last_real_key_start appropriately. */
8764 if (last_real_key_start
== t
&& t
> 0)
8765 last_real_key_start
= t
- 1;
8770 /* We have finally decided that KEY is something we might want
8772 first_binding
= (follow_key (key
,
8773 nmaps
- first_binding
,
8774 submaps
+ first_binding
,
8775 defs
+ first_binding
,
8776 submaps
+ first_binding
)
8779 /* If KEY wasn't bound, we'll try some fallbacks. */
8780 if (first_binding
< nmaps
)
8781 /* This is needed for the following scenario:
8782 event 0: a down-event that gets dropped by calling replay_key.
8783 event 1: some normal prefix like C-h.
8784 After event 0, first_unbound is 0, after event 1 fkey.start
8785 and keytran.start are both 1, so when we see that C-h is bound,
8786 we need to update first_unbound. */
8787 first_unbound
= max (t
+ 1, first_unbound
);
8792 /* Remember the position to put an upper bound on fkey.start. */
8793 first_unbound
= min (t
, first_unbound
);
8795 head
= EVENT_HEAD (key
);
8796 if (help_char_p (head
) && t
> 0)
8798 read_key_sequence_cmd
= Vprefix_help_command
;
8800 last_nonmenu_event
= key
;
8801 /* The Microsoft C compiler can't handle the goto that
8809 Lisp_Object breakdown
;
8812 breakdown
= parse_modifiers (head
);
8813 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8814 /* Attempt to reduce an unbound mouse event to a simpler
8815 event that is bound:
8816 Drags reduce to clicks.
8817 Double-clicks reduce to clicks.
8818 Triple-clicks reduce to double-clicks, then to clicks.
8819 Down-clicks are eliminated.
8820 Double-downs reduce to downs, then are eliminated.
8821 Triple-downs reduce to double-downs, then to downs,
8822 then are eliminated. */
8823 if (modifiers
& (down_modifier
| drag_modifier
8824 | double_modifier
| triple_modifier
))
8826 while (modifiers
& (down_modifier
| drag_modifier
8827 | double_modifier
| triple_modifier
))
8829 Lisp_Object new_head
, new_click
;
8830 if (modifiers
& triple_modifier
)
8831 modifiers
^= (double_modifier
| triple_modifier
);
8832 else if (modifiers
& double_modifier
)
8833 modifiers
&= ~double_modifier
;
8834 else if (modifiers
& drag_modifier
)
8835 modifiers
&= ~drag_modifier
;
8838 /* Dispose of this `down' event by simply jumping
8839 back to replay_key, to get another event.
8841 Note that if this event came from mock input,
8842 then just jumping back to replay_key will just
8843 hand it to us again. So we have to wipe out any
8846 We could delete keybuf[t] and shift everything
8847 after that to the left by one spot, but we'd also
8848 have to fix up any variable that points into
8849 keybuf, and shifting isn't really necessary
8852 Adding prefixes for non-textual mouse clicks
8853 creates two characters of mock input, and both
8854 must be thrown away. If we're only looking at
8855 the prefix now, we can just jump back to
8856 replay_key. On the other hand, if we've already
8857 processed the prefix, and now the actual click
8858 itself is giving us trouble, then we've lost the
8859 state of the keymaps we want to backtrack to, and
8860 we need to replay the whole sequence to rebuild
8863 Beyond that, only function key expansion could
8864 create more than two keys, but that should never
8865 generate mouse events, so it's okay to zero
8866 mock_input in that case too.
8868 FIXME: The above paragraph seems just plain
8869 wrong, if you consider things like
8870 xterm-mouse-mode. -stef
8872 Isn't this just the most wonderful code ever? */
8873 if (t
== last_real_key_start
)
8880 mock_input
= last_real_key_start
;
8881 goto replay_sequence
;
8886 = apply_modifiers (modifiers
, XCAR (breakdown
));
8888 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8890 /* Look for a binding for this new key. follow_key
8891 promises that it didn't munge submaps the
8892 last time we called it, since key was unbound. */
8894 = (follow_key (new_click
,
8895 nmaps
- local_first_binding
,
8896 submaps
+ local_first_binding
,
8897 defs
+ local_first_binding
,
8898 submaps
+ local_first_binding
)
8899 + local_first_binding
);
8901 /* If that click is bound, go for it. */
8902 if (first_binding
< nmaps
)
8907 /* Otherwise, we'll leave key set to the drag event. */
8914 /* Normally, last_nonmenu_event gets the previous key we read.
8915 But when a mouse popup menu is being used,
8916 we don't update last_nonmenu_event; it continues to hold the mouse
8917 event that preceded the first level of menu. */
8918 if (!used_mouse_menu
)
8919 last_nonmenu_event
= key
;
8921 /* Record what part of this_command_keys is the current key sequence. */
8922 this_single_command_key_start
= this_command_key_count
- t
;
8924 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
8925 /* There is a binding and it's not a prefix.
8926 There is thus no function-key in this sequence.
8927 Moving fkey.start is important in this case to allow keytran.start
8928 to go over the sequence before we return (since we keep the
8929 invariant that keytran.end <= fkey.start). */
8932 (fkey
.start
= fkey
.end
= t
, fkey
.map
= Vfunction_key_map
);
8935 /* If the sequence is unbound, see if we can hang a function key
8936 off the end of it. */
8940 /* Continue scan from fkey.end until we find a bound suffix.
8941 If we fail, increment fkey.start and start over from there. */
8942 while (fkey
.end
< t
)
8946 key
= keybuf
[fkey
.end
++];
8947 next
= access_keymap (fkey
.map
, key
, 1, 0, 1);
8949 /* Handle symbol with autoload definition. */
8950 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
8951 && CONSP (XSYMBOL (next
)->function
)
8952 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8953 do_autoload (XSYMBOL (next
)->function
, next
);
8955 /* Handle a symbol whose function definition is a keymap
8957 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
8958 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8959 || KEYMAPP (XSYMBOL (next
)->function
)))
8960 next
= XSYMBOL (next
)->function
;
8962 #if 0 /* I didn't turn this on, because it might cause trouble
8963 for the mapping of return into C-m and tab into C-i. */
8964 /* Optionally don't map function keys into other things.
8965 This enables the user to redefine kp- keys easily. */
8966 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8970 /* If the function key map gives a function, not an
8971 array, then call the function with no args and use
8972 its value instead. */
8973 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
8974 /* If there's a binding (i.e. first_binding >= nmaps)
8975 we don't want to apply this function-key-mapping. */
8976 && fkey
.end
== t
&& first_binding
>= nmaps
)
8978 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8982 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
8983 next
= call1 (next
, prompt
);
8985 /* If the function returned something invalid,
8986 barf--don't ignore it.
8987 (To ignore it safely, we would need to gcpro a bunch of
8988 other variables.) */
8989 if (! (VECTORP (next
) || STRINGP (next
)))
8990 error ("Function in key-translation-map returns invalid key sequence");
8993 /* If keybuf[fkey.start..fkey.end] is bound in the
8994 function key map and it's a suffix of the current
8995 sequence (i.e. fkey.end == t), replace it with
8996 the binding and restart with fkey.start at the end. */
8997 if ((VECTORP (next
) || STRINGP (next
))
8998 /* If there's a binding (i.e. first_binding >= nmaps)
8999 we don't want to apply this function-key-mapping. */
9000 && fkey
.end
== t
&& first_binding
>= nmaps
)
9002 int len
= XFASTINT (Flength (next
));
9004 t
= fkey
.start
+ len
;
9006 error ("Key sequence too long");
9009 bcopy (XVECTOR (next
)->contents
,
9010 keybuf
+ fkey
.start
,
9011 (t
- fkey
.start
) * sizeof (keybuf
[0]));
9012 else if (STRINGP (next
))
9016 for (i
= 0; i
< len
; i
++)
9017 XSETFASTINT (keybuf
[fkey
.start
+ i
], SREF (next
, i
));
9021 fkey
.start
= fkey
.end
= t
;
9022 fkey
.map
= Vfunction_key_map
;
9024 /* Do pass the results through key-translation-map.
9025 But don't retranslate what key-translation-map
9026 has already translated. */
9027 keytran
.end
= keytran
.start
;
9028 keytran
.map
= Vkey_translation_map
;
9030 goto replay_sequence
;
9033 fkey
.map
= get_keymap (next
, 0, 1);
9035 /* If we no longer have a bound suffix, try a new positions for
9037 if (!CONSP (fkey
.map
))
9039 fkey
.end
= ++fkey
.start
;
9040 fkey
.map
= Vfunction_key_map
;
9045 /* Look for this sequence in key-translation-map. */
9049 /* Scan from keytran.end until we find a bound suffix. */
9050 while (keytran
.end
< fkey
.start
)
9054 key
= keybuf
[keytran
.end
++];
9055 next
= access_keymap (keytran
.map
, key
, 1, 0, 1);
9057 /* Handle symbol with autoload definition. */
9058 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9059 && CONSP (XSYMBOL (next
)->function
)
9060 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9061 do_autoload (XSYMBOL (next
)->function
, next
);
9063 /* Handle a symbol whose function definition is a keymap
9065 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9066 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9067 || KEYMAPP (XSYMBOL (next
)->function
)))
9068 next
= XSYMBOL (next
)->function
;
9070 /* If the key translation map gives a function, not an
9071 array, then call the function with one arg and use
9072 its value instead. */
9073 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
)))
9075 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9079 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9080 next
= call1 (next
, prompt
);
9082 /* If the function returned something invalid,
9083 barf--don't ignore it.
9084 (To ignore it safely, we would need to gcpro a bunch of
9085 other variables.) */
9086 if (! (VECTORP (next
) || STRINGP (next
)))
9087 error ("Function in key-translation-map returns invalid key sequence");
9090 /* If keybuf[keytran.start..keytran.end] is bound in the
9091 key translation map and it's a suffix of the current
9092 sequence (i.e. keytran.end == t), replace it with
9093 the binding and restart with keytran.start at the end. */
9094 if ((VECTORP (next
) || STRINGP (next
)))
9096 int len
= XFASTINT (Flength (next
));
9097 int i
, diff
= len
- (keytran
.end
- keytran
.start
);
9099 mock_input
= max (t
, mock_input
);
9100 if (mock_input
+ diff
>= bufsize
)
9101 error ("Key sequence too long");
9103 /* Shift the keys that are after keytran.end. */
9105 for (i
= keytran
.end
; i
< mock_input
; i
++)
9106 keybuf
[i
+ diff
] = keybuf
[i
];
9108 for (i
= mock_input
- 1; i
>= keytran
.end
; i
--)
9109 keybuf
[i
+ diff
] = keybuf
[i
];
9110 /* Replace the keys between keytran.start and keytran.end
9111 with those from next. */
9112 for (i
= 0; i
< len
; i
++)
9113 keybuf
[keytran
.start
+ i
]
9114 = Faref (next
, make_number (i
));
9117 keytran
.start
= keytran
.end
+= diff
;
9118 keytran
.map
= Vkey_translation_map
;
9120 /* Adjust the function-key-map counters. */
9124 goto replay_sequence
;
9127 keytran
.map
= get_keymap (next
, 0, 1);
9129 /* If we no longer have a bound suffix, try a new positions for
9131 if (!CONSP (keytran
.map
))
9133 keytran
.end
= ++keytran
.start
;
9134 keytran
.map
= Vkey_translation_map
;
9139 /* If KEY is not defined in any of the keymaps,
9140 and cannot be part of a function key or translation,
9141 and is an upper case letter
9142 use the corresponding lower-case letter instead. */
9143 if (first_binding
>= nmaps
9144 && fkey
.start
>= t
&& keytran
.start
>= t
9146 && ((((XINT (key
) & 0x3ffff)
9147 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9148 && UPPERCASEP (XINT (key
) & 0x3ffff))
9149 || (XINT (key
) & shift_modifier
)))
9151 Lisp_Object new_key
;
9153 original_uppercase
= key
;
9154 original_uppercase_position
= t
- 1;
9156 if (XINT (key
) & shift_modifier
)
9157 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9159 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9160 | (XINT (key
) & ~0x3ffff)));
9162 /* We have to do this unconditionally, regardless of whether
9163 the lower-case char is defined in the keymaps, because they
9164 might get translated through function-key-map. */
9165 keybuf
[t
- 1] = new_key
;
9166 mock_input
= max (t
, mock_input
);
9168 goto replay_sequence
;
9170 /* If KEY is not defined in any of the keymaps,
9171 and cannot be part of a function key or translation,
9172 and is a shifted function key,
9173 use the corresponding unshifted function key instead. */
9174 if (first_binding
>= nmaps
9175 && fkey
.start
>= t
&& keytran
.start
>= t
9178 Lisp_Object breakdown
;
9181 breakdown
= parse_modifiers (key
);
9182 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9183 if (modifiers
& shift_modifier
)
9185 Lisp_Object new_key
;
9187 original_uppercase
= key
;
9188 original_uppercase_position
= t
- 1;
9190 modifiers
&= ~shift_modifier
;
9191 new_key
= apply_modifiers (modifiers
,
9194 keybuf
[t
- 1] = new_key
;
9195 mock_input
= max (t
, mock_input
);
9197 goto replay_sequence
;
9203 read_key_sequence_cmd
= (first_binding
< nmaps
9204 ? defs
[first_binding
]
9207 unread_switch_frame
= delayed_switch_frame
;
9208 unbind_to (count
, Qnil
);
9210 /* Don't downcase the last character if the caller says don't.
9211 Don't downcase it if the result is undefined, either. */
9212 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9213 && t
- 1 == original_uppercase_position
)
9214 keybuf
[t
- 1] = original_uppercase
;
9216 /* Occasionally we fabricate events, perhaps by expanding something
9217 according to function-key-map, or by adding a prefix symbol to a
9218 mouse click in the scroll bar or modeline. In this cases, return
9219 the entire generated key sequence, even if we hit an unbound
9220 prefix or a definition before the end. This means that you will
9221 be able to push back the event properly, and also means that
9222 read-key-sequence will always return a logical unit.
9225 for (; t
< mock_input
; t
++)
9227 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9228 && NILP (Fzerop (Vecho_keystrokes
)))
9229 echo_char (keybuf
[t
]);
9230 add_command_key (keybuf
[t
]);
9239 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9240 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9241 The sequence is sufficient to specify a non-prefix command in the
9242 current local and global maps.
9244 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9245 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9246 as a continuation of the previous key.
9248 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9249 convert the last event to lower case. (Normally any upper case event
9250 is converted to lower case if the original event is undefined and the lower
9251 case equivalent is defined.) A non-nil value is appropriate for reading
9252 a key sequence to be defined.
9254 A C-g typed while in this function is treated like any other character,
9255 and `quit-flag' is not set.
9257 If the key sequence starts with a mouse click, then the sequence is read
9258 using the keymaps of the buffer of the window clicked in, not the buffer
9259 of the selected window as normal.
9261 `read-key-sequence' drops unbound button-down events, since you normally
9262 only care about the click or drag events which follow them. If a drag
9263 or multi-click event is unbound, but the corresponding click event would
9264 be bound, `read-key-sequence' turns the event into a click event at the
9265 drag's starting position. This means that you don't have to distinguish
9266 between click and drag, double, or triple events unless you want to.
9268 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9269 lines separating windows, and scroll bars with imaginary keys
9270 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9272 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9273 function will process a switch-frame event if the user switches frames
9274 before typing anything. If the user switches frames in the middle of a
9275 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9276 is nil, then the event will be put off until after the current key sequence.
9278 `read-key-sequence' checks `function-key-map' for function key
9279 sequences, where they wouldn't conflict with ordinary bindings. See
9280 `function-key-map' for more details.
9282 The optional fifth argument COMMAND-LOOP, if non-nil, means
9283 that this key sequence is being read by something that will
9284 read commands one after another. It should be nil if the caller
9285 will read just one key sequence. */)
9286 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9288 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9289 Lisp_Object can_return_switch_frame
, command_loop
;
9291 Lisp_Object keybuf
[30];
9293 struct gcpro gcpro1
;
9294 int count
= SPECPDL_INDEX ();
9297 CHECK_STRING (prompt
);
9300 specbind (Qinput_method_exit_on_first_char
,
9301 (NILP (command_loop
) ? Qt
: Qnil
));
9302 specbind (Qinput_method_use_echo_area
,
9303 (NILP (command_loop
) ? Qt
: Qnil
));
9305 bzero (keybuf
, sizeof keybuf
);
9307 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9309 if (NILP (continue_echo
))
9311 this_command_key_count
= 0;
9312 this_single_command_key_start
= 0;
9315 #ifdef HAVE_X_WINDOWS
9316 if (display_hourglass_p
)
9317 cancel_hourglass ();
9320 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9321 prompt
, ! NILP (dont_downcase_last
),
9322 ! NILP (can_return_switch_frame
), 0);
9324 #if 0 /* The following is fine for code reading a key sequence and
9325 then proceeding with a lenghty computation, but it's not good
9326 for code reading keys in a loop, like an input method. */
9327 #ifdef HAVE_X_WINDOWS
9328 if (display_hourglass_p
)
9339 return unbind_to (count
, make_event_array (i
, keybuf
));
9342 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9343 Sread_key_sequence_vector
, 1, 5, 0,
9344 doc
: /* Like `read-key-sequence' but always return a vector. */)
9345 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9347 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9348 Lisp_Object can_return_switch_frame
, command_loop
;
9350 Lisp_Object keybuf
[30];
9352 struct gcpro gcpro1
;
9353 int count
= SPECPDL_INDEX ();
9356 CHECK_STRING (prompt
);
9359 specbind (Qinput_method_exit_on_first_char
,
9360 (NILP (command_loop
) ? Qt
: Qnil
));
9361 specbind (Qinput_method_use_echo_area
,
9362 (NILP (command_loop
) ? Qt
: Qnil
));
9364 bzero (keybuf
, sizeof keybuf
);
9366 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9368 if (NILP (continue_echo
))
9370 this_command_key_count
= 0;
9371 this_single_command_key_start
= 0;
9374 #ifdef HAVE_X_WINDOWS
9375 if (display_hourglass_p
)
9376 cancel_hourglass ();
9379 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9380 prompt
, ! NILP (dont_downcase_last
),
9381 ! NILP (can_return_switch_frame
), 0);
9383 #ifdef HAVE_X_WINDOWS
9384 if (display_hourglass_p
)
9394 return unbind_to (count
, Fvector (i
, keybuf
));
9397 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9398 doc
: /* Execute CMD as an editor command.
9399 CMD must be a symbol that satisfies the `commandp' predicate.
9400 Optional second arg RECORD-FLAG non-nil
9401 means unconditionally put this command in `command-history'.
9402 Otherwise, that is done only if an arg is read using the minibuffer.
9403 The argument KEYS specifies the value to use instead of (this-command-keys)
9404 when reading the arguments; if it is nil, (this-command-keys) is used.
9405 The argument SPECIAL, if non-nil, means that this command is executing
9406 a special event, so ignore the prefix argument and don't clear it. */)
9407 (cmd
, record_flag
, keys
, special
)
9408 Lisp_Object cmd
, record_flag
, keys
, special
;
9410 register Lisp_Object final
;
9411 register Lisp_Object tem
;
9412 Lisp_Object prefixarg
;
9413 struct backtrace backtrace
;
9414 extern int debug_on_next_call
;
9416 debug_on_next_call
= 0;
9420 prefixarg
= current_kboard
->Vprefix_arg
;
9421 Vcurrent_prefix_arg
= prefixarg
;
9422 current_kboard
->Vprefix_arg
= Qnil
;
9429 tem
= Fget (cmd
, Qdisabled
);
9430 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9432 tem
= Fsymbol_value (Qdisabled_command_hook
);
9434 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9440 final
= Findirect_function (cmd
);
9442 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9444 struct gcpro gcpro1
, gcpro2
;
9446 GCPRO2 (cmd
, prefixarg
);
9447 do_autoload (final
, cmd
);
9454 if (STRINGP (final
) || VECTORP (final
))
9456 /* If requested, place the macro in the command history. For
9457 other sorts of commands, call-interactively takes care of
9459 if (!NILP (record_flag
))
9462 = Fcons (Fcons (Qexecute_kbd_macro
,
9463 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9466 /* Don't keep command history around forever. */
9467 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9469 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9471 XSETCDR (tem
, Qnil
);
9475 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9478 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9480 backtrace
.next
= backtrace_list
;
9481 backtrace_list
= &backtrace
;
9482 backtrace
.function
= &Qcall_interactively
;
9483 backtrace
.args
= &cmd
;
9484 backtrace
.nargs
= 1;
9485 backtrace
.evalargs
= 0;
9487 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9489 backtrace_list
= backtrace
.next
;
9497 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9499 doc
: /* Read function name, then read its arguments and call it. */)
9501 Lisp_Object prefixarg
;
9503 Lisp_Object function
;
9505 int saved_last_point_position
;
9506 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9507 Lisp_Object bindings
, value
;
9508 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9510 saved_keys
= Fvector (this_command_key_count
,
9511 XVECTOR (this_command_keys
)->contents
);
9512 saved_last_point_position_buffer
= last_point_position_buffer
;
9513 saved_last_point_position
= last_point_position
;
9515 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9517 if (EQ (prefixarg
, Qminus
))
9519 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9520 strcpy (buf
, "C-u ");
9521 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9523 if (sizeof (int) == sizeof (EMACS_INT
))
9524 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9525 else if (sizeof (long) == sizeof (EMACS_INT
))
9526 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9530 else if (INTEGERP (prefixarg
))
9532 if (sizeof (int) == sizeof (EMACS_INT
))
9533 sprintf (buf
, "%d ", XINT (prefixarg
));
9534 else if (sizeof (long) == sizeof (EMACS_INT
))
9535 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9540 /* This isn't strictly correct if execute-extended-command
9541 is bound to anything else. Perhaps it should use
9542 this_command_keys? */
9543 strcat (buf
, "M-x ");
9545 /* Prompt with buf, and then read a string, completing from and
9546 restricting to the set of all defined commands. Don't provide
9547 any initial input. Save the command read on the extended-command
9549 function
= Fcompleting_read (build_string (buf
),
9550 Vobarray
, Qcommandp
,
9551 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9554 if (STRINGP (function
) && SCHARS (function
) == 0)
9555 error ("No command name given");
9557 /* Set this_command_keys to the concatenation of saved_keys and
9558 function, followed by a RET. */
9563 this_command_key_count
= 0;
9564 this_single_command_key_start
= 0;
9566 keys
= XVECTOR (saved_keys
)->contents
;
9567 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9568 add_command_key (keys
[i
]);
9570 for (i
= 0; i
< SCHARS (function
); i
++)
9571 add_command_key (Faref (function
, make_number (i
)));
9573 add_command_key (make_number ('\015'));
9576 last_point_position
= saved_last_point_position
;
9577 last_point_position_buffer
= saved_last_point_position_buffer
;
9581 function
= Fintern (function
, Qnil
);
9582 current_kboard
->Vprefix_arg
= prefixarg
;
9583 Vthis_command
= function
;
9584 real_this_command
= function
;
9586 /* If enabled, show which key runs this command. */
9587 if (!NILP (Vsuggest_key_bindings
)
9588 && NILP (Vexecuting_macro
)
9589 && SYMBOLP (function
))
9590 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9596 GCPRO2 (bindings
, value
);
9597 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9599 /* If the command has a key binding, print it now. */
9600 if (!NILP (bindings
)
9601 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9604 /* But first wait, and skip the message if there is input. */
9606 if (!NILP (echo_area_buffer
[0]))
9607 /* This command displayed something in the echo area;
9608 so wait a few seconds, then display our suggestion message. */
9609 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9610 ? XINT (Vsuggest_key_bindings
) : 2);
9612 /* This command left the echo area empty,
9613 so display our message immediately. */
9616 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9617 && ! CONSP (Vunread_command_events
))
9619 Lisp_Object binding
;
9621 int message_p
= push_message ();
9622 int count
= SPECPDL_INDEX ();
9624 record_unwind_protect (pop_message_unwind
, Qnil
);
9625 binding
= Fkey_description (bindings
);
9628 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9631 sprintf (newmessage
, "You can run the command `%s' with %s",
9632 SDATA (SYMBOL_NAME (function
)),
9634 message2_nolog (newmessage
,
9635 strlen (newmessage
),
9636 STRING_MULTIBYTE (binding
));
9637 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9638 ? Vsuggest_key_bindings
: make_number (2)),
9643 unbind_to (count
, Qnil
);
9647 RETURN_UNGCPRO (value
);
9651 /* Return nonzero if input events are pending. */
9654 detect_input_pending ()
9657 get_input_pending (&input_pending
, 0);
9659 return input_pending
;
9662 /* Return nonzero if input events are pending, and run any pending timers. */
9665 detect_input_pending_run_timers (do_display
)
9668 int old_timers_run
= timers_run
;
9671 get_input_pending (&input_pending
, 1);
9673 if (old_timers_run
!= timers_run
&& do_display
)
9675 redisplay_preserve_echo_area (8);
9676 /* The following fixes a bug when using lazy-lock with
9677 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9678 from an idle timer function. The symptom of the bug is that
9679 the cursor sometimes doesn't become visible until the next X
9680 event is processed. --gerd. */
9682 rif
->flush_display (NULL
);
9685 return input_pending
;
9688 /* This is called in some cases before a possible quit.
9689 It cases the next call to detect_input_pending to recompute input_pending.
9690 So calling this function unnecessarily can't do any harm. */
9693 clear_input_pending ()
9698 /* Return nonzero if there are pending requeued events.
9699 This isn't used yet. The hope is to make wait_reading_process_input
9700 call it, and return if it runs Lisp code that unreads something.
9701 The problem is, kbd_buffer_get_event needs to be fixed to know what
9702 to do in that case. It isn't trivial. */
9705 requeued_events_pending_p ()
9707 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9711 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9712 doc
: /* Return t if command input is currently available with no wait.
9713 Actually, the value is nil only if we can be sure that no input is available;
9714 if there is a doubt, the value is t. */)
9717 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9720 get_filtered_input_pending (&input_pending
, 1, 1);
9721 return input_pending
> 0 ? Qt
: Qnil
;
9724 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9725 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9728 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9731 if (total_keys
< NUM_RECENT_KEYS
)
9732 return Fvector (total_keys
, keys
);
9735 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9736 bcopy (keys
+ recent_keys_index
,
9737 XVECTOR (val
)->contents
,
9738 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9740 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9741 recent_keys_index
* sizeof (Lisp_Object
));
9746 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9747 doc
: /* Return the key sequence that invoked this command.
9748 However, if the command has called `read-key-sequence', it returns
9749 the last key sequence that has been read.
9750 The value is a string or a vector. */)
9753 return make_event_array (this_command_key_count
,
9754 XVECTOR (this_command_keys
)->contents
);
9757 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9758 doc
: /* Return the key sequence that invoked this command, as a vector.
9759 However, if the command has called `read-key-sequence', it returns
9760 the last key sequence that has been read. */)
9763 return Fvector (this_command_key_count
,
9764 XVECTOR (this_command_keys
)->contents
);
9767 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9768 Sthis_single_command_keys
, 0, 0, 0,
9769 doc
: /* Return the key sequence that invoked this command.
9770 More generally, it returns the last key sequence read, either by
9771 the command loop or by `read-key-sequence'.
9772 Unlike `this-command-keys', this function's value
9773 does not include prefix arguments.
9774 The value is always a vector. */)
9777 return Fvector (this_command_key_count
9778 - this_single_command_key_start
,
9779 (XVECTOR (this_command_keys
)->contents
9780 + this_single_command_key_start
));
9783 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9784 Sthis_single_command_raw_keys
, 0, 0, 0,
9785 doc
: /* Return the raw events that were read for this command.
9786 More generally, it returns the last key sequence read, either by
9787 the command loop or by `read-key-sequence'.
9788 Unlike `this-single-command-keys', this function's value
9789 shows the events before all translations (except for input methods).
9790 The value is always a vector. */)
9793 return Fvector (raw_keybuf_count
,
9794 (XVECTOR (raw_keybuf
)->contents
));
9797 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9798 Sreset_this_command_lengths
, 0, 0, 0,
9799 doc
: /* Used for complicated reasons in `universal-argument-other-key'.
9801 `universal-argument-other-key' rereads the event just typed.
9802 It then gets translated through `function-key-map'.
9803 The translated event gets included in the echo area and in
9804 the value of `this-command-keys' in addition to the raw original event.
9807 Calling this function directs the translated event to replace
9808 the original event, so that only one version of the event actually
9809 appears in the echo area and in the value of `this-command-keys'. */)
9812 before_command_restore_flag
= 1;
9813 before_command_key_count_1
= before_command_key_count
;
9814 before_command_echo_length_1
= before_command_echo_length
;
9818 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9819 Sclear_this_command_keys
, 0, 1, 0,
9820 doc
: /* Clear out the vector that `this-command-keys' returns.
9821 Also clear the record of the last 100 events, unless optional arg
9822 KEEP-RECORD is non-nil. */)
9824 Lisp_Object keep_record
;
9828 this_command_key_count
= 0;
9830 if (NILP (keep_record
))
9832 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9833 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9835 recent_keys_index
= 0;
9840 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9841 doc
: /* Return the current depth in recursive edits. */)
9845 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9849 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9850 "FOpen dribble file: ",
9851 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9852 If FILE is nil, close any open dribble file. */)
9863 file
= Fexpand_file_name (file
, Qnil
);
9864 dribble
= fopen (SDATA (file
), "w");
9866 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9871 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9872 doc
: /* Discard the contents of the terminal input buffer.
9873 Also end any kbd macro being defined. */)
9876 if (!NILP (current_kboard
->defining_kbd_macro
))
9878 /* Discard the last command from the macro. */
9879 Fcancel_kbd_macro_events ();
9883 update_mode_lines
++;
9885 Vunread_command_events
= Qnil
;
9886 unread_command_char
= -1;
9888 discard_tty_input ();
9890 kbd_fetch_ptr
= kbd_store_ptr
;
9891 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9897 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9898 doc
: /* Stop Emacs and return to superior process. You can resume later.
9899 If `cannot-suspend' is non-nil, or if the system doesn't support job
9900 control, run a subshell instead.
9902 If optional arg STUFFSTRING is non-nil, its characters are stuffed
9903 to be read as terminal input by Emacs's parent, after suspension.
9905 Before suspending, run the normal hook `suspend-hook'.
9906 After resumption run the normal hook `suspend-resume-hook'.
9908 Some operating systems cannot stop the Emacs process and resume it later.
9909 On such systems, Emacs starts a subshell instead of suspending. */)
9911 Lisp_Object stuffstring
;
9913 int count
= SPECPDL_INDEX ();
9914 int old_height
, old_width
;
9916 struct gcpro gcpro1
;
9918 if (!NILP (stuffstring
))
9919 CHECK_STRING (stuffstring
);
9921 /* Run the functions in suspend-hook. */
9922 if (!NILP (Vrun_hooks
))
9923 call1 (Vrun_hooks
, intern ("suspend-hook"));
9925 GCPRO1 (stuffstring
);
9926 get_frame_size (&old_width
, &old_height
);
9928 /* sys_suspend can get an error if it tries to fork a subshell
9929 and the system resources aren't available for that. */
9930 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9932 stuff_buffered_input (stuffstring
);
9937 unbind_to (count
, Qnil
);
9939 /* Check if terminal/window size has changed.
9940 Note that this is not useful when we are running directly
9941 with a window system; but suspend should be disabled in that case. */
9942 get_frame_size (&width
, &height
);
9943 if (width
!= old_width
|| height
!= old_height
)
9944 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9946 /* Run suspend-resume-hook. */
9947 if (!NILP (Vrun_hooks
))
9948 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9954 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9955 Then in any case stuff anything Emacs has read ahead and not used. */
9958 stuff_buffered_input (stuffstring
)
9959 Lisp_Object stuffstring
;
9961 /* stuff_char works only in BSD, versions 4.2 and up. */
9964 register unsigned char *p
;
9966 if (STRINGP (stuffstring
))
9970 p
= SDATA (stuffstring
);
9971 count
= SBYTES (stuffstring
);
9977 /* Anything we have read ahead, put back for the shell to read. */
9978 /* ?? What should this do when we have multiple keyboards??
9979 Should we ignore anything that was typed in at the "wrong" kboard? */
9980 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9984 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9985 kbd_fetch_ptr
= kbd_buffer
;
9986 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
9987 stuff_char (kbd_fetch_ptr
->code
);
9989 kbd_fetch_ptr
->kind
= NO_EVENT
;
9990 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
9991 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
9992 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
9997 #endif /* BSD_SYSTEM and not BSD4_1 */
10001 set_waiting_for_input (time_to_clear
)
10002 EMACS_TIME
*time_to_clear
;
10004 input_available_clear_time
= time_to_clear
;
10006 /* Tell interrupt_signal to throw back to read_char, */
10007 waiting_for_input
= 1;
10009 /* If interrupt_signal was called before and buffered a C-g,
10010 make it run again now, to avoid timing error. */
10011 if (!NILP (Vquit_flag
))
10012 quit_throw_to_read_char ();
10016 clear_waiting_for_input ()
10018 /* Tell interrupt_signal not to throw back to read_char, */
10019 waiting_for_input
= 0;
10020 input_available_clear_time
= 0;
10023 /* This routine is called at interrupt level in response to C-g.
10025 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10026 is called from kbd_buffer_store_event, in handling SIGIO or
10029 If `waiting_for_input' is non zero, then unless `echoing' is
10030 nonzero, immediately throw back to read_char.
10032 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10033 eval to throw, when it gets a chance. If quit-flag is already
10034 non-nil, it stops the job right away. */
10037 interrupt_signal (signalnum
) /* If we don't have an argument, */
10038 int signalnum
; /* some compilers complain in signal calls. */
10041 /* Must preserve main program's value of errno. */
10042 int old_errno
= errno
;
10043 struct frame
*sf
= SELECTED_FRAME ();
10045 #if defined (USG) && !defined (POSIX_SIGNALS)
10046 if (!read_socket_hook
&& NILP (Vwindow_system
))
10048 /* USG systems forget handlers when they are used;
10049 must reestablish each time */
10050 signal (SIGINT
, interrupt_signal
);
10051 signal (SIGQUIT
, interrupt_signal
);
10057 if (!NILP (Vquit_flag
)
10058 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10060 /* If SIGINT isn't blocked, don't let us be interrupted by
10061 another SIGINT, it might be harmful due to non-reentrancy
10062 in I/O functions. */
10063 sigblock (sigmask (SIGINT
));
10066 reset_sys_modes ();
10068 #ifdef SIGTSTP /* Support possible in later USG versions */
10070 * On systems which can suspend the current process and return to the original
10071 * shell, this command causes the user to end up back at the shell.
10072 * The "Auto-save" and "Abort" questions are not asked until
10073 * the user elects to return to emacs, at which point he can save the current
10074 * job and either dump core or continue.
10079 if (sys_suspend () == -1)
10081 printf ("Not running as a subprocess;\n");
10082 printf ("you can continue or abort.\n");
10084 #else /* not VMS */
10085 /* Perhaps should really fork an inferior shell?
10086 But that would not provide any way to get back
10087 to the original shell, ever. */
10088 printf ("No support for stopping a process on this operating system;\n");
10089 printf ("you can continue or abort.\n");
10090 #endif /* not VMS */
10091 #endif /* not SIGTSTP */
10093 /* We must remain inside the screen area when the internal terminal
10094 is used. Note that [Enter] is not echoed by dos. */
10097 /* It doesn't work to autosave while GC is in progress;
10098 the code used for auto-saving doesn't cope with the mark bit. */
10099 if (!gc_in_progress
)
10101 printf ("Auto-save? (y or n) ");
10103 if (((c
= getchar ()) & ~040) == 'Y')
10105 Fdo_auto_save (Qt
, Qnil
);
10107 printf ("\r\nAuto-save done");
10108 #else /* not MSDOS */
10109 printf ("Auto-save done\n");
10110 #endif /* not MSDOS */
10112 while (c
!= '\n') c
= getchar ();
10116 /* During GC, it must be safe to reenable quitting again. */
10117 Vinhibit_quit
= Qnil
;
10120 #endif /* not MSDOS */
10121 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10122 printf ("but will instead do a real quit after garbage collection ends\r\n");
10127 printf ("\r\nAbort? (y or n) ");
10128 #else /* not MSDOS */
10130 printf ("Abort (and enter debugger)? (y or n) ");
10131 #else /* not VMS */
10132 printf ("Abort (and dump core)? (y or n) ");
10133 #endif /* not VMS */
10134 #endif /* not MSDOS */
10136 if (((c
= getchar ()) & ~040) == 'Y')
10138 while (c
!= '\n') c
= getchar ();
10140 printf ("\r\nContinuing...\r\n");
10141 #else /* not MSDOS */
10142 printf ("Continuing...\n");
10143 #endif /* not MSDOS */
10150 /* If executing a function that wants to be interrupted out of
10151 and the user has not deferred quitting by binding `inhibit-quit'
10152 then quit right away. */
10153 if (immediate_quit
&& NILP (Vinhibit_quit
))
10155 struct gl_state_s saved
;
10156 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10158 immediate_quit
= 0;
10161 GCPRO4 (saved
.object
, saved
.global_code
,
10162 saved
.current_syntax_table
, saved
.old_prop
);
10163 Fsignal (Qquit
, Qnil
);
10168 /* Else request quit when it's safe */
10172 if (waiting_for_input
&& !echoing
)
10173 quit_throw_to_read_char ();
10178 /* Handle a C-g by making read_char return C-g. */
10181 quit_throw_to_read_char ()
10184 /* Prevent another signal from doing this before we finish. */
10185 clear_waiting_for_input ();
10188 Vunread_command_events
= Qnil
;
10189 unread_command_char
= -1;
10191 #if 0 /* Currently, sit_for is called from read_char without turning
10192 off polling. And that can call set_waiting_for_input.
10193 It seems to be harmless. */
10194 #ifdef POLL_FOR_INPUT
10195 /* May be > 1 if in recursive minibuffer. */
10196 if (poll_suppress_count
== 0)
10200 if (FRAMEP (internal_last_event_frame
)
10201 && !EQ (internal_last_event_frame
, selected_frame
))
10202 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10205 _longjmp (getcjmp
, 1);
10208 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10209 doc
: /* Set mode of reading keyboard input.
10210 First arg INTERRUPT non-nil means use input interrupts;
10211 nil means use CBREAK mode.
10212 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10213 (no effect except in CBREAK mode).
10214 Third arg META t means accept 8-bit input (for a Meta key).
10215 META nil means ignore the top bit, on the assumption it is parity.
10216 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10217 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10218 See also `current-input-mode'. */)
10219 (interrupt
, flow
, meta
, quit
)
10220 Lisp_Object interrupt
, flow
, meta
, quit
;
10223 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10224 error ("set-input-mode: QUIT must be an ASCII character");
10226 #ifdef POLL_FOR_INPUT
10231 /* this causes startup screen to be restored and messes with the mouse */
10232 reset_sys_modes ();
10236 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10237 if (read_socket_hook
)
10239 /* When using X, don't give the user a real choice,
10240 because we haven't implemented the mechanisms to support it. */
10241 #ifdef NO_SOCK_SIGIO
10242 interrupt_input
= 0;
10243 #else /* not NO_SOCK_SIGIO */
10244 interrupt_input
= 1;
10245 #endif /* NO_SOCK_SIGIO */
10248 interrupt_input
= !NILP (interrupt
);
10249 #else /* not SIGIO */
10250 interrupt_input
= 0;
10251 #endif /* not SIGIO */
10253 /* Our VMS input only works by interrupts, as of now. */
10255 interrupt_input
= 1;
10258 flow_control
= !NILP (flow
);
10261 else if (EQ (meta
, Qt
))
10266 /* Don't let this value be out of range. */
10267 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10273 #ifdef POLL_FOR_INPUT
10274 poll_suppress_count
= 1;
10280 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10281 doc
: /* Return information about the way Emacs currently reads keyboard input.
10282 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10283 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10284 nil, Emacs is using CBREAK mode.
10285 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10286 terminal; this does not apply if Emacs uses interrupt-driven input.
10287 META is t if accepting 8-bit input with 8th bit as Meta flag.
10288 META nil means ignoring the top bit, on the assumption it is parity.
10289 META is neither t nor nil if accepting 8-bit input and using
10290 all 8 bits as the character code.
10291 QUIT is the character Emacs currently uses to quit.
10292 The elements of this list correspond to the arguments of
10293 `set-input-mode'. */)
10296 Lisp_Object val
[4];
10298 val
[0] = interrupt_input
? Qt
: Qnil
;
10299 val
[1] = flow_control
? Qt
: Qnil
;
10300 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10301 XSETFASTINT (val
[3], quit_char
);
10303 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10308 * Set up a new kboard object with reasonable initial values.
10314 kb
->Voverriding_terminal_local_map
= Qnil
;
10315 kb
->Vlast_command
= Qnil
;
10316 kb
->Vreal_last_command
= Qnil
;
10317 kb
->Vprefix_arg
= Qnil
;
10318 kb
->Vlast_prefix_arg
= Qnil
;
10319 kb
->kbd_queue
= Qnil
;
10320 kb
->kbd_queue_has_data
= 0;
10321 kb
->immediate_echo
= 0;
10322 kb
->echo_string
= Qnil
;
10323 kb
->echo_after_prompt
= -1;
10324 kb
->kbd_macro_buffer
= 0;
10325 kb
->kbd_macro_bufsize
= 0;
10326 kb
->defining_kbd_macro
= Qnil
;
10327 kb
->Vlast_kbd_macro
= Qnil
;
10328 kb
->reference_count
= 0;
10329 kb
->Vsystem_key_alist
= Qnil
;
10330 kb
->system_key_syms
= Qnil
;
10331 kb
->Vdefault_minibuffer_frame
= Qnil
;
10335 * Destroy the contents of a kboard object, but not the object itself.
10336 * We use this just before deleting it, or if we're going to initialize
10337 * it a second time.
10343 if (kb
->kbd_macro_buffer
)
10344 xfree (kb
->kbd_macro_buffer
);
10347 #ifdef MULTI_KBOARD
10349 /* Free KB and memory referenced from it. */
10357 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10360 *kbp
= kb
->next_kboard
;
10362 /* Prevent a dangling reference to KB. */
10363 if (kb
== current_kboard
10364 && FRAMEP (selected_frame
)
10365 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10367 current_kboard
= XFRAME (selected_frame
)->kboard
;
10368 if (current_kboard
== kb
)
10376 #endif /* MULTI_KBOARD */
10381 /* This is correct before outermost invocation of the editor loop */
10382 command_loop_level
= -1;
10383 immediate_quit
= 0;
10384 quit_char
= Ctl ('g');
10385 Vunread_command_events
= Qnil
;
10386 unread_command_char
= -1;
10387 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10389 recent_keys_index
= 0;
10390 kbd_fetch_ptr
= kbd_buffer
;
10391 kbd_store_ptr
= kbd_buffer
;
10392 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10394 do_mouse_tracking
= Qnil
;
10398 /* This means that command_loop_1 won't try to select anything the first
10400 internal_last_event_frame
= Qnil
;
10401 Vlast_event_frame
= internal_last_event_frame
;
10403 #ifdef MULTI_KBOARD
10404 current_kboard
= initial_kboard
;
10406 wipe_kboard (current_kboard
);
10407 init_kboard (current_kboard
);
10409 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10411 signal (SIGINT
, interrupt_signal
);
10412 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10413 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10414 SIGQUIT and we can't tell which one it will give us. */
10415 signal (SIGQUIT
, interrupt_signal
);
10416 #endif /* HAVE_TERMIO */
10418 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10420 if (!noninteractive
)
10421 signal (SIGIO
, input_available_signal
);
10424 /* Use interrupt input by default, if it works and noninterrupt input
10425 has deficiencies. */
10427 #ifdef INTERRUPT_INPUT
10428 interrupt_input
= 1;
10430 interrupt_input
= 0;
10433 /* Our VMS input only works by interrupts, as of now. */
10435 interrupt_input
= 1;
10441 if (keyboard_init_hook
)
10442 (*keyboard_init_hook
) ();
10444 #ifdef POLL_FOR_INPUT
10445 poll_suppress_count
= 1;
10450 /* This type's only use is in syms_of_keyboard, to initialize the
10451 event header symbols and put properties on them. */
10452 struct event_head
{
10458 struct event_head head_table
[] = {
10459 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10460 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10461 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10462 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10463 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10464 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10465 {&Qselect_window
, "select-window", &Qselect_window
}
10469 syms_of_keyboard ()
10471 Vpre_help_message
= Qnil
;
10472 staticpro (&Vpre_help_message
);
10474 Vlispy_mouse_stem
= build_string ("mouse");
10475 staticpro (&Vlispy_mouse_stem
);
10478 QCimage
= intern (":image");
10479 staticpro (&QCimage
);
10481 staticpro (&Qhelp_echo
);
10482 Qhelp_echo
= intern ("help-echo");
10484 staticpro (&item_properties
);
10485 item_properties
= Qnil
;
10487 staticpro (&tool_bar_item_properties
);
10488 tool_bar_item_properties
= Qnil
;
10489 staticpro (&tool_bar_items_vector
);
10490 tool_bar_items_vector
= Qnil
;
10492 staticpro (&real_this_command
);
10493 real_this_command
= Qnil
;
10495 Qtimer_event_handler
= intern ("timer-event-handler");
10496 staticpro (&Qtimer_event_handler
);
10498 Qdisabled_command_hook
= intern ("disabled-command-hook");
10499 staticpro (&Qdisabled_command_hook
);
10501 Qself_insert_command
= intern ("self-insert-command");
10502 staticpro (&Qself_insert_command
);
10504 Qforward_char
= intern ("forward-char");
10505 staticpro (&Qforward_char
);
10507 Qbackward_char
= intern ("backward-char");
10508 staticpro (&Qbackward_char
);
10510 Qdisabled
= intern ("disabled");
10511 staticpro (&Qdisabled
);
10513 Qundefined
= intern ("undefined");
10514 staticpro (&Qundefined
);
10516 Qpre_command_hook
= intern ("pre-command-hook");
10517 staticpro (&Qpre_command_hook
);
10519 Qpost_command_hook
= intern ("post-command-hook");
10520 staticpro (&Qpost_command_hook
);
10522 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10523 staticpro (&Qpost_command_idle_hook
);
10525 Qdeferred_action_function
= intern ("deferred-action-function");
10526 staticpro (&Qdeferred_action_function
);
10528 Qcommand_hook_internal
= intern ("command-hook-internal");
10529 staticpro (&Qcommand_hook_internal
);
10531 Qfunction_key
= intern ("function-key");
10532 staticpro (&Qfunction_key
);
10533 Qmouse_click
= intern ("mouse-click");
10534 staticpro (&Qmouse_click
);
10535 #if defined(WINDOWSNT) || defined(MAC_OSX)
10536 Qmouse_wheel
= intern ("mouse-wheel");
10537 staticpro (&Qmouse_wheel
);
10540 Qlanguage_change
= intern ("language-change");
10541 staticpro (&Qlanguage_change
);
10543 Qdrag_n_drop
= intern ("drag-n-drop");
10544 staticpro (&Qdrag_n_drop
);
10546 Qsave_session
= intern ("save-session");
10547 staticpro(&Qsave_session
);
10549 Qusr1_signal
= intern ("usr1-signal");
10550 staticpro (&Qusr1_signal
);
10551 Qusr2_signal
= intern ("usr2-signal");
10552 staticpro (&Qusr2_signal
);
10554 Qmenu_enable
= intern ("menu-enable");
10555 staticpro (&Qmenu_enable
);
10556 Qmenu_alias
= intern ("menu-alias");
10557 staticpro (&Qmenu_alias
);
10558 QCenable
= intern (":enable");
10559 staticpro (&QCenable
);
10560 QCvisible
= intern (":visible");
10561 staticpro (&QCvisible
);
10562 QChelp
= intern (":help");
10563 staticpro (&QChelp
);
10564 QCfilter
= intern (":filter");
10565 staticpro (&QCfilter
);
10566 QCbutton
= intern (":button");
10567 staticpro (&QCbutton
);
10568 QCkeys
= intern (":keys");
10569 staticpro (&QCkeys
);
10570 QCkey_sequence
= intern (":key-sequence");
10571 staticpro (&QCkey_sequence
);
10572 QCtoggle
= intern (":toggle");
10573 staticpro (&QCtoggle
);
10574 QCradio
= intern (":radio");
10575 staticpro (&QCradio
);
10577 Qmode_line
= intern ("mode-line");
10578 staticpro (&Qmode_line
);
10579 Qvertical_line
= intern ("vertical-line");
10580 staticpro (&Qvertical_line
);
10581 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10582 staticpro (&Qvertical_scroll_bar
);
10583 Qmenu_bar
= intern ("menu-bar");
10584 staticpro (&Qmenu_bar
);
10586 Qabove_handle
= intern ("above-handle");
10587 staticpro (&Qabove_handle
);
10588 Qhandle
= intern ("handle");
10589 staticpro (&Qhandle
);
10590 Qbelow_handle
= intern ("below-handle");
10591 staticpro (&Qbelow_handle
);
10592 Qup
= intern ("up");
10594 Qdown
= intern ("down");
10595 staticpro (&Qdown
);
10596 Qtop
= intern ("top");
10598 Qbottom
= intern ("bottom");
10599 staticpro (&Qbottom
);
10600 Qend_scroll
= intern ("end-scroll");
10601 staticpro (&Qend_scroll
);
10602 Qratio
= intern ("ratio");
10603 staticpro (&Qratio
);
10605 Qevent_kind
= intern ("event-kind");
10606 staticpro (&Qevent_kind
);
10607 Qevent_symbol_elements
= intern ("event-symbol-elements");
10608 staticpro (&Qevent_symbol_elements
);
10609 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10610 staticpro (&Qevent_symbol_element_mask
);
10611 Qmodifier_cache
= intern ("modifier-cache");
10612 staticpro (&Qmodifier_cache
);
10614 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10615 staticpro (&Qrecompute_lucid_menubar
);
10616 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10617 staticpro (&Qactivate_menubar_hook
);
10619 Qpolling_period
= intern ("polling-period");
10620 staticpro (&Qpolling_period
);
10622 Qinput_method_function
= intern ("input-method-function");
10623 staticpro (&Qinput_method_function
);
10625 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10626 staticpro (&Qinput_method_exit_on_first_char
);
10627 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10628 staticpro (&Qinput_method_use_echo_area
);
10630 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10631 Fset (Qinput_method_use_echo_area
, Qnil
);
10633 last_point_position_buffer
= Qnil
;
10636 struct event_head
*p
;
10638 for (p
= head_table
;
10639 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10642 *p
->var
= intern (p
->name
);
10643 staticpro (p
->var
);
10644 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10645 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10649 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10650 staticpro (&button_down_location
);
10651 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10652 staticpro (&mouse_syms
);
10656 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10658 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10659 for (i
= 0; i
< len
; i
++)
10660 if (modifier_names
[i
])
10661 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10662 staticpro (&modifier_symbols
);
10665 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10666 staticpro (&recent_keys
);
10668 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10669 staticpro (&this_command_keys
);
10671 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10672 staticpro (&raw_keybuf
);
10674 Qextended_command_history
= intern ("extended-command-history");
10675 Fset (Qextended_command_history
, Qnil
);
10676 staticpro (&Qextended_command_history
);
10678 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10679 staticpro (&kbd_buffer_gcpro
);
10681 accent_key_syms
= Qnil
;
10682 staticpro (&accent_key_syms
);
10684 func_key_syms
= Qnil
;
10685 staticpro (&func_key_syms
);
10687 #if defined(WINDOWSNT) || defined(MAC_OSX)
10688 mouse_wheel_syms
= Qnil
;
10689 staticpro (&mouse_wheel_syms
);
10690 drag_n_drop_syms
= Qnil
;
10691 staticpro (&drag_n_drop_syms
);
10694 unread_switch_frame
= Qnil
;
10695 staticpro (&unread_switch_frame
);
10697 internal_last_event_frame
= Qnil
;
10698 staticpro (&internal_last_event_frame
);
10700 read_key_sequence_cmd
= Qnil
;
10701 staticpro (&read_key_sequence_cmd
);
10703 menu_bar_one_keymap_changed_items
= Qnil
;
10704 staticpro (&menu_bar_one_keymap_changed_items
);
10706 defsubr (&Sevent_convert_list
);
10707 defsubr (&Sread_key_sequence
);
10708 defsubr (&Sread_key_sequence_vector
);
10709 defsubr (&Srecursive_edit
);
10711 defsubr (&Strack_mouse
);
10713 defsubr (&Sinput_pending_p
);
10714 defsubr (&Scommand_execute
);
10715 defsubr (&Srecent_keys
);
10716 defsubr (&Sthis_command_keys
);
10717 defsubr (&Sthis_command_keys_vector
);
10718 defsubr (&Sthis_single_command_keys
);
10719 defsubr (&Sthis_single_command_raw_keys
);
10720 defsubr (&Sreset_this_command_lengths
);
10721 defsubr (&Sclear_this_command_keys
);
10722 defsubr (&Ssuspend_emacs
);
10723 defsubr (&Sabort_recursive_edit
);
10724 defsubr (&Sexit_recursive_edit
);
10725 defsubr (&Srecursion_depth
);
10726 defsubr (&Stop_level
);
10727 defsubr (&Sdiscard_input
);
10728 defsubr (&Sopen_dribble_file
);
10729 defsubr (&Sset_input_mode
);
10730 defsubr (&Scurrent_input_mode
);
10731 defsubr (&Sexecute_extended_command
);
10733 DEFVAR_LISP ("last-command-char", &last_command_char
,
10734 doc
: /* Last input event that was part of a command. */);
10736 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10737 doc
: /* Last input event that was part of a command. */);
10739 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10740 doc
: /* Last input event in a command, except for mouse menu events.
10741 Mouse menus give back keys that don't look like mouse events;
10742 this variable holds the actual mouse event that led to the menu,
10743 so that you can determine whether the command was run by mouse or not. */);
10745 DEFVAR_LISP ("last-input-char", &last_input_char
,
10746 doc
: /* Last input event. */);
10748 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10749 doc
: /* Last input event. */);
10751 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10752 doc
: /* List of events to be read as the command input.
10753 These events are processed first, before actual keyboard input. */);
10754 Vunread_command_events
= Qnil
;
10756 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10757 doc
: /* If not -1, an object to be read as next command input event. */);
10759 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10760 doc
: /* List of events to be processed as input by input methods.
10761 These events are processed after `unread-command-events', but
10762 before actual keyboard input. */);
10763 Vunread_post_input_method_events
= Qnil
;
10765 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10766 doc
: /* List of events to be processed as input by input methods.
10767 These events are processed after `unread-command-events', but
10768 before actual keyboard input. */);
10769 Vunread_input_method_events
= Qnil
;
10771 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10772 doc
: /* Meta-prefix character code.
10773 Meta-foo as command input turns into this character followed by foo. */);
10774 XSETINT (meta_prefix_char
, 033);
10776 DEFVAR_KBOARD ("last-command", Vlast_command
,
10777 doc
: /* The last command executed.
10778 Normally a symbol with a function definition, but can be whatever was found
10779 in the keymap, or whatever the variable `this-command' was set to by that
10782 The value `mode-exit' is special; it means that the previous command
10783 read an event that told it to exit, and it did so and unread that event.
10784 In other words, the present command is the event that made the previous
10787 The value `kill-region' is special; it means that the previous command
10788 was a kill command. */);
10790 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10791 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10793 DEFVAR_LISP ("this-command", &Vthis_command
,
10794 doc
: /* The command now being executed.
10795 The command can set this variable; whatever is put here
10796 will be in `last-command' during the following command. */);
10797 Vthis_command
= Qnil
;
10799 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10800 doc
: /* If non-nil, the original command bound to the current key sequence.
10801 The value of `this-command' is the result of looking up the original
10802 command in the active keymaps. */);
10803 Vthis_original_command
= Qnil
;
10805 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10806 doc
: /* *Number of input events between auto-saves.
10807 Zero means disable autosaving due to number of characters typed. */);
10808 auto_save_interval
= 300;
10810 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10811 doc
: /* *Number of seconds idle time before auto-save.
10812 Zero or nil means disable auto-saving due to idleness.
10813 After auto-saving due to this many seconds of idle time,
10814 Emacs also does a garbage collection if that seems to be warranted. */);
10815 XSETFASTINT (Vauto_save_timeout
, 30);
10817 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10818 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10819 The value may be integer or floating point. */);
10820 Vecho_keystrokes
= make_number (1);
10822 DEFVAR_INT ("polling-period", &polling_period
,
10823 doc
: /* *Interval between polling for input during Lisp execution.
10824 The reason for polling is to make C-g work to stop a running program.
10825 Polling is needed only when using X windows and SIGIO does not work.
10826 Polling is automatically disabled in all other cases. */);
10827 polling_period
= 2;
10829 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10830 doc
: /* *Maximum time between mouse clicks to make a double-click.
10831 Measured in milliseconds. nil means disable double-click recognition;
10832 t means double-clicks have no time limit and are detected
10833 by position only. */);
10834 Vdouble_click_time
= make_number (500);
10836 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10837 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10838 On window-system frames, value is the number of pixels the mouse may have
10839 moved horizontally or vertically between two clicks to make a double-click.
10840 On non window-system frames, value is interpreted in units of 1/8 characters
10843 This variable is also the threshold for motion of the mouse
10844 to count as a drag. */);
10845 double_click_fuzz
= 3;
10847 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10848 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10849 inhibit_local_menu_bar_menus
= 0;
10851 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10852 doc
: /* Number of complete key sequences read as input so far.
10853 This includes key sequences read from keyboard macros.
10854 The number is effectively the number of interactive command invocations. */);
10855 num_input_keys
= 0;
10857 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10858 doc
: /* Number of input events read from the keyboard so far.
10859 This does not include events generated by keyboard macros. */);
10860 num_nonmacro_input_events
= 0;
10862 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10863 doc
: /* The frame in which the most recently read event occurred.
10864 If the last event came from a keyboard macro, this is set to `macro'. */);
10865 Vlast_event_frame
= Qnil
;
10867 /* This variable is set up in sysdep.c. */
10868 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10869 doc
: /* The ERASE character as set by the user with stty. */);
10871 DEFVAR_LISP ("help-char", &Vhelp_char
,
10872 doc
: /* Character to recognize as meaning Help.
10873 When it is read, do `(eval help-form)', and display result if it's a string.
10874 If the value of `help-form' is nil, this char can be read normally. */);
10875 XSETINT (Vhelp_char
, Ctl ('H'));
10877 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10878 doc
: /* List of input events to recognize as meaning Help.
10879 These work just like the value of `help-char' (see that). */);
10880 Vhelp_event_list
= Qnil
;
10882 DEFVAR_LISP ("help-form", &Vhelp_form
,
10883 doc
: /* Form to execute when character `help-char' is read.
10884 If the form returns a string, that string is displayed.
10885 If `help-form' is nil, the help char is not recognized. */);
10888 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10889 doc
: /* Command to run when `help-char' character follows a prefix key.
10890 This command is used only when there is no actual binding
10891 for that character after that prefix key. */);
10892 Vprefix_help_command
= Qnil
;
10894 DEFVAR_LISP ("top-level", &Vtop_level
,
10895 doc
: /* Form to evaluate when Emacs starts up.
10896 Useful to set before you dump a modified Emacs. */);
10899 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10900 doc
: /* Translate table for keyboard input, or nil.
10901 Each character is looked up in this string and the contents used instead.
10902 The value may be a string, a vector, or a char-table.
10903 If it is a string or vector of length N,
10904 character codes N and up are untranslated.
10905 In a vector or a char-table, an element which is nil means "no translation".
10907 This is applied to the characters supplied to input methods, not their
10908 output. See also `translation-table-for-input'. */);
10909 Vkeyboard_translate_table
= Qnil
;
10911 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10912 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
10913 \(Even if the operating system has support for stopping a process.\) */);
10914 cannot_suspend
= 0;
10916 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10917 doc
: /* Non-nil means prompt with menus when appropriate.
10918 This is done when reading from a keymap that has a prompt string,
10919 for elements that have prompt strings.
10920 The menu is displayed on the screen
10921 if X menus were enabled at configuration
10922 time and the previous event was a mouse click prefix key.
10923 Otherwise, menu prompting uses the echo area. */);
10924 menu_prompting
= 1;
10926 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10927 doc
: /* Character to see next line of menu prompt.
10928 Type this character while in a menu prompt to rotate around the lines of it. */);
10929 XSETINT (menu_prompt_more_char
, ' ');
10931 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10932 doc
: /* A mask of additional modifier keys to use with every keyboard character.
10933 Emacs applies the modifiers of the character stored here to each keyboard
10934 character it reads. For example, after evaluating the expression
10935 (setq extra-keyboard-modifiers ?\\C-x)
10936 all input characters will have the control modifier applied to them.
10938 Note that the character ?\\C-@, equivalent to the integer zero, does
10939 not count as a control character; rather, it counts as a character
10940 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
10941 cancels any modification. */);
10942 extra_keyboard_modifiers
= 0;
10944 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10945 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
10946 The command loop sets this to nil before each command,
10947 and tests the value when the command returns.
10948 Buffer modification stores t in this variable. */);
10949 Vdeactivate_mark
= Qnil
;
10951 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10952 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
10953 Vcommand_hook_internal
= Qnil
;
10955 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10956 doc
: /* Normal hook run before each command is executed.
10957 If an unhandled error happens in running this hook,
10958 the hook value is set to nil, since otherwise the error
10959 might happen repeatedly and make Emacs nonfunctional. */);
10960 Vpre_command_hook
= Qnil
;
10962 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10963 doc
: /* Normal hook run after each command is executed.
10964 If an unhandled error happens in running this hook,
10965 the hook value is set to nil, since otherwise the error
10966 might happen repeatedly and make Emacs nonfunctional. */);
10967 Vpost_command_hook
= Qnil
;
10969 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10970 doc
: /* Normal hook run after each command is executed, if idle.
10971 Errors running the hook are caught and ignored. */);
10972 Vpost_command_idle_hook
= Qnil
;
10974 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10975 doc
: /* Delay time before running `post-command-idle-hook'.
10976 This is measured in microseconds. */);
10977 post_command_idle_delay
= 100000;
10980 DEFVAR_LISP ("echo-area-clear-hook", ...,
10981 doc
: /* Normal hook run when clearing the echo area. */);
10983 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10984 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
10986 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10987 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
10988 Vlucid_menu_bar_dirty_flag
= Qnil
;
10990 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10991 doc
: /* List of menu bar items to move to the end of the menu bar.
10992 The elements of the list are event types that may have menu bar bindings. */);
10993 Vmenu_bar_final_items
= Qnil
;
10995 DEFVAR_KBOARD ("overriding-terminal-local-map",
10996 Voverriding_terminal_local_map
,
10997 doc
: /* Per-terminal keymap that overrides all other local keymaps.
10998 If this variable is non-nil, it is used as a keymap instead of the
10999 buffer's local map, and the minor mode keymaps and text property keymaps.
11000 This variable is intended to let commands such as `universal-argument'
11001 set up a different keymap for reading the next command. */);
11003 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11004 doc
: /* Keymap that overrides all other local keymaps.
11005 If this variable is non-nil, it is used as a keymap instead of the
11006 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11007 Voverriding_local_map
= Qnil
;
11009 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11010 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11011 Otherwise, the menu bar continues to reflect the buffer's local map
11012 and the minor mode maps regardless of `overriding-local-map'. */);
11013 Voverriding_local_map_menu_flag
= Qnil
;
11015 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11016 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11017 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11019 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11020 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11022 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11023 doc
: /* Alist of system-specific X windows key symbols.
11024 Each element should have the form (N . SYMBOL) where N is the
11025 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11026 and SYMBOL is its name. */);
11028 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11029 doc
: /* List of deferred actions to be performed at a later time.
11030 The precise format isn't relevant here; we just check whether it is nil. */);
11031 Vdeferred_action_list
= Qnil
;
11033 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11034 doc
: /* Function to call to handle deferred actions, after each command.
11035 This function is called with no arguments after each command
11036 whenever `deferred-action-list' is non-nil. */);
11037 Vdeferred_action_function
= Qnil
;
11039 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11040 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11041 The value can be a length of time to show the message for.
11042 If the value is non-nil and not a number, we wait 2 seconds. */);
11043 Vsuggest_key_bindings
= Qt
;
11045 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11046 doc
: /* List of active absolute time timers in order of increasing time. */);
11047 Vtimer_list
= Qnil
;
11049 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11050 doc
: /* List of active idle-time timers in order of increasing time. */);
11051 Vtimer_idle_list
= Qnil
;
11053 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11054 doc
: /* If non-nil, the function that implements the current input method.
11055 It's called with one argument, a printing character that was just read.
11056 \(That means a character with code 040...0176.)
11057 Typically this function uses `read-event' to read additional events.
11058 When it does so, it should first bind `input-method-function' to nil
11059 so it will not be called recursively.
11061 The function should return a list of zero or more events
11062 to be used as input. If it wants to put back some events
11063 to be reconsidered, separately, by the input method,
11064 it can add them to the beginning of `unread-command-events'.
11066 The input method function can find in `input-method-previous-method'
11067 the previous echo area message.
11069 The input method function should refer to the variables
11070 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11071 for guidance on what to do. */);
11072 Vinput_method_function
= Qnil
;
11074 DEFVAR_LISP ("input-method-previous-message",
11075 &Vinput_method_previous_message
,
11076 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11077 This variable exists because `read-event' clears the echo area
11078 before running the input method. It is nil if there was no message. */);
11079 Vinput_method_previous_message
= Qnil
;
11081 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11082 doc
: /* If non-nil, the function that implements the display of help.
11083 It's called with one argument, the help string to display. */);
11084 Vshow_help_function
= Qnil
;
11086 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11087 doc
: /* If non-nil, suppress point adjustment after executing a command.
11089 After a command is executed, if point is moved into a region that has
11090 special properties (e.g. composition, display), we adjust point to
11091 the boundary of the region. But, several special commands sets this
11092 variable to non-nil, then we suppress the point adjustment.
11094 This variable is set to nil before reading a command, and is checked
11095 just after executing the command. */);
11096 Vdisable_point_adjustment
= Qnil
;
11098 DEFVAR_LISP ("global-disable-point-adjustment",
11099 &Vglobal_disable_point_adjustment
,
11100 doc
: /* *If non-nil, always suppress point adjustment.
11102 The default value is nil, in which case, point adjustment are
11103 suppressed only after special commands that set
11104 `disable-point-adjustment' (which see) to non-nil. */);
11105 Vglobal_disable_point_adjustment
= Qnil
;
11107 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11108 doc
: /* Non-nil means updating menu bindings is allowed.
11109 A value of nil means menu bindings should not be updated.
11110 Used during Emacs' startup. */);
11111 update_menu_bindings
= 1;
11113 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11114 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11115 If the value is not a number, such messages don't time out. */);
11116 Vminibuffer_message_timeout
= make_number (2);
11120 keys_of_keyboard ()
11122 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11123 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11124 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11125 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11126 initial_define_key (meta_map
, 'x', "execute-extended-command");
11128 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11129 "handle-delete-frame");
11130 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11132 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11134 initial_define_lispy_key (Vspecial_event_map
, "select-window",
11135 "handle-select-window");
11136 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11137 "handle-save-session");