1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000, 2001
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 */
78 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
85 /* Variables for blockinput.h: */
87 /* Non-zero if interrupt input is blocked right now. */
88 int interrupt_input_blocked
;
90 /* Nonzero means an input interrupt has arrived
91 during the current critical section. */
92 int interrupt_input_pending
;
95 /* File descriptor to use for input. */
98 #ifdef HAVE_WINDOW_SYSTEM
99 /* Make all keyboard buffers much bigger when using X windows. */
101 /* But not too big (local data > 32K error) if on macintosh. */
102 #define KBD_BUFFER_SIZE 512
104 #define KBD_BUFFER_SIZE 4096
106 #else /* No X-windows, character input */
107 #define KBD_BUFFER_SIZE 4096
108 #endif /* No X-windows */
110 #define abs(x) ((x) >= 0 ? (x) : -(x))
112 /* Following definition copied from eval.c */
116 struct backtrace
*next
;
117 Lisp_Object
*function
;
118 Lisp_Object
*args
; /* Points to vector of args. */
119 int nargs
; /* length of vector. If nargs is UNEVALLED,
120 args points to slot holding list of
126 KBOARD
*initial_kboard
;
127 KBOARD
*current_kboard
;
131 KBOARD the_only_kboard
;
134 /* Non-nil disable property on a command means
135 do not execute it; call disabled-command-hook's value instead. */
136 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
138 #define NUM_RECENT_KEYS (100)
139 int recent_keys_index
; /* Index for storing next element into recent_keys */
140 int total_keys
; /* Total number of elements stored into recent_keys */
141 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
143 /* Vector holding the key sequence that invoked the current command.
144 It is reused for each command, and it may be longer than the current
145 sequence; this_command_key_count indicates how many elements
146 actually mean something.
147 It's easier to staticpro a single Lisp_Object than an array. */
148 Lisp_Object this_command_keys
;
149 int this_command_key_count
;
151 /* This vector is used as a buffer to record the events that were actually read
152 by read_key_sequence. */
153 Lisp_Object raw_keybuf
;
154 int raw_keybuf_count
;
156 #define GROW_RAW_KEYBUF \
157 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
159 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
161 new = Fmake_vector (make_number (newsize), Qnil); \
162 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
163 raw_keybuf_count * sizeof (Lisp_Object)); \
167 /* Number of elements of this_command_keys
168 that precede this key sequence. */
169 int this_single_command_key_start
;
171 /* Record values of this_command_key_count and echo_length ()
172 before this command was read. */
173 static int before_command_key_count
;
174 static int before_command_echo_length
;
175 /* Values of before_command_key_count and before_command_echo_length
176 saved by reset-this-command-lengths. */
177 static int before_command_key_count_1
;
178 static int before_command_echo_length_1
;
179 /* Flag set by reset-this-command-lengths,
180 saying to reset the lengths when add_command_key is called. */
181 static int before_command_restore_flag
;
183 extern int minbuf_level
;
185 extern int message_enable_multibyte
;
187 extern struct backtrace
*backtrace_list
;
189 /* If non-nil, the function that implements the display of help.
190 It's called with one argument, the help string to display. */
192 Lisp_Object Vshow_help_function
;
194 /* If a string, the message displayed before displaying a help-echo
197 Lisp_Object Vpre_help_message
;
199 /* Nonzero means do menu prompting. */
201 static int menu_prompting
;
203 /* Character to see next line of menu prompt. */
205 static Lisp_Object menu_prompt_more_char
;
207 /* For longjmp to where kbd input is being done. */
209 static jmp_buf getcjmp
;
211 /* True while doing kbd input. */
212 int waiting_for_input
;
214 /* True while displaying for echoing. Delays C-g throwing. */
218 /* Non-null means we can start echoing at the next input pause even
219 though there is something in the echo area. */
221 static struct kboard
*ok_to_echo_at_next_pause
;
223 /* The kboard last echoing, or null for none. Reset to 0 in
224 cancel_echoing. If non-null, and a current echo area message
225 exists, and echo_message_buffer is eq to the current message
226 buffer, we know that the message comes from echo_kboard. */
228 struct kboard
*echo_kboard
;
230 /* The buffer used for echoing. Set in echo_now, reset in
233 Lisp_Object echo_message_buffer
;
235 /* Nonzero means disregard local maps for the menu bar. */
236 static int inhibit_local_menu_bar_menus
;
238 /* Nonzero means C-g should cause immediate error-signal. */
241 /* The user's ERASE setting. */
242 Lisp_Object Vtty_erase_char
;
244 /* Character to recognize as the help char. */
245 Lisp_Object Vhelp_char
;
247 /* List of other event types to recognize as meaning "help". */
248 Lisp_Object Vhelp_event_list
;
250 /* Form to execute when help char is typed. */
251 Lisp_Object Vhelp_form
;
253 /* Command to run when the help character follows a prefix key. */
254 Lisp_Object Vprefix_help_command
;
256 /* List of items that should move to the end of the menu bar. */
257 Lisp_Object Vmenu_bar_final_items
;
259 /* Non-nil means show the equivalent key-binding for
260 any M-x command that has one.
261 The value can be a length of time to show the message for.
262 If the value is non-nil and not a number, we wait 2 seconds. */
263 Lisp_Object Vsuggest_key_bindings
;
265 /* How long to display an echo-area message when the minibuffer is active.
266 If the value is not a number, such messages don't time out. */
267 Lisp_Object Vminibuffer_message_timeout
;
269 /* Character that causes a quit. Normally C-g.
271 If we are running on an ordinary terminal, this must be an ordinary
272 ASCII char, since we want to make it our interrupt character.
274 If we are not running on an ordinary terminal, it still needs to be
275 an ordinary ASCII char. This character needs to be recognized in
276 the input interrupt handler. At this point, the keystroke is
277 represented as a struct input_event, while the desired quit
278 character is specified as a lispy event. The mapping from struct
279 input_events to lispy events cannot run in an interrupt handler,
280 and the reverse mapping is difficult for anything but ASCII
283 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
287 extern Lisp_Object current_global_map
;
288 extern int minibuf_level
;
290 /* If non-nil, this is a map that overrides all other local maps. */
291 Lisp_Object Voverriding_local_map
;
293 /* If non-nil, Voverriding_local_map applies to the menu bar. */
294 Lisp_Object Voverriding_local_map_menu_flag
;
296 /* Keymap that defines special misc events that should
297 be processed immediately at a low level. */
298 Lisp_Object Vspecial_event_map
;
300 /* Current depth in recursive edits. */
301 int command_loop_level
;
303 /* Total number of times command_loop has read a key sequence. */
306 /* Last input character read as a command. */
307 Lisp_Object last_command_char
;
309 /* Last input character read as a command, not counting menus
310 reached by the mouse. */
311 Lisp_Object last_nonmenu_event
;
313 /* Last input character read for any purpose. */
314 Lisp_Object last_input_char
;
316 /* If not Qnil, a list of objects to be read as subsequent command input. */
317 Lisp_Object Vunread_command_events
;
319 /* If not Qnil, a list of objects to be read as subsequent command input
320 including input method processing. */
321 Lisp_Object Vunread_input_method_events
;
323 /* If not Qnil, a list of objects to be read as subsequent command input
324 but NOT including input method processing. */
325 Lisp_Object Vunread_post_input_method_events
;
327 /* If not -1, an event to be read as subsequent command input. */
328 int unread_command_char
;
330 /* If not Qnil, this is a switch-frame event which we decided to put
331 off until the end of a key sequence. This should be read as the
332 next command input, after any unread_command_events.
334 read_key_sequence uses this to delay switch-frame events until the
335 end of the key sequence; Fread_char uses it to put off switch-frame
336 events until a non-ASCII event is acceptable as input. */
337 Lisp_Object unread_switch_frame
;
339 /* A mask of extra modifier bits to put into every keyboard char. */
340 int extra_keyboard_modifiers
;
342 /* Char to use as prefix when a meta character is typed in.
343 This is bound on entry to minibuffer in case ESC is changed there. */
345 Lisp_Object meta_prefix_char
;
347 /* Last size recorded for a current buffer which is not a minibuffer. */
348 static int last_non_minibuf_size
;
350 /* Number of idle seconds before an auto-save and garbage collection. */
351 static Lisp_Object Vauto_save_timeout
;
353 /* Total number of times read_char has returned. */
354 int num_input_events
;
356 /* Total number of times read_char has returned, outside of macros. */
357 int num_nonmacro_input_events
;
359 /* Auto-save automatically when this many characters have been typed
360 since the last time. */
362 static int auto_save_interval
;
364 /* Value of num_nonmacro_input_events as of last auto save. */
368 /* The command being executed by the command loop.
369 Commands may set this, and the value set will be copied into
370 current_kboard->Vlast_command instead of the actual command. */
371 Lisp_Object Vthis_command
;
373 /* This is like Vthis_command, except that commands never set it. */
374 Lisp_Object real_this_command
;
376 /* The value of point when the last command was executed. */
377 int last_point_position
;
379 /* The buffer that was current when the last command was started. */
380 Lisp_Object last_point_position_buffer
;
382 /* The frame in which the last input event occurred, or Qmacro if the
383 last event came from a macro. We use this to determine when to
384 generate switch-frame events. This may be cleared by functions
385 like Fselect_frame, to make sure that a switch-frame event is
386 generated by the next character. */
387 Lisp_Object internal_last_event_frame
;
389 /* A user-visible version of the above, intended to allow users to
390 figure out where the last event came from, if the event doesn't
391 carry that information itself (i.e. if it was a character). */
392 Lisp_Object Vlast_event_frame
;
394 /* The timestamp of the last input event we received from the X server.
395 X Windows wants this for selection ownership. */
396 unsigned long last_event_timestamp
;
398 Lisp_Object Qself_insert_command
;
399 Lisp_Object Qforward_char
;
400 Lisp_Object Qbackward_char
;
401 Lisp_Object Qundefined
;
402 Lisp_Object Qtimer_event_handler
;
404 /* read_key_sequence stores here the command definition of the
405 key sequence that it reads. */
406 Lisp_Object read_key_sequence_cmd
;
408 /* Echo unfinished commands after this many seconds of pause. */
409 Lisp_Object Vecho_keystrokes
;
411 /* Form to evaluate (if non-nil) when Emacs is started. */
412 Lisp_Object Vtop_level
;
414 /* User-supplied string to translate input characters through. */
415 Lisp_Object Vkeyboard_translate_table
;
417 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
418 extern Lisp_Object Vfunction_key_map
;
420 /* Another keymap that maps key sequences into key sequences.
421 This one takes precedence over ordinary definitions. */
422 extern Lisp_Object Vkey_translation_map
;
424 /* If non-nil, this implements the current input method. */
425 Lisp_Object Vinput_method_function
;
426 Lisp_Object Qinput_method_function
;
428 /* When we call Vinput_method_function,
429 this holds the echo area message that was just erased. */
430 Lisp_Object Vinput_method_previous_message
;
432 /* Non-nil means deactivate the mark at end of this command. */
433 Lisp_Object Vdeactivate_mark
;
435 /* Menu bar specified in Lucid Emacs fashion. */
437 Lisp_Object Vlucid_menu_bar_dirty_flag
;
438 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
440 Lisp_Object Qecho_area_clear_hook
;
442 /* Hooks to run before and after each command. */
443 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
444 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
445 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
446 /* Hook run after a command if there's no more input soon. */
447 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
449 /* Delay time in microseconds before running post-command-idle-hook. */
450 int post_command_idle_delay
;
452 /* List of deferred actions to be performed at a later time.
453 The precise format isn't relevant here; we just check whether it is nil. */
454 Lisp_Object Vdeferred_action_list
;
456 /* Function to call to handle deferred actions, when there are any. */
457 Lisp_Object Vdeferred_action_function
;
458 Lisp_Object Qdeferred_action_function
;
460 Lisp_Object Qinput_method_exit_on_first_char
;
461 Lisp_Object Qinput_method_use_echo_area
;
463 /* File in which we write all commands we read. */
466 /* Nonzero if input is available. */
469 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
470 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
474 /* Non-zero means force key bindings update in parse_menu_item. */
476 int update_menu_bindings
;
478 extern char *pending_malloc_warning
;
480 /* Circular buffer for pre-read keyboard input. */
482 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
484 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
486 The interrupt-level event handlers will never enqueue an event on a
487 frame which is not in Vframe_list, and once an event is dequeued,
488 internal_last_event_frame or the event itself points to the frame.
491 But while the event is sitting in the queue, it's completely
492 unprotected. Suppose the user types one command which will run for
493 a while and then delete a frame, and then types another event at
494 the frame that will be deleted, before the command gets around to
495 it. Suppose there are no references to this frame elsewhere in
496 Emacs, and a GC occurs before the second event is dequeued. Now we
497 have an event referring to a freed frame, which will crash Emacs
500 Similar things happen when an event on a scroll bar is enqueued; the
501 window may be deleted while the event is in the queue.
503 So, we use this vector to protect the Lisp_Objects in the event
504 queue. That way, they'll be dequeued as dead frames or windows,
505 but still valid Lisp objects.
507 If kbd_buffer[i].kind != no_event, then
509 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
510 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
512 static Lisp_Object kbd_buffer_gcpro
;
514 /* Pointer to next available character in kbd_buffer.
515 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
516 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
517 next available char is in kbd_buffer[0]. */
518 static struct input_event
*kbd_fetch_ptr
;
520 /* Pointer to next place to store character in kbd_buffer. This
521 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
522 character should go in kbd_buffer[0]. */
523 static struct input_event
* volatile kbd_store_ptr
;
525 /* The above pair of variables forms a "queue empty" flag. When we
526 enqueue a non-hook event, we increment kbd_store_ptr. When we
527 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
528 there is input available iff the two pointers are not equal.
530 Why not just have a flag set and cleared by the enqueuing and
531 dequeuing functions? Such a flag could be screwed up by interrupts
532 at inopportune times. */
534 /* If this flag is non-nil, we check mouse_moved to see when the
535 mouse moves, and motion events will appear in the input stream.
536 Otherwise, mouse motion is ignored. */
537 Lisp_Object do_mouse_tracking
;
539 /* Symbols to head events. */
540 Lisp_Object Qmouse_movement
;
541 Lisp_Object Qscroll_bar_movement
;
542 Lisp_Object Qswitch_frame
;
543 Lisp_Object Qdelete_frame
;
544 Lisp_Object Qiconify_frame
;
545 Lisp_Object Qmake_frame_visible
;
546 Lisp_Object Qhelp_echo
;
548 /* Symbols to denote kinds of events. */
549 Lisp_Object Qfunction_key
;
550 Lisp_Object Qmouse_click
;
552 Lisp_Object Qmouse_wheel
;
553 Lisp_Object Qlanguage_change
;
555 Lisp_Object Qdrag_n_drop
;
556 /* Lisp_Object Qmouse_movement; - also an event header */
558 /* Properties of event headers. */
559 Lisp_Object Qevent_kind
;
560 Lisp_Object Qevent_symbol_elements
;
562 /* menu item parts */
563 Lisp_Object Qmenu_alias
;
564 Lisp_Object Qmenu_enable
;
565 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
566 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
567 extern Lisp_Object Vdefine_key_rebound_commands
;
568 extern Lisp_Object Qmenu_item
;
570 /* An event header symbol HEAD may have a property named
571 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
572 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
573 mask of modifiers applied to it. If present, this is used to help
574 speed up parse_modifiers. */
575 Lisp_Object Qevent_symbol_element_mask
;
577 /* An unmodified event header BASE may have a property named
578 Qmodifier_cache, which is an alist mapping modifier masks onto
579 modified versions of BASE. If present, this helps speed up
581 Lisp_Object Qmodifier_cache
;
583 /* Symbols to use for parts of windows. */
584 Lisp_Object Qmode_line
;
585 Lisp_Object Qvertical_line
;
586 Lisp_Object Qvertical_scroll_bar
;
587 Lisp_Object Qmenu_bar
;
589 Lisp_Object
recursive_edit_unwind (), command_loop ();
590 Lisp_Object
Fthis_command_keys ();
591 Lisp_Object Qextended_command_history
;
592 EMACS_TIME
timer_check ();
594 extern Lisp_Object Vhistory_length
;
596 extern char *x_get_keysym_name ();
598 static void record_menu_key ();
600 Lisp_Object Qpolling_period
;
602 /* List of absolute timers. Appears in order of next scheduled event. */
603 Lisp_Object Vtimer_list
;
605 /* List of idle time timers. Appears in order of next scheduled event. */
606 Lisp_Object Vtimer_idle_list
;
608 /* Incremented whenever a timer is run. */
611 extern Lisp_Object Vprint_level
, Vprint_length
;
613 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
615 EMACS_TIME
*input_available_clear_time
;
617 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
618 Default is 1 if INTERRUPT_INPUT is defined. */
621 /* Nonzero while interrupts are temporarily deferred during redisplay. */
622 int interrupts_deferred
;
624 /* Nonzero means use ^S/^Q for flow control. */
627 /* Allow m- file to inhibit use of FIONREAD. */
628 #ifdef BROKEN_FIONREAD
632 /* We are unable to use interrupts if FIONREAD is not available,
633 so flush SIGIO so we won't try. */
640 /* If we support a window system, turn on the code to poll periodically
641 to detect C-g. It isn't actually used when doing interrupt input. */
642 #ifdef HAVE_WINDOW_SYSTEM
643 #define POLL_FOR_INPUT
646 /* After a command is executed, if point is moved into a region that
647 has specific properties (e.g. composition, display), we adjust
648 point to the boundary of the region. But, if a command sets this
649 valiable to non-nil, we suppress this point adjustment. This
650 variable is set to nil before reading a command. */
652 Lisp_Object Vdisable_point_adjustment
;
654 /* If non-nil, always disable point adjustment. */
656 Lisp_Object Vglobal_disable_point_adjustment
;
658 /* The time when Emacs started being idle. */
660 static EMACS_TIME timer_idleness_start_time
;
663 /* Global variable declarations. */
665 /* Function for init_keyboard to call with no args (if nonzero). */
666 void (*keyboard_init_hook
) ();
668 static int read_avail_input
P_ ((int));
669 static void get_input_pending
P_ ((int *, int));
670 static int readable_events
P_ ((int));
671 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
672 Lisp_Object
, int *));
673 static Lisp_Object
read_char_x_menu_prompt ();
674 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
676 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
678 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
679 enum scroll_bar_part
,
680 Lisp_Object
, Lisp_Object
,
683 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
684 Lisp_Object
, char **,
685 Lisp_Object
*, unsigned));
686 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
687 static int parse_solitary_modifier
P_ ((Lisp_Object
));
688 static int parse_solitary_modifier ();
689 static void save_getcjmp
P_ ((jmp_buf));
690 static void save_getcjmp ();
691 static void restore_getcjmp
P_ ((jmp_buf));
692 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
693 static void clear_event
P_ ((struct input_event
*));
694 static void any_kboard_state
P_ ((void));
696 /* Nonzero means don't try to suspend even if the operating system seems
698 static int cannot_suspend
;
700 /* Install the string STR as the beginning of the string of echoing,
701 so that it serves as a prompt for the next character.
702 Also start echoing. */
708 int nbytes
= STRING_BYTES (XSTRING (str
));
709 int multibyte_p
= STRING_MULTIBYTE (str
);
711 if (nbytes
> ECHOBUFSIZE
- 4)
715 /* Have to find the last character that fit's into the
717 unsigned char *p
= XSTRING (str
)->data
;
718 unsigned char *pend
= p
+ ECHOBUFSIZE
- 4;
723 PARSE_MULTIBYTE_SEQ (p
, pend
- p
, char_len
);
728 nbytes
= p
- XSTRING (str
)->data
- char_len
;
731 nbytes
= ECHOBUFSIZE
- 4;
734 nbytes
= copy_text (XSTRING (str
)->data
, current_kboard
->echobuf
, nbytes
,
735 STRING_MULTIBYTE (str
), 1);
736 current_kboard
->echoptr
= current_kboard
->echobuf
+ nbytes
;
737 *current_kboard
->echoptr
= '\0';
738 current_kboard
->echo_after_prompt
= nbytes
;
743 /* Add C to the echo string, if echoing is going on.
744 C can be a character, which is printed prettily ("M-C-x" and all that
745 jazz), or a symbol, whose name is printed. */
751 if (current_kboard
->immediate_echo
)
753 char *ptr
= current_kboard
->echoptr
;
755 if (ptr
!= current_kboard
->echobuf
)
758 /* If someone has passed us a composite event, use its head symbol. */
765 if (ptr
- current_kboard
->echobuf
766 > ECHOBUFSIZE
- KEY_DESCRIPTION_SIZE
)
769 ptr
= push_key_description (ch
, ptr
, 1);
771 else if (SYMBOLP (c
))
773 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
774 if ((ptr
- current_kboard
->echobuf
) + STRING_BYTES (name
) + 4
777 ptr
+= copy_text (name
->data
, ptr
, STRING_BYTES (name
),
778 name
->size_byte
>= 0, 1);
781 if (current_kboard
->echoptr
== current_kboard
->echobuf
784 strcpy (ptr
, " (Type ? for further options)");
789 current_kboard
->echoptr
= ptr
;
795 /* Temporarily add a dash to the end of the echo string if it's not
796 empty, so that it serves as a mini-prompt for the very next character. */
801 if (!current_kboard
->immediate_echo
802 && current_kboard
->echoptr
== current_kboard
->echobuf
)
804 /* Do nothing if we just printed a prompt. */
805 if (current_kboard
->echo_after_prompt
806 == current_kboard
->echoptr
- current_kboard
->echobuf
)
808 /* Do nothing if not echoing at all. */
809 if (current_kboard
->echoptr
== 0)
812 /* Put a dash at the end of the buffer temporarily,
813 but make it go away when the next character is added. */
814 current_kboard
->echoptr
[0] = '-';
815 current_kboard
->echoptr
[1] = 0;
820 /* Display the current echo string, and begin echoing if not already
826 if (!current_kboard
->immediate_echo
)
829 current_kboard
->immediate_echo
= 1;
831 for (i
= 0; i
< this_command_key_count
; i
++)
834 c
= XVECTOR (this_command_keys
)->contents
[i
];
835 if (! (EVENT_HAS_PARAMETERS (c
)
836 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
843 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
847 /* Record in what buffer we echoed, and from which kboard. */
848 echo_message_buffer
= echo_area_buffer
[0];
849 echo_kboard
= current_kboard
;
851 if (waiting_for_input
&& !NILP (Vquit_flag
))
852 quit_throw_to_read_char ();
855 /* Turn off echoing, for the start of a new command. */
860 current_kboard
->immediate_echo
= 0;
861 current_kboard
->echoptr
= current_kboard
->echobuf
;
862 current_kboard
->echo_after_prompt
= -1;
863 ok_to_echo_at_next_pause
= NULL
;
865 echo_message_buffer
= Qnil
;
868 /* Return the length of the current echo string. */
873 return current_kboard
->echoptr
- current_kboard
->echobuf
;
876 /* Truncate the current echo message to its first LEN chars.
877 This and echo_char get used by read_key_sequence when the user
878 switches frames while entering a key sequence. */
884 current_kboard
->echobuf
[len
] = '\0';
885 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
886 truncate_echo_area (len
);
890 /* Functions for manipulating this_command_keys. */
892 add_command_key (key
)
895 /* If reset-this-command-length was called recently, obey it now.
896 See the doc string of that function for an explanation of why. */
897 if (before_command_restore_flag
)
899 this_command_key_count
= before_command_key_count_1
;
900 if (this_command_key_count
< this_single_command_key_start
)
901 this_single_command_key_start
= this_command_key_count
;
902 echo_truncate (before_command_echo_length_1
);
903 before_command_restore_flag
= 0;
906 if (this_command_key_count
>= ASIZE (this_command_keys
))
907 this_command_keys
= larger_vector (this_command_keys
,
908 2 * ASIZE (this_command_keys
),
911 AREF (this_command_keys
, this_command_key_count
) = key
;
912 ++this_command_key_count
;
919 int count
= specpdl_ptr
- specpdl
;
922 if (command_loop_level
> 0)
924 specbind (Qstandard_output
, Qt
);
925 specbind (Qstandard_input
, Qt
);
928 #ifdef HAVE_X_WINDOWS
929 /* The command loop has started an hourglass timer, so we have to
930 cancel it here, otherwise it will fire because the recursive edit
931 can take some time. */
932 if (display_hourglass_p
)
936 /* This function may have been called from a debugger called from
937 within redisplay, for instance by Edebugging a function called
938 from fontification-functions. We want to allow redisplay in
939 the debugging session.
941 The recursive edit is left with a `(throw exit ...)'. The `exit'
942 tag is not caught anywhere in redisplay, i.e. when we leave the
943 recursive edit, the original redisplay leading to the recursive
944 edit will be unwound. The outcome should therefore be safe. */
945 specbind (Qinhibit_redisplay
, Qnil
);
948 val
= command_loop ();
950 Fsignal (Qquit
, Qnil
);
951 /* Handle throw from read_minibuf when using minibuffer
952 while it's active but we're in another window. */
954 Fsignal (Qerror
, Fcons (val
, Qnil
));
956 return unbind_to (count
, Qnil
);
959 /* When an auto-save happens, record the "time", and don't do again soon. */
964 last_auto_save
= num_nonmacro_input_events
;
967 /* Make an auto save happen as soon as possible at command level. */
970 force_auto_save_soon ()
972 last_auto_save
= - auto_save_interval
- 1;
974 record_asynch_buffer_change ();
977 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
978 doc
: /* Invoke the editor command loop recursively.
979 To get out of the recursive edit, a command can do `(throw 'exit nil)';
980 that tells this function to return.
981 Alternately, `(throw 'exit t)' makes this function signal an error.
982 This function is called by the editor initialization to begin editing. */)
985 int count
= specpdl_ptr
- specpdl
;
988 command_loop_level
++;
989 update_mode_lines
= 1;
991 if (command_loop_level
992 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
993 buffer
= Fcurrent_buffer ();
997 /* If we leave recursive_edit_1 below with a `throw' for instance,
998 like it is done in the splash screen display, we have to
999 make sure that we restore single_kboard as command_loop_1
1000 would have done if it were left normally. */
1001 record_unwind_protect (recursive_edit_unwind
,
1002 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1004 recursive_edit_1 ();
1005 return unbind_to (count
, Qnil
);
1009 recursive_edit_unwind (info
)
1012 if (BUFFERP (XCAR (info
)))
1013 Fset_buffer (XCAR (info
));
1015 if (NILP (XCDR (info
)))
1016 any_kboard_state ();
1018 single_kboard_state ();
1020 command_loop_level
--;
1021 update_mode_lines
= 1;
1030 #if 0 /* Theory: if there's anything in Vunread_command_events,
1031 it will right away be read by read_key_sequence,
1032 and then if we do switch KBOARDS, it will go into the side
1033 queue then. So we don't need to do anything special here -- rms. */
1034 if (CONSP (Vunread_command_events
))
1036 current_kboard
->kbd_queue
1037 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1038 current_kboard
->kbd_queue_has_data
= 1;
1040 Vunread_command_events
= Qnil
;
1046 /* Switch to the single-kboard state, making current_kboard
1047 the only KBOARD from which further input is accepted. */
1050 single_kboard_state ()
1057 /* Maintain a stack of kboards, so other parts of Emacs
1058 can switch temporarily to the kboard of a given frame
1059 and then revert to the previous status. */
1064 struct kboard_stack
*next
;
1067 static struct kboard_stack
*kboard_stack
;
1070 push_frame_kboard (f
)
1074 struct kboard_stack
*p
1075 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1077 p
->next
= kboard_stack
;
1078 p
->kboard
= current_kboard
;
1081 current_kboard
= FRAME_KBOARD (f
);
1089 struct kboard_stack
*p
= kboard_stack
;
1090 current_kboard
= p
->kboard
;
1091 kboard_stack
= p
->next
;
1096 /* Handle errors that are not handled at inner levels
1097 by printing an error message and returning to the editor command loop. */
1103 Lisp_Object old_level
, old_length
;
1104 char macroerror
[50];
1106 if (!NILP (executing_macro
))
1108 if (executing_macro_iterations
== 1)
1109 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1111 sprintf (macroerror
, "After %d kbd macro iterations: ",
1112 executing_macro_iterations
);
1117 Vstandard_output
= Qt
;
1118 Vstandard_input
= Qt
;
1119 Vexecuting_macro
= Qnil
;
1120 executing_macro
= Qnil
;
1121 current_kboard
->Vprefix_arg
= Qnil
;
1122 current_kboard
->Vlast_prefix_arg
= Qnil
;
1125 /* Avoid unquittable loop if data contains a circular list. */
1126 old_level
= Vprint_level
;
1127 old_length
= Vprint_length
;
1128 XSETFASTINT (Vprint_level
, 10);
1129 XSETFASTINT (Vprint_length
, 10);
1130 cmd_error_internal (data
, macroerror
);
1131 Vprint_level
= old_level
;
1132 Vprint_length
= old_length
;
1136 Vinhibit_quit
= Qnil
;
1138 any_kboard_state ();
1141 return make_number (0);
1144 /* Take actions on handling an error. DATA is the data that describes
1147 CONTEXT is a C-string containing ASCII characters only which
1148 describes the context in which the error happened. If we need to
1149 generalize CONTEXT to allow multibyte characters, make it a Lisp
1153 cmd_error_internal (data
, context
)
1158 int kill_emacs_p
= 0;
1159 struct frame
*sf
= SELECTED_FRAME ();
1163 clear_message (1, 0);
1165 /* If the window system or terminal frame hasn't been initialized
1166 yet, or we're not interactive, it's best to dump this message out
1167 to stderr and exit. */
1168 if (!sf
->glyphs_initialized_p
1169 /* This is the case of the frame dumped with Emacs, when we're
1170 running under a window system. */
1171 || (!NILP (Vwindow_system
)
1172 && !inhibit_window_system
1173 && FRAME_TERMCAP_P (sf
))
1176 stream
= Qexternal_debugging_output
;
1187 write_string_1 (context
, -1, stream
);
1189 print_error_message (data
, stream
);
1191 /* If the window system or terminal frame hasn't been initialized
1192 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1196 Fkill_emacs (make_number (-1));
1200 Lisp_Object
command_loop_1 ();
1201 Lisp_Object
command_loop_2 ();
1202 Lisp_Object
top_level_1 ();
1204 /* Entry to editor-command-loop.
1205 This level has the catches for exiting/returning to editor command loop.
1206 It returns nil to exit recursive edit, t to abort it. */
1211 if (command_loop_level
> 0 || minibuf_level
> 0)
1214 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1215 executing_macro
= Qnil
;
1221 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1222 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1223 executing_macro
= Qnil
;
1225 /* End of file in -batch run causes exit here. */
1231 /* Here we catch errors in execution of commands within the
1232 editing loop, and reenter the editing loop.
1233 When there is an error, cmd_error runs and returns a non-nil
1234 value to us. A value of nil means that cmd_loop_1 itself
1235 returned due to end of file (or end of kbd macro). */
1240 register Lisp_Object val
;
1243 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1244 while (!NILP (val
));
1252 return Feval (Vtop_level
);
1258 /* On entry to the outer level, run the startup file */
1259 if (!NILP (Vtop_level
))
1260 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1261 else if (!NILP (Vpurify_flag
))
1262 message ("Bare impure Emacs (standard Lisp code not loaded)");
1264 message ("Bare Emacs (standard Lisp code not loaded)");
1268 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1269 doc
: /* Exit all recursive editing levels. */)
1272 #ifdef HAVE_X_WINDOWS
1273 if (display_hourglass_p
)
1274 cancel_hourglass ();
1276 return Fthrow (Qtop_level
, Qnil
);
1279 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1280 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1283 if (command_loop_level
> 0 || minibuf_level
> 0)
1284 Fthrow (Qexit
, Qnil
);
1286 error ("No recursive edit is in progress");
1290 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1291 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1294 if (command_loop_level
> 0 || minibuf_level
> 0)
1297 error ("No recursive edit is in progress");
1301 /* This is the actual command reading loop,
1302 sans error-handling encapsulation. */
1304 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1306 void safe_run_hooks
P_ ((Lisp_Object
));
1307 static void adjust_point_for_property
P_ ((int));
1315 Lisp_Object keybuf
[30];
1319 struct buffer
*prev_buffer
= NULL
;
1321 int was_locked
= single_kboard
;
1324 current_kboard
->Vprefix_arg
= Qnil
;
1325 current_kboard
->Vlast_prefix_arg
= Qnil
;
1326 Vdeactivate_mark
= Qnil
;
1327 waiting_for_input
= 0;
1331 this_command_key_count
= 0;
1332 this_single_command_key_start
= 0;
1334 /* Make sure this hook runs after commands that get errors and
1335 throw to top level. */
1336 /* Note that the value cell will never directly contain nil
1337 if the symbol is a local variable. */
1338 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1339 safe_run_hooks (Qpost_command_hook
);
1341 /* If displaying a message, resize the echo area window to fit
1342 that message's size exactly. */
1343 if (!NILP (echo_area_buffer
[0]))
1344 resize_echo_area_exactly ();
1346 if (!NILP (Vdeferred_action_list
))
1347 call0 (Vdeferred_action_function
);
1349 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1351 if (NILP (Vunread_command_events
)
1352 && NILP (Vunread_input_method_events
)
1353 && NILP (Vunread_post_input_method_events
)
1354 && NILP (Vexecuting_macro
)
1355 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1356 safe_run_hooks (Qpost_command_idle_hook
);
1359 /* Do this after running Vpost_command_hook, for consistency. */
1360 current_kboard
->Vlast_command
= Vthis_command
;
1361 current_kboard
->Vreal_last_command
= real_this_command
;
1365 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1368 /* Make sure the current window's buffer is selected. */
1369 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1370 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1372 /* Display any malloc warning that just came out. Use while because
1373 displaying one warning can cause another. */
1375 while (pending_malloc_warning
)
1376 display_malloc_warning ();
1380 Vdeactivate_mark
= Qnil
;
1382 /* If minibuffer on and echo area in use,
1383 wait a short time and redraw minibuffer. */
1386 && !NILP (echo_area_buffer
[0])
1387 && EQ (minibuf_window
, echo_area_window
)
1388 && NUMBERP (Vminibuffer_message_timeout
))
1390 /* Bind inhibit-quit to t so that C-g gets read in
1391 rather than quitting back to the minibuffer. */
1392 int count
= specpdl_ptr
- specpdl
;
1393 specbind (Qinhibit_quit
, Qt
);
1395 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1396 /* Clear the echo area. */
1398 safe_run_hooks (Qecho_area_clear_hook
);
1400 unbind_to (count
, Qnil
);
1402 /* If a C-g came in before, treat it as input now. */
1403 if (!NILP (Vquit_flag
))
1406 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1411 alloca (0); /* Cause a garbage collection now */
1412 /* Since we can free the most stuff here. */
1413 #endif /* C_ALLOCA */
1416 /* Select the frame that the last event came from. Usually,
1417 switch-frame events will take care of this, but if some lisp
1418 code swallows a switch-frame event, we'll fix things up here.
1419 Is this a good idea? */
1420 if (FRAMEP (internal_last_event_frame
)
1421 && !EQ (internal_last_event_frame
, selected_frame
))
1422 Fselect_frame (internal_last_event_frame
, Qnil
);
1424 /* If it has changed current-menubar from previous value,
1425 really recompute the menubar from the value. */
1426 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1427 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1428 call0 (Qrecompute_lucid_menubar
);
1430 before_command_key_count
= this_command_key_count
;
1431 before_command_echo_length
= echo_length ();
1433 Vthis_command
= Qnil
;
1434 real_this_command
= Qnil
;
1436 /* Read next key sequence; i gets its length. */
1437 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1440 /* A filter may have run while we were reading the input. */
1441 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1443 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1444 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1448 /* Now we have read a key sequence of length I,
1449 or else I is 0 and we found end of file. */
1451 if (i
== 0) /* End of file -- happens only in */
1452 return Qnil
; /* a kbd macro, at the end. */
1453 /* -1 means read_key_sequence got a menu that was rejected.
1454 Just loop around and read another command. */
1458 this_command_key_count
= 0;
1459 this_single_command_key_start
= 0;
1463 last_command_char
= keybuf
[i
- 1];
1465 /* If the previous command tried to force a specific window-start,
1466 forget about that, in case this command moves point far away
1467 from that position. But also throw away beg_unchanged and
1468 end_unchanged information in that case, so that redisplay will
1469 update the whole window properly. */
1470 if (!NILP (XWINDOW (selected_window
)->force_start
))
1473 XWINDOW (selected_window
)->force_start
= Qnil
;
1474 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1475 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1478 cmd
= read_key_sequence_cmd
;
1479 if (!NILP (Vexecuting_macro
))
1481 if (!NILP (Vquit_flag
))
1483 Vexecuting_macro
= Qt
;
1484 QUIT
; /* Make some noise. */
1485 /* Will return since macro now empty. */
1489 /* Do redisplay processing after this command except in special
1490 cases identified below. */
1491 prev_buffer
= current_buffer
;
1492 prev_modiff
= MODIFF
;
1493 last_point_position
= PT
;
1494 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1496 /* By default, we adjust point to a boundary of a region that
1497 has such a property that should be treated intangible
1498 (e.g. composition, display). But, some commands will set
1499 this variable differently. */
1500 Vdisable_point_adjustment
= Qnil
;
1502 /* Process filters and timers may have messed with deactivate-mark.
1503 reset it before we execute the command. */
1504 Vdeactivate_mark
= Qnil
;
1506 /* Execute the command. */
1508 Vthis_command
= cmd
;
1509 real_this_command
= cmd
;
1510 /* Note that the value cell will never directly contain nil
1511 if the symbol is a local variable. */
1512 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1513 safe_run_hooks (Qpre_command_hook
);
1515 if (NILP (Vthis_command
))
1517 /* nil means key is undefined. */
1519 current_kboard
->defining_kbd_macro
= Qnil
;
1520 update_mode_lines
= 1;
1521 current_kboard
->Vprefix_arg
= Qnil
;
1525 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1527 /* In case we jump to directly_done. */
1528 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1530 /* Recognize some common commands in common situations and
1531 do them directly. */
1532 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1534 struct Lisp_Char_Table
*dp
1535 = window_display_table (XWINDOW (selected_window
));
1536 lose
= FETCH_CHAR (PT_BYTE
);
1539 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1540 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1541 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1542 && (lose
>= 0x20 && lose
< 0x7f)))
1543 : (lose
>= 0x20 && lose
< 0x7f))
1544 /* To extract the case of continuation on
1545 wide-column characters. */
1546 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1547 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1549 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1551 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1553 && !windows_or_buffers_changed
1554 && EQ (current_buffer
->selective_display
, Qnil
)
1555 && !detect_input_pending ()
1556 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1557 && NILP (Vexecuting_macro
))
1558 direct_output_forward_char (1);
1561 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1563 struct Lisp_Char_Table
*dp
1564 = window_display_table (XWINDOW (selected_window
));
1566 lose
= FETCH_CHAR (PT_BYTE
);
1568 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1569 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1570 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1571 && (lose
>= 0x20 && lose
< 0x7f)))
1572 : (lose
>= 0x20 && lose
< 0x7f))
1573 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1575 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1577 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1579 && !windows_or_buffers_changed
1580 && EQ (current_buffer
->selective_display
, Qnil
)
1581 && !detect_input_pending ()
1582 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1583 && NILP (Vexecuting_macro
))
1584 direct_output_forward_char (-1);
1587 else if (EQ (Vthis_command
, Qself_insert_command
)
1588 /* Try this optimization only on ascii keystrokes. */
1589 && INTEGERP (last_command_char
))
1591 unsigned int c
= XINT (last_command_char
);
1593 if (NILP (Vexecuting_macro
)
1594 && !EQ (minibuf_window
, selected_window
))
1596 if (!nonundocount
|| nonundocount
>= 20)
1604 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1606 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1608 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1610 || MODIFF
<= SAVE_MODIFF
1611 || windows_or_buffers_changed
1612 || !EQ (current_buffer
->selective_display
, Qnil
)
1613 || detect_input_pending ()
1614 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1615 || !NILP (Vexecuting_macro
));
1617 value
= internal_self_insert (c
, 0);
1622 /* VALUE == 1 when AFTER-CHANGE functions are
1623 installed which is the case most of the time
1624 because FONT-LOCK installs one. */
1625 if (!lose
&& !value
)
1626 direct_output_for_insert (c
);
1631 /* Here for a command that isn't executed directly */
1633 #ifdef HAVE_X_WINDOWS
1634 if (display_hourglass_p
)
1639 if (NILP (current_kboard
->Vprefix_arg
))
1641 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1643 #ifdef HAVE_X_WINDOWS
1644 if (display_hourglass_p
)
1645 cancel_hourglass ();
1649 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1651 /* Note that the value cell will never directly contain nil
1652 if the symbol is a local variable. */
1653 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1654 safe_run_hooks (Qpost_command_hook
);
1656 /* If displaying a message, resize the echo area window to fit
1657 that message's size exactly. */
1658 if (!NILP (echo_area_buffer
[0]))
1659 resize_echo_area_exactly ();
1661 if (!NILP (Vdeferred_action_list
))
1662 safe_run_hooks (Qdeferred_action_function
);
1664 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1666 if (NILP (Vunread_command_events
)
1667 && NILP (Vunread_input_method_events
)
1668 && NILP (Vunread_post_input_method_events
)
1669 && NILP (Vexecuting_macro
)
1670 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1671 safe_run_hooks (Qpost_command_idle_hook
);
1674 /* If there is a prefix argument,
1675 1) We don't want Vlast_command to be ``universal-argument''
1676 (that would be dumb), so don't set Vlast_command,
1677 2) we want to leave echoing on so that the prefix will be
1678 echoed as part of this key sequence, so don't call
1680 3) we want to leave this_command_key_count non-zero, so that
1681 read_char will realize that it is re-reading a character, and
1682 not echo it a second time.
1684 If the command didn't actually create a prefix arg,
1685 but is merely a frame event that is transparent to prefix args,
1686 then the above doesn't apply. */
1687 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1689 current_kboard
->Vlast_command
= Vthis_command
;
1690 current_kboard
->Vreal_last_command
= real_this_command
;
1692 this_command_key_count
= 0;
1693 this_single_command_key_start
= 0;
1696 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1698 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1700 current_buffer
->mark_active
= Qnil
;
1701 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1703 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1704 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1709 if (current_buffer
== prev_buffer
1710 && last_point_position
!= PT
1711 && NILP (Vdisable_point_adjustment
)
1712 && NILP (Vglobal_disable_point_adjustment
))
1713 adjust_point_for_property (last_point_position
);
1715 /* Install chars successfully executed in kbd macro. */
1717 if (!NILP (current_kboard
->defining_kbd_macro
)
1718 && NILP (current_kboard
->Vprefix_arg
))
1719 finalize_kbd_macro_chars ();
1723 any_kboard_state ();
1728 extern Lisp_Object Qcomposition
, Qdisplay
;
1730 /* Adjust point to a boundary of a region that has such a property
1731 that should be treated intangible. For the moment, we check
1732 `composition' and `display' property. LAST_PT is the last position
1736 adjust_point_for_property (last_pt
)
1741 int check_composition
= 1, check_display
= 1;
1743 while (check_composition
|| check_display
)
1745 if (check_composition
1746 && PT
> BEGV
&& PT
< ZV
1747 && get_property_and_range (PT
, Qcomposition
, &val
, &start
, &end
, Qnil
)
1748 && COMPOSITION_VALID_P (start
, end
, val
)
1749 && start
< PT
&& end
> PT
1750 && (last_pt
<= start
|| last_pt
>= end
))
1758 check_composition
= 0;
1760 && PT
> BEGV
&& PT
< ZV
1761 && get_property_and_range (PT
, Qdisplay
, &val
, &start
, &end
, Qnil
)
1762 && display_prop_intangible_p (val
)
1763 && start
< PT
&& end
> PT
1764 && (last_pt
<= start
|| last_pt
>= end
))
1770 check_composition
= 1;
1776 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1779 safe_run_hooks_1 (hook
)
1782 return call1 (Vrun_hooks
, Vinhibit_quit
);
1785 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1788 safe_run_hooks_error (data
)
1791 return Fset (Vinhibit_quit
, Qnil
);
1794 /* If we get an error while running the hook, cause the hook variable
1795 to be nil. Also inhibit quits, so that C-g won't cause the hook
1796 to mysteriously evaporate. */
1799 safe_run_hooks (hook
)
1802 int count
= specpdl_ptr
- specpdl
;
1803 specbind (Qinhibit_quit
, hook
);
1805 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1807 unbind_to (count
, Qnil
);
1811 /* Number of seconds between polling for input. This is a Lisp
1812 variable that can be bound. */
1816 /* Nonzero means polling for input is temporarily suppressed. */
1818 int poll_suppress_count
;
1820 /* Asynchronous timer for polling. */
1822 struct atimer
*poll_timer
;
1825 #ifdef POLL_FOR_INPUT
1827 /* Poll for input, so what we catch a C-g if it comes in. This
1828 function is called from x_make_frame_visible, see comment
1834 if (interrupt_input_blocked
== 0
1835 && !waiting_for_input
)
1836 read_avail_input (0);
1839 /* Timer callback function for poll_timer. TIMER is equal to
1843 poll_for_input (timer
)
1844 struct atimer
*timer
;
1846 if (poll_suppress_count
== 0)
1847 poll_for_input_1 ();
1850 #endif /* POLL_FOR_INPUT */
1852 /* Begin signals to poll for input, if they are appropriate.
1853 This function is called unconditionally from various places. */
1858 #ifdef POLL_FOR_INPUT
1859 if (read_socket_hook
&& !interrupt_input
)
1861 /* Turn alarm handling on unconditionally. It might have
1862 been turned off in process.c. */
1863 turn_on_atimers (1);
1865 /* If poll timer doesn't exist, are we need one with
1866 a different interval, start a new one. */
1867 if (poll_timer
== NULL
1868 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1870 EMACS_TIME interval
;
1873 cancel_atimer (poll_timer
);
1875 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1876 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1877 poll_for_input
, NULL
);
1880 /* Let the timer's callback function poll for input
1881 if this becomes zero. */
1882 --poll_suppress_count
;
1887 /* Nonzero if we are using polling to handle input asynchronously. */
1890 input_polling_used ()
1892 #ifdef POLL_FOR_INPUT
1893 return read_socket_hook
&& !interrupt_input
;
1899 /* Turn off polling. */
1904 #ifdef POLL_FOR_INPUT
1905 if (read_socket_hook
&& !interrupt_input
)
1906 ++poll_suppress_count
;
1910 /* Set the value of poll_suppress_count to COUNT
1911 and start or stop polling accordingly. */
1914 set_poll_suppress_count (count
)
1917 #ifdef POLL_FOR_INPUT
1918 if (count
== 0 && poll_suppress_count
!= 0)
1920 poll_suppress_count
= 1;
1923 else if (count
!= 0 && poll_suppress_count
== 0)
1927 poll_suppress_count
= count
;
1931 /* Bind polling_period to a value at least N.
1932 But don't decrease it. */
1935 bind_polling_period (n
)
1938 #ifdef POLL_FOR_INPUT
1939 int new = polling_period
;
1944 stop_other_atimers (poll_timer
);
1946 specbind (Qpolling_period
, make_number (new));
1947 /* Start a new alarm with the new period. */
1952 /* Apply the control modifier to CHARACTER. */
1958 /* Save the upper bits here. */
1959 int upper
= c
& ~0177;
1963 /* Everything in the columns containing the upper-case letters
1964 denotes a control character. */
1965 if (c
>= 0100 && c
< 0140)
1969 /* Set the shift modifier for a control char
1970 made from a shifted letter. But only for letters! */
1971 if (oc
>= 'A' && oc
<= 'Z')
1972 c
|= shift_modifier
;
1975 /* The lower-case letters denote control characters too. */
1976 else if (c
>= 'a' && c
<= 'z')
1979 /* Include the bits for control and shift
1980 only if the basic ASCII code can't indicate them. */
1984 /* Replace the high bits. */
1985 c
|= (upper
& ~ctrl_modifier
);
1990 /* Display help echo in the echo area.
1992 HELP a string means display that string, HELP nil means clear the
1993 help echo. If HELP is a function, call it with OBJECT and POS as
1994 arguments; the function should return a help string or nil for
1995 none. For all other types of HELP evaluate it to obtain a string.
1997 WINDOW is the window in which the help was generated, if any.
1998 It is nil if not in a window.
2000 If OBJECT is a buffer, POS is the position in the buffer where the
2001 `help-echo' text property was found.
2003 If OBJECT is an overlay, that overlay has a `help-echo' property,
2004 and POS is the position in the overlay's buffer under the mouse.
2006 If OBJECT is a string (an overlay string or a string displayed with
2007 the `display' property). POS is the position in that string under
2010 OK_TO_IVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2011 echo overwrites a keystroke echo currently displayed in the echo
2014 Note: this function may only be called with HELP nil or a string
2015 from X code running asynchronously. */
2018 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2019 Lisp_Object help
, window
, object
, pos
;
2020 int ok_to_overwrite_keystroke_echo
;
2022 if (!NILP (help
) && !STRINGP (help
))
2024 if (FUNCTIONP (help
))
2026 Lisp_Object args
[4];
2031 help
= safe_call (4, args
);
2034 help
= safe_eval (help
);
2036 if (!STRINGP (help
))
2040 if (STRINGP (help
) || NILP (help
))
2042 if (!NILP (Vshow_help_function
))
2043 call1 (Vshow_help_function
, help
);
2044 else if (/* Don't overwrite minibuffer contents. */
2045 !MINI_WINDOW_P (XWINDOW (selected_window
))
2046 /* Don't overwrite a keystroke echo. */
2047 && (NILP (echo_message_buffer
)
2048 || ok_to_overwrite_keystroke_echo
)
2049 /* Don't overwrite a prompt. */
2050 && !cursor_in_echo_area
)
2054 int count
= BINDING_STACK_SIZE ();
2056 if (!help_echo_showing_p
)
2057 Vpre_help_message
= current_message ();
2059 specbind (Qmessage_truncate_lines
, Qt
);
2060 message3_nolog (help
, STRING_BYTES (XSTRING (help
)),
2061 STRING_MULTIBYTE (help
));
2062 unbind_to (count
, Qnil
);
2064 else if (STRINGP (Vpre_help_message
))
2066 message3_nolog (Vpre_help_message
,
2067 STRING_BYTES (XSTRING (Vpre_help_message
)),
2068 STRING_MULTIBYTE (Vpre_help_message
));
2069 Vpre_help_message
= Qnil
;
2075 help_echo_showing_p
= STRINGP (help
);
2081 /* Input of single characters from keyboard */
2083 Lisp_Object
print_help ();
2084 static Lisp_Object
kbd_buffer_get_event ();
2085 static void record_char ();
2088 static jmp_buf wrong_kboard_jmpbuf
;
2091 /* read a character from the keyboard; call the redisplay if needed */
2092 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2093 -1 means do not do redisplay, but do do autosaving.
2096 /* The arguments MAPS and NMAPS are for menu prompting.
2097 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2099 PREV_EVENT is the previous input event, or nil if we are reading
2100 the first event of a key sequence (or not reading a key sequence).
2101 If PREV_EVENT is t, that is a "magic" value that says
2102 not to run input methods, but in other respects to act as if
2103 not reading a key sequence.
2105 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2106 if we used a mouse menu to read the input, or zero otherwise. If
2107 USED_MOUSE_MENU is null, we don't dereference it.
2109 Value is t if we showed a menu and the user rejected it. */
2112 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2116 Lisp_Object prev_event
;
2117 int *used_mouse_menu
;
2119 volatile Lisp_Object c
;
2121 jmp_buf local_getcjmp
;
2123 volatile int key_already_recorded
= 0;
2124 Lisp_Object tem
, save
;
2125 volatile Lisp_Object previous_echo_area_message
;
2126 volatile Lisp_Object also_record
;
2127 volatile int reread
;
2128 struct gcpro gcpro1
, gcpro2
;
2129 EMACS_TIME last_idle_start
;
2133 before_command_key_count
= this_command_key_count
;
2134 before_command_echo_length
= echo_length ();
2136 previous_echo_area_message
= Qnil
;
2138 GCPRO2 (c
, previous_echo_area_message
);
2143 if (CONSP (Vunread_post_input_method_events
))
2145 c
= XCAR (Vunread_post_input_method_events
);
2146 Vunread_post_input_method_events
2147 = XCDR (Vunread_post_input_method_events
);
2149 /* Undo what read_char_x_menu_prompt did when it unread
2150 additional keys returned by Fx_popup_menu. */
2152 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2160 if (unread_command_char
!= -1)
2162 XSETINT (c
, unread_command_char
);
2163 unread_command_char
= -1;
2169 if (CONSP (Vunread_command_events
))
2171 c
= XCAR (Vunread_command_events
);
2172 Vunread_command_events
= XCDR (Vunread_command_events
);
2174 /* Undo what read_char_x_menu_prompt did when it unread
2175 additional keys returned by Fx_popup_menu. */
2177 && EQ (XCDR (c
), Qdisabled
)
2178 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2181 /* If the queued event is something that used the mouse,
2182 set used_mouse_menu accordingly. */
2184 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2185 *used_mouse_menu
= 1;
2188 goto reread_for_input_method
;
2191 if (CONSP (Vunread_input_method_events
))
2193 c
= XCAR (Vunread_input_method_events
);
2194 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2196 /* Undo what read_char_x_menu_prompt did when it unread
2197 additional keys returned by Fx_popup_menu. */
2199 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2203 goto reread_for_input_method
;
2206 /* If there is no function key translated before
2207 reset-this-command-lengths takes effect, forget about it. */
2208 before_command_restore_flag
= 0;
2210 if (!NILP (Vexecuting_macro
))
2212 /* We set this to Qmacro; since that's not a frame, nobody will
2213 try to switch frames on us, and the selected window will
2216 Since this event came from a macro, it would be misleading to
2217 leave internal_last_event_frame set to wherever the last
2218 real event came from. Normally, a switch-frame event selects
2219 internal_last_event_frame after each command is read, but
2220 events read from a macro should never cause a new frame to be
2222 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2224 /* Exit the macro if we are at the end.
2225 Also, some things replace the macro with t
2226 to force an early exit. */
2227 if (EQ (Vexecuting_macro
, Qt
)
2228 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2234 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2235 if (STRINGP (Vexecuting_macro
)
2236 && (XINT (c
) & 0x80))
2237 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2239 executing_macro_index
++;
2244 if (!NILP (unread_switch_frame
))
2246 c
= unread_switch_frame
;
2247 unread_switch_frame
= Qnil
;
2249 /* This event should make it into this_command_keys, and get echoed
2250 again, so we do not set `reread'. */
2254 /* if redisplay was requested */
2255 if (commandflag
>= 0)
2257 /* If there is pending input, process any events which are not
2258 user-visible, such as X selection_request events. */
2260 || detect_input_pending_run_timers (0))
2261 swallow_events (0); /* may clear input_pending */
2263 /* Redisplay if no pending input. */
2264 while (!input_pending
)
2266 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2267 redisplay_preserve_echo_area (5);
2272 /* Normal case: no input arrived during redisplay. */
2275 /* Input arrived and pre-empted redisplay.
2276 Process any events which are not user-visible. */
2278 /* If that cleared input_pending, try again to redisplay. */
2282 /* Message turns off echoing unless more keystrokes turn it on again.
2284 The code in 20.x for the condition was
2286 1. echo_area_glyphs && *echo_area_glyphs
2287 2. && echo_area_glyphs != current_kboard->echobuf
2288 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2290 (1) means there's a current message displayed
2292 (2) means it's not the message from echoing from the current
2295 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2296 is set to a non-null value. This is done in read_char and it is
2297 set to echo_area_glyphs after a call to echo_char. That means
2298 ok_to_echo_at_next_pause is either null or
2299 current_kboard->echobuf with the appropriate current_kboard at
2302 So, condition (3) means in clear text ok_to_echo_at_next_pause
2303 must be either null, or the current message isn't from echoing at
2304 all, or it's from echoing from a different kboard than the
2307 if (/* There currently something in the echo area */
2308 !NILP (echo_area_buffer
[0])
2309 && (/* And it's either not from echoing. */
2310 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2311 /* Or it's an echo from a different kboard. */
2312 || echo_kboard
!= current_kboard
2313 /* Or we explicitly allow overwriting whatever there is. */
2314 || ok_to_echo_at_next_pause
== NULL
))
2319 /* Try reading a character via menu prompting in the minibuf.
2320 Try this before the sit-for, because the sit-for
2321 would do the wrong thing if we are supposed to do
2322 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2323 after a mouse event so don't try a minibuf menu. */
2325 if (nmaps
> 0 && INTERACTIVE
2326 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2327 /* Don't bring up a menu if we already have another event. */
2328 && NILP (Vunread_command_events
)
2329 && unread_command_char
< 0
2330 && !detect_input_pending_run_timers (0))
2332 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2335 key_already_recorded
= 1;
2340 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2341 We will do that below, temporarily for short sections of code,
2342 when appropriate. local_getcjmp must be in effect
2343 around any call to sit_for or kbd_buffer_get_event;
2344 it *must not* be in effect when we call redisplay. */
2346 if (_setjmp (local_getcjmp
))
2348 XSETINT (c
, quit_char
);
2349 internal_last_event_frame
= selected_frame
;
2350 Vlast_event_frame
= internal_last_event_frame
;
2351 /* If we report the quit char as an event,
2352 don't do so more than once. */
2353 if (!NILP (Vinhibit_quit
))
2358 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2359 if (kb
!= current_kboard
)
2361 Lisp_Object link
= kb
->kbd_queue
;
2362 /* We shouldn't get here if we were in single-kboard mode! */
2367 while (CONSP (XCDR (link
)))
2369 if (!NILP (XCDR (link
)))
2373 kb
->kbd_queue
= Fcons (c
, Qnil
);
2375 XSETCDR (link
, Fcons (c
, Qnil
));
2376 kb
->kbd_queue_has_data
= 1;
2377 current_kboard
= kb
;
2378 /* This is going to exit from read_char
2379 so we had better get rid of this frame's stuff. */
2381 longjmp (wrong_kboard_jmpbuf
, 1);
2388 timer_start_idle ();
2390 /* If in middle of key sequence and minibuffer not active,
2391 start echoing if enough time elapses. */
2393 if (minibuf_level
== 0
2394 && !current_kboard
->immediate_echo
2395 && this_command_key_count
> 0
2397 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2398 && NILP (Fzerop (Vecho_keystrokes
))
2399 && (/* No message. */
2400 NILP (echo_area_buffer
[0])
2401 /* Or empty message. */
2402 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2403 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2404 /* Or already echoing from same kboard. */
2405 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2406 /* Or not echoing before and echoing allowed. */
2407 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2411 /* After a mouse event, start echoing right away.
2412 This is because we are probably about to display a menu,
2413 and we don't want to delay before doing so. */
2414 if (EVENT_HAS_PARAMETERS (prev_event
))
2419 double duration
= extract_float (Vecho_keystrokes
);
2420 sec
= (int) duration
;
2421 usec
= (duration
- sec
) * 1000000;
2422 save_getcjmp (save_jump
);
2423 restore_getcjmp (local_getcjmp
);
2424 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2425 restore_getcjmp (save_jump
);
2427 && ! CONSP (Vunread_command_events
))
2432 /* Maybe auto save due to number of keystrokes. */
2434 if (commandflag
!= 0
2435 && auto_save_interval
> 0
2436 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2437 && !detect_input_pending_run_timers (0))
2439 Fdo_auto_save (Qnil
, Qnil
);
2440 /* Hooks can actually change some buffers in auto save. */
2444 /* Try reading using an X menu.
2445 This is never confused with reading using the minibuf
2446 because the recursive call of read_char in read_char_minibuf_menu_prompt
2447 does not pass on any keymaps. */
2449 if (nmaps
> 0 && INTERACTIVE
2450 && !NILP (prev_event
)
2451 && EVENT_HAS_PARAMETERS (prev_event
)
2452 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2453 && !EQ (XCAR (prev_event
), Qtool_bar
)
2454 /* Don't bring up a menu if we already have another event. */
2455 && NILP (Vunread_command_events
)
2456 && unread_command_char
< 0)
2458 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2460 /* Now that we have read an event, Emacs is not idle. */
2466 /* Maybe autosave and/or garbage collect due to idleness. */
2468 if (INTERACTIVE
&& NILP (c
))
2470 int delay_level
, buffer_size
;
2472 /* Slow down auto saves logarithmically in size of current buffer,
2473 and garbage collect while we're at it. */
2474 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2475 last_non_minibuf_size
= Z
- BEG
;
2476 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2478 while (buffer_size
> 64)
2479 delay_level
++, buffer_size
-= buffer_size
>> 2;
2480 if (delay_level
< 4) delay_level
= 4;
2481 /* delay_level is 4 for files under around 50k, 7 at 100k,
2482 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2484 /* Auto save if enough time goes by without input. */
2485 if (commandflag
!= 0
2486 && num_nonmacro_input_events
> last_auto_save
2487 && INTEGERP (Vauto_save_timeout
)
2488 && XINT (Vauto_save_timeout
) > 0)
2492 save_getcjmp (save_jump
);
2493 restore_getcjmp (local_getcjmp
);
2494 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2496 restore_getcjmp (save_jump
);
2499 && ! CONSP (Vunread_command_events
))
2501 Fdo_auto_save (Qnil
, Qnil
);
2503 /* If we have auto-saved and there is still no input
2504 available, garbage collect if there has been enough
2505 consing going on to make it worthwhile. */
2506 if (!detect_input_pending_run_timers (0)
2507 && consing_since_gc
> gc_cons_threshold
/ 2)
2508 Fgarbage_collect ();
2515 /* If this has become non-nil here, it has been set by a timer
2516 or sentinel or filter. */
2517 if (CONSP (Vunread_command_events
))
2519 c
= XCAR (Vunread_command_events
);
2520 Vunread_command_events
= XCDR (Vunread_command_events
);
2523 /* Read something from current KBOARD's side queue, if possible. */
2527 if (current_kboard
->kbd_queue_has_data
)
2529 if (!CONSP (current_kboard
->kbd_queue
))
2531 c
= XCAR (current_kboard
->kbd_queue
);
2532 current_kboard
->kbd_queue
2533 = XCDR (current_kboard
->kbd_queue
);
2534 if (NILP (current_kboard
->kbd_queue
))
2535 current_kboard
->kbd_queue_has_data
= 0;
2536 input_pending
= readable_events (0);
2537 if (EVENT_HAS_PARAMETERS (c
)
2538 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2539 internal_last_event_frame
= XCAR (XCDR (c
));
2540 Vlast_event_frame
= internal_last_event_frame
;
2545 /* If current_kboard's side queue is empty check the other kboards.
2546 If one of them has data that we have not yet seen here,
2547 switch to it and process the data waiting for it.
2549 Note: if the events queued up for another kboard
2550 have already been seen here, and therefore are not a complete command,
2551 the kbd_queue_has_data field is 0, so we skip that kboard here.
2552 That's to avoid an infinite loop switching between kboards here. */
2553 if (NILP (c
) && !single_kboard
)
2556 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2557 if (kb
->kbd_queue_has_data
)
2559 current_kboard
= kb
;
2560 /* This is going to exit from read_char
2561 so we had better get rid of this frame's stuff. */
2563 longjmp (wrong_kboard_jmpbuf
, 1);
2572 /* Finally, we read from the main queue,
2573 and if that gives us something we can't use yet, we put it on the
2574 appropriate side queue and try again. */
2580 /* Actually read a character, waiting if necessary. */
2581 save_getcjmp (save_jump
);
2582 restore_getcjmp (local_getcjmp
);
2583 timer_start_idle ();
2584 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2585 restore_getcjmp (save_jump
);
2588 if (! NILP (c
) && (kb
!= current_kboard
))
2590 Lisp_Object link
= kb
->kbd_queue
;
2593 while (CONSP (XCDR (link
)))
2595 if (!NILP (XCDR (link
)))
2599 kb
->kbd_queue
= Fcons (c
, Qnil
);
2601 XSETCDR (link
, Fcons (c
, Qnil
));
2602 kb
->kbd_queue_has_data
= 1;
2606 current_kboard
= kb
;
2607 /* This is going to exit from read_char
2608 so we had better get rid of this frame's stuff. */
2610 longjmp (wrong_kboard_jmpbuf
, 1);
2615 /* Terminate Emacs in batch mode if at eof. */
2616 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2617 Fkill_emacs (make_number (1));
2621 /* Add in any extra modifiers, where appropriate. */
2622 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2623 || ((extra_keyboard_modifiers
& 0177) < ' '
2624 && (extra_keyboard_modifiers
& 0177) != 0))
2625 XSETINT (c
, make_ctrl_char (XINT (c
)));
2627 /* Transfer any other modifier bits directly from
2628 extra_keyboard_modifiers to c. Ignore the actual character code
2629 in the low 16 bits of extra_keyboard_modifiers. */
2630 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2635 /* Record the last idle start time so that we can reset it
2636 should the next event read be a help-echo. */
2637 last_idle_start
= timer_idleness_start_time
;
2643 if (commandflag
>= 0
2644 && !input_pending
&& !detect_input_pending_run_timers (0))
2652 /* Buffer switch events are only for internal wakeups
2653 so don't show them to the user.
2654 Also, don't record a key if we already did. */
2655 if (BUFFERP (c
) || key_already_recorded
)
2658 /* Process special events within read_char
2659 and loop around to read another event. */
2662 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2667 int was_locked
= single_kboard
;
2669 last_input_char
= c
;
2670 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2672 /* Resume allowing input from any kboard, if that was true before. */
2674 any_kboard_state ();
2679 /* Handle things that only apply to characters. */
2682 /* If kbd_buffer_get_event gave us an EOF, return that. */
2686 if ((STRINGP (Vkeyboard_translate_table
)
2687 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2688 || (VECTORP (Vkeyboard_translate_table
)
2689 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2690 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2691 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2694 d
= Faref (Vkeyboard_translate_table
, c
);
2695 /* nil in keyboard-translate-table means no translation. */
2701 /* If this event is a mouse click in the menu bar,
2702 return just menu-bar for now. Modify the mouse click event
2703 so we won't do this twice, then queue it up. */
2704 if (EVENT_HAS_PARAMETERS (c
)
2706 && CONSP (EVENT_START (c
))
2707 && CONSP (XCDR (EVENT_START (c
))))
2711 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2712 /* Handle menu-bar events:
2713 insert the dummy prefix event `menu-bar'. */
2714 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2716 /* Change menu-bar to (menu-bar) as the event "position". */
2717 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2720 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2725 /* Store these characters into recent_keys, the dribble file if any,
2726 and the keyboard macro being defined, if any. */
2728 if (! NILP (also_record
))
2729 record_char (also_record
);
2731 /* Wipe the echo area.
2732 But first, if we are about to use an input method,
2733 save the echo area contents for it to refer to. */
2735 && ! NILP (Vinput_method_function
)
2736 && (unsigned) XINT (c
) >= ' '
2737 && (unsigned) XINT (c
) != 127
2738 && (unsigned) XINT (c
) < 256)
2740 previous_echo_area_message
= Fcurrent_message ();
2741 Vinput_method_previous_message
= previous_echo_area_message
;
2744 /* Now wipe the echo area, except for help events which do their
2745 own stuff with the echo area. */
2747 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2748 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2750 if (!NILP (echo_area_buffer
[0]))
2751 safe_run_hooks (Qecho_area_clear_hook
);
2752 clear_message (1, 0);
2755 reread_for_input_method
:
2757 /* Pass this to the input method, if appropriate. */
2759 && ! NILP (Vinput_method_function
)
2760 /* Don't run the input method within a key sequence,
2761 after the first event of the key sequence. */
2762 && NILP (prev_event
)
2763 && (unsigned) XINT (c
) >= ' '
2764 && (unsigned) XINT (c
) != 127
2765 && (unsigned) XINT (c
) < 256)
2769 struct gcpro gcpro1
;
2770 int count
= specpdl_ptr
- specpdl
;
2772 /* Save the echo status. */
2773 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2774 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2775 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2777 if (before_command_restore_flag
)
2779 this_command_key_count
= before_command_key_count_1
;
2780 if (this_command_key_count
< this_single_command_key_start
)
2781 this_single_command_key_start
= this_command_key_count
;
2782 echo_truncate (before_command_echo_length_1
);
2783 before_command_restore_flag
= 0;
2786 /* Save the this_command_keys status. */
2787 key_count
= this_command_key_count
;
2790 keys
= Fcopy_sequence (this_command_keys
);
2795 /* Clear out this_command_keys. */
2796 this_command_key_count
= 0;
2798 /* Now wipe the echo area. */
2799 if (!NILP (echo_area_buffer
[0]))
2800 safe_run_hooks (Qecho_area_clear_hook
);
2801 clear_message (1, 0);
2804 /* If we are not reading a key sequence,
2805 never use the echo area. */
2808 specbind (Qinput_method_use_echo_area
, Qt
);
2811 /* Call the input method. */
2812 tem
= call1 (Vinput_method_function
, c
);
2814 tem
= unbind_to (count
, tem
);
2816 /* Restore the saved echoing state
2817 and this_command_keys state. */
2818 this_command_key_count
= key_count
;
2820 this_command_keys
= keys
;
2823 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2824 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2825 if (saved_immediate_echo
)
2830 /* The input method can return no events. */
2833 /* Bring back the previous message, if any. */
2834 if (! NILP (previous_echo_area_message
))
2835 message_with_string ("%s", previous_echo_area_message
, 0);
2838 /* It returned one event or more. */
2840 Vunread_post_input_method_events
2841 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2846 /* Display help if not echoing. */
2847 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2849 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
2850 Lisp_Object help
, object
, position
, window
, tem
;
2852 tem
= Fcdr (XCDR (c
));
2855 window
= Fcar (tem
);
2857 object
= Fcar (tem
);
2859 position
= Fcar (tem
);
2861 show_help_echo (help
, window
, object
, position
, 0);
2863 /* We stopped being idle for this event; undo that. */
2864 timer_idleness_start_time
= last_idle_start
;
2868 if (this_command_key_count
== 0 || ! reread
)
2870 before_command_key_count
= this_command_key_count
;
2871 before_command_echo_length
= echo_length ();
2873 /* Don't echo mouse motion events. */
2874 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2875 && NILP (Fzerop (Vecho_keystrokes
))
2876 && ! (EVENT_HAS_PARAMETERS (c
)
2877 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2880 if (! NILP (also_record
))
2881 echo_char (also_record
);
2882 /* Once we reread a character, echoing can happen
2883 the next time we pause to read a new one. */
2884 ok_to_echo_at_next_pause
= current_kboard
;
2887 /* Record this character as part of the current key. */
2888 add_command_key (c
);
2889 if (! NILP (also_record
))
2890 add_command_key (also_record
);
2893 last_input_char
= c
;
2896 /* Process the help character specially if enabled */
2897 if (!NILP (Vhelp_form
) && help_char_p (c
))
2900 count
= specpdl_ptr
- specpdl
;
2902 record_unwind_protect (Fset_window_configuration
,
2903 Fcurrent_window_configuration (Qnil
));
2905 tem0
= Feval (Vhelp_form
);
2907 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2911 c
= read_char (0, 0, 0, Qnil
, 0);
2912 while (BUFFERP (c
));
2913 /* Remove the help from the frame */
2914 unbind_to (count
, Qnil
);
2917 if (EQ (c
, make_number (040)))
2921 c
= read_char (0, 0, 0, Qnil
, 0);
2922 while (BUFFERP (c
));
2929 /* Record a key that came from a mouse menu.
2930 Record it for echoing, for this-command-keys, and so on. */
2936 /* Wipe the echo area. */
2937 clear_message (1, 0);
2941 before_command_key_count
= this_command_key_count
;
2942 before_command_echo_length
= echo_length ();
2944 /* Don't echo mouse motion events. */
2945 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2946 && NILP (Fzerop (Vecho_keystrokes
)))
2950 /* Once we reread a character, echoing can happen
2951 the next time we pause to read a new one. */
2952 ok_to_echo_at_next_pause
= 0;
2955 /* Record this character as part of the current key. */
2956 add_command_key (c
);
2958 /* Re-reading in the middle of a command */
2959 last_input_char
= c
;
2963 /* Return 1 if should recognize C as "the help character". */
2971 if (EQ (c
, Vhelp_char
))
2973 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
2974 if (EQ (c
, XCAR (tail
)))
2979 /* Record the input event C in various ways. */
2985 /* Don't record `help-echo' in recent_keys unless it shows some help
2986 message, and a different help than the previoiusly recorded
2988 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2992 help
= Fcar (Fcdr (XCDR (c
)));
2996 Lisp_Object last_c
, last_help
;
2998 last_idx
= recent_keys_index
- 1;
3000 last_idx
= NUM_RECENT_KEYS
- 1;
3001 last_c
= AREF (recent_keys
, last_idx
);
3004 || !EQ (XCAR (last_c
), Qhelp_echo
)
3005 || (last_help
= Fcar (Fcdr (XCDR (last_c
))),
3006 !EQ (last_help
, help
)))
3009 ASET (recent_keys
, recent_keys_index
, c
);
3010 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3011 recent_keys_index
= 0;
3018 ASET (recent_keys
, recent_keys_index
, c
);
3019 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3020 recent_keys_index
= 0;
3023 /* Write c to the dribble file. If c is a lispy event, write
3024 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3025 If you, dear reader, have a better idea, you've got the source. :-) */
3030 if (XUINT (c
) < 0x100)
3031 putc (XINT (c
), dribble
);
3033 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3037 Lisp_Object dribblee
;
3039 /* If it's a structured event, take the event header. */
3040 dribblee
= EVENT_HEAD (c
);
3042 if (SYMBOLP (dribblee
))
3044 putc ('<', dribble
);
3045 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
3046 STRING_BYTES (XSYMBOL (dribblee
)->name
),
3048 putc ('>', dribble
);
3055 if (!CONSP (c
) || !EQ (Qhelp_echo
, XCAR (c
)))
3056 store_kbd_macro_char (c
);
3058 num_nonmacro_input_events
++;
3065 struct buffer
*old
= current_buffer
;
3066 Fprinc (object
, Qnil
);
3067 set_buffer_internal (XBUFFER (Vstandard_output
));
3068 call0 (intern ("help-mode"));
3069 set_buffer_internal (old
);
3073 /* Copy out or in the info on where C-g should throw to.
3074 This is used when running Lisp code from within get_char,
3075 in case get_char is called recursively.
3076 See read_process_output. */
3082 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3086 restore_getcjmp (temp
)
3089 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3094 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3095 of this function. */
3098 tracking_off (old_value
)
3099 Lisp_Object old_value
;
3101 do_mouse_tracking
= old_value
;
3102 if (NILP (old_value
))
3104 /* Redisplay may have been preempted because there was input
3105 available, and it assumes it will be called again after the
3106 input has been processed. If the only input available was
3107 the sort that we have just disabled, then we need to call
3109 if (!readable_events (1))
3111 redisplay_preserve_echo_area (6);
3112 get_input_pending (&input_pending
, 1);
3118 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3119 doc
: /* Evaluate BODY with mouse movement events enabled.
3120 Within a `track-mouse' form, mouse motion generates input events that
3121 you can read with `read-event'.
3122 Normally, mouse motion is ignored.
3123 usage: (track-mouse BODY ...) */)
3127 int count
= specpdl_ptr
- specpdl
;
3130 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3132 do_mouse_tracking
= Qt
;
3134 val
= Fprogn (args
);
3135 return unbind_to (count
, val
);
3138 /* If mouse has moved on some frame, return one of those frames.
3139 Return 0 otherwise. */
3144 Lisp_Object tail
, frame
;
3146 FOR_EACH_FRAME (tail
, frame
)
3148 if (XFRAME (frame
)->mouse_moved
)
3149 return XFRAME (frame
);
3155 #endif /* HAVE_MOUSE */
3157 /* Low level keyboard/mouse input.
3158 kbd_buffer_store_event places events in kbd_buffer, and
3159 kbd_buffer_get_event retrieves them. */
3161 /* Return true iff there are any events in the queue that read-char
3162 would return. If this returns false, a read-char would block. */
3164 readable_events (do_timers_now
)
3168 timer_check (do_timers_now
);
3170 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3173 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3178 if (current_kboard
->kbd_queue_has_data
)
3184 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3185 if (kb
->kbd_queue_has_data
)
3191 /* Set this for debugging, to have a way to get out */
3196 event_to_kboard (event
)
3197 struct input_event
*event
;
3200 frame
= event
->frame_or_window
;
3202 frame
= XCAR (frame
);
3203 else if (WINDOWP (frame
))
3204 frame
= WINDOW_FRAME (XWINDOW (frame
));
3206 /* There are still some events that don't set this field.
3207 For now, just ignore the problem.
3208 Also ignore dead frames here. */
3209 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3212 return FRAME_KBOARD (XFRAME (frame
));
3216 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3219 kbd_buffer_store_event (event
)
3220 register struct input_event
*event
;
3222 if (event
->kind
== no_event
)
3225 if (event
->kind
== ascii_keystroke
)
3227 register int c
= event
->code
& 0377;
3229 if (event
->modifiers
& ctrl_modifier
)
3230 c
= make_ctrl_char (c
);
3232 c
|= (event
->modifiers
3233 & (meta_modifier
| alt_modifier
3234 | hyper_modifier
| super_modifier
));
3238 static SIGTYPE
interrupt_signal (int);
3241 struct input_event
*sp
;
3244 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3245 kb
!= current_kboard
))
3248 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3249 Fcons (make_number (c
), Qnil
));
3250 kb
->kbd_queue_has_data
= 1;
3251 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3253 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3256 if (event_to_kboard (sp
) == kb
)
3258 sp
->kind
= no_event
;
3259 sp
->frame_or_window
= Qnil
;
3267 /* If this results in a quit_char being returned to Emacs as
3268 input, set Vlast_event_frame properly. If this doesn't
3269 get returned to Emacs as an event, the next event read
3270 will set Vlast_event_frame again, so this is safe to do. */
3274 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3276 focus
= event
->frame_or_window
;
3277 internal_last_event_frame
= focus
;
3278 Vlast_event_frame
= focus
;
3281 last_event_timestamp
= event
->timestamp
;
3282 interrupt_signal (0 /* dummy */);
3286 if (c
&& c
== stop_character
)
3292 /* Don't insert two buffer_switch_event's in a row.
3293 Just ignore the second one. */
3294 else if (event
->kind
== buffer_switch_event
3295 && kbd_fetch_ptr
!= kbd_store_ptr
3296 && kbd_store_ptr
->kind
== buffer_switch_event
)
3299 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3300 kbd_store_ptr
= kbd_buffer
;
3302 /* Don't let the very last slot in the buffer become full,
3303 since that would make the two pointers equal,
3304 and that is indistinguishable from an empty buffer.
3305 Discard the event if it would fill the last slot. */
3306 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3310 #if 0 /* The selection_request_event case looks bogus, and it's error
3311 prone to assign individual members for other events, in case
3312 the input_event structure is changed. --2000-07-13, gerd. */
3313 struct input_event
*sp
= kbd_store_ptr
;
3314 sp
->kind
= event
->kind
;
3315 if (event
->kind
== selection_request_event
)
3317 /* We must not use the ordinary copying code for this case,
3318 since `part' is an enum and copying it might not copy enough
3320 bcopy (event
, (char *) sp
, sizeof (*event
));
3325 sp
->code
= event
->code
;
3326 sp
->part
= event
->part
;
3327 sp
->frame_or_window
= event
->frame_or_window
;
3328 sp
->arg
= event
->arg
;
3329 sp
->modifiers
= event
->modifiers
;
3332 sp
->timestamp
= event
->timestamp
;
3335 *kbd_store_ptr
= *event
;
3338 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3339 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3340 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3346 /* Generate HELP_EVENT input_events in BUFP which has room for
3347 SIZE events. If there's not enough room in BUFP, ignore this
3350 HELP is the help form.
3352 FRAME is the frame on which the help is generated. OBJECT is the
3353 Lisp object where the help was found (a buffer, a string, an
3354 overlay, or nil if neither from a string nor from a buffer. POS is
3355 the position within OBJECT where the help was found.
3357 Value is the number of input_events generated. */
3360 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3361 struct input_event
*bufp
;
3363 Lisp_Object help
, frame
, object
, window
;
3366 int nevents_stored
= 0;
3370 bufp
->kind
= HELP_EVENT
;
3371 bufp
->frame_or_window
= frame
;
3373 bufp
->x
= make_number (pos
);
3377 bufp
->kind
= HELP_EVENT
;
3378 bufp
->frame_or_window
= WINDOWP (window
) ? window
: frame
;
3384 return nevents_stored
;
3388 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3391 kbd_buffer_store_help_event (frame
, help
)
3392 Lisp_Object frame
, help
;
3394 struct input_event event
;
3396 event
.kind
= HELP_EVENT
;
3397 event
.frame_or_window
= frame
;
3399 event
.x
= make_number (0);
3401 kbd_buffer_store_event (&event
);
3403 event
.kind
= HELP_EVENT
;
3404 event
.frame_or_window
= frame
;
3406 event
.x
= make_number (0);
3408 kbd_buffer_store_event (&event
);
3412 /* Discard any mouse events in the event buffer by setting them to
3415 discard_mouse_events ()
3417 struct input_event
*sp
;
3418 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3420 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3423 if (sp
->kind
== mouse_click
3425 || sp
->kind
== w32_scroll_bar_click
3427 || sp
->kind
== scroll_bar_click
)
3429 sp
->kind
= no_event
;
3435 /* Return non-zero if there are any real events waiting in the event
3436 buffer, not counting `no_event's.
3438 If DISCARD is non-zero, discard no_event events at the front of
3439 the input queue, possibly leaving the input queue empty if there
3440 are no real input events. */
3443 kbd_buffer_events_waiting (discard
)
3446 struct input_event
*sp
;
3448 for (sp
= kbd_fetch_ptr
;
3449 sp
!= kbd_store_ptr
&& sp
->kind
== no_event
;
3452 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3459 return sp
!= kbd_store_ptr
&& sp
->kind
!= no_event
;
3463 /* Clear input event EVENT. */
3467 struct input_event
*event
;
3469 int idx
= 2 * (event
- kbd_buffer
);
3470 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3471 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3472 event
->kind
= no_event
;
3476 /* Read one event from the event buffer, waiting if necessary.
3477 The value is a Lisp object representing the event.
3478 The value is nil for an event that should be ignored,
3479 or that was handled here.
3480 We always read and discard one event. */
3483 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3485 int *used_mouse_menu
;
3494 *kbp
= current_kboard
;
3498 /* Wait until there is input available. */
3501 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3504 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3508 /* If the quit flag is set, then read_char will return
3509 quit_char, so that counts as "available input." */
3510 if (!NILP (Vquit_flag
))
3511 quit_throw_to_read_char ();
3513 /* One way or another, wait until input is available; then, if
3514 interrupt handlers have not read it, read it now. */
3517 wait_for_kbd_input ();
3519 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3523 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3526 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3530 Lisp_Object minus_one
;
3532 XSETINT (minus_one
, -1);
3533 wait_reading_process_input (0, 0, minus_one
, 1);
3535 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3536 /* Pass 1 for EXPECT since we just waited to have input. */
3537 read_avail_input (1);
3539 #endif /* not VMS */
3542 if (CONSP (Vunread_command_events
))
3545 first
= XCAR (Vunread_command_events
);
3546 Vunread_command_events
= XCDR (Vunread_command_events
);
3547 *kbp
= current_kboard
;
3551 /* At this point, we know that there is a readable event available
3552 somewhere. If the event queue is empty, then there must be a
3553 mouse movement enabled and available. */
3554 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3556 struct input_event
*event
;
3558 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3562 last_event_timestamp
= event
->timestamp
;
3565 *kbp
= event_to_kboard (event
);
3567 *kbp
= current_kboard
; /* Better than returning null ptr? */
3569 *kbp
= &the_only_kboard
;
3574 /* These two kinds of events get special handling
3575 and don't actually appear to the command loop.
3576 We return nil for them. */
3577 if (event
->kind
== selection_request_event
)
3580 struct input_event copy
;
3582 /* Remove it from the buffer before processing it,
3583 since otherwise swallow_events will see it
3584 and process it again. */
3586 kbd_fetch_ptr
= event
+ 1;
3587 input_pending
= readable_events (0);
3588 x_handle_selection_request (©
);
3590 /* We're getting selection request events, but we don't have
3596 else if (event
->kind
== selection_clear_event
)
3599 struct input_event copy
;
3601 /* Remove it from the buffer before processing it. */
3603 kbd_fetch_ptr
= event
+ 1;
3604 input_pending
= readable_events (0);
3605 x_handle_selection_clear (©
);
3607 /* We're getting selection request events, but we don't have
3612 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (macintosh)
3613 else if (event
->kind
== delete_window_event
)
3615 /* Make an event (delete-frame (FRAME)). */
3616 obj
= Fcons (event
->frame_or_window
, Qnil
);
3617 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3618 kbd_fetch_ptr
= event
+ 1;
3621 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3622 else if (event
->kind
== iconify_event
)
3624 /* Make an event (iconify-frame (FRAME)). */
3625 obj
= Fcons (event
->frame_or_window
, Qnil
);
3626 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3627 kbd_fetch_ptr
= event
+ 1;
3629 else if (event
->kind
== deiconify_event
)
3631 /* Make an event (make-frame-visible (FRAME)). */
3632 obj
= Fcons (event
->frame_or_window
, Qnil
);
3633 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3634 kbd_fetch_ptr
= event
+ 1;
3637 else if (event
->kind
== buffer_switch_event
)
3639 /* The value doesn't matter here; only the type is tested. */
3640 XSETBUFFER (obj
, current_buffer
);
3641 kbd_fetch_ptr
= event
+ 1;
3643 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
3644 else if (event
->kind
== menu_bar_activate_event
)
3646 kbd_fetch_ptr
= event
+ 1;
3647 input_pending
= readable_events (0);
3648 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3649 x_activate_menubar (XFRAME (event
->frame_or_window
));
3653 else if (event
->kind
== language_change_event
)
3655 /* Make an event (language-change (FRAME CHARSET LCID)). */
3656 obj
= Fcons (event
->modifiers
, Qnil
);
3657 obj
= Fcons (event
->code
, Qnil
);
3658 obj
= Fcons (event
->frame_or_window
, obj
);
3659 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3660 kbd_fetch_ptr
= event
+ 1;
3663 /* Just discard these, by returning nil.
3664 With MULTI_KBOARD, these events are used as placeholders
3665 when we need to randomly delete events from the queue.
3666 (They shouldn't otherwise be found in the buffer,
3667 but on some machines it appears they do show up
3668 even without MULTI_KBOARD.) */
3669 /* On Windows NT/9X, no_event is used to delete extraneous
3670 mouse events during a popup-menu call. */
3671 else if (event
->kind
== no_event
)
3672 kbd_fetch_ptr
= event
+ 1;
3673 else if (event
->kind
== HELP_EVENT
)
3675 /* There are always two HELP_EVENTs in the input queue. */
3676 Lisp_Object object
, position
, help
, frame
, window
;
3678 xassert (event
->code
== 0);
3679 frame
= event
->frame_or_window
;
3680 object
= event
->arg
;
3681 position
= event
->x
;
3682 clear_event (event
);
3684 kbd_fetch_ptr
= event
+ 1;
3685 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3688 xassert (event
->code
== 1);
3690 window
= event
->frame_or_window
;
3691 if (!WINDOWP (window
))
3693 obj
= Fcons (Qhelp_echo
,
3694 list5 (frame
, help
, window
, object
, position
));
3695 clear_event (event
);
3696 kbd_fetch_ptr
= event
+ 1;
3698 else if (event
->kind
== FOCUS_IN_EVENT
)
3700 /* Notification of a FocusIn event. The frame receiving the
3701 focus is in event->frame_or_window. Generate a
3702 switch-frame event if necessary. */
3703 Lisp_Object frame
, focus
;
3705 frame
= event
->frame_or_window
;
3706 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3710 if (!EQ (frame
, internal_last_event_frame
)
3711 && !EQ (frame
, selected_frame
))
3712 obj
= make_lispy_switch_frame (frame
);
3713 internal_last_event_frame
= frame
;
3714 kbd_fetch_ptr
= event
+ 1;
3718 /* If this event is on a different frame, return a switch-frame this
3719 time, and leave the event in the queue for next time. */
3723 frame
= event
->frame_or_window
;
3725 frame
= XCAR (frame
);
3726 else if (WINDOWP (frame
))
3727 frame
= WINDOW_FRAME (XWINDOW (frame
));
3729 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3733 if (! EQ (frame
, internal_last_event_frame
)
3734 && !EQ (frame
, selected_frame
))
3735 obj
= make_lispy_switch_frame (frame
);
3736 internal_last_event_frame
= frame
;
3738 /* If we didn't decide to make a switch-frame event, go ahead
3739 and build a real event from the queue entry. */
3743 obj
= make_lispy_event (event
);
3745 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3746 /* If this was a menu selection, then set the flag to inhibit
3747 writing to last_nonmenu_event. Don't do this if the event
3748 we're returning is (menu-bar), though; that indicates the
3749 beginning of the menu sequence, and we might as well leave
3750 that as the `event with parameters' for this selection. */
3752 && !EQ (event
->frame_or_window
, event
->arg
)
3753 && (event
->kind
== MENU_BAR_EVENT
3754 || event
->kind
== TOOL_BAR_EVENT
))
3755 *used_mouse_menu
= 1;
3758 /* Wipe out this event, to catch bugs. */
3759 clear_event (event
);
3760 kbd_fetch_ptr
= event
+ 1;
3765 /* Try generating a mouse motion event. */
3766 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3768 FRAME_PTR f
= some_mouse_moved ();
3769 Lisp_Object bar_window
;
3770 enum scroll_bar_part part
;
3774 *kbp
= current_kboard
;
3775 /* Note that this uses F to determine which display to look at.
3776 If there is no valid info, it does not store anything
3777 so x remains nil. */
3779 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3783 /* Decide if we should generate a switch-frame event. Don't
3784 generate switch-frame events for motion outside of all Emacs
3790 frame
= FRAME_FOCUS_FRAME (f
);
3792 XSETFRAME (frame
, f
);
3794 if (! EQ (frame
, internal_last_event_frame
)
3795 && !EQ (frame
, selected_frame
))
3796 obj
= make_lispy_switch_frame (frame
);
3797 internal_last_event_frame
= frame
;
3800 /* If we didn't decide to make a switch-frame event, go ahead and
3801 return a mouse-motion event. */
3802 if (!NILP (x
) && NILP (obj
))
3803 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3805 #endif /* HAVE_MOUSE */
3807 /* We were promised by the above while loop that there was
3808 something for us to read! */
3811 input_pending
= readable_events (0);
3813 Vlast_event_frame
= internal_last_event_frame
;
3818 /* Process any events that are not user-visible,
3819 then return, without reading any user-visible events. */
3822 swallow_events (do_display
)
3827 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3829 struct input_event
*event
;
3831 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3835 last_event_timestamp
= event
->timestamp
;
3837 /* These two kinds of events get special handling
3838 and don't actually appear to the command loop. */
3839 if (event
->kind
== selection_request_event
)
3842 struct input_event copy
;
3844 /* Remove it from the buffer before processing it,
3845 since otherwise swallow_events called recursively could see it
3846 and process it again. */
3848 kbd_fetch_ptr
= event
+ 1;
3849 input_pending
= readable_events (0);
3850 x_handle_selection_request (©
);
3852 /* We're getting selection request events, but we don't have
3858 else if (event
->kind
== selection_clear_event
)
3861 struct input_event copy
;
3863 /* Remove it from the buffer before processing it, */
3866 kbd_fetch_ptr
= event
+ 1;
3867 input_pending
= readable_events (0);
3868 x_handle_selection_clear (©
);
3870 /* We're getting selection request events, but we don't have
3879 old_timers_run
= timers_run
;
3880 get_input_pending (&input_pending
, 1);
3882 if (timers_run
!= old_timers_run
&& do_display
)
3883 redisplay_preserve_echo_area (7);
3886 /* Record the start of when Emacs is idle,
3887 for the sake of running idle-time timers. */
3894 /* If we are already in the idle state, do nothing. */
3895 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3898 EMACS_GET_TIME (timer_idleness_start_time
);
3900 /* Mark all idle-time timers as once again candidates for running. */
3901 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
3905 timer
= XCAR (timers
);
3907 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3909 XVECTOR (timer
)->contents
[0] = Qnil
;
3913 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3918 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3921 /* This is only for debugging. */
3922 struct input_event last_timer_event
;
3924 /* Check whether a timer has fired. To prevent larger problems we simply
3925 disregard elements that are not proper timers. Do not make a circular
3926 timer list for the time being.
3928 Returns the number of seconds to wait until the next timer fires. If a
3929 timer is triggering now, return zero seconds.
3930 If no timer is active, return -1 seconds.
3932 If a timer is ripe, we run it, with quitting turned off.
3934 DO_IT_NOW is now ignored. It used to mean that we should
3935 run the timer directly instead of queueing a timer-event.
3936 Now we always run timers directly. */
3939 timer_check (do_it_now
)
3942 EMACS_TIME nexttime
;
3943 EMACS_TIME now
, idleness_now
;
3944 Lisp_Object timers
, idle_timers
, chosen_timer
;
3945 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3947 EMACS_SET_SECS (nexttime
, -1);
3948 EMACS_SET_USECS (nexttime
, -1);
3950 /* Always consider the ordinary timers. */
3951 timers
= Vtimer_list
;
3952 /* Consider the idle timers only if Emacs is idle. */
3953 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3954 idle_timers
= Vtimer_idle_list
;
3957 chosen_timer
= Qnil
;
3958 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3960 if (CONSP (timers
) || CONSP (idle_timers
))
3962 EMACS_GET_TIME (now
);
3963 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3964 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3967 while (CONSP (timers
) || CONSP (idle_timers
))
3969 Lisp_Object
*vector
;
3970 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
3971 EMACS_TIME timer_time
, idle_timer_time
;
3972 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3974 /* Skip past invalid timers and timers already handled. */
3977 timer
= XCAR (timers
);
3978 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3980 timers
= XCDR (timers
);
3983 vector
= XVECTOR (timer
)->contents
;
3985 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3986 || !INTEGERP (vector
[3])
3987 || ! NILP (vector
[0]))
3989 timers
= XCDR (timers
);
3993 if (!NILP (idle_timers
))
3995 timer
= XCAR (idle_timers
);
3996 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3998 idle_timers
= XCDR (idle_timers
);
4001 vector
= XVECTOR (timer
)->contents
;
4003 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4004 || !INTEGERP (vector
[3])
4005 || ! NILP (vector
[0]))
4007 idle_timers
= XCDR (idle_timers
);
4012 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4013 based on the next ordinary timer.
4014 TIMER_DIFFERENCE is the distance in time from NOW to when
4015 this timer becomes ripe (negative if it's already ripe). */
4018 timer
= XCAR (timers
);
4019 vector
= XVECTOR (timer
)->contents
;
4020 EMACS_SET_SECS (timer_time
,
4021 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4022 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4023 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4026 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4027 based on the next idle timer. */
4028 if (!NILP (idle_timers
))
4030 idle_timer
= XCAR (idle_timers
);
4031 vector
= XVECTOR (idle_timer
)->contents
;
4032 EMACS_SET_SECS (idle_timer_time
,
4033 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4034 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4035 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4038 /* Decide which timer is the next timer,
4039 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4040 Also step down the list where we found that timer. */
4042 if (! NILP (timers
) && ! NILP (idle_timers
))
4045 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4046 if (EMACS_TIME_NEG_P (temp
))
4048 chosen_timer
= timer
;
4049 timers
= XCDR (timers
);
4050 difference
= timer_difference
;
4054 chosen_timer
= idle_timer
;
4055 idle_timers
= XCDR (idle_timers
);
4056 difference
= idle_timer_difference
;
4059 else if (! NILP (timers
))
4061 chosen_timer
= timer
;
4062 timers
= XCDR (timers
);
4063 difference
= timer_difference
;
4067 chosen_timer
= idle_timer
;
4068 idle_timers
= XCDR (idle_timers
);
4069 difference
= idle_timer_difference
;
4071 vector
= XVECTOR (chosen_timer
)->contents
;
4073 /* If timer is ripe, run it if it hasn't been run. */
4074 if (EMACS_TIME_NEG_P (difference
)
4075 || (EMACS_SECS (difference
) == 0
4076 && EMACS_USECS (difference
) == 0))
4078 if (NILP (vector
[0]))
4080 int was_locked
= single_kboard
;
4081 int count
= BINDING_STACK_SIZE ();
4082 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4084 /* Mark the timer as triggered to prevent problems if the lisp
4085 code fails to reschedule it right. */
4088 specbind (Qinhibit_quit
, Qt
);
4090 call1 (Qtimer_event_handler
, chosen_timer
);
4091 Vdeactivate_mark
= old_deactivate_mark
;
4093 unbind_to (count
, Qnil
);
4095 /* Resume allowing input from any kboard, if that was true before. */
4097 any_kboard_state ();
4099 /* Since we have handled the event,
4100 we don't need to tell the caller to wake up and do it. */
4104 /* When we encounter a timer that is still waiting,
4105 return the amount of time to wait before it is ripe. */
4112 /* No timers are pending in the future. */
4113 /* Return 0 if we generated an event, and -1 if not. */
4118 /* Caches for modify_event_symbol. */
4119 static Lisp_Object accent_key_syms
;
4120 static Lisp_Object func_key_syms
;
4121 static Lisp_Object mouse_syms
;
4123 static Lisp_Object mouse_wheel_syms
;
4125 static Lisp_Object drag_n_drop_syms
;
4127 /* This is a list of keysym codes for special "accent" characters.
4128 It parallels lispy_accent_keys. */
4130 static int lispy_accent_codes
[] =
4132 #ifdef XK_dead_circumflex
4137 #ifdef XK_dead_grave
4142 #ifdef XK_dead_tilde
4147 #ifdef XK_dead_diaeresis
4152 #ifdef XK_dead_macron
4157 #ifdef XK_dead_degree
4162 #ifdef XK_dead_acute
4167 #ifdef XK_dead_cedilla
4172 #ifdef XK_dead_breve
4177 #ifdef XK_dead_ogonek
4182 #ifdef XK_dead_caron
4187 #ifdef XK_dead_doubleacute
4188 XK_dead_doubleacute
,
4192 #ifdef XK_dead_abovedot
4199 /* This is a list of Lisp names for special "accent" characters.
4200 It parallels lispy_accent_codes. */
4202 static char *lispy_accent_keys
[] =
4220 #define FUNCTION_KEY_OFFSET 0x0
4222 char *lispy_function_keys
[] =
4226 0, /* VK_LBUTTON 0x01 */
4227 0, /* VK_RBUTTON 0x02 */
4228 "cancel", /* VK_CANCEL 0x03 */
4229 0, /* VK_MBUTTON 0x04 */
4231 0, 0, 0, /* 0x05 .. 0x07 */
4233 "backspace", /* VK_BACK 0x08 */
4234 "tab", /* VK_TAB 0x09 */
4236 0, 0, /* 0x0A .. 0x0B */
4238 "clear", /* VK_CLEAR 0x0C */
4239 "return", /* VK_RETURN 0x0D */
4241 0, 0, /* 0x0E .. 0x0F */
4243 0, /* VK_SHIFT 0x10 */
4244 0, /* VK_CONTROL 0x11 */
4245 0, /* VK_MENU 0x12 */
4246 "pause", /* VK_PAUSE 0x13 */
4247 "capslock", /* VK_CAPITAL 0x14 */
4249 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4251 "escape", /* VK_ESCAPE 0x1B */
4253 0, 0, 0, 0, /* 0x1C .. 0x1F */
4255 0, /* VK_SPACE 0x20 */
4256 "prior", /* VK_PRIOR 0x21 */
4257 "next", /* VK_NEXT 0x22 */
4258 "end", /* VK_END 0x23 */
4259 "home", /* VK_HOME 0x24 */
4260 "left", /* VK_LEFT 0x25 */
4261 "up", /* VK_UP 0x26 */
4262 "right", /* VK_RIGHT 0x27 */
4263 "down", /* VK_DOWN 0x28 */
4264 "select", /* VK_SELECT 0x29 */
4265 "print", /* VK_PRINT 0x2A */
4266 "execute", /* VK_EXECUTE 0x2B */
4267 "snapshot", /* VK_SNAPSHOT 0x2C */
4268 "insert", /* VK_INSERT 0x2D */
4269 "delete", /* VK_DELETE 0x2E */
4270 "help", /* VK_HELP 0x2F */
4272 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4274 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4276 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4278 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4280 0, 0, 0, 0, 0, 0, 0, 0, 0,
4281 0, 0, 0, 0, 0, 0, 0, 0, 0,
4282 0, 0, 0, 0, 0, 0, 0, 0,
4284 "lwindow", /* VK_LWIN 0x5B */
4285 "rwindow", /* VK_RWIN 0x5C */
4286 "apps", /* VK_APPS 0x5D */
4288 0, 0, /* 0x5E .. 0x5F */
4290 "kp-0", /* VK_NUMPAD0 0x60 */
4291 "kp-1", /* VK_NUMPAD1 0x61 */
4292 "kp-2", /* VK_NUMPAD2 0x62 */
4293 "kp-3", /* VK_NUMPAD3 0x63 */
4294 "kp-4", /* VK_NUMPAD4 0x64 */
4295 "kp-5", /* VK_NUMPAD5 0x65 */
4296 "kp-6", /* VK_NUMPAD6 0x66 */
4297 "kp-7", /* VK_NUMPAD7 0x67 */
4298 "kp-8", /* VK_NUMPAD8 0x68 */
4299 "kp-9", /* VK_NUMPAD9 0x69 */
4300 "kp-multiply", /* VK_MULTIPLY 0x6A */
4301 "kp-add", /* VK_ADD 0x6B */
4302 "kp-separator", /* VK_SEPARATOR 0x6C */
4303 "kp-subtract", /* VK_SUBTRACT 0x6D */
4304 "kp-decimal", /* VK_DECIMAL 0x6E */
4305 "kp-divide", /* VK_DIVIDE 0x6F */
4306 "f1", /* VK_F1 0x70 */
4307 "f2", /* VK_F2 0x71 */
4308 "f3", /* VK_F3 0x72 */
4309 "f4", /* VK_F4 0x73 */
4310 "f5", /* VK_F5 0x74 */
4311 "f6", /* VK_F6 0x75 */
4312 "f7", /* VK_F7 0x76 */
4313 "f8", /* VK_F8 0x77 */
4314 "f9", /* VK_F9 0x78 */
4315 "f10", /* VK_F10 0x79 */
4316 "f11", /* VK_F11 0x7A */
4317 "f12", /* VK_F12 0x7B */
4318 "f13", /* VK_F13 0x7C */
4319 "f14", /* VK_F14 0x7D */
4320 "f15", /* VK_F15 0x7E */
4321 "f16", /* VK_F16 0x7F */
4322 "f17", /* VK_F17 0x80 */
4323 "f18", /* VK_F18 0x81 */
4324 "f19", /* VK_F19 0x82 */
4325 "f20", /* VK_F20 0x83 */
4326 "f21", /* VK_F21 0x84 */
4327 "f22", /* VK_F22 0x85 */
4328 "f23", /* VK_F23 0x86 */
4329 "f24", /* VK_F24 0x87 */
4331 0, 0, 0, 0, /* 0x88 .. 0x8B */
4332 0, 0, 0, 0, /* 0x8C .. 0x8F */
4334 "kp-numlock", /* VK_NUMLOCK 0x90 */
4335 "scroll", /* VK_SCROLL 0x91 */
4337 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4338 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4339 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4340 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4341 "kp-end", /* VK_NUMPAD_END 0x96 */
4342 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4343 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4344 "kp-up", /* VK_NUMPAD_UP 0x99 */
4345 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4346 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4347 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4348 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4350 0, 0, /* 0x9E .. 0x9F */
4353 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4354 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4355 * No other API or message will distinguish left and right keys this way.
4359 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4360 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4361 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4362 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4363 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4369 "attn", /* VK_ATTN 0xF6 */
4370 "crsel", /* VK_CRSEL 0xF7 */
4371 "exsel", /* VK_EXSEL 0xF8 */
4372 "ereof", /* VK_EREOF 0xF9 */
4373 "play", /* VK_PLAY 0xFA */
4374 "zoom", /* VK_ZOOM 0xFB */
4375 "noname", /* VK_NONAME 0xFC */
4376 "pa1", /* VK_PA1 0xFD */
4377 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4381 #else /* not HAVE_NTGUI */
4384 static char *lispy_kana_keys
[] =
4386 /* X Keysym value */
4387 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4388 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4389 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4390 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4391 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4392 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4393 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4394 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4395 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4396 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4397 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4398 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4399 "kana-i", "kana-u", "kana-e", "kana-o",
4400 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4401 "prolongedsound", "kana-A", "kana-I", "kana-U",
4402 "kana-E", "kana-O", "kana-KA", "kana-KI",
4403 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4404 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4405 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4406 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4407 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4408 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4409 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4410 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4411 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4412 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4413 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4414 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4416 #endif /* XK_kana_A */
4418 #define FUNCTION_KEY_OFFSET 0xff00
4420 /* You'll notice that this table is arranged to be conveniently
4421 indexed by X Windows keysym values. */
4422 static char *lispy_function_keys
[] =
4424 /* X Keysym value */
4426 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4427 "backspace", "tab", "linefeed", "clear",
4429 0, 0, 0, "pause", /* 0xff10...1f */
4430 0, 0, 0, 0, 0, 0, 0, "escape",
4432 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4433 "romaji", "hiragana", "katakana", "hiragana-katakana",
4434 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4435 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4436 "eisu-toggle", /* 0xff30...3f */
4437 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4438 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4440 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4441 "down", "prior", "next", "end",
4442 "begin", 0, 0, 0, 0, 0, 0, 0,
4443 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4454 "break", /* 0xff6b */
4457 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4458 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4459 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4460 0, 0, 0, 0, 0, 0, 0, 0,
4461 "kp-tab", /* 0xff89 */
4463 "kp-enter", /* 0xff8d */
4465 "kp-f1", /* 0xff91 */
4469 "kp-home", /* 0xff95 */
4474 "kp-prior", /* kp-page-up */
4475 "kp-next", /* kp-page-down */
4481 0, 0, 0, 0, 0, 0, 0, 0, 0,
4482 "kp-multiply", /* 0xffaa */
4487 "kp-divide", /* 0xffaf */
4488 "kp-0", /* 0xffb0 */
4489 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4492 "kp-equal", /* 0xffbd */
4493 "f1", /* 0xffbe */ /* IsFunctionKey */
4495 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4496 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4497 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4498 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4499 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4500 0, 0, 0, 0, 0, 0, 0, 0,
4501 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4502 0, 0, 0, 0, 0, 0, 0, "delete"
4505 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4506 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4508 static char *iso_lispy_function_keys
[] =
4510 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4511 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4512 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4513 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4514 "iso-lefttab", /* 0xfe20 */
4515 "iso-move-line-up", "iso-move-line-down",
4516 "iso-partial-line-up", "iso-partial-line-down",
4517 "iso-partial-space-left", "iso-partial-space-right",
4518 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4519 "iso-release-margin-left", "iso-release-margin-right",
4520 "iso-release-both-margins",
4521 "iso-fast-cursor-left", "iso-fast-cursor-right",
4522 "iso-fast-cursor-up", "iso-fast-cursor-down",
4523 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4524 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4527 #endif /* not HAVE_NTGUI */
4529 Lisp_Object Vlispy_mouse_stem
;
4532 /* mouse-wheel events are generated by the wheel on devices such as
4533 the MS Intellimouse. The wheel sits in between the left and right
4534 mouse buttons, and is typically used to scroll or zoom the window
4535 underneath the pointer. mouse-wheel events specify the object on
4536 which they operate, and a delta corresponding to the amount and
4537 direction that the wheel is rotated. Clicking the mouse-wheel
4538 generates a mouse-2 event. */
4539 static char *lispy_mouse_wheel_names
[] =
4544 #endif /* WINDOWSNT */
4546 /* drag-n-drop events are generated when a set of selected files are
4547 dragged from another application and dropped onto an Emacs window. */
4548 static char *lispy_drag_n_drop_names
[] =
4553 /* Scroll bar parts. */
4554 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4555 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4556 Lisp_Object Qtop
, Qratio
;
4558 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4559 Lisp_Object
*scroll_bar_parts
[] = {
4560 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4561 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4564 /* User signal events. */
4565 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4567 Lisp_Object
*lispy_user_signals
[] =
4569 &Qusr1_signal
, &Qusr2_signal
4573 /* A vector, indexed by button number, giving the down-going location
4574 of currently depressed buttons, both scroll bar and non-scroll bar.
4576 The elements have the form
4577 (BUTTON-NUMBER MODIFIER-MASK . REST)
4578 where REST is the cdr of a position as it would be reported in the event.
4580 The make_lispy_event function stores positions here to tell the
4581 difference between click and drag events, and to store the starting
4582 location to be included in drag events. */
4584 static Lisp_Object button_down_location
;
4586 /* Information about the most recent up-going button event: Which
4587 button, what location, and what time. */
4589 static int last_mouse_button
;
4590 static int last_mouse_x
;
4591 static int last_mouse_y
;
4592 static unsigned long button_down_time
;
4594 /* The maximum time between clicks to make a double-click, or Qnil to
4595 disable double-click detection, or Qt for no time limit. */
4597 Lisp_Object Vdouble_click_time
;
4599 /* Maximum number of pixels the mouse may be moved between clicks
4600 to make a double-click. */
4602 int double_click_fuzz
;
4604 /* The number of clicks in this multiple-click. */
4606 int double_click_count
;
4608 /* Given a struct input_event, build the lisp event which represents
4609 it. If EVENT is 0, build a mouse movement event from the mouse
4610 movement buffer, which should have a movement event in it.
4612 Note that events must be passed to this function in the order they
4613 are received; this function stores the location of button presses
4614 in order to build drag events when the button is released. */
4617 make_lispy_event (event
)
4618 struct input_event
*event
;
4622 switch (SWITCH_ENUM_CAST (event
->kind
))
4624 /* A simple keystroke. */
4625 case ascii_keystroke
:
4627 Lisp_Object lispy_c
;
4628 int c
= event
->code
& 0377;
4629 /* Turn ASCII characters into control characters
4631 if (event
->modifiers
& ctrl_modifier
)
4632 c
= make_ctrl_char (c
);
4634 /* Add in the other modifier bits. We took care of ctrl_modifier
4635 just above, and the shift key was taken care of by the X code,
4636 and applied to control characters by make_ctrl_char. */
4637 c
|= (event
->modifiers
4638 & (meta_modifier
| alt_modifier
4639 | hyper_modifier
| super_modifier
));
4640 /* Distinguish Shift-SPC from SPC. */
4641 if ((event
->code
& 0377) == 040
4642 && event
->modifiers
& shift_modifier
)
4643 c
|= shift_modifier
;
4644 button_down_time
= 0;
4645 XSETFASTINT (lispy_c
, c
);
4649 case multibyte_char_keystroke
:
4651 Lisp_Object lispy_c
;
4653 XSETFASTINT (lispy_c
, event
->code
);
4657 /* A function key. The symbol may need to have modifier prefixes
4659 case non_ascii_keystroke
:
4660 button_down_time
= 0;
4662 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4663 if (event
->code
== lispy_accent_codes
[i
])
4664 return modify_event_symbol (i
,
4666 Qfunction_key
, Qnil
,
4667 lispy_accent_keys
, &accent_key_syms
,
4668 (sizeof (lispy_accent_keys
)
4669 / sizeof (lispy_accent_keys
[0])));
4671 /* Handle system-specific keysyms. */
4672 if (event
->code
& (1 << 28))
4674 /* We need to use an alist rather than a vector as the cache
4675 since we can't make a vector long enuf. */
4676 if (NILP (current_kboard
->system_key_syms
))
4677 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4678 return modify_event_symbol (event
->code
,
4681 current_kboard
->Vsystem_key_alist
,
4682 0, ¤t_kboard
->system_key_syms
,
4687 if (event
->code
>= 0x400 && event
->code
< 0x500)
4688 return modify_event_symbol (event
->code
- 0x400,
4689 event
->modifiers
& ~shift_modifier
,
4690 Qfunction_key
, Qnil
,
4691 lispy_kana_keys
, &func_key_syms
,
4692 (sizeof (lispy_kana_keys
)
4693 / sizeof (lispy_kana_keys
[0])));
4694 #endif /* XK_kana_A */
4696 #ifdef ISO_FUNCTION_KEY_OFFSET
4697 if (event
->code
< FUNCTION_KEY_OFFSET
4698 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4699 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4701 Qfunction_key
, Qnil
,
4702 iso_lispy_function_keys
, &func_key_syms
,
4703 (sizeof (iso_lispy_function_keys
)
4704 / sizeof (iso_lispy_function_keys
[0])));
4708 #ifdef HAVE_X_WINDOWS
4709 if (event
->code
- FUNCTION_KEY_OFFSET
< 0
4710 || (event
->code
- FUNCTION_KEY_OFFSET
4711 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
))
4713 /* EVENT->code is an unknown keysym, for example someone
4714 assigned `ccaron' to a key in a locale where
4715 XmbLookupString doesn't return a translation for it. */
4720 /* This returns a pointer to a static area. Don't free it. */
4721 name
= XKeysymToString (event
->code
);
4722 symbol
= name
? intern (name
) : Qnil
;
4726 return apply_modifiers (event
->modifiers
, symbol
);
4728 #endif /* HAVE_X_WINDOWS */
4730 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4732 Qfunction_key
, Qnil
,
4733 lispy_function_keys
, &func_key_syms
,
4734 (sizeof (lispy_function_keys
)
4735 / sizeof (lispy_function_keys
[0])));
4738 /* A mouse click. Figure out where it is, decide whether it's
4739 a press, click or drag, and build the appropriate structure. */
4741 #ifndef USE_TOOLKIT_SCROLL_BARS
4742 case scroll_bar_click
:
4745 int button
= event
->code
;
4747 Lisp_Object position
;
4748 Lisp_Object
*start_pos_ptr
;
4749 Lisp_Object start_pos
;
4754 /* Build the position as appropriate for this mouse click. */
4755 if (event
->kind
== mouse_click
)
4758 struct frame
*f
= XFRAME (event
->frame_or_window
);
4760 Lisp_Object string_info
= Qnil
;
4763 /* Ignore mouse events that were made on frame that
4764 have been deleted. */
4765 if (! FRAME_LIVE_P (f
))
4768 /* EVENT->x and EVENT->y are frame-relative pixel
4769 coordinates at this place. Under old redisplay, COLUMN
4770 and ROW are set to frame relative glyph coordinates
4771 which are then used to determine whether this click is
4772 in a menu (non-toolkit version). */
4773 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4774 &column
, &row
, NULL
, 1);
4776 #ifndef USE_X_TOOLKIT
4777 /* In the non-toolkit version, clicks on the menu bar
4778 are ordinary button events in the event buffer.
4779 Distinguish them, and invoke the menu.
4781 (In the toolkit version, the toolkit handles the menu bar
4782 and Emacs doesn't know about it until after the user
4783 makes a selection.) */
4784 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4785 && (event
->modifiers
& down_modifier
))
4787 Lisp_Object items
, item
;
4792 /* Activate the menu bar on the down event. If the
4793 up event comes in before the menu code can deal with it,
4795 if (! (event
->modifiers
& down_modifier
))
4799 /* Find the menu bar item under `column'. */
4801 items
= FRAME_MENU_BAR_ITEMS (f
);
4802 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4804 Lisp_Object pos
, string
;
4805 string
= AREF (items
, i
+ 1);
4806 pos
= AREF (items
, i
+ 3);
4809 if (column
>= XINT (pos
)
4810 && column
< XINT (pos
) + XSTRING (string
)->size
)
4812 item
= AREF (items
, i
);
4817 /* ELisp manual 2.4b says (x y) are window relative but
4818 code says they are frame-relative. */
4820 = Fcons (event
->frame_or_window
,
4822 Fcons (Fcons (event
->x
, event
->y
),
4823 Fcons (make_number (event
->timestamp
),
4826 return Fcons (item
, Fcons (position
, Qnil
));
4828 #endif /* not USE_X_TOOLKIT */
4830 /* Set `window' to the window under frame pixel coordinates
4831 event->x/event->y. */
4832 window
= window_from_coordinates (f
, XINT (event
->x
),
4833 XINT (event
->y
), &part
, 0);
4835 if (!WINDOWP (window
))
4837 window
= event
->frame_or_window
;
4842 /* It's a click in window window at frame coordinates
4843 event->x/ event->y. */
4844 struct window
*w
= XWINDOW (window
);
4846 /* Get window relative coordinates. Original code
4847 `rounded' this to glyph boundaries. */
4848 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4849 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4851 /* Set event coordinates to window-relative coordinates
4852 for constructing the Lisp event below. */
4853 XSETINT (event
->x
, wx
);
4854 XSETINT (event
->y
, wy
);
4856 if (part
== 1 || part
== 3)
4858 /* Mode line or header line. Look for a string under
4859 the mouse that may have a `local-map' property. */
4863 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
4864 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
4865 if (STRINGP (string
))
4866 string_info
= Fcons (string
, make_number (charpos
));
4869 posn
= Qvertical_line
;
4873 struct display_pos p
;
4874 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
4875 posn
= make_number (CHARPOS (p
.pos
));
4876 if (STRINGP (object
))
4879 make_number (CHARPOS (p
.string_pos
)));
4886 Fcons (Fcons (event
->x
, event
->y
),
4887 Fcons (make_number (event
->timestamp
),
4890 : Fcons (string_info
, Qnil
))))));
4892 #ifndef USE_TOOLKIT_SCROLL_BARS
4895 /* It's a scrollbar click. */
4896 Lisp_Object portion_whole
;
4899 window
= event
->frame_or_window
;
4900 portion_whole
= Fcons (event
->x
, event
->y
);
4901 part
= *scroll_bar_parts
[(int) event
->part
];
4905 Fcons (Qvertical_scroll_bar
,
4906 Fcons (portion_whole
,
4907 Fcons (make_number (event
->timestamp
),
4908 Fcons (part
, Qnil
)))));
4910 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4912 if (button
>= ASIZE (button_down_location
))
4914 button_down_location
= larger_vector (button_down_location
,
4916 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
4919 start_pos_ptr
= &AREF (button_down_location
, button
);
4920 start_pos
= *start_pos_ptr
;
4921 *start_pos_ptr
= Qnil
;
4924 /* On window-system frames, use the value of
4925 double-click-fuzz as is. On other frames, interpret it
4926 as a multiple of 1/8 characters. */
4930 if (WINDOWP (event
->frame_or_window
))
4931 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
4932 else if (FRAMEP (event
->frame_or_window
))
4933 f
= XFRAME (event
->frame_or_window
);
4937 if (FRAME_WINDOW_P (f
))
4938 fuzz
= double_click_fuzz
;
4940 fuzz
= double_click_fuzz
/ 8;
4942 is_double
= (button
== last_mouse_button
4943 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
4944 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
4945 && button_down_time
!= 0
4946 && (EQ (Vdouble_click_time
, Qt
)
4947 || (INTEGERP (Vdouble_click_time
)
4948 && ((int)(event
->timestamp
- button_down_time
)
4949 < XINT (Vdouble_click_time
)))));
4952 last_mouse_button
= button
;
4953 last_mouse_x
= XINT (event
->x
);
4954 last_mouse_y
= XINT (event
->y
);
4956 /* If this is a button press, squirrel away the location, so
4957 we can decide later whether it was a click or a drag. */
4958 if (event
->modifiers
& down_modifier
)
4962 double_click_count
++;
4963 event
->modifiers
|= ((double_click_count
> 2)
4968 double_click_count
= 1;
4969 button_down_time
= event
->timestamp
;
4970 *start_pos_ptr
= Fcopy_alist (position
);
4973 /* Now we're releasing a button - check the co-ordinates to
4974 see if this was a click or a drag. */
4975 else if (event
->modifiers
& up_modifier
)
4977 /* If we did not see a down before this up, ignore the up.
4978 Probably this happened because the down event chose a
4979 menu item. It would be an annoyance to treat the
4980 release of the button that chose the menu item as a
4983 if (!CONSP (start_pos
))
4986 event
->modifiers
&= ~up_modifier
;
4987 #if 0 /* Formerly we treated an up with no down as a click event. */
4988 if (!CONSP (start_pos
))
4989 event
->modifiers
|= click_modifier
;
4994 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
4996 /* The third element of every position
4997 should be the (x,y) pair. */
4998 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5000 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5002 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5003 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5006 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5007 && ydiff
< double_click_fuzz
5008 && ydiff
> - double_click_fuzz
)
5009 /* Mouse hasn't moved (much). */
5010 event
->modifiers
|= click_modifier
;
5013 button_down_time
= 0;
5014 event
->modifiers
|= drag_modifier
;
5017 /* Don't check is_double; treat this as multiple
5018 if the down-event was multiple. */
5019 if (double_click_count
> 1)
5020 event
->modifiers
|= ((double_click_count
> 2)
5026 /* Every mouse event should either have the down_modifier or
5027 the up_modifier set. */
5031 /* Get the symbol we should use for the mouse click. */
5034 head
= modify_event_symbol (button
,
5036 Qmouse_click
, Vlispy_mouse_stem
,
5039 XVECTOR (mouse_syms
)->size
);
5040 if (event
->modifiers
& drag_modifier
)
5045 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5048 Fcons (make_number (double_click_count
),
5057 #if USE_TOOLKIT_SCROLL_BARS
5059 /* We don't have down and up events if using toolkit scroll bars,
5060 so make this always a click event. Store in the `part' of
5061 the Lisp event a symbol which maps to the following actions:
5063 `above_handle' page up
5064 `below_handle' page down
5068 `bottom' bottom of buffer
5069 `handle' thumb has been dragged.
5070 `end-scroll' end of interaction with scroll bar
5072 The incoming input_event contains in its `part' member an
5073 index of type `enum scroll_bar_part' which we can use as an
5074 index in scroll_bar_parts to get the appropriate symbol. */
5076 case scroll_bar_click
:
5078 Lisp_Object position
, head
, window
, portion_whole
, part
;
5080 window
= event
->frame_or_window
;
5081 portion_whole
= Fcons (event
->x
, event
->y
);
5082 part
= *scroll_bar_parts
[(int) event
->part
];
5086 Fcons (Qvertical_scroll_bar
,
5087 Fcons (portion_whole
,
5088 Fcons (make_number (event
->timestamp
),
5089 Fcons (part
, Qnil
)))));
5091 /* Always treat scroll bar events as clicks. */
5092 event
->modifiers
|= click_modifier
;
5094 /* Get the symbol we should use for the mouse click. */
5095 head
= modify_event_symbol (event
->code
,
5100 XVECTOR (mouse_syms
)->size
);
5101 return Fcons (head
, Fcons (position
, Qnil
));
5104 #endif /* USE_TOOLKIT_SCROLL_BARS */
5107 case w32_scroll_bar_click
:
5109 int button
= event
->code
;
5111 Lisp_Object position
;
5112 Lisp_Object
*start_pos_ptr
;
5113 Lisp_Object start_pos
;
5117 Lisp_Object portion_whole
;
5120 window
= event
->frame_or_window
;
5121 portion_whole
= Fcons (event
->x
, event
->y
);
5122 part
= *scroll_bar_parts
[(int) event
->part
];
5126 Fcons (Qvertical_scroll_bar
,
5127 Fcons (portion_whole
,
5128 Fcons (make_number (event
->timestamp
),
5129 Fcons (part
, Qnil
)))));
5132 /* Always treat W32 scroll bar events as clicks. */
5133 event
->modifiers
|= click_modifier
;
5136 /* Get the symbol we should use for the mouse click. */
5139 head
= modify_event_symbol (button
,
5144 XVECTOR (mouse_syms
)->size
);
5153 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5156 Lisp_Object head
, position
;
5159 /* Ignore mouse events that were made on frame that
5160 have been deleted. */
5161 if (! FRAME_LIVE_P (f
))
5163 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5164 &column
, &row
, NULL
, 1);
5165 window
= window_from_coordinates (f
, XINT (event
->x
),
5166 XINT (event
->y
), &part
, 0);
5168 if (!WINDOWP (window
))
5170 window
= event
->frame_or_window
;
5175 int pixcolumn
, pixrow
;
5176 column
-= XINT (XWINDOW (window
)->left
);
5177 row
-= XINT (XWINDOW (window
)->top
);
5178 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5179 &pixcolumn
, &pixrow
);
5180 XSETINT (event
->x
, pixcolumn
);
5181 XSETINT (event
->y
, pixrow
);
5186 posn
= Qvertical_line
;
5188 posn
= Qheader_line
;
5192 struct display_pos p
;
5193 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5195 posn
= make_number (CHARPOS (p
.pos
));
5200 Lisp_Object head
, position
;
5205 Fcons (Fcons (event
->x
, event
->y
),
5206 Fcons (make_number (event
->timestamp
),
5209 head
= modify_event_symbol (0, event
->modifiers
,
5211 lispy_mouse_wheel_names
,
5212 &mouse_wheel_syms
, 1);
5215 Fcons (make_number (event
->code
),
5219 #endif /* WINDOWSNT */
5229 /* The frame_or_window field should be a cons of the frame in
5230 which the event occurred and a list of the filenames
5232 if (! CONSP (event
->frame_or_window
))
5235 f
= XFRAME (XCAR (event
->frame_or_window
));
5236 files
= XCDR (event
->frame_or_window
);
5238 /* Ignore mouse events that were made on frames that
5239 have been deleted. */
5240 if (! FRAME_LIVE_P (f
))
5243 window
= window_from_coordinates (f
, XINT (event
->x
),
5244 XINT (event
->y
), &part
, 0);
5246 if (!WINDOWP (window
))
5248 window
= XCAR (event
->frame_or_window
);
5253 /* It's an event in window `window' at frame coordinates
5254 event->x/ event->y. */
5255 struct window
*w
= XWINDOW (window
);
5257 /* Get window relative coordinates. */
5258 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5259 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5261 /* Set event coordinates to window-relative coordinates
5262 for constructing the Lisp event below. */
5263 XSETINT (event
->x
, wx
);
5264 XSETINT (event
->y
, wy
);
5269 posn
= Qvertical_line
;
5271 posn
= Qheader_line
;
5275 struct display_pos p
;
5276 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5277 posn
= make_number (CHARPOS (p
.pos
));
5282 Lisp_Object head
, position
;
5287 Fcons (Fcons (event
->x
, event
->y
),
5288 Fcons (make_number (event
->timestamp
),
5291 head
= modify_event_symbol (0, event
->modifiers
,
5293 lispy_drag_n_drop_names
,
5294 &drag_n_drop_syms
, 1);
5301 #endif /* HAVE_MOUSE */
5303 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
5304 case MENU_BAR_EVENT
:
5305 if (EQ (event
->arg
, event
->frame_or_window
))
5306 /* This is the prefix key. We translate this to
5307 `(menu_bar)' because the code in keyboard.c for menu
5308 events, which we use, relies on this. */
5309 return Fcons (Qmenu_bar
, Qnil
);
5313 case TOOL_BAR_EVENT
:
5314 if (EQ (event
->arg
, event
->frame_or_window
))
5315 /* This is the prefix key. We translate this to
5316 `(tool_bar)' because the code in keyboard.c for menu
5317 events, which we use, relies on this. */
5318 return Fcons (Qtool_bar
, Qnil
);
5319 else if (SYMBOLP (event
->arg
))
5320 return apply_modifiers (event
->modifiers
, event
->arg
);
5323 case USER_SIGNAL_EVENT
:
5324 /* A user signal. */
5325 return *lispy_user_signals
[event
->code
];
5327 /* The 'kind' field of the event is something we don't recognize. */
5336 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5338 Lisp_Object bar_window
;
5339 enum scroll_bar_part part
;
5343 /* Is it a scroll bar movement? */
5344 if (frame
&& ! NILP (bar_window
))
5346 Lisp_Object part_sym
;
5348 part_sym
= *scroll_bar_parts
[(int) part
];
5349 return Fcons (Qscroll_bar_movement
,
5350 (Fcons (Fcons (bar_window
,
5351 Fcons (Qvertical_scroll_bar
,
5352 Fcons (Fcons (x
, y
),
5353 Fcons (make_number (time
),
5359 /* Or is it an ordinary mouse movement? */
5367 /* It's in a frame; which window on that frame? */
5368 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5372 if (WINDOWP (window
))
5374 struct window
*w
= XWINDOW (window
);
5377 /* Get window relative coordinates. */
5378 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5379 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5386 posn
= Qvertical_line
;
5388 posn
= Qheader_line
;
5392 struct display_pos p
;
5393 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5394 posn
= make_number (CHARPOS (p
.pos
));
5397 else if (frame
!= 0)
5399 XSETFRAME (window
, frame
);
5410 return Fcons (Qmouse_movement
,
5411 Fcons (Fcons (window
,
5413 Fcons (Fcons (x
, y
),
5414 Fcons (make_number (time
),
5420 #endif /* HAVE_MOUSE */
5422 /* Construct a switch frame event. */
5424 make_lispy_switch_frame (frame
)
5427 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5430 /* Manipulating modifiers. */
5432 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5434 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5435 SYMBOL's name of the end of the modifiers; the string from this
5436 position is the unmodified symbol name.
5438 This doesn't use any caches. */
5441 parse_modifiers_uncached (symbol
, modifier_end
)
5445 struct Lisp_String
*name
;
5449 CHECK_SYMBOL (symbol
);
5452 name
= XSYMBOL (symbol
)->name
;
5454 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
5456 int this_mod_end
= 0;
5459 /* See if the name continues with a modifier word.
5460 Check that the word appears, but don't check what follows it.
5461 Set this_mod and this_mod_end to record what we find. */
5463 switch (name
->data
[i
])
5465 #define SINGLE_LETTER_MOD(BIT) \
5466 (this_mod_end = i + 1, this_mod = BIT)
5469 SINGLE_LETTER_MOD (alt_modifier
);
5473 SINGLE_LETTER_MOD (ctrl_modifier
);
5477 SINGLE_LETTER_MOD (hyper_modifier
);
5481 SINGLE_LETTER_MOD (meta_modifier
);
5485 SINGLE_LETTER_MOD (shift_modifier
);
5489 SINGLE_LETTER_MOD (super_modifier
);
5492 #undef SINGLE_LETTER_MOD
5495 /* If we found no modifier, stop looking for them. */
5496 if (this_mod_end
== 0)
5499 /* Check there is a dash after the modifier, so that it
5500 really is a modifier. */
5501 if (this_mod_end
>= STRING_BYTES (name
)
5502 || name
->data
[this_mod_end
] != '-')
5505 /* This modifier is real; look for another. */
5506 modifiers
|= this_mod
;
5507 i
= this_mod_end
+ 1;
5510 /* Should we include the `click' modifier? */
5511 if (! (modifiers
& (down_modifier
| drag_modifier
5512 | double_modifier
| triple_modifier
))
5513 && i
+ 7 == STRING_BYTES (name
)
5514 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
5515 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
5516 modifiers
|= click_modifier
;
5524 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5525 prepended to the string BASE[0..BASE_LEN-1].
5526 This doesn't use any caches. */
5528 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5531 int base_len
, base_len_byte
;
5533 /* Since BASE could contain nulls, we can't use intern here; we have
5534 to use Fintern, which expects a genuine Lisp_String, and keeps a
5537 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5543 /* Only the event queue may use the `up' modifier; it should always
5544 be turned into a click or drag event before presented to lisp code. */
5545 if (modifiers
& up_modifier
)
5548 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5549 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5550 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5551 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5552 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5553 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5554 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5555 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5556 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5557 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5558 /* The click modifier is denoted by the absence of other modifiers. */
5562 mod_len
= p
- new_mods
;
5566 Lisp_Object new_name
;
5568 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5569 mod_len
+ base_len_byte
);
5570 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
5571 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
5573 return Fintern (new_name
, Qnil
);
5578 static char *modifier_names
[] =
5580 "up", "down", "drag", "click", "double", "triple", 0, 0,
5581 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5582 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5584 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5586 static Lisp_Object modifier_symbols
;
5588 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5590 lispy_modifier_list (modifiers
)
5593 Lisp_Object modifier_list
;
5596 modifier_list
= Qnil
;
5597 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5598 if (modifiers
& (1<<i
))
5599 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5602 return modifier_list
;
5606 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5607 where UNMODIFIED is the unmodified form of SYMBOL,
5608 MASK is the set of modifiers present in SYMBOL's name.
5609 This is similar to parse_modifiers_uncached, but uses the cache in
5610 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5611 Qevent_symbol_elements property. */
5614 parse_modifiers (symbol
)
5617 Lisp_Object elements
;
5619 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5620 if (CONSP (elements
))
5625 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5626 Lisp_Object unmodified
;
5629 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
5630 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
5633 if (modifiers
& ~VALMASK
)
5635 XSETFASTINT (mask
, modifiers
);
5636 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5638 /* Cache the parsing results on SYMBOL. */
5639 Fput (symbol
, Qevent_symbol_element_mask
,
5641 Fput (symbol
, Qevent_symbol_elements
,
5642 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5644 /* Since we know that SYMBOL is modifiers applied to unmodified,
5645 it would be nice to put that in unmodified's cache.
5646 But we can't, since we're not sure that parse_modifiers is
5653 /* Apply the modifiers MODIFIERS to the symbol BASE.
5654 BASE must be unmodified.
5656 This is like apply_modifiers_uncached, but uses BASE's
5657 Qmodifier_cache property, if present. It also builds
5658 Qevent_symbol_elements properties, since it has that info anyway.
5660 apply_modifiers copies the value of BASE's Qevent_kind property to
5661 the modified symbol. */
5663 apply_modifiers (modifiers
, base
)
5667 Lisp_Object cache
, index
, entry
, new_symbol
;
5669 /* Mask out upper bits. We don't know where this value's been. */
5670 modifiers
&= VALMASK
;
5672 /* The click modifier never figures into cache indices. */
5673 cache
= Fget (base
, Qmodifier_cache
);
5674 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5675 entry
= assq_no_quit (index
, cache
);
5678 new_symbol
= XCDR (entry
);
5681 /* We have to create the symbol ourselves. */
5682 new_symbol
= apply_modifiers_uncached (modifiers
,
5683 XSYMBOL (base
)->name
->data
,
5684 XSYMBOL (base
)->name
->size
,
5685 STRING_BYTES (XSYMBOL (base
)->name
));
5687 /* Add the new symbol to the base's cache. */
5688 entry
= Fcons (index
, new_symbol
);
5689 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5691 /* We have the parsing info now for free, so add it to the caches. */
5692 XSETFASTINT (index
, modifiers
);
5693 Fput (new_symbol
, Qevent_symbol_element_mask
,
5694 Fcons (base
, Fcons (index
, Qnil
)));
5695 Fput (new_symbol
, Qevent_symbol_elements
,
5696 Fcons (base
, lispy_modifier_list (modifiers
)));
5699 /* Make sure this symbol is of the same kind as BASE.
5701 You'd think we could just set this once and for all when we
5702 intern the symbol above, but reorder_modifiers may call us when
5703 BASE's property isn't set right; we can't assume that just
5704 because it has a Qmodifier_cache property it must have its
5705 Qevent_kind set right as well. */
5706 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5710 kind
= Fget (base
, Qevent_kind
);
5712 Fput (new_symbol
, Qevent_kind
, kind
);
5719 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5720 return a symbol with the modifiers placed in the canonical order.
5721 Canonical order is alphabetical, except for down and drag, which
5722 always come last. The 'click' modifier is never written out.
5724 Fdefine_key calls this to make sure that (for example) C-M-foo
5725 and M-C-foo end up being equivalent in the keymap. */
5728 reorder_modifiers (symbol
)
5731 /* It's hopefully okay to write the code this way, since everything
5732 will soon be in caches, and no consing will be done at all. */
5735 parsed
= parse_modifiers (symbol
);
5736 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5741 /* For handling events, we often want to produce a symbol whose name
5742 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5743 to some base, like the name of a function key or mouse button.
5744 modify_event_symbol produces symbols of this sort.
5746 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5747 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5750 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5751 into symbol names, or a string specifying a name stem used to
5752 construct a symbol name or the form `STEM-N', where N is the decimal
5753 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5754 non-nil; otherwise NAME_TABLE is used.
5756 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5757 persist between calls to modify_event_symbol that it can use to
5758 store a cache of the symbols it's generated for this NAME_TABLE
5759 before. The object stored there may be a vector or an alist.
5761 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5763 MODIFIERS is a set of modifier bits (as given in struct input_events)
5764 whose prefixes should be applied to the symbol name.
5766 SYMBOL_KIND is the value to be placed in the event_kind property of
5767 the returned symbol.
5769 The symbols we create are supposed to have an
5770 `event-symbol-elements' property, which lists the modifiers present
5771 in the symbol's name. */
5774 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5775 name_table
, symbol_table
, table_size
)
5778 Lisp_Object symbol_kind
;
5779 Lisp_Object name_alist_or_stem
;
5781 Lisp_Object
*symbol_table
;
5782 unsigned int table_size
;
5785 Lisp_Object symbol_int
;
5787 /* Get rid of the "vendor-specific" bit here. */
5788 XSETINT (symbol_int
, symbol_num
& 0xffffff);
5790 /* Is this a request for a valid symbol? */
5791 if (symbol_num
< 0 || symbol_num
>= table_size
)
5794 if (CONSP (*symbol_table
))
5795 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
5797 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5798 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5799 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5800 we've never used that symbol before. */
5803 if (! VECTORP (*symbol_table
)
5804 || XVECTOR (*symbol_table
)->size
!= table_size
)
5808 XSETFASTINT (size
, table_size
);
5809 *symbol_table
= Fmake_vector (size
, Qnil
);
5812 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5815 /* Have we already used this symbol before? */
5818 /* No; let's create it. */
5819 if (CONSP (name_alist_or_stem
))
5820 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
5821 else if (STRINGP (name_alist_or_stem
))
5823 int len
= STRING_BYTES (XSTRING (name_alist_or_stem
));
5824 char *buf
= (char *) alloca (len
+ 50);
5825 sprintf (buf
, "%s-%d", XSTRING (name_alist_or_stem
)->data
,
5826 XINT (symbol_int
) + 1);
5827 value
= intern (buf
);
5829 else if (name_table
!= 0 && name_table
[symbol_num
])
5830 value
= intern (name_table
[symbol_num
]);
5832 #ifdef HAVE_WINDOW_SYSTEM
5835 char *name
= x_get_keysym_name (symbol_num
);
5837 value
= intern (name
);
5844 sprintf (buf
, "key-%d", symbol_num
);
5845 value
= intern (buf
);
5848 if (CONSP (*symbol_table
))
5849 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5851 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5853 /* Fill in the cache entries for this symbol; this also
5854 builds the Qevent_symbol_elements property, which the user
5856 apply_modifiers (modifiers
& click_modifier
, value
);
5857 Fput (value
, Qevent_kind
, symbol_kind
);
5860 /* Apply modifiers to that symbol. */
5861 return apply_modifiers (modifiers
, value
);
5864 /* Convert a list that represents an event type,
5865 such as (ctrl meta backspace), into the usual representation of that
5866 event type as a number or a symbol. */
5868 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5869 doc
: /* Convert the event description list EVENT-DESC to an event type.
5870 EVENT-DESC should contain one base event type (a character or symbol)
5871 and zero or more modifier names (control, meta, hyper, super, shift, alt,
5872 drag, down, double or triple). The base must be last.
5873 The return value is an event type (a character or symbol) which
5874 has the same base event type and all the specified modifiers. */)
5876 Lisp_Object event_desc
;
5884 while (CONSP (rest
))
5892 /* Given a symbol, see if it is a modifier name. */
5893 if (SYMBOLP (elt
) && CONSP (rest
))
5894 this = parse_solitary_modifier (elt
);
5898 else if (!NILP (base
))
5899 error ("Two bases given in one event");
5905 /* Let the symbol A refer to the character A. */
5906 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
5907 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
5909 if (INTEGERP (base
))
5911 /* Turn (shift a) into A. */
5912 if ((modifiers
& shift_modifier
) != 0
5913 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
5915 XSETINT (base
, XINT (base
) - ('a' - 'A'));
5916 modifiers
&= ~shift_modifier
;
5919 /* Turn (control a) into C-a. */
5920 if (modifiers
& ctrl_modifier
)
5921 return make_number ((modifiers
& ~ctrl_modifier
)
5922 | make_ctrl_char (XINT (base
)));
5924 return make_number (modifiers
| XINT (base
));
5926 else if (SYMBOLP (base
))
5927 return apply_modifiers (modifiers
, base
);
5930 error ("Invalid base event");
5935 /* Try to recognize SYMBOL as a modifier name.
5936 Return the modifier flag bit, or 0 if not recognized. */
5939 parse_solitary_modifier (symbol
)
5942 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
5944 switch (name
->data
[0])
5946 #define SINGLE_LETTER_MOD(BIT) \
5947 if (STRING_BYTES (name) == 1) \
5950 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5951 if (LEN == STRING_BYTES (name) \
5952 && ! strncmp (name->data, NAME, LEN)) \
5956 SINGLE_LETTER_MOD (alt_modifier
);
5960 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
5964 SINGLE_LETTER_MOD (ctrl_modifier
);
5968 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
5969 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
5973 SINGLE_LETTER_MOD (hyper_modifier
);
5977 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
5981 SINGLE_LETTER_MOD (meta_modifier
);
5985 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
5989 SINGLE_LETTER_MOD (shift_modifier
);
5993 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
5994 MULTI_LETTER_MOD (super_modifier
, "super", 5);
5995 SINGLE_LETTER_MOD (super_modifier
);
5999 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6000 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6001 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6005 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6008 #undef SINGLE_LETTER_MOD
6009 #undef MULTI_LETTER_MOD
6015 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6016 Such a list is not valid as an event,
6017 but it can be a Lucid-style event type list. */
6020 lucid_event_type_list_p (object
)
6025 if (! CONSP (object
))
6028 if (EQ (XCAR (object
), Qhelp_echo
)
6029 || EQ (XCAR (object
), Qvertical_line
)
6030 || EQ (XCAR (object
), Qmode_line
)
6031 || EQ (XCAR (object
), Qheader_line
))
6034 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6038 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6045 /* Store into *addr a value nonzero if terminal input chars are available.
6046 Serves the purpose of ioctl (0, FIONREAD, addr)
6047 but works even if FIONREAD does not exist.
6048 (In fact, this may actually read some input.)
6050 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6053 get_input_pending (addr
, do_timers_now
)
6057 /* First of all, have we already counted some input? */
6058 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
6060 /* If input is being read as it arrives, and we have none, there is none. */
6061 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6064 /* Try to read some input and see how much we get. */
6066 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
6069 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6072 gobble_input (expected
)
6077 if (interrupt_input
)
6080 mask
= sigblock (sigmask (SIGIO
));
6081 read_avail_input (expected
);
6085 #ifdef POLL_FOR_INPUT
6086 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6089 mask
= sigblock (sigmask (SIGALRM
));
6090 read_avail_input (expected
);
6096 read_avail_input (expected
);
6100 /* Put a buffer_switch_event in the buffer
6101 so that read_key_sequence will notice the new current buffer. */
6104 record_asynch_buffer_change ()
6106 struct input_event event
;
6109 event
.kind
= buffer_switch_event
;
6110 event
.frame_or_window
= Qnil
;
6114 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6115 The purpose of the event is to make read_key_sequence look up the
6116 keymaps again. If we aren't in read_key_sequence, we don't need one,
6117 and the event could cause trouble by messing up (input-pending-p). */
6118 tem
= Fwaiting_for_user_input_p ();
6122 /* We never need these events if we have no asynchronous subprocesses. */
6126 /* Make sure no interrupt happens while storing the event. */
6128 if (interrupt_input
)
6131 mask
= sigblock (sigmask (SIGIO
));
6132 kbd_buffer_store_event (&event
);
6139 kbd_buffer_store_event (&event
);
6146 /* Read any terminal input already buffered up by the system
6147 into the kbd_buffer, but do not wait.
6149 EXPECTED should be nonzero if the caller knows there is some input.
6151 Except on VMS, all input is read by this function.
6152 If interrupt_input is nonzero, this function MUST be called
6153 only when SIGIO is blocked.
6155 Returns the number of keyboard chars read, or -1 meaning
6156 this is a bad time to try to read input. */
6159 read_avail_input (expected
)
6162 struct input_event buf
[KBD_BUFFER_SIZE
];
6166 if (read_socket_hook
)
6167 /* No need for FIONREAD or fcntl; just say don't wait. */
6168 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6171 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6172 the kbd_buffer can really hold. That may prevent loss
6173 of characters on some systems when input is stuffed at us. */
6174 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6177 /* Determine how many characters we should *try* to read. */
6180 #else /* not WINDOWSNT */
6182 n_to_read
= dos_keysns ();
6185 #else /* not MSDOS */
6187 /* Find out how much input is available. */
6188 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6189 /* Formerly simply reported no input, but that sometimes led to
6190 a failure of Emacs to terminate.
6191 SIGHUP seems appropriate if we can't reach the terminal. */
6192 /* ??? Is it really right to send the signal just to this process
6193 rather than to the whole process group?
6194 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6195 kill (getpid (), SIGHUP
);
6198 if (n_to_read
> sizeof cbuf
)
6199 n_to_read
= sizeof cbuf
;
6200 #else /* no FIONREAD */
6201 #if defined (USG) || defined (DGUX)
6202 /* Read some input if available, but don't wait. */
6203 n_to_read
= sizeof cbuf
;
6204 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6209 #endif /* not MSDOS */
6210 #endif /* not WINDOWSNT */
6212 /* Now read; for one reason or another, this will not block.
6213 NREAD is set to the number of chars read. */
6217 cbuf
[0] = dos_keyread ();
6220 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6222 /* POSIX infers that processes which are not in the session leader's
6223 process group won't get SIGHUP's at logout time. BSDI adheres to
6224 this part standard and returns -1 from read (0) with errno==EIO
6225 when the control tty is taken away.
6226 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6227 if (nread
== -1 && errno
== EIO
)
6229 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6230 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6231 This looks incorrect, but it isn't, because _BSD causes
6232 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6233 and that causes a value other than 0 when there is no input. */
6239 /* We used to retry the read if it was interrupted.
6240 But this does the wrong thing when O_NDELAY causes
6241 an EAGAIN error. Does anybody know of a situation
6242 where a retry is actually needed? */
6244 nread
< 0 && (errno
== EAGAIN
6258 #if defined (USG) || defined (DGUX)
6259 fcntl (input_fd
, F_SETFL
, 0);
6260 #endif /* USG or DGUX */
6261 #endif /* no FIONREAD */
6262 for (i
= 0; i
< nread
; i
++)
6264 buf
[i
].kind
= ascii_keystroke
;
6265 buf
[i
].modifiers
= 0;
6266 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6267 buf
[i
].modifiers
= meta_modifier
;
6271 buf
[i
].code
= cbuf
[i
];
6272 buf
[i
].frame_or_window
= selected_frame
;
6277 /* Scan the chars for C-g and store them in kbd_buffer. */
6278 for (i
= 0; i
< nread
; i
++)
6280 kbd_buffer_store_event (&buf
[i
]);
6281 /* Don't look at input that follows a C-g too closely.
6282 This reduces lossage due to autorepeat on C-g. */
6283 if (buf
[i
].kind
== ascii_keystroke
6284 && buf
[i
].code
== quit_char
)
6290 #endif /* not VMS */
6292 #ifdef SIGIO /* for entire page */
6293 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6296 input_available_signal (signo
)
6299 /* Must preserve main program's value of errno. */
6300 int old_errno
= errno
;
6302 extern int select_alarmed
;
6305 #if defined (USG) && !defined (POSIX_SIGNALS)
6306 /* USG systems forget handlers when they are used;
6307 must reestablish each time */
6308 signal (signo
, input_available_signal
);
6315 if (input_available_clear_time
)
6316 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6321 nread
= read_avail_input (1);
6322 /* -1 means it's not ok to read the input now.
6323 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6324 0 means there was no keyboard input available. */
6329 select_alarmed
= 1; /* Force the select emulator back to life */
6340 /* Send ourselves a SIGIO.
6342 This function exists so that the UNBLOCK_INPUT macro in
6343 blockinput.h can have some way to take care of input we put off
6344 dealing with, without assuming that every file which uses
6345 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6347 reinvoke_input_signal ()
6350 kill (getpid (), SIGIO
);
6356 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6357 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6359 /* These variables hold the vector under construction within
6360 menu_bar_items and its subroutines, and the current index
6361 for storing into that vector. */
6362 static Lisp_Object menu_bar_items_vector
;
6363 static int menu_bar_items_index
;
6365 /* Return a vector of menu items for a menu bar, appropriate
6366 to the current buffer. Each item has three elements in the vector:
6369 OLD is an old vector we can optionally reuse, or nil. */
6372 menu_bar_items (old
)
6375 /* The number of keymaps we're scanning right now, and the number of
6376 keymaps we have allocated space for. */
6379 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6380 in the current keymaps, or nil where it is not a prefix. */
6383 Lisp_Object def
, tail
;
6392 struct gcpro gcpro1
;
6394 /* In order to build the menus, we need to call the keymap
6395 accessors. They all call QUIT. But this function is called
6396 during redisplay, during which a quit is fatal. So inhibit
6397 quitting while building the menus.
6398 We do this instead of specbind because (1) errors will clear it anyway
6399 and (2) this avoids risk of specpdl overflow. */
6400 oquit
= Vinhibit_quit
;
6404 menu_bar_items_vector
= old
;
6406 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6407 menu_bar_items_index
= 0;
6409 GCPRO1 (menu_bar_items_vector
);
6411 /* Build our list of keymaps.
6412 If we recognize a function key and replace its escape sequence in
6413 keybuf with its symbol, or if the sequence starts with a mouse
6414 click and we need to switch buffers, we jump back here to rebuild
6415 the initial keymaps from the current buffer. */
6419 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6420 if (!NILP (Voverriding_local_map_menu_flag
))
6422 /* Yes, use them (if non-nil) as well as the global map. */
6423 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6425 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6426 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6427 if (!NILP (Voverriding_local_map
))
6428 maps
[nmaps
++] = Voverriding_local_map
;
6432 /* No, so use major and minor mode keymaps and keymap property. */
6434 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
6437 nmaps
= current_minor_maps (NULL
, &tmaps
);
6438 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
6439 * sizeof (maps
[0]));
6440 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6442 maps
[nmaps
++] = map
;
6443 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6445 maps
[nmaps
++] = current_global_map
;
6448 /* Look up in each map the dummy prefix key `menu-bar'. */
6452 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6453 if (!NILP (maps
[mapno
]))
6455 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6458 menu_bar_one_keymap (def
);
6461 /* Move to the end those items that should be at the end. */
6463 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6466 int end
= menu_bar_items_index
;
6468 for (i
= 0; i
< end
; i
+= 4)
6469 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6471 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6472 /* Move the item at index I to the end,
6473 shifting all the others forward. */
6474 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6475 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6476 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6477 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6479 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6480 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6481 (end
- i
- 4) * sizeof (Lisp_Object
));
6482 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6483 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6484 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6485 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6490 /* Add nil, nil, nil, nil at the end. */
6491 i
= menu_bar_items_index
;
6492 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6495 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6496 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6497 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6498 menu_bar_items_vector
= tem
;
6500 /* Add this item. */
6501 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6502 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6503 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6504 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6505 menu_bar_items_index
= i
;
6507 Vinhibit_quit
= oquit
;
6509 return menu_bar_items_vector
;
6512 /* Scan one map KEYMAP, accumulating any menu items it defines
6513 in menu_bar_items_vector. */
6515 static Lisp_Object menu_bar_one_keymap_changed_items
;
6518 menu_bar_one_keymap (keymap
)
6521 Lisp_Object tail
, item
;
6523 menu_bar_one_keymap_changed_items
= Qnil
;
6525 /* Loop over all keymap entries that have menu strings. */
6526 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6530 menu_bar_item (XCAR (item
), XCDR (item
));
6531 else if (VECTORP (item
))
6533 /* Loop over the char values represented in the vector. */
6534 int len
= XVECTOR (item
)->size
;
6536 for (c
= 0; c
< len
; c
++)
6538 Lisp_Object character
;
6539 XSETFASTINT (character
, c
);
6540 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6546 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6547 If there's already an item for KEY, add this DEF to it. */
6549 Lisp_Object item_properties
;
6552 menu_bar_item (key
, item
)
6553 Lisp_Object key
, item
;
6555 struct gcpro gcpro1
;
6559 if (EQ (item
, Qundefined
))
6561 /* If a map has an explicit `undefined' as definition,
6562 discard any previously made menu bar item. */
6564 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6565 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6567 if (menu_bar_items_index
> i
+ 4)
6568 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6569 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6570 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6571 menu_bar_items_index
-= 4;
6575 /* If this keymap has already contributed to this KEY,
6576 don't contribute to it a second time. */
6577 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6578 if (!NILP (tem
) || NILP (item
))
6581 menu_bar_one_keymap_changed_items
6582 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6584 /* We add to menu_bar_one_keymap_changed_items before doing the
6585 parse_menu_item, so that if it turns out it wasn't a menu item,
6586 it still correctly hides any further menu item. */
6588 i
= parse_menu_item (item
, 0, 1);
6593 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6595 /* Find any existing item for this KEY. */
6596 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6597 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6600 /* If we did not find this KEY, add it at the end. */
6601 if (i
== menu_bar_items_index
)
6603 /* If vector is too small, get a bigger one. */
6604 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6607 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6608 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6609 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6610 menu_bar_items_vector
= tem
;
6613 /* Add this item. */
6614 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6615 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6616 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6617 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6618 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6619 menu_bar_items_index
= i
;
6621 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6625 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6626 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6630 /* This is used as the handler when calling menu_item_eval_property. */
6632 menu_item_eval_property_1 (arg
)
6635 /* If we got a quit from within the menu computation,
6636 quit all the way out of it. This takes care of C-] in the debugger. */
6637 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6638 Fsignal (Qquit
, Qnil
);
6643 /* Evaluate an expression and return the result (or nil if something
6644 went wrong). Used to evaluate dynamic parts of menu items. */
6646 menu_item_eval_property (sexpr
)
6649 int count
= specpdl_ptr
- specpdl
;
6651 specbind (Qinhibit_redisplay
, Qt
);
6652 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6653 menu_item_eval_property_1
);
6654 return unbind_to (count
, val
);
6657 /* This function parses a menu item and leaves the result in the
6658 vector item_properties.
6659 ITEM is a key binding, a possible menu item.
6660 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6661 evaluate dynamic expressions in the menu item.
6662 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6664 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6665 parse_menu_item returns true if the item is a menu item and false
6669 parse_menu_item (item
, notreal
, inmenubar
)
6671 int notreal
, inmenubar
;
6673 Lisp_Object def
, tem
, item_string
, start
;
6674 Lisp_Object cachelist
;
6676 Lisp_Object keyhint
;
6687 /* Create item_properties vector if necessary. */
6688 if (NILP (item_properties
))
6690 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6692 /* Initialize optional entries. */
6693 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6694 AREF (item_properties
, i
) = Qnil
;
6695 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
6697 /* Save the item here to protect it from GC. */
6698 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
6700 item_string
= XCAR (item
);
6704 if (STRINGP (item_string
))
6706 /* Old format menu item. */
6707 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6709 /* Maybe help string. */
6710 if (CONSP (item
) && STRINGP (XCAR (item
)))
6712 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6717 /* Maybe key binding cache. */
6718 if (CONSP (item
) && CONSP (XCAR (item
))
6719 && (NILP (XCAR (XCAR (item
)))
6720 || VECTORP (XCAR (XCAR (item
)))))
6722 cachelist
= XCAR (item
);
6726 /* This is the real definition--the function to run. */
6727 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
6729 /* Get enable property, if any. */
6732 tem
= Fget (item
, Qmenu_enable
);
6734 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6737 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6739 /* New format menu item. */
6740 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
6741 start
= XCDR (item
);
6744 /* We have a real binding. */
6745 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
6747 item
= XCDR (start
);
6748 /* Is there a cache list with key equivalences. */
6749 if (CONSP (item
) && CONSP (XCAR (item
)))
6751 cachelist
= XCAR (item
);
6755 /* Parse properties. */
6756 while (CONSP (item
) && CONSP (XCDR (item
)))
6761 if (EQ (tem
, QCenable
))
6762 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
6763 else if (EQ (tem
, QCvisible
) && !notreal
)
6765 /* If got a visible property and that evaluates to nil
6766 then ignore this item. */
6767 tem
= menu_item_eval_property (XCAR (item
));
6771 else if (EQ (tem
, QChelp
))
6772 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6773 else if (EQ (tem
, QCfilter
))
6775 else if (EQ (tem
, QCkey_sequence
))
6778 if (NILP (cachelist
)
6779 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
6780 /* Be GC protected. Set keyhint to item instead of tem. */
6783 else if (EQ (tem
, QCkeys
))
6786 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
6787 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6789 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
6794 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6796 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6798 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
6805 else if (inmenubar
|| !NILP (start
))
6809 return 0; /* not a menu item */
6811 /* If item string is not a string, evaluate it to get string.
6812 If we don't get a string, skip this item. */
6813 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
6814 if (!(STRINGP (item_string
) || notreal
))
6816 item_string
= menu_item_eval_property (item_string
);
6817 if (!STRINGP (item_string
))
6819 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6822 /* If got a filter apply it on definition. */
6823 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6826 def
= menu_item_eval_property (list2 (XCAR (filter
),
6827 list2 (Qquote
, def
)));
6829 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
6832 /* Enable or disable selection of item. */
6833 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
6839 tem
= menu_item_eval_property (tem
);
6840 if (inmenubar
&& NILP (tem
))
6841 return 0; /* Ignore disabled items in menu bar. */
6842 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6845 /* If we got no definition, this item is just unselectable text which
6846 is OK in a submenu but not in the menubar. */
6848 return (inmenubar
? 0 : 1);
6850 /* See if this is a separate pane or a submenu. */
6851 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6852 tem
= get_keymap (def
, 0, 1);
6853 /* For a subkeymap, just record its details and exit. */
6856 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
6857 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
6861 /* At the top level in the menu bar, do likewise for commands also.
6862 The menu bar does not display equivalent key bindings anyway.
6863 ITEM_PROPERTY_DEF is already set up properly. */
6867 /* This is a command. See if there is an equivalent key binding. */
6868 if (NILP (cachelist
))
6870 /* We have to create a cachelist. */
6871 CHECK_IMPURE (start
);
6872 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
6873 cachelist
= XCAR (XCDR (start
));
6875 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
6876 if (!NILP (keyhint
))
6878 XSETCAR (cachelist
, XCAR (keyhint
));
6881 else if (STRINGP (tem
))
6883 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
6884 XSETCAR (cachelist
, Qt
);
6888 tem
= XCAR (cachelist
);
6895 tem
= Fkey_binding (tem
, Qnil
);
6897 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
6900 def
= XCAR (prefix
);
6901 prefix
= XCDR (prefix
);
6904 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6906 if (!update_menu_bindings
)
6908 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
6910 if (newcache
/* Always check first time. */
6911 /* Should we check everything when precomputing key
6913 /* If something had no key binding before, don't recheck it
6914 because that is too slow--except if we have a list of
6915 rebound commands in Vdefine_key_rebound_commands, do
6916 recheck any command that appears in that list. */
6917 || (CONSP (Vdefine_key_rebound_commands
)
6918 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
6921 /* We had a saved key. Is it still bound to the command? */
6924 /* If the command is an alias for another
6925 (such as lmenu.el set it up), check if the
6926 original command matches the cached command. */
6927 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
6928 chkcache
= 1; /* Need to recompute key binding. */
6932 /* Recompute equivalent key binding. If the command is an alias
6933 for another (such as lmenu.el set it up), see if the original
6934 command name has equivalent keys. Otherwise look up the
6935 specified command itself. We don't try both, because that
6936 makes lmenu menus slow. */
6938 && SYMBOLP (XSYMBOL (def
)->function
)
6939 && ! NILP (Fget (def
, Qmenu_alias
)))
6940 def
= XSYMBOL (def
)->function
;
6941 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
6942 XSETCAR (cachelist
, tem
);
6945 XSETCDR (cachelist
, Qnil
);
6949 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
6951 tem
= XCAR (cachelist
);
6955 newcache
= chkcache
;
6958 tem
= Fkey_description (tem
);
6961 if (STRINGP (XCAR (prefix
)))
6962 tem
= concat2 (XCAR (prefix
), tem
);
6963 if (STRINGP (XCDR (prefix
)))
6964 tem
= concat2 (tem
, XCDR (prefix
));
6966 XSETCDR (cachelist
, tem
);
6970 tem
= XCDR (cachelist
);
6971 if (newcache
&& !NILP (tem
))
6973 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
6974 XSETCDR (cachelist
, tem
);
6977 /* If we only want to precompute equivalent key bindings, stop here. */
6981 /* If we have an equivalent key binding, use that. */
6982 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6984 /* Include this when menu help is implemented.
6985 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
6986 if (!(NILP (tem) || STRINGP (tem)))
6988 tem = menu_item_eval_property (tem);
6991 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
6995 /* Handle radio buttons or toggle boxes. */
6996 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
6998 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6999 = menu_item_eval_property (tem
);
7006 /***********************************************************************
7008 ***********************************************************************/
7010 /* A vector holding tool bar items while they are parsed in function
7011 tool_bar_items runs Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7014 static Lisp_Object tool_bar_items_vector
;
7016 /* A vector holding the result of parse_tool_bar_item. Layout is like
7017 the one for a single item in tool_bar_items_vector. */
7019 static Lisp_Object tool_bar_item_properties
;
7021 /* Next free index in tool_bar_items_vector. */
7023 static int ntool_bar_items
;
7025 /* The symbols `tool-bar', and `:image'. */
7027 extern Lisp_Object Qtool_bar
;
7028 Lisp_Object QCimage
;
7030 /* Function prototypes. */
7032 static void init_tool_bar_items
P_ ((Lisp_Object
));
7033 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7034 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7035 static void append_tool_bar_item
P_ ((void));
7038 /* Return a vector of tool bar items for keymaps currently in effect.
7039 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7040 tool bar items found. */
7043 tool_bar_items (reuse
, nitems
)
7051 extern Lisp_Object Voverriding_local_map_menu_flag
;
7052 extern Lisp_Object Voverriding_local_map
;
7056 /* In order to build the menus, we need to call the keymap
7057 accessors. They all call QUIT. But this function is called
7058 during redisplay, during which a quit is fatal. So inhibit
7059 quitting while building the menus. We do this instead of
7060 specbind because (1) errors will clear it anyway and (2) this
7061 avoids risk of specpdl overflow. */
7062 oquit
= Vinhibit_quit
;
7065 /* Initialize tool_bar_items_vector and protect it from GC. */
7066 init_tool_bar_items (reuse
);
7068 /* Build list of keymaps in maps. Set nmaps to the number of maps
7071 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7072 if (!NILP (Voverriding_local_map_menu_flag
))
7074 /* Yes, use them (if non-nil) as well as the global map. */
7075 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7077 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7078 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7079 if (!NILP (Voverriding_local_map
))
7080 maps
[nmaps
++] = Voverriding_local_map
;
7084 /* No, so use major and minor mode keymaps and keymap property. */
7086 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
7089 nmaps
= current_minor_maps (NULL
, &tmaps
);
7090 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
7091 * sizeof (maps
[0]));
7092 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7094 maps
[nmaps
++] = map
;
7095 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7098 /* Add global keymap at the end. */
7099 maps
[nmaps
++] = current_global_map
;
7101 /* Process maps in reverse order and look up in each map the prefix
7103 for (i
= nmaps
- 1; i
>= 0; --i
)
7104 if (!NILP (maps
[i
]))
7108 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7113 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7114 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7116 Lisp_Object keydef
= XCAR (tail
);
7118 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7123 Vinhibit_quit
= oquit
;
7124 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7125 return tool_bar_items_vector
;
7129 /* Process the definition of KEY which is DEF. */
7132 process_tool_bar_item (key
, def
)
7133 Lisp_Object key
, def
;
7136 extern Lisp_Object Qundefined
;
7137 struct gcpro gcpro1
, gcpro2
;
7139 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7143 if (EQ (def
, Qundefined
))
7145 /* If a map has an explicit `undefined' as definition,
7146 discard any previously made item. */
7147 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7149 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7151 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7153 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7154 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7155 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7156 * sizeof (Lisp_Object
)));
7157 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7162 else if (parse_tool_bar_item (key
, def
))
7163 /* Append a new tool bar item to tool_bar_items_vector. Accept
7164 more than one definition for the same key. */
7165 append_tool_bar_item ();
7171 /* Parse a tool bar item specification ITEM for key KEY and return the
7172 result in tool_bar_item_properties. Value is zero if ITEM is
7175 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7177 CAPTION is the caption of the item, If it's not a string, it is
7178 evaluated to get a string.
7180 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7181 as binding are currently ignored.
7183 The following properties are recognized:
7187 FORM is evaluated and specifies whether the tool bar item is
7188 enabled or disabled.
7192 FORM is evaluated and specifies whether the tool bar item is visible.
7194 - `:filter FUNCTION'
7196 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7197 result is stored as the new binding.
7199 - `:button (TYPE SELECTED)'
7201 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7202 and specifies whether the button is selected (pressed) or not.
7206 IMAGES is either a single image specification or a vector of four
7207 image specifications. See enum tool_bar_item_images.
7209 - `:help HELP-STRING'.
7211 Gives a help string to display for the tool bar item. */
7214 parse_tool_bar_item (key
, item
)
7215 Lisp_Object key
, item
;
7217 /* Access slot with index IDX of vector tool_bar_item_properties. */
7218 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7220 Lisp_Object filter
= Qnil
;
7221 Lisp_Object caption
;
7222 extern Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
;
7223 extern Lisp_Object QCbutton
, QCtoggle
, QCradio
;
7226 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7227 Rule out items that aren't lists, don't start with
7228 `menu-item' or whose rest following `tool-bar-item' is not a
7231 || !EQ (XCAR (item
), Qmenu_item
)
7232 || (item
= XCDR (item
),
7236 /* Create tool_bar_item_properties vector if necessary. Reset it to
7238 if (VECTORP (tool_bar_item_properties
))
7240 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7244 tool_bar_item_properties
7245 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7248 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7249 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7251 /* Get the caption of the item. If the caption is not a string,
7252 evaluate it to get a string. If we don't get a string, skip this
7254 caption
= XCAR (item
);
7255 if (!STRINGP (caption
))
7257 caption
= menu_item_eval_property (caption
);
7258 if (!STRINGP (caption
))
7261 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7263 /* Give up if rest following the caption is not a list. */
7268 /* Store the binding. */
7269 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7272 /* Ignore cached key binding, if any. */
7273 if (CONSP (item
) && CONSP (XCAR (item
)))
7276 /* Process the rest of the properties. */
7277 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7279 Lisp_Object key
, value
;
7282 value
= XCAR (XCDR (item
));
7284 if (EQ (key
, QCenable
))
7285 /* `:enable FORM'. */
7286 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7287 else if (EQ (key
, QCvisible
))
7289 /* `:visible FORM'. If got a visible property and that
7290 evaluates to nil then ignore this item. */
7291 if (NILP (menu_item_eval_property (value
)))
7294 else if (EQ (key
, QChelp
))
7295 /* `:help HELP-STRING'. */
7296 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7297 else if (EQ (key
, QCfilter
))
7298 /* ':filter FORM'. */
7300 else if (EQ (key
, QCbutton
) && CONSP (value
))
7302 /* `:button (TYPE . SELECTED)'. */
7303 Lisp_Object type
, selected
;
7305 type
= XCAR (value
);
7306 selected
= XCDR (value
);
7307 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7309 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7310 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7313 else if (EQ (key
, QCimage
)
7315 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7316 /* Value is either a single image specification or a vector
7317 of 4 such specifications for the different buttion states. */
7318 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7321 /* If got a filter apply it on binding. */
7323 PROP (TOOL_BAR_ITEM_BINDING
)
7324 = menu_item_eval_property (list2 (filter
,
7326 PROP (TOOL_BAR_ITEM_BINDING
))));
7328 /* See if the binding is a keymap. Give up if it is. */
7329 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7332 /* Enable or disable selection of item. */
7333 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7334 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7335 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7337 /* Handle radio buttons or toggle boxes. */
7338 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7339 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7340 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7348 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7349 that can be reused. */
7352 init_tool_bar_items (reuse
)
7355 if (VECTORP (reuse
))
7356 tool_bar_items_vector
= reuse
;
7358 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7359 ntool_bar_items
= 0;
7363 /* Append parsed tool bar item properties from
7364 tool_bar_item_properties */
7367 append_tool_bar_item ()
7369 Lisp_Object
*to
, *from
;
7371 /* Enlarge tool_bar_items_vector if necessary. */
7372 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7373 >= XVECTOR (tool_bar_items_vector
)->size
)
7375 Lisp_Object new_vector
;
7376 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7378 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7379 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7380 XVECTOR (new_vector
)->contents
,
7381 old_size
* sizeof (Lisp_Object
));
7382 tool_bar_items_vector
= new_vector
;
7385 /* Append entries from tool_bar_item_properties to the end of
7386 tool_bar_items_vector. */
7387 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7388 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7389 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7390 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7397 /* Read a character using menus based on maps in the array MAPS.
7398 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7399 Return t if we displayed a menu but the user rejected it.
7401 PREV_EVENT is the previous input event, or nil if we are reading
7402 the first event of a key sequence.
7404 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7405 if we used a mouse menu to read the input, or zero otherwise. If
7406 USED_MOUSE_MENU is null, we don't dereference it.
7408 The prompting is done based on the prompt-string of the map
7409 and the strings associated with various map elements.
7411 This can be done with X menus or with menus put in the minibuf.
7412 These are done in different ways, depending on how the input will be read.
7413 Menus using X are done after auto-saving in read-char, getting the input
7414 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7415 and do auto-saving in the inner call of read_char. */
7418 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7421 Lisp_Object prev_event
;
7422 int *used_mouse_menu
;
7425 register Lisp_Object name
;
7427 if (used_mouse_menu
)
7428 *used_mouse_menu
= 0;
7430 /* Use local over global Menu maps */
7432 if (! menu_prompting
)
7435 /* Optionally disregard all but the global map. */
7436 if (inhibit_local_menu_bar_menus
)
7438 maps
+= (nmaps
- 1);
7442 /* Get the menu name from the first map that has one (a prompt string). */
7443 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7445 name
= Fkeymap_prompt (maps
[mapno
]);
7450 /* If we don't have any menus, just read a character normally. */
7455 /* If we got to this point via a mouse click,
7456 use a real menu for mouse selection. */
7457 if (EVENT_HAS_PARAMETERS (prev_event
)
7458 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7459 && !EQ (XCAR (prev_event
), Qtool_bar
))
7461 /* Display the menu and get the selection. */
7462 Lisp_Object
*realmaps
7463 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7467 /* Use the maps that are not nil. */
7468 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7469 if (!NILP (maps
[mapno
]))
7470 realmaps
[nmaps1
++] = maps
[mapno
];
7472 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7477 record_menu_key (XCAR (value
));
7479 /* If we got multiple events, unread all but
7481 There is no way to prevent those unread events
7482 from showing up later in last_nonmenu_event.
7483 So turn symbol and integer events into lists,
7484 to indicate that they came from a mouse menu,
7485 so that when present in last_nonmenu_event
7486 they won't confuse things. */
7487 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7489 record_menu_key (XCAR (tem
));
7490 if (SYMBOLP (XCAR (tem
))
7491 || INTEGERP (XCAR (tem
)))
7492 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7495 /* If we got more than one event, put all but the first
7496 onto this list to be read later.
7497 Return just the first event now. */
7498 Vunread_command_events
7499 = nconc2 (XCDR (value
), Vunread_command_events
);
7500 value
= XCAR (value
);
7502 else if (NILP (value
))
7504 if (used_mouse_menu
)
7505 *used_mouse_menu
= 1;
7508 #endif /* HAVE_MENUS */
7512 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7513 We make this bigger when necessary, and never free it. */
7514 static char *read_char_minibuf_menu_text
;
7515 /* Size of that buffer. */
7516 static int read_char_minibuf_menu_width
;
7519 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7525 register Lisp_Object name
;
7527 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7530 Lisp_Object rest
, vector
;
7536 if (! menu_prompting
)
7539 /* Make sure we have a big enough buffer for the menu text. */
7540 if (read_char_minibuf_menu_text
== 0)
7542 read_char_minibuf_menu_width
= width
+ 4;
7543 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7545 else if (width
+ 4 > read_char_minibuf_menu_width
)
7547 read_char_minibuf_menu_width
= width
+ 4;
7548 read_char_minibuf_menu_text
7549 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7551 menu
= read_char_minibuf_menu_text
;
7553 /* Get the menu name from the first map that has one (a prompt string). */
7554 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7556 name
= Fkeymap_prompt (maps
[mapno
]);
7561 /* If we don't have any menus, just read a character normally. */
7562 if (!STRINGP (name
));
7565 /* Prompt string always starts with map's prompt, and a space. */
7566 strcpy (menu
, XSTRING (name
)->data
);
7567 nlength
= STRING_BYTES (XSTRING (name
));
7568 menu
[nlength
++] = ':';
7569 menu
[nlength
++] = ' ';
7572 /* Start prompting at start of first map. */
7576 /* Present the documented bindings, a line at a time. */
7583 Lisp_Object orig_defn_macro
;
7585 /* Loop over elements of map. */
7590 /* If reached end of map, start at beginning of next map. */
7594 /* At end of last map, wrap around to first map if just starting,
7595 or end this line if already have something on it. */
7599 if (notfirst
|| nobindings
) break;
7604 /* Look at the next element of the map. */
7606 elt
= XVECTOR (vector
)->contents
[idx
];
7608 elt
= Fcar_safe (rest
);
7610 if (idx
< 0 && VECTORP (elt
))
7612 /* If we found a dense table in the keymap,
7613 advanced past it, but start scanning its contents. */
7614 rest
= Fcdr_safe (rest
);
7620 /* An ordinary element. */
7621 Lisp_Object event
, tem
;
7625 event
= Fcar_safe (elt
); /* alist */
7626 elt
= Fcdr_safe (elt
);
7630 XSETINT (event
, idx
); /* vector */
7633 /* Ignore the element if it has no prompt string. */
7634 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7636 /* 1 if the char to type matches the string. */
7638 Lisp_Object upcased_event
, downcased_event
;
7639 Lisp_Object desc
= Qnil
;
7641 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7643 upcased_event
= Fupcase (event
);
7644 downcased_event
= Fdowncase (event
);
7645 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
7646 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
7648 desc
= Fsingle_key_description (event
, Qnil
);
7651 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7653 /* Insert equivalent keybinding. */
7654 s
= concat2 (s
, tem
);
7657 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7658 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7660 /* Insert button prefix. */
7661 Lisp_Object selected
7662 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7663 if (EQ (tem
, QCradio
))
7664 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7666 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7667 s
= concat2 (tem
, s
);
7671 /* If we have room for the prompt string, add it to this line.
7672 If this is the first on the line, always add it. */
7673 if ((XSTRING (s
)->size
+ i
+ 2
7674 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
7680 /* Punctuate between strings. */
7683 strcpy (menu
+ i
, ", ");
7689 /* If the char to type doesn't match the string's
7690 first char, explicitly show what char to type. */
7693 /* Add as much of string as fits. */
7694 thiswidth
= XSTRING (desc
)->size
;
7695 if (thiswidth
+ i
> width
)
7696 thiswidth
= width
- i
;
7697 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
7699 strcpy (menu
+ i
, " = ");
7703 /* Add as much of string as fits. */
7704 thiswidth
= XSTRING (s
)->size
;
7705 if (thiswidth
+ i
> width
)
7706 thiswidth
= width
- i
;
7707 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
7713 /* If this element does not fit, end the line now,
7714 and save the element for the next line. */
7715 strcpy (menu
+ i
, "...");
7720 /* Move past this element. */
7721 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7722 /* Handle reaching end of dense table. */
7727 rest
= Fcdr_safe (rest
);
7731 /* Prompt with that and read response. */
7732 message2_nolog (menu
, strlen (menu
),
7733 ! NILP (current_buffer
->enable_multibyte_characters
));
7735 /* Make believe its not a keyboard macro in case the help char
7736 is pressed. Help characters are not recorded because menu prompting
7737 is not used on replay.
7739 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7740 current_kboard
->defining_kbd_macro
= Qnil
;
7742 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
7743 while (BUFFERP (obj
));
7744 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7746 if (!INTEGERP (obj
))
7751 if (! EQ (obj
, menu_prompt_more_char
)
7752 && (!INTEGERP (menu_prompt_more_char
)
7753 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
7755 if (!NILP (current_kboard
->defining_kbd_macro
))
7756 store_kbd_macro_char (obj
);
7759 /* Help char - go round again */
7763 /* Reading key sequences. */
7765 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7766 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7767 keymap, or nil otherwise. Return the index of the first keymap in
7768 which KEY has any binding, or NMAPS if no map has a binding.
7770 If KEY is a meta ASCII character, treat it like meta-prefix-char
7771 followed by the corresponding non-meta character. Keymaps in
7772 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7775 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7778 NEXT may be the same array as CURRENT. */
7781 follow_key (key
, nmaps
, current
, defs
, next
)
7783 Lisp_Object
*current
, *defs
, *next
;
7786 int i
, first_binding
;
7789 first_binding
= nmaps
;
7790 for (i
= nmaps
- 1; i
>= 0; i
--)
7792 if (! NILP (current
[i
]))
7800 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
7801 if (! NILP (defs
[i
]))
7808 /* Given the set of bindings we've found, produce the next set of maps. */
7809 if (first_binding
< nmaps
)
7810 for (i
= 0; i
< nmaps
; i
++)
7811 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
7813 return first_binding
;
7816 /* Read a sequence of keys that ends with a non prefix character,
7817 storing it in KEYBUF, a buffer of size BUFSIZE.
7819 Return the length of the key sequence stored.
7820 Return -1 if the user rejected a command menu.
7822 Echo starting immediately unless `prompt' is 0.
7824 Where a key sequence ends depends on the currently active keymaps.
7825 These include any minor mode keymaps active in the current buffer,
7826 the current buffer's local map, and the global map.
7828 If a key sequence has no other bindings, we check Vfunction_key_map
7829 to see if some trailing subsequence might be the beginning of a
7830 function key's sequence. If so, we try to read the whole function
7831 key, and substitute its symbolic name into the key sequence.
7833 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7834 `double-' events into similar click events, if that would make them
7835 bound. We try to turn `triple-' events first into `double-' events,
7838 If we get a mouse click in a mode line, vertical divider, or other
7839 non-text area, we treat the click as if it were prefixed by the
7840 symbol denoting that area - `mode-line', `vertical-line', or
7843 If the sequence starts with a mouse click, we read the key sequence
7844 with respect to the buffer clicked on, not the current buffer.
7846 If the user switches frames in the midst of a key sequence, we put
7847 off the switch-frame event until later; the next call to
7848 read_char will return it.
7850 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
7851 from the selected window's buffer. */
7854 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
7855 can_return_switch_frame
, fix_current_buffer
)
7856 Lisp_Object
*keybuf
;
7859 int dont_downcase_last
;
7860 int can_return_switch_frame
;
7861 int fix_current_buffer
;
7863 volatile Lisp_Object from_string
;
7864 volatile int count
= specpdl_ptr
- specpdl
;
7866 /* How many keys there are in the current key sequence. */
7869 /* The length of the echo buffer when we started reading, and
7870 the length of this_command_keys when we started reading. */
7871 volatile int echo_start
;
7872 volatile int keys_start
;
7874 /* The number of keymaps we're scanning right now, and the number of
7875 keymaps we have allocated space for. */
7877 volatile int nmaps_allocated
= 0;
7879 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
7880 the current keymaps. */
7881 Lisp_Object
*volatile defs
= NULL
;
7883 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7884 in the current keymaps, or nil where it is not a prefix. */
7885 Lisp_Object
*volatile submaps
= NULL
;
7887 /* The local map to start out with at start of key sequence. */
7888 volatile Lisp_Object orig_local_map
;
7890 /* The map from the `keymap' property to start out with at start of
7892 volatile Lisp_Object orig_keymap
;
7894 /* 1 if we have already considered switching to the local-map property
7895 of the place where a mouse click occurred. */
7896 volatile int localized_local_map
= 0;
7898 /* The index in defs[] of the first keymap that has a binding for
7899 this key sequence. In other words, the lowest i such that
7900 defs[i] is non-nil. */
7901 volatile int first_binding
;
7902 /* Index of the first key that has no binding.
7903 It is useless to try fkey_start larger than that. */
7904 volatile int first_unbound
;
7906 /* If t < mock_input, then KEYBUF[t] should be read as the next
7909 We use this to recover after recognizing a function key. Once we
7910 realize that a suffix of the current key sequence is actually a
7911 function key's escape sequence, we replace the suffix with the
7912 function key's binding from Vfunction_key_map. Now keybuf
7913 contains a new and different key sequence, so the echo area,
7914 this_command_keys, and the submaps and defs arrays are wrong. In
7915 this situation, we set mock_input to t, set t to 0, and jump to
7916 restart_sequence; the loop will read keys from keybuf up until
7917 mock_input, thus rebuilding the state; and then it will resume
7918 reading characters from the keyboard. */
7919 volatile int mock_input
= 0;
7921 /* If the sequence is unbound in submaps[], then
7922 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
7923 and fkey_map is its binding.
7925 These might be > t, indicating that all function key scanning
7926 should hold off until t reaches them. We do this when we've just
7927 recognized a function key, to avoid searching for the function
7928 key's again in Vfunction_key_map. */
7929 volatile int fkey_start
= 0, fkey_end
= 0;
7930 volatile Lisp_Object fkey_map
;
7932 /* Likewise, for key_translation_map. */
7933 volatile int keytran_start
= 0, keytran_end
= 0;
7934 volatile Lisp_Object keytran_map
;
7936 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
7937 we put it off for later. While we're reading, we keep the event here. */
7938 volatile Lisp_Object delayed_switch_frame
;
7940 /* See the comment below... */
7941 #if defined (GOBBLE_FIRST_EVENT)
7942 Lisp_Object first_event
;
7945 volatile Lisp_Object original_uppercase
;
7946 volatile int original_uppercase_position
= -1;
7948 /* Gets around Microsoft compiler limitations. */
7951 struct buffer
*starting_buffer
;
7953 /* Nonzero if we seem to have got the beginning of a binding
7954 in function_key_map. */
7955 volatile int function_key_possible
= 0;
7956 volatile int key_translation_possible
= 0;
7958 /* List of events for which a fake prefix key has been generated. */
7959 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
7961 /* Save the status of key translation before each step,
7962 so that we can restore this after downcasing. */
7963 Lisp_Object prev_fkey_map
;
7964 int prev_fkey_start
;
7967 Lisp_Object prev_keytran_map
;
7968 int prev_keytran_start
;
7969 int prev_keytran_end
;
7971 #if defined (GOBBLE_FIRST_EVENT)
7975 struct gcpro gcpro1
;
7977 GCPRO1 (fake_prefixed_keys
);
7978 raw_keybuf_count
= 0;
7980 last_nonmenu_event
= Qnil
;
7982 delayed_switch_frame
= Qnil
;
7983 fkey_map
= Vfunction_key_map
;
7984 keytran_map
= Vkey_translation_map
;
7986 /* If there is no function-key-map, turn off function key scanning. */
7987 if (!KEYMAPP (Vfunction_key_map
))
7988 fkey_start
= fkey_end
= bufsize
+ 1;
7990 /* If there is no key-translation-map, turn off scanning. */
7991 if (!KEYMAPP (Vkey_translation_map
))
7992 keytran_start
= keytran_end
= bufsize
+ 1;
7997 echo_prompt (prompt
);
7998 else if (cursor_in_echo_area
7999 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8000 && NILP (Fzerop (Vecho_keystrokes
)))
8001 /* This doesn't put in a dash if the echo buffer is empty, so
8002 you don't always see a dash hanging out in the minibuffer. */
8006 /* Record the initial state of the echo area and this_command_keys;
8007 we will need to restore them if we replay a key sequence. */
8009 echo_start
= echo_length ();
8010 keys_start
= this_command_key_count
;
8011 this_single_command_key_start
= keys_start
;
8013 #if defined (GOBBLE_FIRST_EVENT)
8014 /* This doesn't quite work, because some of the things that read_char
8015 does cannot safely be bypassed. It seems too risky to try to make
8018 /* Read the first char of the sequence specially, before setting
8019 up any keymaps, in case a filter runs and switches buffers on us. */
8020 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8022 #endif /* GOBBLE_FIRST_EVENT */
8024 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8025 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8028 /* We jump here when the key sequence has been thoroughly changed, and
8029 we need to rescan it starting from the beginning. When we jump here,
8030 keybuf[0..mock_input] holds the sequence we should reread. */
8033 starting_buffer
= current_buffer
;
8034 function_key_possible
= 0;
8035 key_translation_possible
= 0;
8036 first_unbound
= bufsize
+ 1;
8038 /* Build our list of keymaps.
8039 If we recognize a function key and replace its escape sequence in
8040 keybuf with its symbol, or if the sequence starts with a mouse
8041 click and we need to switch buffers, we jump back here to rebuild
8042 the initial keymaps from the current buffer. */
8046 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8047 || !NILP (Voverriding_local_map
))
8049 if (3 > nmaps_allocated
)
8051 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8052 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8053 nmaps_allocated
= 3;
8056 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8057 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8058 if (!NILP (Voverriding_local_map
))
8059 submaps
[nmaps
++] = Voverriding_local_map
;
8064 nmaps
= current_minor_maps (0, &maps
);
8065 if (!NILP (orig_keymap
))
8067 if (nmaps
+ extra_maps
> nmaps_allocated
)
8069 submaps
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
8070 * sizeof (submaps
[0]));
8071 defs
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
8072 * sizeof (defs
[0]));
8073 nmaps_allocated
= nmaps
+ extra_maps
;
8075 bcopy (maps
, (void *) submaps
, nmaps
* sizeof (submaps
[0]));
8076 if (!NILP (orig_keymap
))
8077 submaps
[nmaps
++] = orig_keymap
;
8078 submaps
[nmaps
++] = orig_local_map
;
8080 submaps
[nmaps
++] = current_global_map
;
8083 /* Find an accurate initial value for first_binding. */
8084 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8085 if (! NILP (submaps
[first_binding
]))
8088 /* Start from the beginning in keybuf. */
8091 /* These are no-ops the first time through, but if we restart, they
8092 revert the echo area and this_command_keys to their original state. */
8093 this_command_key_count
= keys_start
;
8094 if (INTERACTIVE
&& t
< mock_input
)
8095 echo_truncate (echo_start
);
8097 /* If the best binding for the current key sequence is a keymap, or
8098 we may be looking at a function key's escape sequence, keep on
8100 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
8101 || (first_binding
>= nmaps
8103 || (first_binding
>= nmaps
8104 && keytran_start
< t
&& key_translation_possible
)
8105 /* Don't return in the middle of a possible function key sequence,
8106 if the only bindings we found were via case conversion.
8107 Thus, if ESC O a has a function-key-map translation
8108 and ESC o has a binding, don't return after ESC O,
8109 so that we can translate ESC O plus the next character. */
8113 int used_mouse_menu
= 0;
8115 /* Where the last real key started. If we need to throw away a
8116 key that has expanded into more than one element of keybuf
8117 (say, a mouse click on the mode line which is being treated
8118 as [mode-line (mouse-...)], then we backtrack to this point
8120 volatile int last_real_key_start
;
8122 /* These variables are analogous to echo_start and keys_start;
8123 while those allow us to restart the entire key sequence,
8124 echo_local_start and keys_local_start allow us to throw away
8126 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8129 if (first_unbound
< fkey_start
&& first_unbound
< keytran_start
)
8130 { /* The prefix upto first_unbound has no binding and has
8131 no translation left to do either, so we know it's unbound.
8132 If we don't stop now, we risk staying here indefinitely
8133 (if the user keeps entering fkey or keytran prefixes
8134 like C-c ESC ESC ESC ESC ...) */
8136 for (i
= first_unbound
+ 1; i
< t
; i
++)
8137 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8138 mock_input
= t
- first_unbound
- 1;
8139 fkey_end
= fkey_start
-= first_unbound
+ 1;
8140 fkey_map
= Vfunction_key_map
;
8141 keytran_end
= keytran_start
-= first_unbound
+ 1;
8142 keytran_map
= Vkey_translation_map
;
8143 goto replay_sequence
;
8147 error ("Key sequence too long");
8150 echo_local_start
= echo_length ();
8151 keys_local_start
= this_command_key_count
;
8152 local_first_binding
= first_binding
;
8155 /* These are no-ops, unless we throw away a keystroke below and
8156 jumped back up to replay_key; in that case, these restore the
8157 variables to their original state, allowing us to replay the
8159 if (INTERACTIVE
&& t
< mock_input
)
8160 echo_truncate (echo_local_start
);
8161 this_command_key_count
= keys_local_start
;
8162 first_binding
= local_first_binding
;
8164 /* By default, assume each event is "real". */
8165 last_real_key_start
= t
;
8167 /* Does mock_input indicate that we are re-reading a key sequence? */
8171 add_command_key (key
);
8172 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8173 && NILP (Fzerop (Vecho_keystrokes
)))
8177 /* If not, we should actually read a character. */
8182 KBOARD
*interrupted_kboard
= current_kboard
;
8183 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8184 if (setjmp (wrong_kboard_jmpbuf
))
8186 if (!NILP (delayed_switch_frame
))
8188 interrupted_kboard
->kbd_queue
8189 = Fcons (delayed_switch_frame
,
8190 interrupted_kboard
->kbd_queue
);
8191 delayed_switch_frame
= Qnil
;
8194 interrupted_kboard
->kbd_queue
8195 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8197 /* If the side queue is non-empty, ensure it begins with a
8198 switch-frame, so we'll replay it in the right context. */
8199 if (CONSP (interrupted_kboard
->kbd_queue
)
8200 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8201 !(EVENT_HAS_PARAMETERS (key
)
8202 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8206 XSETFRAME (frame
, interrupted_frame
);
8207 interrupted_kboard
->kbd_queue
8208 = Fcons (make_lispy_switch_frame (frame
),
8209 interrupted_kboard
->kbd_queue
);
8212 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8213 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8214 goto replay_sequence
;
8217 key
= read_char (NILP (prompt
), nmaps
,
8218 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8222 /* read_char returns t when it shows a menu and the user rejects it.
8226 unbind_to (count
, Qnil
);
8231 /* read_char returns -1 at the end of a macro.
8232 Emacs 18 handles this by returning immediately with a
8233 zero, so that's what we'll do. */
8234 if (INTEGERP (key
) && XINT (key
) == -1)
8237 /* The Microsoft C compiler can't handle the goto that
8243 /* If the current buffer has been changed from under us, the
8244 keymap may have changed, so replay the sequence. */
8248 /* Reset the current buffer from the selected window
8249 in case something changed the former and not the latter.
8250 This is to be more consistent with the behavior
8251 of the command_loop_1. */
8252 if (fix_current_buffer
)
8254 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8256 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8257 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8260 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8261 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8262 goto replay_sequence
;
8265 /* If we have a quit that was typed in another frame, and
8266 quit_throw_to_read_char switched buffers,
8267 replay to get the right keymap. */
8269 && XINT (key
) == quit_char
8270 && current_buffer
!= starting_buffer
)
8273 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8277 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8278 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8279 goto replay_sequence
;
8284 if (EVENT_HAS_PARAMETERS (key
)
8285 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8287 /* If we're at the beginning of a key sequence, and the caller
8288 says it's okay, go ahead and return this event. If we're
8289 in the midst of a key sequence, delay it until the end. */
8290 if (t
> 0 || !can_return_switch_frame
)
8292 delayed_switch_frame
= key
;
8298 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8301 /* Clicks in non-text areas get prefixed by the symbol
8302 in their CHAR-ADDRESS field. For example, a click on
8303 the mode line is prefixed by the symbol `mode-line'.
8305 Furthermore, key sequences beginning with mouse clicks
8306 are read using the keymaps of the buffer clicked on, not
8307 the current buffer. So we may have to switch the buffer
8310 When we turn one event into two events, we must make sure
8311 that neither of the two looks like the original--so that,
8312 if we replay the events, they won't be expanded again.
8313 If not for this, such reexpansion could happen either here
8314 or when user programs play with this-command-keys. */
8315 if (EVENT_HAS_PARAMETERS (key
))
8319 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8320 if (EQ (kind
, Qmouse_click
))
8322 Lisp_Object window
, posn
;
8324 window
= POSN_WINDOW (EVENT_START (key
));
8325 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8328 || (!NILP (fake_prefixed_keys
)
8329 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8331 /* We're looking a second time at an event for which
8332 we generated a fake prefix key. Set
8333 last_real_key_start appropriately. */
8335 last_real_key_start
= t
- 1;
8338 /* Key sequences beginning with mouse clicks are
8339 read using the keymaps in the buffer clicked on,
8340 not the current buffer. If we're at the
8341 beginning of a key sequence, switch buffers. */
8342 if (last_real_key_start
== 0
8344 && BUFFERP (XWINDOW (window
)->buffer
)
8345 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8347 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8351 /* Arrange to go back to the original buffer once we're
8352 done reading the key sequence. Note that we can't
8353 use save_excursion_{save,restore} here, because they
8354 save point as well as the current buffer; we don't
8355 want to save point, because redisplay may change it,
8356 to accommodate a Fset_window_start or something. We
8357 don't want to do this at the top of the function,
8358 because we may get input from a subprocess which
8359 wants to change the selected window and stuff (say,
8361 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8363 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8365 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8366 orig_local_map
= get_local_map (PT
, current_buffer
,
8368 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8369 goto replay_sequence
;
8372 /* For a mouse click, get the local text-property keymap
8373 of the place clicked on, rather than point. */
8374 if (last_real_key_start
== 0
8375 && CONSP (XCDR (key
))
8376 && ! localized_local_map
)
8378 Lisp_Object map_here
, start
, pos
;
8380 localized_local_map
= 1;
8381 start
= EVENT_START (key
);
8383 if (CONSP (start
) && CONSP (XCDR (start
)))
8385 pos
= POSN_BUFFER_POSN (start
);
8387 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8389 map_here
= get_local_map (XINT (pos
),
8390 current_buffer
, Qlocal_map
);
8391 if (!EQ (map_here
, orig_local_map
))
8393 orig_local_map
= map_here
;
8397 goto replay_sequence
;
8399 map_here
= get_local_map (XINT (pos
),
8400 current_buffer
, Qkeymap
);
8401 if (!EQ (map_here
, orig_keymap
))
8403 orig_keymap
= map_here
;
8407 goto replay_sequence
;
8413 /* Expand mode-line and scroll-bar events into two events:
8414 use posn as a fake prefix key. */
8416 && (NILP (fake_prefixed_keys
)
8417 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8419 if (t
+ 1 >= bufsize
)
8420 error ("Key sequence too long");
8423 keybuf
[t
+ 1] = key
;
8426 /* Record that a fake prefix key has been generated
8427 for KEY. Don't modify the event; this would
8428 prevent proper action when the event is pushed
8429 back tino unread-command-events. */
8430 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8432 /* If on a mode line string with a local keymap,
8433 reconsider the key sequence with that keymap. */
8434 if (CONSP (POSN_STRING (EVENT_START (key
))))
8436 Lisp_Object string
, pos
, map
, map2
;
8438 string
= POSN_STRING (EVENT_START (key
));
8439 pos
= XCDR (string
);
8440 string
= XCAR (string
);
8442 && XINT (pos
) < XSTRING (string
)->size
)
8444 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8446 orig_local_map
= map
;
8447 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8450 if (!NILP (map
) || !NILP (map2
))
8451 goto replay_sequence
;
8457 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8458 && NILP (from_string
))
8460 /* For a click on a string, i.e. overlay string or a
8461 string displayed via the `display' property,
8462 consider `local-map' and `keymap' properties of
8464 Lisp_Object string
, pos
, map
, map2
;
8466 string
= POSN_STRING (EVENT_START (key
));
8467 pos
= XCDR (string
);
8468 string
= XCAR (string
);
8470 && XINT (pos
) < XSTRING (string
)->size
)
8472 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8474 orig_local_map
= map
;
8475 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8479 if (!NILP (map
) || !NILP (map2
))
8481 from_string
= string
;
8482 goto replay_sequence
;
8487 else if (CONSP (XCDR (key
))
8488 && CONSP (EVENT_START (key
))
8489 && CONSP (XCDR (EVENT_START (key
))))
8493 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8494 /* Handle menu-bar events:
8495 insert the dummy prefix event `menu-bar'. */
8496 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8498 if (t
+ 1 >= bufsize
)
8499 error ("Key sequence too long");
8503 /* Zap the position in key, so we know that we've
8504 expanded it, and don't try to do so again. */
8505 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8506 Fcons (posn
, Qnil
));
8509 goto replay_sequence
;
8511 else if (CONSP (posn
))
8513 /* We're looking at the second event of a
8514 sequence which we expanded before. Set
8515 last_real_key_start appropriately. */
8516 if (last_real_key_start
== t
&& t
> 0)
8517 last_real_key_start
= t
- 1;
8522 /* We have finally decided that KEY is something we might want
8524 first_binding
= (follow_key (key
,
8525 nmaps
- first_binding
,
8526 submaps
+ first_binding
,
8527 defs
+ first_binding
,
8528 submaps
+ first_binding
)
8531 /* If KEY wasn't bound, we'll try some fallbacks. */
8532 if (first_binding
>= nmaps
)
8536 /* Remember the position to put an upper bound on fkey_start. */
8537 first_unbound
= min (t
, first_unbound
);
8539 head
= EVENT_HEAD (key
);
8540 if (help_char_p (head
) && t
> 0)
8542 read_key_sequence_cmd
= Vprefix_help_command
;
8544 last_nonmenu_event
= key
;
8545 /* The Microsoft C compiler can't handle the goto that
8553 Lisp_Object breakdown
;
8556 breakdown
= parse_modifiers (head
);
8557 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8558 /* Attempt to reduce an unbound mouse event to a simpler
8559 event that is bound:
8560 Drags reduce to clicks.
8561 Double-clicks reduce to clicks.
8562 Triple-clicks reduce to double-clicks, then to clicks.
8563 Down-clicks are eliminated.
8564 Double-downs reduce to downs, then are eliminated.
8565 Triple-downs reduce to double-downs, then to downs,
8566 then are eliminated. */
8567 if (modifiers
& (down_modifier
| drag_modifier
8568 | double_modifier
| triple_modifier
))
8570 while (modifiers
& (down_modifier
| drag_modifier
8571 | double_modifier
| triple_modifier
))
8573 Lisp_Object new_head
, new_click
;
8574 if (modifiers
& triple_modifier
)
8575 modifiers
^= (double_modifier
| triple_modifier
);
8576 else if (modifiers
& double_modifier
)
8577 modifiers
&= ~double_modifier
;
8578 else if (modifiers
& drag_modifier
)
8579 modifiers
&= ~drag_modifier
;
8582 /* Dispose of this `down' event by simply jumping
8583 back to replay_key, to get another event.
8585 Note that if this event came from mock input,
8586 then just jumping back to replay_key will just
8587 hand it to us again. So we have to wipe out any
8590 We could delete keybuf[t] and shift everything
8591 after that to the left by one spot, but we'd also
8592 have to fix up any variable that points into
8593 keybuf, and shifting isn't really necessary
8596 Adding prefixes for non-textual mouse clicks
8597 creates two characters of mock input, and both
8598 must be thrown away. If we're only looking at
8599 the prefix now, we can just jump back to
8600 replay_key. On the other hand, if we've already
8601 processed the prefix, and now the actual click
8602 itself is giving us trouble, then we've lost the
8603 state of the keymaps we want to backtrack to, and
8604 we need to replay the whole sequence to rebuild
8607 Beyond that, only function key expansion could
8608 create more than two keys, but that should never
8609 generate mouse events, so it's okay to zero
8610 mock_input in that case too.
8612 Isn't this just the most wonderful code ever? */
8613 if (t
== last_real_key_start
)
8620 mock_input
= last_real_key_start
;
8621 goto replay_sequence
;
8626 = apply_modifiers (modifiers
, XCAR (breakdown
));
8628 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8630 /* Look for a binding for this new key. follow_key
8631 promises that it didn't munge submaps the
8632 last time we called it, since key was unbound. */
8634 = (follow_key (new_click
,
8635 nmaps
- local_first_binding
,
8636 submaps
+ local_first_binding
,
8637 defs
+ local_first_binding
,
8638 submaps
+ local_first_binding
)
8639 + local_first_binding
);
8641 /* If that click is bound, go for it. */
8642 if (first_binding
< nmaps
)
8647 /* Otherwise, we'll leave key set to the drag event. */
8654 /* Normally, last_nonmenu_event gets the previous key we read.
8655 But when a mouse popup menu is being used,
8656 we don't update last_nonmenu_event; it continues to hold the mouse
8657 event that preceded the first level of menu. */
8658 if (!used_mouse_menu
)
8659 last_nonmenu_event
= key
;
8661 /* Record what part of this_command_keys is the current key sequence. */
8662 this_single_command_key_start
= this_command_key_count
- t
;
8664 prev_fkey_map
= fkey_map
;
8665 prev_fkey_start
= fkey_start
;
8666 prev_fkey_end
= fkey_end
;
8668 prev_keytran_map
= keytran_map
;
8669 prev_keytran_start
= keytran_start
;
8670 prev_keytran_end
= keytran_end
;
8672 /* If the sequence is unbound, see if we can hang a function key
8673 off the end of it. We only want to scan real keyboard input
8674 for function key sequences, so if mock_input says that we're
8675 re-reading old events, don't examine it. */
8676 if (first_binding
>= nmaps
8679 Lisp_Object fkey_next
;
8681 /* Continue scan from fkey_end until we find a bound suffix.
8682 If we fail, increment fkey_start
8683 and start fkey_end from there. */
8684 while (fkey_end
< t
)
8688 key
= keybuf
[fkey_end
++];
8690 = access_keymap (fkey_map
, key
, 1, 0, 1);
8692 /* Handle symbol with autoload definition. */
8693 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8694 && CONSP (XSYMBOL (fkey_next
)->function
)
8695 && EQ (XCAR (XSYMBOL (fkey_next
)->function
), Qautoload
))
8696 do_autoload (XSYMBOL (fkey_next
)->function
,
8699 /* Handle a symbol whose function definition is a keymap
8701 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8702 && (!NILP (Farrayp (XSYMBOL (fkey_next
)->function
))
8703 || KEYMAPP (XSYMBOL (fkey_next
)->function
)))
8704 fkey_next
= XSYMBOL (fkey_next
)->function
;
8706 #if 0 /* I didn't turn this on, because it might cause trouble
8707 for the mapping of return into C-m and tab into C-i. */
8708 /* Optionally don't map function keys into other things.
8709 This enables the user to redefine kp- keys easily. */
8710 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8714 /* If the function key map gives a function, not an
8715 array, then call the function with no args and use
8716 its value instead. */
8717 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8720 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8724 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8725 fkey_next
= call1 (fkey_next
, prompt
);
8727 /* If the function returned something invalid,
8728 barf--don't ignore it.
8729 (To ignore it safely, we would need to gcpro a bunch of
8730 other variables.) */
8731 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
8732 error ("Function in key-translation-map returns invalid key sequence");
8735 function_key_possible
= ! NILP (fkey_next
);
8737 /* If keybuf[fkey_start..fkey_end] is bound in the
8738 function key map and it's a suffix of the current
8739 sequence (i.e. fkey_end == t), replace it with
8740 the binding and restart with fkey_start at the end. */
8741 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
8744 int len
= XFASTINT (Flength (fkey_next
));
8746 t
= fkey_start
+ len
;
8748 error ("Key sequence too long");
8750 if (VECTORP (fkey_next
))
8751 bcopy (XVECTOR (fkey_next
)->contents
,
8752 keybuf
+ fkey_start
,
8753 (t
- fkey_start
) * sizeof (keybuf
[0]));
8754 else if (STRINGP (fkey_next
))
8758 for (i
= 0; i
< len
; i
++)
8759 XSETFASTINT (keybuf
[fkey_start
+ i
],
8760 XSTRING (fkey_next
)->data
[i
]);
8764 fkey_start
= fkey_end
= t
;
8765 fkey_map
= Vfunction_key_map
;
8767 /* Do pass the results through key-translation-map.
8768 But don't retranslate what key-translation-map
8769 has already translated. */
8770 keytran_end
= keytran_start
;
8771 keytran_map
= Vkey_translation_map
;
8773 goto replay_sequence
;
8776 fkey_map
= get_keymap (fkey_next
, 0, 1);
8778 /* If we no longer have a bound suffix, try a new positions for
8780 if (!CONSP (fkey_map
))
8782 fkey_end
= ++fkey_start
;
8783 fkey_map
= Vfunction_key_map
;
8784 function_key_possible
= 0;
8789 /* Look for this sequence in key-translation-map. */
8791 Lisp_Object keytran_next
;
8793 /* Scan from keytran_end until we find a bound suffix. */
8794 while (keytran_end
< t
)
8798 key
= keybuf
[keytran_end
++];
8800 = access_keymap (keytran_map
, key
, 1, 0, 1);
8802 /* Handle symbol with autoload definition. */
8803 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8804 && CONSP (XSYMBOL (keytran_next
)->function
)
8805 && EQ (XCAR (XSYMBOL (keytran_next
)->function
), Qautoload
))
8806 do_autoload (XSYMBOL (keytran_next
)->function
,
8809 /* Handle a symbol whose function definition is a keymap
8811 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8812 && (!NILP (Farrayp (XSYMBOL (keytran_next
)->function
))
8813 || KEYMAPP (XSYMBOL (keytran_next
)->function
)))
8814 keytran_next
= XSYMBOL (keytran_next
)->function
;
8816 /* If the key translation map gives a function, not an
8817 array, then call the function with one arg and use
8818 its value instead. */
8819 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8820 && keytran_end
== t
)
8822 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8826 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8827 keytran_next
= call1 (keytran_next
, prompt
);
8829 /* If the function returned something invalid,
8830 barf--don't ignore it.
8831 (To ignore it safely, we would need to gcpro a bunch of
8832 other variables.) */
8833 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8834 error ("Function in key-translation-map returns invalid key sequence");
8837 key_translation_possible
= ! NILP (keytran_next
);
8839 /* If keybuf[keytran_start..keytran_end] is bound in the
8840 key translation map and it's a suffix of the current
8841 sequence (i.e. keytran_end == t), replace it with
8842 the binding and restart with keytran_start at the end. */
8843 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
8844 && keytran_end
== t
)
8846 int len
= XFASTINT (Flength (keytran_next
));
8848 t
= keytran_start
+ len
;
8850 error ("Key sequence too long");
8852 if (VECTORP (keytran_next
))
8853 bcopy (XVECTOR (keytran_next
)->contents
,
8854 keybuf
+ keytran_start
,
8855 (t
- keytran_start
) * sizeof (keybuf
[0]));
8856 else if (STRINGP (keytran_next
))
8860 for (i
= 0; i
< len
; i
++)
8861 XSETFASTINT (keybuf
[keytran_start
+ i
],
8862 XSTRING (keytran_next
)->data
[i
]);
8866 keytran_start
= keytran_end
= t
;
8867 keytran_map
= Vkey_translation_map
;
8869 /* Don't pass the results of key-translation-map
8870 through function-key-map. */
8871 fkey_start
= fkey_end
= t
;
8872 fkey_map
= Vfunction_key_map
;
8874 goto replay_sequence
;
8877 keytran_map
= get_keymap (keytran_next
, 0, 1);
8879 /* If we no longer have a bound suffix, try a new positions for
8881 if (!CONSP (keytran_map
))
8883 keytran_end
= ++keytran_start
;
8884 keytran_map
= Vkey_translation_map
;
8885 key_translation_possible
= 0;
8890 /* If KEY is not defined in any of the keymaps,
8891 and cannot be part of a function key or translation,
8892 and is an upper case letter
8893 use the corresponding lower-case letter instead. */
8894 if (first_binding
== nmaps
&& ! function_key_possible
8895 && ! key_translation_possible
8897 && ((((XINT (key
) & 0x3ffff)
8898 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
8899 && UPPERCASEP (XINT (key
) & 0x3ffff))
8900 || (XINT (key
) & shift_modifier
)))
8902 Lisp_Object new_key
;
8904 original_uppercase
= key
;
8905 original_uppercase_position
= t
- 1;
8907 if (XINT (key
) & shift_modifier
)
8908 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
8910 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
8911 | (XINT (key
) & ~0x3ffff)));
8913 /* We have to do this unconditionally, regardless of whether
8914 the lower-case char is defined in the keymaps, because they
8915 might get translated through function-key-map. */
8916 keybuf
[t
- 1] = new_key
;
8919 fkey_map
= prev_fkey_map
;
8920 fkey_start
= prev_fkey_start
;
8921 fkey_end
= prev_fkey_end
;
8923 keytran_map
= prev_keytran_map
;
8924 keytran_start
= prev_keytran_start
;
8925 keytran_end
= prev_keytran_end
;
8927 goto replay_sequence
;
8929 /* If KEY is not defined in any of the keymaps,
8930 and cannot be part of a function key or translation,
8931 and is a shifted function key,
8932 use the corresponding unshifted function key instead. */
8933 if (first_binding
== nmaps
&& ! function_key_possible
8934 && ! key_translation_possible
8937 Lisp_Object breakdown
;
8940 breakdown
= parse_modifiers (key
);
8941 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8942 if (modifiers
& shift_modifier
)
8944 Lisp_Object new_key
;
8946 original_uppercase
= key
;
8947 original_uppercase_position
= t
- 1;
8949 modifiers
&= ~shift_modifier
;
8950 new_key
= apply_modifiers (modifiers
,
8953 keybuf
[t
- 1] = new_key
;
8956 fkey_map
= prev_fkey_map
;
8957 fkey_start
= prev_fkey_start
;
8958 fkey_end
= prev_fkey_end
;
8960 keytran_map
= prev_keytran_map
;
8961 keytran_start
= prev_keytran_start
;
8962 keytran_end
= prev_keytran_end
;
8964 goto replay_sequence
;
8970 read_key_sequence_cmd
= (first_binding
< nmaps
8971 ? defs
[first_binding
]
8974 unread_switch_frame
= delayed_switch_frame
;
8975 unbind_to (count
, Qnil
);
8977 /* Don't downcase the last character if the caller says don't.
8978 Don't downcase it if the result is undefined, either. */
8979 if ((dont_downcase_last
|| first_binding
>= nmaps
)
8980 && t
- 1 == original_uppercase_position
)
8981 keybuf
[t
- 1] = original_uppercase
;
8983 /* Occasionally we fabricate events, perhaps by expanding something
8984 according to function-key-map, or by adding a prefix symbol to a
8985 mouse click in the scroll bar or modeline. In this cases, return
8986 the entire generated key sequence, even if we hit an unbound
8987 prefix or a definition before the end. This means that you will
8988 be able to push back the event properly, and also means that
8989 read-key-sequence will always return a logical unit.
8992 for (; t
< mock_input
; t
++)
8994 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8995 && NILP (Fzerop (Vecho_keystrokes
)))
8996 echo_char (keybuf
[t
]);
8997 add_command_key (keybuf
[t
]);
9006 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9007 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9008 The sequence is sufficient to specify a non-prefix command in the
9009 current local and global maps.
9011 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9012 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9013 as a continuation of the previous key.
9015 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9016 convert the last event to lower case. (Normally any upper case event
9017 is converted to lower case if the original event is undefined and the lower
9018 case equivalent is defined.) A non-nil value is appropriate for reading
9019 a key sequence to be defined.
9021 A C-g typed while in this function is treated like any other character,
9022 and `quit-flag' is not set.
9024 If the key sequence starts with a mouse click, then the sequence is read
9025 using the keymaps of the buffer of the window clicked in, not the buffer
9026 of the selected window as normal.
9028 `read-key-sequence' drops unbound button-down events, since you normally
9029 only care about the click or drag events which follow them. If a drag
9030 or multi-click event is unbound, but the corresponding click event would
9031 be bound, `read-key-sequence' turns the event into a click event at the
9032 drag's starting position. This means that you don't have to distinguish
9033 between click and drag, double, or triple events unless you want to.
9035 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9036 lines separating windows, and scroll bars with imaginary keys
9037 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9039 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9040 function will process a switch-frame event if the user switches frames
9041 before typing anything. If the user switches frames in the middle of a
9042 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9043 is nil, then the event will be put off until after the current key sequence.
9045 `read-key-sequence' checks `function-key-map' for function key
9046 sequences, where they wouldn't conflict with ordinary bindings. See
9047 `function-key-map' for more details.
9049 The optional fifth argument COMMAND-LOOP, if non-nil, means
9050 that this key sequence is being read by something that will
9051 read commands one after another. It should be nil if the caller
9052 will read just one key sequence. */)
9053 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9055 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9056 Lisp_Object can_return_switch_frame
, command_loop
;
9058 Lisp_Object keybuf
[30];
9060 struct gcpro gcpro1
;
9061 int count
= specpdl_ptr
- specpdl
;
9064 CHECK_STRING (prompt
);
9067 specbind (Qinput_method_exit_on_first_char
,
9068 (NILP (command_loop
) ? Qt
: Qnil
));
9069 specbind (Qinput_method_use_echo_area
,
9070 (NILP (command_loop
) ? Qt
: Qnil
));
9072 bzero (keybuf
, sizeof keybuf
);
9074 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9076 if (NILP (continue_echo
))
9078 this_command_key_count
= 0;
9079 this_single_command_key_start
= 0;
9082 #ifdef HAVE_X_WINDOWS
9083 if (display_hourglass_p
)
9084 cancel_hourglass ();
9087 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9088 prompt
, ! NILP (dont_downcase_last
),
9089 ! NILP (can_return_switch_frame
), 0);
9091 #if 0 /* The following is fine for code reading a key sequence and
9092 then proceeding with a lenghty compuation, but it's not good
9093 for code reading keys in a loop, like an input method. */
9094 #ifdef HAVE_X_WINDOWS
9095 if (display_hourglass_p
)
9106 return unbind_to (count
, make_event_array (i
, keybuf
));
9109 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9110 Sread_key_sequence_vector
, 1, 5, 0,
9111 doc
: /* Like `read-key-sequence' but always return a vector. */)
9112 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9114 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9115 Lisp_Object can_return_switch_frame
, command_loop
;
9117 Lisp_Object keybuf
[30];
9119 struct gcpro gcpro1
;
9120 int count
= specpdl_ptr
- specpdl
;
9123 CHECK_STRING (prompt
);
9126 specbind (Qinput_method_exit_on_first_char
,
9127 (NILP (command_loop
) ? Qt
: Qnil
));
9128 specbind (Qinput_method_use_echo_area
,
9129 (NILP (command_loop
) ? Qt
: Qnil
));
9131 bzero (keybuf
, sizeof keybuf
);
9133 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9135 if (NILP (continue_echo
))
9137 this_command_key_count
= 0;
9138 this_single_command_key_start
= 0;
9141 #ifdef HAVE_X_WINDOWS
9142 if (display_hourglass_p
)
9143 cancel_hourglass ();
9146 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9147 prompt
, ! NILP (dont_downcase_last
),
9148 ! NILP (can_return_switch_frame
), 0);
9150 #ifdef HAVE_X_WINDOWS
9151 if (display_hourglass_p
)
9161 return unbind_to (count
, Fvector (i
, keybuf
));
9164 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9165 doc
: /* Execute CMD as an editor command.
9166 CMD must be a symbol that satisfies the `commandp' predicate.
9167 Optional second arg RECORD-FLAG non-nil
9168 means unconditionally put this command in `command-history'.
9169 Otherwise, that is done only if an arg is read using the minibuffer.
9170 The argument KEYS specifies the value to use instead of (this-command-keys)
9171 when reading the arguments; if it is nil, (this-command-keys) is used.
9172 The argument SPECIAL, if non-nil, means that this command is executing
9173 a special event, so ignore the prefix argument and don't clear it. */)
9174 (cmd
, record_flag
, keys
, special
)
9175 Lisp_Object cmd
, record_flag
, keys
, special
;
9177 register Lisp_Object final
;
9178 register Lisp_Object tem
;
9179 Lisp_Object prefixarg
;
9180 struct backtrace backtrace
;
9181 extern int debug_on_next_call
;
9183 debug_on_next_call
= 0;
9187 prefixarg
= current_kboard
->Vprefix_arg
;
9188 Vcurrent_prefix_arg
= prefixarg
;
9189 current_kboard
->Vprefix_arg
= Qnil
;
9196 tem
= Fget (cmd
, Qdisabled
);
9197 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9199 tem
= Fsymbol_value (Qdisabled_command_hook
);
9201 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9207 final
= Findirect_function (cmd
);
9209 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9211 struct gcpro gcpro1
, gcpro2
;
9213 GCPRO2 (cmd
, prefixarg
);
9214 do_autoload (final
, cmd
);
9221 if (STRINGP (final
) || VECTORP (final
))
9223 /* If requested, place the macro in the command history. For
9224 other sorts of commands, call-interactively takes care of
9226 if (!NILP (record_flag
))
9229 = Fcons (Fcons (Qexecute_kbd_macro
,
9230 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9233 /* Don't keep command history around forever. */
9234 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9236 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9238 XSETCDR (tem
, Qnil
);
9242 return Fexecute_kbd_macro (final
, prefixarg
);
9245 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9247 backtrace
.next
= backtrace_list
;
9248 backtrace_list
= &backtrace
;
9249 backtrace
.function
= &Qcall_interactively
;
9250 backtrace
.args
= &cmd
;
9251 backtrace
.nargs
= 1;
9252 backtrace
.evalargs
= 0;
9254 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9256 backtrace_list
= backtrace
.next
;
9264 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9266 doc
: /* Read function name, then read its arguments and call it. */)
9268 Lisp_Object prefixarg
;
9270 Lisp_Object function
;
9272 Lisp_Object saved_keys
;
9273 Lisp_Object bindings
, value
;
9274 struct gcpro gcpro1
, gcpro2
;
9276 saved_keys
= Fvector (this_command_key_count
,
9277 XVECTOR (this_command_keys
)->contents
);
9279 GCPRO2 (saved_keys
, prefixarg
);
9281 if (EQ (prefixarg
, Qminus
))
9283 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9284 strcpy (buf
, "C-u ");
9285 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9287 if (sizeof (int) == sizeof (EMACS_INT
))
9288 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9289 else if (sizeof (long) == sizeof (EMACS_INT
))
9290 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9294 else if (INTEGERP (prefixarg
))
9296 if (sizeof (int) == sizeof (EMACS_INT
))
9297 sprintf (buf
, "%d ", XINT (prefixarg
));
9298 else if (sizeof (long) == sizeof (EMACS_INT
))
9299 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9304 /* This isn't strictly correct if execute-extended-command
9305 is bound to anything else. Perhaps it should use
9306 this_command_keys? */
9307 strcat (buf
, "M-x ");
9309 /* Prompt with buf, and then read a string, completing from and
9310 restricting to the set of all defined commands. Don't provide
9311 any initial input. Save the command read on the extended-command
9313 function
= Fcompleting_read (build_string (buf
),
9314 Vobarray
, Qcommandp
,
9315 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9318 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
9319 error ("No command name given");
9321 /* Set this_command_keys to the concatenation of saved_keys and
9322 function, followed by a RET. */
9324 struct Lisp_String
*str
;
9328 this_command_key_count
= 0;
9329 this_single_command_key_start
= 0;
9331 keys
= XVECTOR (saved_keys
)->contents
;
9332 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9333 add_command_key (keys
[i
]);
9335 str
= XSTRING (function
);
9336 for (i
= 0; i
< str
->size
; i
++)
9337 add_command_key (Faref (function
, make_number (i
)));
9339 add_command_key (make_number ('\015'));
9344 function
= Fintern (function
, Qnil
);
9345 current_kboard
->Vprefix_arg
= prefixarg
;
9346 Vthis_command
= function
;
9347 real_this_command
= function
;
9349 /* If enabled, show which key runs this command. */
9350 if (!NILP (Vsuggest_key_bindings
)
9351 && NILP (Vexecuting_macro
)
9352 && SYMBOLP (function
))
9353 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9359 GCPRO2 (bindings
, value
);
9360 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9362 /* If the command has a key binding, print it now. */
9363 if (!NILP (bindings
)
9364 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9367 /* But first wait, and skip the message if there is input. */
9369 if (!NILP (echo_area_buffer
[0]))
9370 /* This command displayed something in the echo area;
9371 so wait a few seconds, then display our suggestion message. */
9372 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9373 ? XINT (Vsuggest_key_bindings
) : 2);
9375 /* This command left the echo area empty,
9376 so display our message immediately. */
9379 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9380 && ! CONSP (Vunread_command_events
))
9382 Lisp_Object binding
;
9384 int message_p
= push_message ();
9385 int count
= BINDING_STACK_SIZE ();
9387 record_unwind_protect (push_message_unwind
, Qnil
);
9388 binding
= Fkey_description (bindings
);
9391 = (char *) alloca (XSYMBOL (function
)->name
->size
9392 + STRING_BYTES (XSTRING (binding
))
9394 sprintf (newmessage
, "You can run the command `%s' with %s",
9395 XSYMBOL (function
)->name
->data
,
9396 XSTRING (binding
)->data
);
9397 message2_nolog (newmessage
,
9398 strlen (newmessage
),
9399 STRING_MULTIBYTE (binding
));
9400 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9401 ? Vsuggest_key_bindings
: make_number (2)),
9406 unbind_to (count
, Qnil
);
9410 RETURN_UNGCPRO (value
);
9413 /* Find the set of keymaps now active.
9414 Store into *MAPS_P a vector holding the various maps
9415 and return the number of them. The vector was malloc'd
9416 and the caller should free it. */
9419 current_active_maps (maps_p
)
9420 Lisp_Object
**maps_p
;
9422 Lisp_Object
*tmaps
, *maps
;
9425 /* Should overriding-terminal-local-map and overriding-local-map apply? */
9426 if (!NILP (Voverriding_local_map_menu_flag
))
9428 /* Yes, use them (if non-nil) as well as the global map. */
9429 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
9431 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9432 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9433 if (!NILP (Voverriding_local_map
))
9434 maps
[nmaps
++] = Voverriding_local_map
;
9438 /* No, so use major and minor mode keymaps and keymap property. */
9440 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
9443 nmaps
= current_minor_maps (NULL
, &tmaps
);
9444 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
9445 * sizeof (maps
[0]));
9446 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
9448 maps
[nmaps
++] = map
;
9449 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
9451 maps
[nmaps
++] = current_global_map
;
9457 /* Return nonzero if input events are pending. */
9460 detect_input_pending ()
9463 get_input_pending (&input_pending
, 0);
9465 return input_pending
;
9468 /* Return nonzero if input events are pending, and run any pending timers. */
9471 detect_input_pending_run_timers (do_display
)
9474 int old_timers_run
= timers_run
;
9477 get_input_pending (&input_pending
, 1);
9479 if (old_timers_run
!= timers_run
&& do_display
)
9481 redisplay_preserve_echo_area (8);
9482 /* The following fixes a bug when using lazy-lock with
9483 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9484 from an idle timer function. The symptom of the bug is that
9485 the cursor sometimes doesn't become visible until the next X
9486 event is processed. --gerd. */
9488 rif
->flush_display (NULL
);
9491 return input_pending
;
9494 /* This is called in some cases before a possible quit.
9495 It cases the next call to detect_input_pending to recompute input_pending.
9496 So calling this function unnecessarily can't do any harm. */
9499 clear_input_pending ()
9504 /* Return nonzero if there are pending requeued events.
9505 This isn't used yet. The hope is to make wait_reading_process_input
9506 call it, and return return if it runs Lisp code that unreads something.
9507 The problem is, kbd_buffer_get_event needs to be fixed to know what
9508 to do in that case. It isn't trivial. */
9511 requeued_events_pending_p ()
9513 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9517 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9518 doc
: /* Return t if command input is currently available with no wait.
9519 Actually, the value is nil only if we can be sure that no input is available;
9520 if there is a doubt, the value is t. */)
9523 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9526 get_input_pending (&input_pending
, 1);
9527 return input_pending
> 0 ? Qt
: Qnil
;
9530 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9531 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9534 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9537 if (total_keys
< NUM_RECENT_KEYS
)
9538 return Fvector (total_keys
, keys
);
9541 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9542 bcopy (keys
+ recent_keys_index
,
9543 XVECTOR (val
)->contents
,
9544 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9546 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9547 recent_keys_index
* sizeof (Lisp_Object
));
9552 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9553 doc
: /* Return the key sequence that invoked this command.
9554 The value is a string or a vector. */)
9557 return make_event_array (this_command_key_count
,
9558 XVECTOR (this_command_keys
)->contents
);
9561 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9562 doc
: /* Return the key sequence that invoked this command, as a vector. */)
9565 return Fvector (this_command_key_count
,
9566 XVECTOR (this_command_keys
)->contents
);
9569 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9570 Sthis_single_command_keys
, 0, 0, 0,
9571 doc
: /* Return the key sequence that invoked this command.
9572 Unlike `this-command-keys', this function's value
9573 does not include prefix arguments.
9574 The value is always a vector. */)
9577 return Fvector (this_command_key_count
9578 - this_single_command_key_start
,
9579 (XVECTOR (this_command_keys
)->contents
9580 + this_single_command_key_start
));
9583 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9584 Sthis_single_command_raw_keys
, 0, 0, 0,
9585 doc
: /* Return the raw events that were read for this command.
9586 Unlike `this-single-command-keys', this function's value
9587 shows the events before all translations (except for input methods).
9588 The value is always a vector. */)
9591 return Fvector (raw_keybuf_count
,
9592 (XVECTOR (raw_keybuf
)->contents
));
9595 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9596 Sreset_this_command_lengths
, 0, 0, 0,
9597 doc
: /* Used for complicated reasons in `universal-argument-other-key'.
9599 `universal-argument-other-key' rereads the event just typed.
9600 It then gets translated through `function-key-map'.
9601 The translated event gets included in the echo area and in
9602 the value of `this-command-keys' in addition to the raw original event.
9605 Calling this function directs the translated event to replace
9606 the original event, so that only one version of the event actually
9607 appears in the echo area and in the value of `this-command-keys'. */)
9610 before_command_restore_flag
= 1;
9611 before_command_key_count_1
= before_command_key_count
;
9612 before_command_echo_length_1
= before_command_echo_length
;
9616 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9617 Sclear_this_command_keys
, 0, 0, 0,
9618 doc
: /* Clear out the vector that `this-command-keys' returns.
9619 Clear vector containing last 100 events. */)
9624 this_command_key_count
= 0;
9626 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9627 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9629 recent_keys_index
= 0;
9633 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9634 doc
: /* Return the current depth in recursive edits. */)
9638 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9642 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9643 "FOpen dribble file: ",
9644 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9645 If FILE is nil, close any open dribble file. */)
9656 file
= Fexpand_file_name (file
, Qnil
);
9657 dribble
= fopen (XSTRING (file
)->data
, "w");
9659 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9664 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9665 doc
: /* Discard the contents of the terminal input buffer.
9666 Also cancel any kbd macro being defined. */)
9669 current_kboard
->defining_kbd_macro
= Qnil
;
9670 update_mode_lines
++;
9672 Vunread_command_events
= Qnil
;
9673 unread_command_char
= -1;
9675 discard_tty_input ();
9677 kbd_fetch_ptr
= kbd_store_ptr
;
9678 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9684 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9685 doc
: /* Stop Emacs and return to superior process. You can resume later.
9686 If `cannot-suspend' is non-nil, or if the system doesn't support job
9687 control, run a subshell instead.
9689 If optional arg STUFFSTRING is non-nil, its characters are stuffed
9690 to be read as terminal input by Emacs's parent, after suspension.
9692 Before suspending, run the normal hook `suspend-hook'.
9693 After resumption run the normal hook `suspend-resume-hook'.
9695 Some operating systems cannot stop the Emacs process and resume it later.
9696 On such systems, Emacs starts a subshell instead of suspending. */)
9698 Lisp_Object stuffstring
;
9700 int count
= specpdl_ptr
- specpdl
;
9701 int old_height
, old_width
;
9703 struct gcpro gcpro1
;
9705 if (!NILP (stuffstring
))
9706 CHECK_STRING (stuffstring
);
9708 /* Run the functions in suspend-hook. */
9709 if (!NILP (Vrun_hooks
))
9710 call1 (Vrun_hooks
, intern ("suspend-hook"));
9712 GCPRO1 (stuffstring
);
9713 get_frame_size (&old_width
, &old_height
);
9715 /* sys_suspend can get an error if it tries to fork a subshell
9716 and the system resources aren't available for that. */
9717 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9719 stuff_buffered_input (stuffstring
);
9724 unbind_to (count
, Qnil
);
9726 /* Check if terminal/window size has changed.
9727 Note that this is not useful when we are running directly
9728 with a window system; but suspend should be disabled in that case. */
9729 get_frame_size (&width
, &height
);
9730 if (width
!= old_width
|| height
!= old_height
)
9731 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9733 /* Run suspend-resume-hook. */
9734 if (!NILP (Vrun_hooks
))
9735 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9741 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9742 Then in any case stuff anything Emacs has read ahead and not used. */
9745 stuff_buffered_input (stuffstring
)
9746 Lisp_Object stuffstring
;
9748 /* stuff_char works only in BSD, versions 4.2 and up. */
9751 register unsigned char *p
;
9753 if (STRINGP (stuffstring
))
9757 p
= XSTRING (stuffstring
)->data
;
9758 count
= STRING_BYTES (XSTRING (stuffstring
));
9764 /* Anything we have read ahead, put back for the shell to read. */
9765 /* ?? What should this do when we have multiple keyboards??
9766 Should we ignore anything that was typed in at the "wrong" kboard? */
9767 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9771 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9772 kbd_fetch_ptr
= kbd_buffer
;
9773 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
9774 stuff_char (kbd_fetch_ptr
->code
);
9776 kbd_fetch_ptr
->kind
= no_event
;
9777 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
9778 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
9779 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
9784 #endif /* BSD_SYSTEM and not BSD4_1 */
9788 set_waiting_for_input (time_to_clear
)
9789 EMACS_TIME
*time_to_clear
;
9791 input_available_clear_time
= time_to_clear
;
9793 /* Tell interrupt_signal to throw back to read_char, */
9794 waiting_for_input
= 1;
9796 /* If interrupt_signal was called before and buffered a C-g,
9797 make it run again now, to avoid timing error. */
9798 if (!NILP (Vquit_flag
))
9799 quit_throw_to_read_char ();
9803 clear_waiting_for_input ()
9805 /* Tell interrupt_signal not to throw back to read_char, */
9806 waiting_for_input
= 0;
9807 input_available_clear_time
= 0;
9810 /* This routine is called at interrupt level in response to C-G.
9812 If interrupt_input, this is the handler for SIGINT. Otherwise, it
9813 is called from kbd_buffer_store_event, in handling SIGIO or
9816 If `waiting_for_input' is non zero, then unless `echoing' is
9817 nonzero, immediately throw back to read_char.
9819 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
9820 eval to throw, when it gets a chance. If quit-flag is already
9821 non-nil, it stops the job right away. */
9824 interrupt_signal (signalnum
) /* If we don't have an argument, */
9825 int signalnum
; /* some compilers complain in signal calls. */
9828 /* Must preserve main program's value of errno. */
9829 int old_errno
= errno
;
9830 struct frame
*sf
= SELECTED_FRAME ();
9832 #if defined (USG) && !defined (POSIX_SIGNALS)
9833 if (!read_socket_hook
&& NILP (Vwindow_system
))
9835 /* USG systems forget handlers when they are used;
9836 must reestablish each time */
9837 signal (SIGINT
, interrupt_signal
);
9838 signal (SIGQUIT
, interrupt_signal
);
9844 if (!NILP (Vquit_flag
)
9845 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
9847 /* If SIGINT isn't blocked, don't let us be interrupted by
9848 another SIGINT, it might be harmful due to non-reentrancy
9849 in I/O functions. */
9850 sigblock (sigmask (SIGINT
));
9855 #ifdef SIGTSTP /* Support possible in later USG versions */
9857 * On systems which can suspend the current process and return to the original
9858 * shell, this command causes the user to end up back at the shell.
9859 * The "Auto-save" and "Abort" questions are not asked until
9860 * the user elects to return to emacs, at which point he can save the current
9861 * job and either dump core or continue.
9866 if (sys_suspend () == -1)
9868 printf ("Not running as a subprocess;\n");
9869 printf ("you can continue or abort.\n");
9872 /* Perhaps should really fork an inferior shell?
9873 But that would not provide any way to get back
9874 to the original shell, ever. */
9875 printf ("No support for stopping a process on this operating system;\n");
9876 printf ("you can continue or abort.\n");
9877 #endif /* not VMS */
9878 #endif /* not SIGTSTP */
9880 /* We must remain inside the screen area when the internal terminal
9881 is used. Note that [Enter] is not echoed by dos. */
9884 /* It doesn't work to autosave while GC is in progress;
9885 the code used for auto-saving doesn't cope with the mark bit. */
9886 if (!gc_in_progress
)
9888 printf ("Auto-save? (y or n) ");
9890 if (((c
= getchar ()) & ~040) == 'Y')
9892 Fdo_auto_save (Qt
, Qnil
);
9894 printf ("\r\nAuto-save done");
9895 #else /* not MSDOS */
9896 printf ("Auto-save done\n");
9897 #endif /* not MSDOS */
9899 while (c
!= '\n') c
= getchar ();
9903 /* During GC, it must be safe to reenable quitting again. */
9904 Vinhibit_quit
= Qnil
;
9907 #endif /* not MSDOS */
9908 printf ("Garbage collection in progress; cannot auto-save now\r\n");
9909 printf ("but will instead do a real quit after garbage collection ends\r\n");
9914 printf ("\r\nAbort? (y or n) ");
9915 #else /* not MSDOS */
9917 printf ("Abort (and enter debugger)? (y or n) ");
9919 printf ("Abort (and dump core)? (y or n) ");
9920 #endif /* not VMS */
9921 #endif /* not MSDOS */
9923 if (((c
= getchar ()) & ~040) == 'Y')
9925 while (c
!= '\n') c
= getchar ();
9927 printf ("\r\nContinuing...\r\n");
9928 #else /* not MSDOS */
9929 printf ("Continuing...\n");
9930 #endif /* not MSDOS */
9937 /* If executing a function that wants to be interrupted out of
9938 and the user has not deferred quitting by binding `inhibit-quit'
9939 then quit right away. */
9940 if (immediate_quit
&& NILP (Vinhibit_quit
))
9942 struct gl_state_s saved
;
9943 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9948 GCPRO4 (saved
.object
, saved
.global_code
,
9949 saved
.current_syntax_table
, saved
.old_prop
);
9950 Fsignal (Qquit
, Qnil
);
9955 /* Else request quit when it's safe */
9959 if (waiting_for_input
&& !echoing
)
9960 quit_throw_to_read_char ();
9965 /* Handle a C-g by making read_char return C-g. */
9968 quit_throw_to_read_char ()
9971 /* Prevent another signal from doing this before we finish. */
9972 clear_waiting_for_input ();
9975 Vunread_command_events
= Qnil
;
9976 unread_command_char
= -1;
9978 #if 0 /* Currently, sit_for is called from read_char without turning
9979 off polling. And that can call set_waiting_for_input.
9980 It seems to be harmless. */
9981 #ifdef POLL_FOR_INPUT
9982 /* May be > 1 if in recursive minibuffer. */
9983 if (poll_suppress_count
== 0)
9987 if (FRAMEP (internal_last_event_frame
)
9988 && !EQ (internal_last_event_frame
, selected_frame
))
9989 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
9992 _longjmp (getcjmp
, 1);
9995 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
9996 doc
: /* Set mode of reading keyboard input.
9997 First arg INTERRUPT non-nil means use input interrupts;
9998 nil means use CBREAK mode.
9999 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10000 (no effect except in CBREAK mode).
10001 Third arg META t means accept 8-bit input (for a Meta key).
10002 META nil means ignore the top bit, on the assumption it is parity.
10003 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10004 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10005 See also `current-input-mode'. */)
10006 (interrupt
, flow
, meta
, quit
)
10007 Lisp_Object interrupt
, flow
, meta
, quit
;
10010 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10011 error ("set-input-mode: QUIT must be an ASCII character");
10013 #ifdef POLL_FOR_INPUT
10018 /* this causes startup screen to be restored and messes with the mouse */
10019 reset_sys_modes ();
10023 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10024 if (read_socket_hook
)
10026 /* When using X, don't give the user a real choice,
10027 because we haven't implemented the mechanisms to support it. */
10028 #ifdef NO_SOCK_SIGIO
10029 interrupt_input
= 0;
10030 #else /* not NO_SOCK_SIGIO */
10031 interrupt_input
= 1;
10032 #endif /* NO_SOCK_SIGIO */
10035 interrupt_input
= !NILP (interrupt
);
10036 #else /* not SIGIO */
10037 interrupt_input
= 0;
10038 #endif /* not SIGIO */
10040 /* Our VMS input only works by interrupts, as of now. */
10042 interrupt_input
= 1;
10045 flow_control
= !NILP (flow
);
10048 else if (EQ (meta
, Qt
))
10053 /* Don't let this value be out of range. */
10054 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10060 #ifdef POLL_FOR_INPUT
10061 poll_suppress_count
= 1;
10067 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10068 doc
: /* Return information about the way Emacs currently reads keyboard input.
10069 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10070 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10071 nil, Emacs is using CBREAK mode.
10072 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10073 terminal; this does not apply if Emacs uses interrupt-driven input.
10074 META is t if accepting 8-bit input with 8th bit as Meta flag.
10075 META nil means ignoring the top bit, on the assumption it is parity.
10076 META is neither t nor nil if accepting 8-bit input and using
10077 all 8 bits as the character code.
10078 QUIT is the character Emacs currently uses to quit.
10079 The elements of this list correspond to the arguments of
10080 `set-input-mode'. */)
10083 Lisp_Object val
[4];
10085 val
[0] = interrupt_input
? Qt
: Qnil
;
10086 val
[1] = flow_control
? Qt
: Qnil
;
10087 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10088 XSETFASTINT (val
[3], quit_char
);
10090 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10095 * Set up a new kboard object with reasonable initial values.
10101 kb
->Voverriding_terminal_local_map
= Qnil
;
10102 kb
->Vlast_command
= Qnil
;
10103 kb
->Vreal_last_command
= Qnil
;
10104 kb
->Vprefix_arg
= Qnil
;
10105 kb
->Vlast_prefix_arg
= Qnil
;
10106 kb
->kbd_queue
= Qnil
;
10107 kb
->kbd_queue_has_data
= 0;
10108 kb
->immediate_echo
= 0;
10109 kb
->echoptr
= kb
->echobuf
;
10110 kb
->echo_after_prompt
= -1;
10111 kb
->kbd_macro_buffer
= 0;
10112 kb
->kbd_macro_bufsize
= 0;
10113 kb
->defining_kbd_macro
= Qnil
;
10114 kb
->Vlast_kbd_macro
= Qnil
;
10115 kb
->reference_count
= 0;
10116 kb
->Vsystem_key_alist
= Qnil
;
10117 kb
->system_key_syms
= Qnil
;
10118 kb
->Vdefault_minibuffer_frame
= Qnil
;
10122 * Destroy the contents of a kboard object, but not the object itself.
10123 * We use this just before deleting it, or if we're going to initialize
10124 * it a second time.
10130 if (kb
->kbd_macro_buffer
)
10131 xfree (kb
->kbd_macro_buffer
);
10134 #ifdef MULTI_KBOARD
10136 /* Free KB and memory referenced from it. */
10144 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10147 *kbp
= kb
->next_kboard
;
10149 /* Prevent a dangling reference to KB. */
10150 if (kb
== current_kboard
10151 && FRAMEP (selected_frame
)
10152 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10154 current_kboard
= XFRAME (selected_frame
)->kboard
;
10155 if (current_kboard
== kb
)
10163 #endif /* MULTI_KBOARD */
10168 /* This is correct before outermost invocation of the editor loop */
10169 command_loop_level
= -1;
10170 immediate_quit
= 0;
10171 quit_char
= Ctl ('g');
10172 Vunread_command_events
= Qnil
;
10173 unread_command_char
= -1;
10174 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10176 recent_keys_index
= 0;
10177 kbd_fetch_ptr
= kbd_buffer
;
10178 kbd_store_ptr
= kbd_buffer
;
10179 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10181 do_mouse_tracking
= Qnil
;
10185 /* This means that command_loop_1 won't try to select anything the first
10187 internal_last_event_frame
= Qnil
;
10188 Vlast_event_frame
= internal_last_event_frame
;
10190 #ifdef MULTI_KBOARD
10191 current_kboard
= initial_kboard
;
10193 wipe_kboard (current_kboard
);
10194 init_kboard (current_kboard
);
10196 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10198 signal (SIGINT
, interrupt_signal
);
10199 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10200 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10201 SIGQUIT and we can't tell which one it will give us. */
10202 signal (SIGQUIT
, interrupt_signal
);
10203 #endif /* HAVE_TERMIO */
10205 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10207 if (!noninteractive
)
10208 signal (SIGIO
, input_available_signal
);
10211 /* Use interrupt input by default, if it works and noninterrupt input
10212 has deficiencies. */
10214 #ifdef INTERRUPT_INPUT
10215 interrupt_input
= 1;
10217 interrupt_input
= 0;
10220 /* Our VMS input only works by interrupts, as of now. */
10222 interrupt_input
= 1;
10228 if (keyboard_init_hook
)
10229 (*keyboard_init_hook
) ();
10231 #ifdef POLL_FOR_INPUT
10232 poll_suppress_count
= 1;
10237 /* This type's only use is in syms_of_keyboard, to initialize the
10238 event header symbols and put properties on them. */
10239 struct event_head
{
10245 struct event_head head_table
[] = {
10246 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
10247 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
10248 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
10249 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
10250 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
10251 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
10255 syms_of_keyboard ()
10257 Vpre_help_message
= Qnil
;
10258 staticpro (&Vpre_help_message
);
10260 Vlispy_mouse_stem
= build_string ("mouse");
10261 staticpro (&Vlispy_mouse_stem
);
10264 QCimage
= intern (":image");
10265 staticpro (&QCimage
);
10267 staticpro (&Qhelp_echo
);
10268 Qhelp_echo
= intern ("help-echo");
10270 staticpro (&item_properties
);
10271 item_properties
= Qnil
;
10273 staticpro (&tool_bar_item_properties
);
10274 tool_bar_item_properties
= Qnil
;
10275 staticpro (&tool_bar_items_vector
);
10276 tool_bar_items_vector
= Qnil
;
10278 staticpro (&real_this_command
);
10279 real_this_command
= Qnil
;
10281 Qtimer_event_handler
= intern ("timer-event-handler");
10282 staticpro (&Qtimer_event_handler
);
10284 Qdisabled_command_hook
= intern ("disabled-command-hook");
10285 staticpro (&Qdisabled_command_hook
);
10287 Qself_insert_command
= intern ("self-insert-command");
10288 staticpro (&Qself_insert_command
);
10290 Qforward_char
= intern ("forward-char");
10291 staticpro (&Qforward_char
);
10293 Qbackward_char
= intern ("backward-char");
10294 staticpro (&Qbackward_char
);
10296 Qdisabled
= intern ("disabled");
10297 staticpro (&Qdisabled
);
10299 Qundefined
= intern ("undefined");
10300 staticpro (&Qundefined
);
10302 Qpre_command_hook
= intern ("pre-command-hook");
10303 staticpro (&Qpre_command_hook
);
10305 Qpost_command_hook
= intern ("post-command-hook");
10306 staticpro (&Qpost_command_hook
);
10308 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10309 staticpro (&Qpost_command_idle_hook
);
10311 Qdeferred_action_function
= intern ("deferred-action-function");
10312 staticpro (&Qdeferred_action_function
);
10314 Qcommand_hook_internal
= intern ("command-hook-internal");
10315 staticpro (&Qcommand_hook_internal
);
10317 Qfunction_key
= intern ("function-key");
10318 staticpro (&Qfunction_key
);
10319 Qmouse_click
= intern ("mouse-click");
10320 staticpro (&Qmouse_click
);
10322 Qmouse_wheel
= intern ("mouse-wheel");
10323 staticpro (&Qmouse_wheel
);
10324 Qlanguage_change
= intern ("language-change");
10325 staticpro (&Qlanguage_change
);
10327 Qdrag_n_drop
= intern ("drag-n-drop");
10328 staticpro (&Qdrag_n_drop
);
10330 Qusr1_signal
= intern ("usr1-signal");
10331 staticpro (&Qusr1_signal
);
10332 Qusr2_signal
= intern ("usr2-signal");
10333 staticpro (&Qusr2_signal
);
10335 Qmenu_enable
= intern ("menu-enable");
10336 staticpro (&Qmenu_enable
);
10337 Qmenu_alias
= intern ("menu-alias");
10338 staticpro (&Qmenu_alias
);
10339 QCenable
= intern (":enable");
10340 staticpro (&QCenable
);
10341 QCvisible
= intern (":visible");
10342 staticpro (&QCvisible
);
10343 QChelp
= intern (":help");
10344 staticpro (&QChelp
);
10345 QCfilter
= intern (":filter");
10346 staticpro (&QCfilter
);
10347 QCbutton
= intern (":button");
10348 staticpro (&QCbutton
);
10349 QCkeys
= intern (":keys");
10350 staticpro (&QCkeys
);
10351 QCkey_sequence
= intern (":key-sequence");
10352 staticpro (&QCkey_sequence
);
10353 QCtoggle
= intern (":toggle");
10354 staticpro (&QCtoggle
);
10355 QCradio
= intern (":radio");
10356 staticpro (&QCradio
);
10358 Qmode_line
= intern ("mode-line");
10359 staticpro (&Qmode_line
);
10360 Qvertical_line
= intern ("vertical-line");
10361 staticpro (&Qvertical_line
);
10362 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10363 staticpro (&Qvertical_scroll_bar
);
10364 Qmenu_bar
= intern ("menu-bar");
10365 staticpro (&Qmenu_bar
);
10367 Qabove_handle
= intern ("above-handle");
10368 staticpro (&Qabove_handle
);
10369 Qhandle
= intern ("handle");
10370 staticpro (&Qhandle
);
10371 Qbelow_handle
= intern ("below-handle");
10372 staticpro (&Qbelow_handle
);
10373 Qup
= intern ("up");
10375 Qdown
= intern ("down");
10376 staticpro (&Qdown
);
10377 Qtop
= intern ("top");
10379 Qbottom
= intern ("bottom");
10380 staticpro (&Qbottom
);
10381 Qend_scroll
= intern ("end-scroll");
10382 staticpro (&Qend_scroll
);
10383 Qratio
= intern ("ratio");
10384 staticpro (&Qratio
);
10386 Qevent_kind
= intern ("event-kind");
10387 staticpro (&Qevent_kind
);
10388 Qevent_symbol_elements
= intern ("event-symbol-elements");
10389 staticpro (&Qevent_symbol_elements
);
10390 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10391 staticpro (&Qevent_symbol_element_mask
);
10392 Qmodifier_cache
= intern ("modifier-cache");
10393 staticpro (&Qmodifier_cache
);
10395 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10396 staticpro (&Qrecompute_lucid_menubar
);
10397 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10398 staticpro (&Qactivate_menubar_hook
);
10400 Qpolling_period
= intern ("polling-period");
10401 staticpro (&Qpolling_period
);
10403 Qinput_method_function
= intern ("input-method-function");
10404 staticpro (&Qinput_method_function
);
10406 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10407 staticpro (&Qinput_method_exit_on_first_char
);
10408 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10409 staticpro (&Qinput_method_use_echo_area
);
10411 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10412 Fset (Qinput_method_use_echo_area
, Qnil
);
10414 last_point_position_buffer
= Qnil
;
10417 struct event_head
*p
;
10419 for (p
= head_table
;
10420 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10423 *p
->var
= intern (p
->name
);
10424 staticpro (p
->var
);
10425 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10426 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10430 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10431 staticpro (&button_down_location
);
10432 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10433 staticpro (&mouse_syms
);
10437 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10439 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10440 for (i
= 0; i
< len
; i
++)
10441 if (modifier_names
[i
])
10442 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10443 staticpro (&modifier_symbols
);
10446 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10447 staticpro (&recent_keys
);
10449 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10450 staticpro (&this_command_keys
);
10452 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10453 staticpro (&raw_keybuf
);
10455 Qextended_command_history
= intern ("extended-command-history");
10456 Fset (Qextended_command_history
, Qnil
);
10457 staticpro (&Qextended_command_history
);
10459 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10460 staticpro (&kbd_buffer_gcpro
);
10462 accent_key_syms
= Qnil
;
10463 staticpro (&accent_key_syms
);
10465 func_key_syms
= Qnil
;
10466 staticpro (&func_key_syms
);
10469 mouse_wheel_syms
= Qnil
;
10470 staticpro (&mouse_wheel_syms
);
10472 drag_n_drop_syms
= Qnil
;
10473 staticpro (&drag_n_drop_syms
);
10476 unread_switch_frame
= Qnil
;
10477 staticpro (&unread_switch_frame
);
10479 internal_last_event_frame
= Qnil
;
10480 staticpro (&internal_last_event_frame
);
10482 read_key_sequence_cmd
= Qnil
;
10483 staticpro (&read_key_sequence_cmd
);
10485 menu_bar_one_keymap_changed_items
= Qnil
;
10486 staticpro (&menu_bar_one_keymap_changed_items
);
10488 defsubr (&Sevent_convert_list
);
10489 defsubr (&Sread_key_sequence
);
10490 defsubr (&Sread_key_sequence_vector
);
10491 defsubr (&Srecursive_edit
);
10493 defsubr (&Strack_mouse
);
10495 defsubr (&Sinput_pending_p
);
10496 defsubr (&Scommand_execute
);
10497 defsubr (&Srecent_keys
);
10498 defsubr (&Sthis_command_keys
);
10499 defsubr (&Sthis_command_keys_vector
);
10500 defsubr (&Sthis_single_command_keys
);
10501 defsubr (&Sthis_single_command_raw_keys
);
10502 defsubr (&Sreset_this_command_lengths
);
10503 defsubr (&Sclear_this_command_keys
);
10504 defsubr (&Ssuspend_emacs
);
10505 defsubr (&Sabort_recursive_edit
);
10506 defsubr (&Sexit_recursive_edit
);
10507 defsubr (&Srecursion_depth
);
10508 defsubr (&Stop_level
);
10509 defsubr (&Sdiscard_input
);
10510 defsubr (&Sopen_dribble_file
);
10511 defsubr (&Sset_input_mode
);
10512 defsubr (&Scurrent_input_mode
);
10513 defsubr (&Sexecute_extended_command
);
10515 DEFVAR_LISP ("last-command-char", &last_command_char
,
10516 doc
: /* Last input event that was part of a command. */);
10518 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10519 doc
: /* Last input event that was part of a command. */);
10521 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10522 doc
: /* Last input event in a command, except for mouse menu events.
10523 Mouse menus give back keys that don't look like mouse events;
10524 this variable holds the actual mouse event that led to the menu,
10525 so that you can determine whether the command was run by mouse or not. */);
10527 DEFVAR_LISP ("last-input-char", &last_input_char
,
10528 doc
: /* Last input event. */);
10530 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10531 doc
: /* Last input event. */);
10533 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10534 doc
: /* List of events to be read as the command input.
10535 These events are processed first, before actual keyboard input. */);
10536 Vunread_command_events
= Qnil
;
10538 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10539 doc
: /* If not -1, an object to be read as next command input event. */);
10541 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10542 doc
: /* List of events to be processed as input by input methods.
10543 These events are processed after `unread-command-events', but
10544 before actual keyboard input. */);
10545 Vunread_post_input_method_events
= Qnil
;
10547 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10548 doc
: /* List of events to be processed as input by input methods.
10549 These events are processed after `unread-command-events', but
10550 before actual keyboard input. */);
10551 Vunread_input_method_events
= Qnil
;
10553 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10554 doc
: /* Meta-prefix character code.
10555 Meta-foo as command input turns into this character followed by foo. */);
10556 XSETINT (meta_prefix_char
, 033);
10558 DEFVAR_KBOARD ("last-command", Vlast_command
,
10559 doc
: /* The last command executed.
10560 Normally a symbol with a function definition, but can be whatever was found
10561 in the keymap, or whatever the variable `this-command' was set to by that
10564 The value `mode-exit' is special; it means that the previous command
10565 read an event that told it to exit, and it did so and unread that event.
10566 In other words, the present command is the event that made the previous
10569 The value `kill-region' is special; it means that the previous command
10570 was a kill command. */);
10572 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10573 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10575 DEFVAR_LISP ("this-command", &Vthis_command
,
10576 doc
: /* The command now being executed.
10577 The command can set this variable; whatever is put here
10578 will be in `last-command' during the following command. */);
10579 Vthis_command
= Qnil
;
10581 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10582 doc
: /* *Number of input events between auto-saves.
10583 Zero means disable autosaving due to number of characters typed. */);
10584 auto_save_interval
= 300;
10586 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10587 doc
: /* *Number of seconds idle time before auto-save.
10588 Zero or nil means disable auto-saving due to idleness.
10589 After auto-saving due to this many seconds of idle time,
10590 Emacs also does a garbage collection if that seems to be warranted. */);
10591 XSETFASTINT (Vauto_save_timeout
, 30);
10593 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10594 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10595 The value may be integer or floating point. */);
10596 Vecho_keystrokes
= make_number (1);
10598 DEFVAR_INT ("polling-period", &polling_period
,
10599 doc
: /* *Interval between polling for input during Lisp execution.
10600 The reason for polling is to make C-g work to stop a running program.
10601 Polling is needed only when using X windows and SIGIO does not work.
10602 Polling is automatically disabled in all other cases. */);
10603 polling_period
= 2;
10605 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10606 doc
: /* *Maximum time between mouse clicks to make a double-click.
10607 Measured in milliseconds. nil means disable double-click recognition;
10608 t means double-clicks have no time limit and are detected
10609 by position only. */);
10610 Vdouble_click_time
= make_number (500);
10612 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10613 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10614 On window-system frames, value is the number of pixels the mouse may have
10615 moved horizontally or vertically between two clicks to make a double-click.
10616 On non window-system frames, value is interpreted in units of 1/8 characters
10617 instead of pixels. */);
10618 double_click_fuzz
= 3;
10620 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10621 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10622 inhibit_local_menu_bar_menus
= 0;
10624 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10625 doc
: /* Number of complete key sequences read as input so far.
10626 This includes key sequences read from keyboard macros.
10627 The number is effectively the number of interactive command invocations. */);
10628 num_input_keys
= 0;
10630 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10631 doc
: /* Number of input events read from the keyboard so far.
10632 This does not include events generated by keyboard macros. */);
10633 num_nonmacro_input_events
= 0;
10635 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10636 doc
: /* The frame in which the most recently read event occurred.
10637 If the last event came from a keyboard macro, this is set to `macro'. */);
10638 Vlast_event_frame
= Qnil
;
10640 /* This variable is set up in sysdep.c. */
10641 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10642 doc
: /* The ERASE character as set by the user with stty. */);
10644 DEFVAR_LISP ("help-char", &Vhelp_char
,
10645 doc
: /* Character to recognize as meaning Help.
10646 When it is read, do `(eval help-form)', and display result if it's a string.
10647 If the value of `help-form' is nil, this char can be read normally. */);
10648 XSETINT (Vhelp_char
, Ctl ('H'));
10650 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10651 doc
: /* List of input events to recognize as meaning Help.
10652 These work just like the value of `help-char' (see that). */);
10653 Vhelp_event_list
= Qnil
;
10655 DEFVAR_LISP ("help-form", &Vhelp_form
,
10656 doc
: /* Form to execute when character `help-char' is read.
10657 If the form returns a string, that string is displayed.
10658 If `help-form' is nil, the help char is not recognized. */);
10661 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10662 doc
: /* Command to run when `help-char' character follows a prefix key.
10663 This command is used only when there is no actual binding
10664 for that character after that prefix key. */);
10665 Vprefix_help_command
= Qnil
;
10667 DEFVAR_LISP ("top-level", &Vtop_level
,
10668 doc
: /* Form to evaluate when Emacs starts up.
10669 Useful to set before you dump a modified Emacs. */);
10672 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10673 doc
: /* Translate table for keyboard input, or nil.
10674 Each character is looked up in this string and the contents used instead.
10675 The value may be a string, a vector, or a char-table.
10676 If it is a string or vector of length N,
10677 character codes N and up are untranslated.
10678 In a vector or a char-table, an element which is nil means "no translation". */);
10679 Vkeyboard_translate_table
= Qnil
;
10681 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10682 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
10683 \(Even if the operating system has support for stopping a process.\) */);
10684 cannot_suspend
= 0;
10686 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10687 doc
: /* Non-nil means prompt with menus when appropriate.
10688 This is done when reading from a keymap that has a prompt string,
10689 for elements that have prompt strings.
10690 The menu is displayed on the screen
10691 if X menus were enabled at configuration
10692 time and the previous event was a mouse click prefix key.
10693 Otherwise, menu prompting uses the echo area. */);
10694 menu_prompting
= 1;
10696 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10697 doc
: /* Character to see next line of menu prompt.
10698 Type this character while in a menu prompt to rotate around the lines of it. */);
10699 XSETINT (menu_prompt_more_char
, ' ');
10701 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10702 doc
: /* A mask of additional modifier keys to use with every keyboard character.
10703 Emacs applies the modifiers of the character stored here to each keyboard
10704 character it reads. For example, after evaluating the expression
10705 (setq extra-keyboard-modifiers ?\\C-x)
10706 all input characters will have the control modifier applied to them.
10708 Note that the character ?\\C-@, equivalent to the integer zero, does
10709 not count as a control character; rather, it counts as a character
10710 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
10711 cancels any modification. */);
10712 extra_keyboard_modifiers
= 0;
10714 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10715 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
10716 The command loop sets this to nil before each command,
10717 and tests the value when the command returns.
10718 Buffer modification stores t in this variable. */);
10719 Vdeactivate_mark
= Qnil
;
10721 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10722 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
10723 Vcommand_hook_internal
= Qnil
;
10725 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10726 doc
: /* Normal hook run before each command is executed.
10727 If an unhandled error happens in running this hook,
10728 the hook value is set to nil, since otherwise the error
10729 might happen repeatedly and make Emacs nonfunctional. */);
10730 Vpre_command_hook
= Qnil
;
10732 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10733 doc
: /* Normal hook run after each command is executed.
10734 If an unhandled error happens in running this hook,
10735 the hook value is set to nil, since otherwise the error
10736 might happen repeatedly and make Emacs nonfunctional. */);
10737 Vpost_command_hook
= Qnil
;
10739 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10740 doc
: /* Normal hook run after each command is executed, if idle.
10741 Errors running the hook are caught and ignored.
10742 This feature is obsolete; use idle timers instead. See `etc/NEWS'. */);
10743 Vpost_command_idle_hook
= Qnil
;
10745 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10746 doc
: /* Delay time before running `post-command-idle-hook'.
10747 This is measured in microseconds. */);
10748 post_command_idle_delay
= 100000;
10751 DEFVAR_LISP ("echo-area-clear-hook", ...,
10752 doc
: /* Normal hook run when clearing the echo area. */);
10754 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10755 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
10757 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10758 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
10759 Vlucid_menu_bar_dirty_flag
= Qnil
;
10761 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10762 doc
: /* List of menu bar items to move to the end of the menu bar.
10763 The elements of the list are event types that may have menu bar bindings. */);
10764 Vmenu_bar_final_items
= Qnil
;
10766 DEFVAR_KBOARD ("overriding-terminal-local-map",
10767 Voverriding_terminal_local_map
,
10768 doc
: /* Per-terminal keymap that overrides all other local keymaps.
10769 If this variable is non-nil, it is used as a keymap instead of the
10770 buffer's local map, and the minor mode keymaps and text property keymaps.
10771 This variable is intended to let commands such as `universal-argument'
10772 set up a different keymap for reading the next command. */);
10774 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
10775 doc
: /* Keymap that overrides all other local keymaps.
10776 If this variable is non-nil, it is used as a keymap instead of the
10777 buffer's local map, and the minor mode keymaps and text property keymaps. */);
10778 Voverriding_local_map
= Qnil
;
10780 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
10781 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
10782 Otherwise, the menu bar continues to reflect the buffer's local map
10783 and the minor mode maps regardless of `overriding-local-map'. */);
10784 Voverriding_local_map_menu_flag
= Qnil
;
10786 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
10787 doc
: /* Keymap defining bindings for special events to execute at low level. */);
10788 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
10790 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
10791 doc
: /* *Non-nil means generate motion events for mouse motion. */);
10793 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
10794 doc
: /* Alist of system-specific X windows key symbols.
10795 Each element should have the form (N . SYMBOL) where N is the
10796 numeric keysym code (sans the \"system-specific\" bit 1<<28)
10797 and SYMBOL is its name. */);
10799 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
10800 doc
: /* List of deferred actions to be performed at a later time.
10801 The precise format isn't relevant here; we just check whether it is nil. */);
10802 Vdeferred_action_list
= Qnil
;
10804 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
10805 doc
: /* Function to call to handle deferred actions, after each command.
10806 This function is called with no arguments after each command
10807 whenever `deferred-action-list' is non-nil. */);
10808 Vdeferred_action_function
= Qnil
;
10810 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
10811 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
10812 The value can be a length of time to show the message for.
10813 If the value is non-nil and not a number, we wait 2 seconds. */);
10814 Vsuggest_key_bindings
= Qt
;
10816 DEFVAR_LISP ("timer-list", &Vtimer_list
,
10817 doc
: /* List of active absolute time timers in order of increasing time. */);
10818 Vtimer_list
= Qnil
;
10820 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
10821 doc
: /* List of active idle-time timers in order of increasing time. */);
10822 Vtimer_idle_list
= Qnil
;
10824 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
10825 doc
: /* If non-nil, the function that implements the current input method.
10826 It's called with one argument, a printing character that was just read.
10827 \(That means a character with code 040...0176.)
10828 Typically this function uses `read-event' to read additional events.
10829 When it does so, it should first bind `input-method-function' to nil
10830 so it will not be called recursively.
10832 The function should return a list of zero or more events
10833 to be used as input. If it wants to put back some events
10834 to be reconsidered, separately, by the input method,
10835 it can add them to the beginning of `unread-command-events'.
10837 The input method function can find in `input-method-previous-method'
10838 the previous echo area message.
10840 The input method function should refer to the variables
10841 `input-method-use-echo-area' and `input-method-exit-on-first-char'
10842 for guidance on what to do. */);
10843 Vinput_method_function
= Qnil
;
10845 DEFVAR_LISP ("input-method-previous-message",
10846 &Vinput_method_previous_message
,
10847 doc
: /* When `input-method-function' is called, hold the previous echo area message.
10848 This variable exists because `read-event' clears the echo area
10849 before running the input method. It is nil if there was no message. */);
10850 Vinput_method_previous_message
= Qnil
;
10852 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
10853 doc
: /* If non-nil, the function that implements the display of help.
10854 It's called with one argument, the help string to display. */);
10855 Vshow_help_function
= Qnil
;
10857 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
10858 doc
: /* If non-nil, suppress point adjustment after executing a command.
10860 After a command is executed, if point is moved into a region that has
10861 special properties (e.g. composition, display), we adjust point to
10862 the boundary of the region. But, several special commands sets this
10863 variable to non-nil, then we suppress the point adjustment.
10865 This variable is set to nil before reading a command, and is checked
10866 just after executing the command. */);
10867 Vdisable_point_adjustment
= Qnil
;
10869 DEFVAR_LISP ("global-disable-point-adjustment",
10870 &Vglobal_disable_point_adjustment
,
10871 doc
: /* *If non-nil, always suppress point adjustment.
10873 The default value is nil, in which case, point adjustment are
10874 suppressed only after special commands that set
10875 `disable-point-adjustment' (which see) to non-nil. */);
10876 Vglobal_disable_point_adjustment
= Qnil
;
10878 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
10879 doc
: /* Non-nil means updating menu bindings is allowed.
10880 A value of nil means menu bindings should not be updated.
10881 Used during Emacs' startup. */);
10882 update_menu_bindings
= 1;
10884 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
10885 doc
: /* *How long to display an echo-area message when the minibuffer is active.
10886 If the value is not a number, such messages don't time out. */);
10887 Vminibuffer_message_timeout
= make_number (2);
10891 keys_of_keyboard ()
10893 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
10894 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
10895 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
10896 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
10897 initial_define_key (meta_map
, 'x', "execute-extended-command");
10899 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
10900 "handle-delete-frame");
10901 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
10903 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",